Merge pull request #38

Support for Customer Reference and Unit Tests

Author: code2prog

src/FedexRest/Entity/CustomerReference.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace FedexRest\Entity;
+
+class CustomerReference
+{
+    public string $type;
+    public string $value;
+
+    public function setType(string $type): CustomerReference
+    {
+        $this->type = $type;
+        return $this;
+    }
+
+    public function setValue(string $value): CustomerReference
+    {
+        $this->value = $value;
+        return $this;
+    }
+
+    public function prepare(): array {
+        $data = [];
+        if (!empty($this->type)) {
+            $data['customerReferenceType'] = $this->type;
+            $data['value'] = $this->value;
+        }
+        return $data;
+    }
+
+
+}

src/FedexRest/Entity/Item.php

@@ -2,6 +2,7 @@
 
 namespace FedexRest\Entity;
 
+use FedexRest\Entity\CustomerReference;
 use FedexRest\Services\Ship\Entity\Value;
 
 class Item
@@ -14,6 +15,7 @@ class Item
     public ?string $subPackagingType;
     public ?Value $declaredValue;
     public ?PackageSpecialServicesRequested $packageSpecialServices;
+    public array $customerReferences = [];
 
     /**
      * @param  string  $itemDescription
@@ -95,6 +97,26 @@ public function setPackageSpecialServices(?PackageSpecialServicesRequested $pack
     return $this;
   }
 
+  /**
+   * @param  CustomerReference[]  $customerReferences
+   * @return Item
+   */
+  public function setCustomerReferences(array $customerReferences): Item
+  {
+      $this->customerReferences = $customerReferences;
+      return $this;
+  }
+
+  /**
+   * @param  CustomerReference  $customerReference
+   * @return Item
+   */
+  public function addCustomerReference(CustomerReference $customerReference): Item
+  {
+      $this->customerReferences[] = $customerReference;
+      return $this;
+  }
+
     public function prepare(): array
     {
         $data = [];
@@ -131,6 +153,14 @@ public function prepare(): array
             $data['packageSpecialServices'] = $this->packageSpecialServices->prepare();
         }
 
+        if (!empty($this->customerReferences)) {
+            $customerReferences = [];
+            foreach ($this->customerReferences as $customerReference) {
+                $customerReferences[] = $customerReference->prepare();
+            }
+            $data['customerReferences'] = $customerReferences;
+        }
+
         return $data;
     }
 

src/FedexRest/Services/Ship/Type/CustomerReferenceType.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace FedexRest\Services\Ship\Type;
+
+class CustomerReferenceType
+{
+
+    const _CUSTOMER_REFERENCE = 'CUSTOMER_REFERENCE';
+    const _DEPARTMENT_NUMBER = 'DEPARTMENT_NUMBER';
+    const _INVOICE_NUMBER = 'INVOICE_NUMBER';
+    const _P_O_NUMBER = 'P_O_NUMBER';
+    const _INTRACOUNTRY_REGULATORY_REFERENCE = 'INTRACOUNTRY_REGULATORY_REFERENCE';
+    const _RMA_ASSOCIATION = 'RMA_ASSOCIATION';
+
+}

tests/FedexRest/Tests/Entity/ItemEntityTest.php

@@ -2,17 +2,19 @@
 
 namespace FedexRest\Tests\Entity;
 
-use FedexRest\Entity\DangerousGoodsDetail;
-use FedexRest\Entity\Dimensions;
 use FedexRest\Entity\Item;
-use FedexRest\Entity\PackageSpecialServicesRequested;
 use FedexRest\Entity\Weight;
+use PHPUnit\Framework\TestCase;
+use FedexRest\Entity\Dimensions;
+use FedexRest\Entity\CustomerReference;
 use FedexRest\Services\Ship\Entity\Value;
-use FedexRest\Services\Ship\Type\DangerousGoodsAccessibilityType;
+use FedexRest\Entity\DangerousGoodsDetail;
 use FedexRest\Services\Ship\Type\LinearUnits;
-use FedexRest\Services\Ship\Type\SubPackagingType;
 use FedexRest\Services\Ship\Type\WeightUnits;
-use PHPUnit\Framework\TestCase;
+use FedexRest\Services\Ship\Type\SubPackagingType;
+use FedexRest\Entity\PackageSpecialServicesRequested;
+use FedexRest\Services\Ship\Type\CustomerReferenceType;
+use FedexRest\Services\Ship\Type\DangerousGoodsAccessibilityType;
 
 class ItemEntityTest extends TestCase
 {
@@ -42,6 +44,10 @@ public function testItemHasAttributes()
                   (new DangerousGoodsDetail())
                     ->setAccessibility(DangerousGoodsAccessibilityType::_ACCESSIBLE)
                 )
+            )->addCustomerReference(
+                (new CustomerReference())
+                    ->setType(CustomerReferenceType::_CUSTOMER_REFERENCE)
+                    ->setValue('123456')
             );
         $this->assertObjectHasProperty('itemDescription', $item);
         $this->assertObjectHasProperty('dimensions', $item);
@@ -51,6 +57,7 @@ public function testItemHasAttributes()
         $this->assertObjectHasProperty('subPackagingType', $item);
         $this->assertObjectHasProperty('declaredValue', $item);
         $this->assertObjectHasProperty('packageSpecialServices', $item);
