Merge pull request #137 from MyParcelCOM/develop

🚀
MyParcelCOM · Dec 31, 2020 · 7fd4a5b · 7fd4a5b
2 parents bf6cf2d + 95fcce9
commit 7fd4a5b
Show file tree

Hide file tree

Showing 10 changed files with 117 additions and 12 deletions.
diff --git a/src/MyParcelComApi.php b/src/MyParcelComApi.php
@@ -473,7 +473,7 @@ public function createShipment(ShipmentInterface $shipment)
             throw $exception;
         }
 
-        return $this->postResource($shipment);
+        return $this->postResource($shipment, $shipment->getMeta());
     }
 
     /**
@@ -492,7 +492,7 @@ public function updateShipment(ShipmentInterface $shipment)
             throw $exception;
         }
 
-        return $this->patchResource($shipment);
+        return $this->patchResource($shipment, $shipment->getMeta());
     }
 
     /**
@@ -764,40 +764,46 @@ public function getResourcesFromUri($uri)
      * Patch given resource and return the resource that was returned by the request.
      *
      * @param ResourceInterface $resource
+     * @param array             $meta
      * @return ResourceInterface|null
      * @throws RequestException
      */
-    protected function patchResource(ResourceInterface $resource)
+    protected function patchResource(ResourceInterface $resource, $meta = [])
     {
-        return $this->sendResource($resource, 'patch');
+        return $this->sendResource($resource, 'patch', $meta);
     }
 
     /**
      * Post given resource and return the resource that was returned by the request.
      *
      * @param ResourceInterface $resource
+     * @param array             $meta
      * @return ResourceInterface|null
      * @throws RequestException
      */
-    protected function postResource(ResourceInterface $resource)
+    protected function postResource(ResourceInterface $resource, $meta = [])
     {
-        return $this->sendResource($resource);
+        return $this->sendResource($resource, 'post', $meta);
     }
 
     /**
      * Send given resource to the API and return the resource that was returned.
      *
      * @param ResourceInterface $resource
      * @param string            $method
+     * @param array             $meta
      * @return ResourceInterface|null
      * @throws RequestException
      */
