Add Cash on Delivery (COD) delivery option (#48)

Author: Thorry84

README.md

@@ -115,18 +115,20 @@ $parcel = new \Mvdnbrk\MyParcel\Resources\Parcel([
         'description' => 'Order #123',
         'signature' => true,
         'only_recipient' => true,
+        'cash_on_delivery' => 9.95,
         ...
     ],
 ]);
 ```
 
-Or you may use a method like `signature()`, `onlyRecipient()` and `labelDescription()`.
+Or you may use a method like `signature()`, `onlyRecipient()`, `labelDescription()` and `cashOnDelivery()`.
 You may call any of these after constructing the parcel.
 
 ``` php
 $parcel->onlyRecipient()
        ->signature()
-       ->labelDescription('Order #123');
+       ->labelDescription('Order #123')
+       ->cashOnDelivery(9.95);
 ```
 
 **Mailbox package**

src/Resources/Parcel.php

@@ -147,6 +147,19 @@ public function servicePoint(string $value)
         return $this;
     }
 
+    /**
+     * Set the amount for "Cash On Delivery" in EUR.
+     *
+     * @param  int|float  $value
+     * @return  $this
+     */
+    public function cashOnDelivery($value)
+    {
+        $this->options->setCashOnDelivery($value);
+
+        return $this;
+    }
+
     /**
      * Set the sender for this parcel.
      *

src/Resources/ShipmentOptions.php

@@ -24,6 +24,13 @@ class ShipmentOptions extends BaseResource
      */
     protected $service_point_id;
 
+    /**
+     * The amount for "Cash On Delivery" in EUR.
+     *
+     * @var int|float
+     */
+    protected $cash_on_delivery;
+
     /**
      * The description that will appear on the shipment label.
      *
@@ -133,6 +140,17 @@ public function setServicePointIdAttribute($value)
         $this->service_point_id = $value;
     }
 
+    /**
+     * Set the amount for "Cash On Delivery" in EUR.
+     *
+     * @param  int|float  $value
+     * @return void
+     */
+    public function setCashOnDelivery($value)
+    {
+        $this->cash_on_delivery = $value;
+    }
+
     /**
      * Convert the ShipmenOptions resource to an array.
      *
@@ -152,6 +170,12 @@ public function toArray()
                     'input' => $this->service_point_id,
                 ]);
             })
+            ->when(! empty($this->cash_on_delivery), function ($collection) {
+                return $collection->push([
+                    'key' => 'COD_CASH',
+                    'input' => $this->cash_on_delivery,
+                ]);
+            })
             ->when(! empty($this->label_description), function ($collection) {
                 return $collection->push([
                     'key' => 'REFERENCE',

tests/Unit/Resources/ParcelTest.php

@@ -216,6 +216,37 @@ public function calling_the_service_point_method_returns_the_same_parcel_instanc
         $this->assertSame($parcel, $parcel->servicePoint('8004-NL-272403'));
     }
 
+    /** @test */
+    public function it_can_set_an_amount_for_cash_on_delivery()
+    {
+        $parcel = new Parcel([
+            'options' => [
+                'cash_on_delivery' => 9.99,
+            ],
+        ]);
+
+        $this->assertEquals([
+            'key' => 'COD_CASH',
+            'input' => '9.99',
+        ], $parcel->options->toArray()[1]);
+
+        $parcel = new Parcel();
+        $parcel->cashOnDelivery(100);
+
+        $this->assertEquals([
+            'key' => 'COD_CASH',
+            'input' => '100',
+        ], $parcel->options->toArray()[1]);
+    }
+
+    /** @test */
+    public function calling_the_cash_on_delivery_method_returns_the_same_parcel_instance()
+    {
+        $parcel = new Parcel();
+
+        $this->assertSame($parcel, $parcel->cashOnDelivery(100));
+    }
+
     /** @test */
     public function it_sets_the_pieces_to_a_default_value_when_pieces_is_empty()
     {

tests/Unit/Resources/ShipmentOptionsTest.php

@@ -135,4 +135,26 @@ public function to_array_with_mailbox_package()
 
         $this->assertEquals(['key' => 'BP'], $array[0]);
     }
+
+    /** @test */
+    public function to_array_with_cash_on_delivery()
+    {
+        $options = new ShipmentOptions([
+            'cash_on_delivery' => 9.99,
+        ]);
+
+        $array = $options->toArray();
+
+        $this->assertIsArray($array);
+
+        $this->assertEquals([
+            [
+                'key' => 'DOOR',
+            ],
+            [
+                'key' => 'COD_CASH',
+                'input' => '9.99',
+            ],
+        ], $array);
+    }
 }