+        $this->assertObjectHasProperty('customerReferences', $item);
         $test_item = $item->prepare();
         $this->assertEquals(1, $test_item['weight']['value']);
         $this->assertEquals(WeightUnits::_POUND, $test_item['weight']['units']);
@@ -64,5 +71,7 @@ public function testItemHasAttributes()
         $this->assertEquals(100, $test_item['declaredValue']['amount']);
         $this->assertEquals('USD', $test_item['declaredValue']['currency']);
         $this->assertEquals(DangerousGoodsAccessibilityType::_ACCESSIBLE, $test_item['packageSpecialServices']['dangerousGoodsDetail']['accessibility']);
+        $this->assertEquals(CustomerReferenceType::_CUSTOMER_REFERENCE, $test_item['customerReferences'][0]['customerReferenceType']);
+        $this->assertEquals('123456', $test_item['customerReferences'][0]['value']);
     }
 }

tests/FedexRest/Tests/Ship/CreateShipmentTest.php

@@ -2,35 +2,37 @@
 
 namespace FedexRest\Tests\Ship;
 
-use FedexRest\Authorization\Authorize;
+use FedexRest\Entity\Item;
+use FedexRest\Entity\Person;
+use FedexRest\Entity\Weight;
 use FedexRest\Entity\Address;
+use PHPUnit\Framework\TestCase;
 use FedexRest\Entity\Dimensions;
+use FedexRest\Authorization\Authorize;
+use FedexRest\Entity\CustomerReference;
+use FedexRest\Services\Ship\Entity\Label;
+use GuzzleHttp\Exception\GuzzleException;
+use FedexRest\Services\Ship\CreateShipment;
+use FedexRest\Services\Ship\Type\ImageType;
+use FedexRest\Services\Ship\Type\PickupType;
+use FedexRest\Services\Ship\Type\LinearUnits;
+use FedexRest\Services\Ship\Type\ServiceType;
+use FedexRest\Services\Ship\Type\WeightUnits;
+use FedexRest\Services\Ship\Type\PackagingType;
 use FedexRest\Entity\EmailNotificationRecipient;
-use FedexRest\Entity\Item;
+use FedexRest\Services\Ship\Type\LabelStockType;
+use FedexRest\Exceptions\MissingLineItemException;
+use FedexRest\Services\Ship\Type\LabelDocOptionType;
 use FedexRest\Exceptions\MissingAccessTokenException;
+use FedexRest\Exceptions\MissingAccountNumberException;
 use FedexRest\Exceptions\MissingAuthCredentialsException;
-use FedexRest\Exceptions\MissingLineItemException;
-use FedexRest\Services\Ship\Entity\EmailNotificationDetail;
-use FedexRest\Services\Ship\Entity\Label;
-use FedexRest\Entity\Person;
 use FedexRest\Services\Ship\Entity\ShippingChargesPayment;
-use FedexRest\Entity\Weight;
-use FedexRest\Exceptions\MissingAccountNumberException;
+use FedexRest\Services\Ship\Type\LabelResponseOptionsType;
+use FedexRest\Services\Ship\Entity\EmailNotificationDetail;
 use FedexRest\Services\Ship\Exceptions\MissingLabelException;
 use FedexRest\Services\Ship\Exceptions\MissingLabelResponseOptionsException;
 use FedexRest\Services\Ship\Exceptions\MissingShippingChargesPaymentException;
-use FedexRest\Services\Ship\CreateShipment;
-use FedexRest\Services\Ship\Type\ImageType;
-use FedexRest\Services\Ship\Type\LabelDocOptionType;
-use FedexRest\Services\Ship\Type\LabelResponseOptionsType;
-use FedexRest\Services\Ship\Type\LabelStockType;
-use FedexRest\Services\Ship\Type\LinearUnits;
-use FedexRest\Services\Ship\Type\PackagingType;
-use FedexRest\Services\Ship\Type\PickupType;
-use FedexRest\Services\Ship\Type\ServiceType;
-use FedexRest\Services\Ship\Type\WeightUnits;
-use GuzzleHttp\Exception\GuzzleException;
-use PHPUnit\Framework\TestCase;
+use FedexRest\Services\Ship\Type\CustomerReferenceType;
 
 class CreateShipmentTest extends TestCase
 {
@@ -413,6 +415,14 @@ public function testRequest()
                     ->setLength(12)
                     ->setHeight(12)
                     ->setUnits(LinearUnits::_INCH)
+                )->addCustomerReference(
+                    (new CustomerReference())
+                        ->setType(CustomerReferenceType::_CUSTOMER_REFERENCE)
+                        ->setValue('123456')
+                )->addCustomerReference(
+                    (new CustomerReference())
+                        ->setType(CustomerReferenceType::_INVOICE_NUMBER)
+                        ->setValue('INVOICE')
                 )
             )
             ->setEmailNotificationDetail((new EmailNotificationDetail)
@@ -441,6 +451,8 @@ public function testRequest()
         $this->assertNotEmpty($new_shipment->pieceResponses);
         $this->assertNotEmpty($new_shipment->completedShipmentDetail);
         $this->assertEquals('GROUND', $new_shipment->serviceCategory);
+        $this->assertNotEmpty($new_shipment->pieceResponses[0]->customerReferences);
+
     }
 
 }