-    protected function sendResource(ResourceInterface $resource, $method = 'post')
+    protected function sendResource(ResourceInterface $resource, $method = 'post', $meta = [])
     {
         $response = $this->doRequest(
             $this->getResourceUri($resource->getType(), $resource->getId()),
             $method,
-            ['data' => $resource],
+            array_filter([
+                'data' => $resource,
+                'meta' => array_filter($meta),
+            ]),
             $this->authenticator->getAuthorizationHeader() + [
                 AuthenticatorInterface::HEADER_ACCEPT => AuthenticatorInterface::MIME_TYPE_JSONAPI,
             ]

diff --git a/src/Resources/Carrier.php b/src/Resources/Carrier.php
@@ -15,6 +15,7 @@ class Carrier implements CarrierInterface
     const ATTRIBUTE_NAME = 'name';
     const ATTRIBUTE_CODE = 'code';
     const ATTRIBUTE_CREDENTIALS_FORMAT = 'credentials_format';
+    const ATTRIBUTE_LABEL_MIME_TYPES = 'label_mime_types';
 
     /** @var string */
     private $id;
@@ -27,6 +28,7 @@ class Carrier implements CarrierInterface
         self::ATTRIBUTE_NAME               => null,
         self::ATTRIBUTE_CODE               => null,
         self::ATTRIBUTE_CREDENTIALS_FORMAT => [],
+        self::ATTRIBUTE_LABEL_MIME_TYPES   => [],
     ];
 
     /**
@@ -113,6 +115,25 @@ public function getCredentialsFormat()
         return $this->attributes[self::ATTRIBUTE_CREDENTIALS_FORMAT];
     }
 
+    /**
+     * @param array $labelMimeTypes
+     * @return $this
+     */
+    public function setLabelMimeTypes(array $labelMimeTypes)
+    {
+        $this->attributes[self::ATTRIBUTE_LABEL_MIME_TYPES] = $labelMimeTypes;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLabelMimeTypes()
+    {
+        return $this->attributes[self::ATTRIBUTE_LABEL_MIME_TYPES];
+    }
+
     /**
      * This function puts all object properties in an array and returns it.
      *

diff --git a/src/Resources/Interfaces/FileInterface.php b/src/Resources/Interfaces/FileInterface.php
@@ -19,6 +19,7 @@ interface FileInterface extends ResourceInterface
     const MIME_TYPE_PNG = 'image/png';
     const MIME_TYPE_JPG = 'image/jpeg';
     const MIME_TYPE_PDF = 'application/pdf';
+    const MIME_TYPE_ZPL = 'application/zpl';
 
     const FORMAT_MIME_TYPE = 'mime_type';
     const FORMAT_EXTENSION = 'extension';

diff --git a/src/Resources/Proxy/CarrierProxy.php b/src/Resources/Proxy/CarrierProxy.php
@@ -105,6 +105,25 @@ public function getCredentialsFormat()
         return $this->getResource()->getCredentialsFormat();
     }
 
+    /**
+     * @param array $labelMimeTypes
+     * @return $this
+     */
+    public function setLabelMimeTypes(array $labelMimeTypes)
+    {
+        $this->getResource()->setLabelMimeTypes($labelMimeTypes);
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getLabelMimeTypes()
+    {
+        return $this->getResource()->getLabelMimeTypes();
+    }
+
     /**
      * This function puts all object properties in an array and returns it.
      *

diff --git a/src/Resources/Proxy/ShipmentProxy.php b/src/Resources/Proxy/ShipmentProxy.php
@@ -59,6 +59,14 @@ public function getType()
         return $this->type;
     }
 
+    /**
+     * @return array
+     */
+    public function getMeta()
+    {
+        return $this->getResource()->getMeta();
+    }
+
     /**
      * @param AddressInterface $recipientAddress
      * @return $this
@@ -711,6 +719,14 @@ public function clearTags()
         return $this->getResource()->clearTags();
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function setLabelMimeType($labelMimeType)
+    {
+        return $this->getResource()->setLabelMimeType($labelMimeType);
+    }
+
     /**
      * This function puts all object properties in an array and returns it.
      *

diff --git a/src/Resources/Shipment.php b/src/Resources/Shipment.php
@@ -118,7 +118,7 @@ class Shipment implements ShipmentInterface
 
     /** @var array */
     private $meta = [
-        self::META_LABEL_MIME_TYPE => 'application/pdf',
+        self::META_LABEL_MIME_TYPE => FileInterface::MIME_TYPE_PDF,
         self::META_SERVICE_CODE    => null,
     ];
 
@@ -148,6 +148,14 @@ public function getType()
         return $this->type;
     }
 
+    /**
+     * @return array
+     */
+    public function getMeta()
+    {
+        return $this->meta;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -834,4 +842,16 @@ public function clearTags()
 
         return $this;
     }
+
+    /**
+     * Supported values are FileInterface::MIME_TYPE_PDF or FileInterface::MIME_TYPE_ZPL
+     * @param $labelMimeType
+     * @return $this
+     */
+    public function setLabelMimeType($labelMimeType)
+    {
+        $this->meta[self::META_LABEL_MIME_TYPE] = $labelMimeType;
+
+        return $this;
+    }
 }
diff --git a/tests/Feature/MyParcelComApiTest.php b/tests/Feature/MyParcelComApiTest.php
@@ -219,6 +219,7 @@ public function testGetCarriers()
             $this->assertNotEmpty($carrier->getName());
             $this->assertNotEmpty($carrier->getCode());
             $this->assertNotEmpty($carrier->getCredentialsFormat());
+            $this->assertNotEmpty($carrier->getLabelMimeTypes());
         }
     }
 

diff --git a/tests/Stubs/get/https---api-carriers-eef00b32-177e-43d3-9b26-715365e4ce46.json b/tests/Stubs/get/https---api-carriers-eef00b32-177e-43d3-9b26-715365e4ce46.json
@@ -19,7 +19,10 @@
             "type": "string"
           }
         }
-      }
+      },
+      "label_mime_types": [
+        "application/pdf"
+      ]
     },
     "links": {
       "self": "https://api/carriers/eef00b32-177e-43d3-9b26-715365e4ce46"

diff --git a/tests/Stubs/get/https---api-carriers/page-number--1/page-size--30.json b/tests/Stubs/get/https---api-carriers/page-number--1/page-size--30.json
@@ -20,7 +20,10 @@
               "type": "string"
             }
           }
-        }
+        },
+        "label_mime_types": [
+          "application/pdf"
+        ]
       },
       "links": {
         "self": "https://api/carriers/eef00b32-177e-43d3-9b26-715365e4ce46"
@@ -46,7 +49,10 @@
               "type": "string"
             }
           }
-        }
+        },
+        "label_mime_types": [
+          "application/pdf"
+        ]
       },
       "links": {
         "self": "https://api/carriers/4a78637a-5d81-4e71-9b18-c338968f72fa"

diff --git a/tests/Unit/ShipmentTest.php b/tests/Unit/ShipmentTest.php
@@ -440,6 +440,18 @@ public function testTags()
         $this->assertNull($shipment->getTags());
     }
 
+    /** @test */
+    public function testLabelMimeType()
+    {
+        $shipment = new Shipment();
+
+        $this->assertEquals(FileInterface::MIME_TYPE_PDF, $shipment->jsonSerialize()['meta']['label_mime_type']);
+
+        $shipment->setLabelMimeType(FileInterface::MIME_TYPE_ZPL);
+
+        $this->assertEquals(FileInterface::MIME_TYPE_ZPL, $shipment->jsonSerialize()['meta']['label_mime_type']);
+    }
+
     /** @test */
     public function testJsonSerialize()
     {