Merge pull request thephpleague#5 from rushi/master

Add ability to specify custom 'billTo' information

Author: anush

src/CIMGateway.php

@@ -9,11 +9,43 @@
  */
 class CIMGateway extends AIMGateway
 {
+    public function getDefaultParameters()
+    {
+        return array(
+            'apiLoginId' => '',
+            'transactionKey' => '',
+            'testMode' => false,
+            'developerMode' => false,
+            'forceCardUpdate' => false,
+            'defaultBillTo' => [[]]
+        );
+    }
+
     public function getName()
     {
         return 'Authorize.Net CIM';
     }
 
+    public function setForceCardUpdate($forceCardUpdate)
+    {
+        return $this->setParameter('forceCardUpdate', $forceCardUpdate);
+    }
+
+    public function getForceCardUpdate()
+    {
+        return $this->getParameter('forceCardUpdate');
+    }
+
+    public function setDefaultBillTo($defaultBillTo)
+    {
+        return $this->setParameter('defaultBillTo', $defaultBillTo);
+    }
+
+    public function getDefaultBillTo()
+    {
+        return $this->getParameter('defaultBillTo');
+    }
+
     /**
      * Create a new debit or credit card
      *
@@ -45,4 +77,9 @@ public function refund(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMRefundRequest', $parameters);
     }
+
+    public function void(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMVoidRequest', $parameters);
+    }
 }

src/Message/CIMAbstractRequest.php

@@ -67,6 +67,16 @@ public function getForceCardUpdate()
         return $this->getParameter('forceCardUpdate');
     }
 
+    public function setDefaultBillTo($defaultBillTo)
+    {
+        return $this->setParameter('defaultBillTo', $defaultBillTo);
+    }
+
+    public function getDefaultBillTo()
+    {
+        return $this->getParameter('defaultBillTo');
+    }
+
     /**
      * Create and return the base XML data required to create a new request
      *

src/Message/CIMCreateCardRequest.php

@@ -88,6 +88,18 @@ protected function addBillingData(\SimpleXMLElement $data)
             $req->zip = $card->getBillingPostcode();
             $req->country = $card->getBillingCountry();
 
+            $defaultBillTo = $this->getParameter('defaultBillTo');
+            if (is_array($defaultBillTo)) {
+                // A configuration parameter to populate billTo has been specified
+                foreach ($defaultBillTo as $field => $value) {
+                    if (empty($req->{$field}) && !empty($value)) {
+                        // This particular field is empty and default value in populateBillTo has been specified
+                        // so use it
+                        $req->{$field} = $value;
+                    }
+                }
+            }
+
             $req = $data->addChild('payment');
             $req->creditCard->cardNumber = $card->getNumber();
             $req->creditCard->expirationDate = $card->getExpiryDate('Y-m');

src/Message/CIMVoidRequest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Omnipay\AuthorizeNet\Message;
+
+/**
+ * Authorize.Net CIM Void Request
+ */
+class CIMVoidRequest extends CIMAbstractRequest
+{
+    protected $action = 'voidTransaction';
+
+    public function getData()
+    {
+        $this->validate('transactionReference');
+
+        $data = $this->getBaseData();
+        $data->transactionRequest->refTransId = $this->getTransactionReference();
+        $this->addTestModeSetting($data);
+
+        return $data;
+    }
+}

tests/CIMGatewayTest.php

@@ -38,12 +38,6 @@ public function setUp()
             'transactionReference' => '{"approvalCode":"DMK100","transId":"2220001902","cardReference":"{\"customerProfileId\":\"28972084\",\"customerPaymentProfileId\":\"26317840\",\"customerShippingAddressId\":\"27057149\"}"}',
         );
 
-        $this->authorizeOptions = array(
-            'cardReference' => '{"customerProfileId":"28972084","customerPaymentProfileId":"26317840","customerShippingAddressId":"27057149"}',
-            'amount' => 10.00,
-            'description' => 'purchase'
-        );
-
         $this->refundOptions = array(
             'amount' => '10.00',
             'transactionReference' => '{"approvalCode":"DMK100","transId":"2220001902","cardReference":"{\"customerProfileId\":\"28972084\",\"customerPaymentProfileId\":\"26317840\",\"customerShippingAddressId\":\"27057149\"}"}',

tests/Message/CIMCreateCardRequestTest.php

@@ -29,4 +29,29 @@ public function testGetData()
         $this->assertEquals($card['number'], $data->profile->paymentProfiles->payment->creditCard->cardNumber);
         $this->assertEquals('testMode', $data->validationMode);
     }
+
+    public function testGetDataShouldHaveCustomBillTo()
+    {
+        $card = $this->getValidCard();
+        unset($card['billingAddress1']);
+        unset($card['billingAddress2']);
+        unset($card['billingCity']);
+        $this->request->initialize(
+            array(
+                'email' => "kaylee@serenity.com",
+                'card' => $card,
+                'developerMode' => true,
+                'forceCardUpdate' => true,
+                'defaultBillTo' => [
+                    'address' => '1234 Test Street',
+                    'city' => 'Blacksburg'
+                ]
+            )
+        );
+
+        $data = $this->request->getData();
+        $this->assertEquals('12345', $data->profile->paymentProfiles->billTo->zip);
+        $this->assertEquals('1234 Test Street', $data->profile->paymentProfiles->billTo->address);
+        $this->assertEquals('Blacksburg', $data->profile->paymentProfiles->billTo->city);
+    }
 }