Ensure API data type property order (#19)

commerceguys · Jul 2, 2017 · 7201ced · 7201ced
1 parent b55014f
commit 7201ced
Show file tree

Hide file tree

Showing 12 changed files with 124 additions and 18 deletions.
diff --git a/src/DataTypes/BankAccount.php b/src/DataTypes/BankAccount.php
@@ -2,9 +2,17 @@
 
 namespace CommerceGuys\AuthNet\DataTypes;
 
-use CommerceGuys\AuthNet\DataTypes\PaymentMethodInterface;
-
 class BankAccount extends BaseDataType implements PaymentMethodInterface
 {
-
+    protected $propertyMap = [
+        'accountType',
+        // Format of routingNumber should be nine digits or four X's followed by the last four digits.
+        'routingNumber',
+        // Format of accountNumber should be numeric string or four X's followed by the last four digits.
+        'accountNumber',
+        'nameOnAccount',
+        'echeckType',
+        'bankName',
+        'checkNumber',
+    ];
 }
diff --git a/src/DataTypes/BaseDataType.php b/src/DataTypes/BaseDataType.php
@@ -4,6 +4,7 @@
 
 abstract class BaseDataType implements DataTypeInterface
 {
+    protected $propertyMap = [];
     protected $properties;
 
     public function __construct(array $values = [])
@@ -25,7 +26,14 @@ protected function validate(array $values)
 
     public function toArray()
     {
-        return $this->properties;
+        $sorted_properties = [];
+        foreach ($this->propertyMap as $property_key) {
+            if (isset($this->properties[$property_key])) {
+                $sorted_properties[$property_key] = $this->properties[$property_key];
+            }
+        }
+        $sorted_properties += $this->properties;
+        return $sorted_properties;
     }
 
     public function getType()

diff --git a/src/DataTypes/BillTo.php b/src/DataTypes/BillTo.php
@@ -5,4 +5,16 @@
 class BillTo extends BaseDataType
 {
 
+    protected $propertyMap = [
+        'firstName',
+        'lastName',
+        'company',
+        'address',
+        'city',
+        'state',
+        'zip',
+        'country',
+        'phoneNumber',
+        'faxNumber',
+    ];
 }
diff --git a/src/DataTypes/CreditCard.php b/src/DataTypes/CreditCard.php
@@ -2,9 +2,12 @@
 
 namespace CommerceGuys\AuthNet\DataTypes;
 
-use CommerceGuys\AuthNet\DataTypes\PaymentMethodInterface;
-
 class CreditCard extends BaseDataType implements PaymentMethodInterface
 {
 
+    protected $propertyMap = [
+        'cardNumber',
+        'expirationDate',
+        'cardCode',
+    ];
 }
diff --git a/src/DataTypes/LineItem.php b/src/DataTypes/LineItem.php
@@ -5,4 +5,12 @@
 class LineItem extends BaseDataType
 {
 
+    protected $propertyMap = [
+        'itemId',
+        'name',
+        'description',
+        'quantity',
+        // Price of an item per unit, excluding tax, freight, and duty.
+        'unitPrice',
+    ];
 }
diff --git a/src/DataTypes/MerchantAuthentication.php b/src/DataTypes/MerchantAuthentication.php
@@ -5,4 +5,8 @@
 class MerchantAuthentication extends BaseDataType
 {
 
+    protected $propertyMap = [
+        'name',
+        'transactionKey',
+    ];
 }
diff --git a/src/DataTypes/Order.php b/src/DataTypes/Order.php
@@ -5,4 +5,8 @@
 class Order extends BaseDataType
 {
 
+    protected $propertyMap = [
+        'invoiceNumber',
+        'description',
+    ];
 }
diff --git a/src/DataTypes/PaymentProfile.php b/src/DataTypes/PaymentProfile.php
@@ -2,9 +2,16 @@
 
 namespace CommerceGuys\AuthNet\DataTypes;
 
-// @todo If the billTo element is not before payment, an error occurs.
 class PaymentProfile extends BaseDataType
 {
+
+    protected $propertyMap = [
+        'customerType',
+        'billTo',
+        'payment',
+        'defaultPaymentProfile',
+    ];
+
     public function addPayment(PaymentMethodInterface $paymentMethod)
     {
         $this->properties['payment'][$paymentMethod->getType()] = $paymentMethod->toArray();

diff --git a/src/DataTypes/Profile.php b/src/DataTypes/Profile.php
@@ -4,6 +4,13 @@
 
 class Profile extends BaseDataType
 {
+    protected $propertyMap = [
+        'merchantCustomerId',
+        'description',
+        'email',
+        'paymentProfiles',
+    ];
+
     public function addPaymentProfile(PaymentProfile $profile)
     {
         $this->properties['paymentProfiles'] = $profile->toArray();

diff --git a/src/DataTypes/ShipTo.php b/src/DataTypes/ShipTo.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace CommerceGuys\AuthNet\DataTypes;
+
+class ShipTo extends BaseDataType
+{
+
+    protected $propertyMap = [
+        'firstName',
+        'lastName',
+        'company',
+        'address',
+        'city',
+        'state',
+        'zip',
+        'country',
+    ];
+}
diff --git a/src/DataTypes/TransactionRequest.php b/src/DataTypes/TransactionRequest.php
@@ -11,10 +11,38 @@ class TransactionRequest extends BaseDataType
     const REFUND = 'refundTransaction';
     const VOID = 'voidTransaction';
 
+    protected $propertyMap = [
+        'transactionType',
+        'amount',
+        'payment',
+        'profile',
+        'solution',
+        'order',
+        'lineItems',
+        'tax',
+        'shipping',
+        'taxExempt',
+        'poNumber',
+        'customer',
+        'billTo',
+        'shipTo',
+        'customerIP',
+        'cardholderAuthentication',
+        'retail',
+        'employeeId',
+        'transactionSettings',
+        'userFields',
+    ];
+
+    protected $properties = [
+        'solution' => [
+            'id' => 'A1000009',
+        ],
+    ];
+
     public function addPayment(CreditCard $creditCard)
     {
         $this->properties['payment'][$creditCard->getType()] = $creditCard->toArray();
-        $this->properties['solution']['id'] = 'A1000009';
     }
     public function addOrder(Order $order)
     {

diff --git a/tests/CustomerPaymentProfileRequestTest.php b/tests/CustomerPaymentProfileRequestTest.php
@@ -25,7 +25,6 @@ public function testCreateCustomerPaymentProfileWithCreditCard()
         $request->setProfile($profile);
         $request->setValidationMode('none');
         $response = $request->execute();
-
         $customerProfileId = $response->customerProfileId;
 
         $request = new CreateCustomerPaymentProfileRequest($this->configurationXml, $this->client);
@@ -104,7 +103,15 @@ public function testCreateCustomerPaymentProfileWithBankAccount()
         $paymentProfile = new PaymentProfile([
             'customerType' => 'individual',
         ]);
-        // @note: You must add the billTo first.
+
+        // Add payment first, to assert properties mapped in proper order.
+        $paymentProfile->addPayment(new BankAccount([
+          'accountType' => 'checking',
+          'routingNumber' => '111000614',
+          'accountNumber' => '123456789',
+          'nameOnAccount' => 'Dwayne Johnson',
+          'bankName' => 'Bank of America'
+        ]));
         $paymentProfile->addBillTo(new BillTo([
             'firstName' => 'Johnny',
             'lastName' => 'Appleseed',
@@ -116,14 +123,6 @@ public function testCreateCustomerPaymentProfileWithBankAccount()
             'phoneNumber' => '5555555555',
         ]));
 
-        $paymentProfile->addPayment(new BankAccount([
-            'accountType' => 'checking',
-            'routingNumber' => '111000614',
-            'accountNumber' => '123456789',
-            'nameOnAccount' => 'Dwayne Johnson',
-            'bankName' => 'Bank of America'
-        ]));
-
         $request->setPaymentProfile($paymentProfile);
 
         $response = $request->execute();