Merge branch 'master' of github.com:mvdnbrk/myparcel-php-api

Author: mvdnbrk

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to `myparcel-php-api` will be documented in this file.
 
 ## [Unreleased]
 
+## [v0.9.2] - 2019-04-26
+
+### Added
+- Added a `setFormatA4` method to change the default label format from A6 to A4. [`#24`](https://github.com/mvdnbrk/myparcel-php-api/pull/24)
+
 ## [v0.9.1] - 2019-04-26
 
 ### Added
@@ -110,7 +115,8 @@ All notable changes to `myparcel-php-api` will be documented in this file.
 
 ### Initial release
 
-[Unreleased]: https://github.com/mvdnbrk/myparcel-php-api/compare/v0.9.1...HEAD
+[Unreleased]: https://github.com/mvdnbrk/myparcel-php-api/compare/v0.9.2...HEAD
+[v0.9.2]: https://github.com/mvdnbrk/myparcel-php-api/compare/v0.9.1...v0.9.2
 [v0.9.1]: https://github.com/mvdnbrk/myparcel-php-api/compare/v0.9.0...v0.9.1
 [v0.9.0]: https://github.com/mvdnbrk/myparcel-php-api/compare/v0.8.0...v0.9.0
 [v0.8.0]: https://github.com/mvdnbrk/myparcel-php-api/compare/v0.7.3...v0.8.0

README.md

@@ -81,15 +81,10 @@ Or you may pass the `Shipment` instance directly to this method:
 $myparcel->labels->get($shipment);
 ```
 
-It's also possible to specify a Label configuration (for example: A4)
-```php
-$label = new \Mvdnbrk\MyParcel\Resources\Label;
-$label->setFormatAttribute('A4');
-
-$shipmentLabel = new \Mvdnbrk\MyParcel\Resources\ShipmentLabels($myparcel);
-$shipmentLabel->setLabel($label);
+The label format is A6 by default, you may change this by calling the `setFormatA4` method:
 
-$shipmentLabel->get($shipment->id);
+```php
+$myparcel->labels->setFormatA4()->get($shipment);
 ```
 
 ### Setting delivery options for a parcel

src/Endpoints/ShipmentLabels.php

@@ -3,6 +3,7 @@
 namespace Mvdnbrk\MyParcel\Endpoints;
 
 use Mvdnbrk\MyParcel\Resources\Label;
+use Mvdnbrk\MyParcel\Types\PaperSize;
 use Mvdnbrk\MyParcel\Resources\Shipment;
 
 class ShipmentLabels extends BaseEndpoint
@@ -46,6 +47,18 @@ public function get($value)
         return $response;
     }
 
+    /**
+     * Sets the label to A4 format.
+     *
+     * @return  $this
+     */
+    public function setFormatA4()
+    {
+        $this->label->setFormatAttribute(PaperSize::A4);
+
+        return $this;
+    }
+
     /**
      * Set a label.
      *

tests/Feature/Endpoints/ShipmentLabelsTest.php

@@ -58,6 +58,12 @@ public function it_can_set_a_label()
         $this->assertInstanceOf(ShipmentLabels::class, $this->client->labels->setLabel($label));
     }
 
+    /** @test */
+    public function it_can_set_the_format_to_A4()
+    {
+        $this->assertInstanceOf(ShipmentLabels::class, $this->client->labels->setFormatA4());
+    }
+
     /** @test */
     public function getting_a_label_with_an_invalid_shipment_id_should_throw_an_error()
     {