tijsverkoyen / bpost

Other
28 stars 47 forks source link

Many changes #25

Closed kouinkouin closed 7 years ago

kouinkouin commented 8 years ago

Hi Tijs,

Presentation

We (Antidot, an IT company) made a lot of changes, requested from bpost:

Below, the changelog.

Caution :warning: :

- Namespaces

We change the namespaces from TijsVerkoyen\bpost to Bpost\BpostApiClient. We can still call TijsVerkoyen\bpost classes (because TijsVerkoyen\bpost classes extend classes with new namespace), but for the exceptions catching, the "instance of" doesn't work. That's known, and we cannot solve it without keep TijsVerkoyen\bpost\Exception (renamed to Bpost\BpostApiClient\BpostException).

- Semantic versions

Since we develop on the library, we use the semantic versioning. That permits to distinct bug-fixes, features, and too, major releases which break the compatibility (with namespaces for example). We didn't publish 4.0.0, I think it will to you (or the maintainer) to publish it, by precising that can break the existent code (on exceptions management).

Change log

For main features, here an extract of the CHANGELOG :

3.4.0

  • Add retro-compatibility with tijsverkoyen library (namespace changes)
  • Complete the README (examples, broken links, ...)
  • Change API URL (api.bpost.be -> api-parcel.bpost.be)
  • Labels features
    • Possibility to append field "order reference"
    • Possibility to force printing
  • Geo6 features
    • Geo6 is now called via HTTPS
    • Send data to API via POST
    • Add Geo6::getPointType() to calculate point types
  • Products features
    • Add "bpack World Easy Return" to international products
    • Box At247 can contain a product bpack 24/7

      3.3.0

  • Use bpost API version 3.3 (yet, bpack part only)
  • Change namespace TijsVerkoyen\Bpost to Bpost\BpostApiClient
  • Add more unit tests to perform code coverage
  • Begin to based the unit tests on XML examples given by bpost
  • Add CONTRIBUTING.md