Using the XML API for AIM gateway

.gitignore

@@ -2,3 +2,4 @@
 composer.lock
 composer.phar
 phpunit.xml
+.idea

README.md

@@ -32,6 +32,7 @@ And run composer to update your dependencies:
 The following gateways are provided by this package:
 
 * AuthorizeNet_AIM
+* AuthorizeNet_CIM
 * AuthorizeNet_SIM
 * AuthorizeNet_DPM
 

composer.json

@@ -24,11 +24,17 @@
             "homepage": "https://github.com/thephpleague/omnipay-authorizenet/contributors"
         }
     ],
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/xola/omnipay-common"
+        }
+    ],
     "autoload": {
         "psr-4": { "Omnipay\\AuthorizeNet\\" : "src/" }
     },
     "require": {
-        "omnipay/common": "~2.0"
+        "omnipay/common": "~2.4.2"
     },
     "require-dev": {
         "omnipay/tests": "~2.0"

src/AIMGateway.php

@@ -2,6 +2,11 @@
 
 namespace Omnipay\AuthorizeNet;
 
+use Omnipay\AuthorizeNet\Message\AIMAuthorizeRequest;
+use Omnipay\AuthorizeNet\Message\AIMCaptureRequest;
+use Omnipay\AuthorizeNet\Message\AIMPurchaseRequest;
+use Omnipay\AuthorizeNet\Message\AIMRefundRequest;
+use Omnipay\AuthorizeNet\Message\AIMVoidRequest;
 use Omnipay\Common\AbstractGateway;
 
 /**
@@ -21,8 +26,8 @@ public function getDefaultParameters()
             'transactionKey'    => '',
             'testMode'          => false,
             'developerMode'     => false,
-            'liveEndpoint'      => 'https://secure2.authorize.net/gateway/transact.dll',
-            'developerEndpoint' => 'https://test.authorize.net/gateway/transact.dll',
+            'liveEndpoint'      => 'https://api.authorize.net/xml/v1/request.api',
+            'developerEndpoint' => 'https://apitest.authorize.net/xml/v1/request.api',
         );
     }
 
@@ -82,26 +87,46 @@ public function setDeveloperEndpoint($value)
         return $this->setParameter('developerEndpoint', $value);
     }
 
+    /**
+     * @param array $parameters
+     * @return AIMAuthorizeRequest
+     */
     public function authorize(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMAuthorizeRequest', $parameters);
     }
 
+    /**
+     * @param array $parameters
+     * @return AIMCaptureRequest
+     */
     public function capture(array $parameters = array())
     {
-        return $this->createRequest('\Omnipay\AuthorizeNet\Message\CaptureRequest', $parameters);
+        return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMCaptureRequest', $parameters);
     }
 
+    /**
+     * @param array $parameters
+     * @return AIMPurchaseRequest
+     */
     public function purchase(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMPurchaseRequest', $parameters);
     }
 
+    /**
+     * @param array $parameters
+     * @return AIMVoidRequest
+     */
     public function void(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMVoidRequest', $parameters);
     }
 
+    /**
+     * @param array $parameters
+     * @return AIMRefundRequest
+     */
     public function refund(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\AuthorizeNet\Message\AIMRefundRequest', $parameters);

src/CIMGateway.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Omnipay\AuthorizeNet;
+
+use Omnipay\AuthorizeNet\Message\CIMCreateCardRequest;
+
+/**
+ * Authorize.Net CIM Class
+ */
+class CIMGateway extends AIMGateway
+{
+    public function getDefaultParameters()
+    {
+        $params = parent::getDefaultParameters();
+        $params['forceCardUpdate'] = false;
+        $params['defaultBillTo'] = array(array());
+        return $params;
+    }
+
+    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
+     *
+     * @param array $parameters
+     *
+     * @return CIMCreateCardRequest
+     */
+    public function createCard(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMCreateCardRequest', $parameters);
+    }
+
+    public function authorize(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMAuthorizeRequest', $parameters);
+    }
+
+    public function capture(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMCaptureRequest', $parameters);
+    }
+
+    public function purchase(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\AuthorizeNet\Message\CIMPurchaseRequest', $parameters);
+    }
+
+    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/AIMAbstractRequest.php

@@ -0,0 +1,201 @@
+<?php
+
+namespace Omnipay\AuthorizeNet\Message;
+
+use Omnipay\Common\CreditCard;
+use Omnipay\Common\Exception\InvalidRequestException;
+use Omnipay\Common\Message\AbstractRequest;
+
+/**
+ * Authorize.Net AIM Abstract Request
+ */
+abstract class AIMAbstractRequest extends AbstractRequest
+{
+    protected $action = null;
+
+    public function getApiLoginId()
+    {
+        return $this->getParameter('apiLoginId');
+    }
+
+    public function setApiLoginId($value)
+    {
+        return $this->setParameter('apiLoginId', $value);
+    }
+
+    public function getTransactionKey()
+    {
+        return $this->getParameter('transactionKey');
+    }
+
+    public function setTransactionKey($value)
+    {
+        return $this->setParameter('transactionKey', $value);
+    }
+
+    public function getDeveloperMode()
+    {
+        return $this->getParameter('developerMode');
+    }
+
+    public function setDeveloperMode($value)
+    {
+        return $this->setParameter('developerMode', $value);
+    }
+
+    public function getCustomerId()
+    {
+        return $this->getParameter('customerId');
+    }
+
+    public function setCustomerId($value)
+    {
+        return $this->setParameter('customerId', $value);
+    }
+
+    public function getHashSecret()
+    {
+        return $this->getParameter('hashSecret');
+    }
+    public function setHashSecret($value)
+    {
+        return $this->setParameter('hashSecret', $value);
+    }
+
+    public function setDuplicateWindow($value)
+    {
+        $this->setParameter('duplicateWindow', $value);
+    }
+
+    private function getDuplicateWindow()
+    {
+        return $this->getParameter('duplicateWindow'); // Maps x_duplicate_window
+    }
+
+    protected function addExtraOptions(\SimpleXMLElement $data)
+    {
+        if (!is_null($this->getDuplicateWindow())) {
+            $extraOptions = $data->addChild('extraOptions');
+            $node = dom_import_simplexml($extraOptions);
+            $nodeOwner = $node->ownerDocument;
+            $duplicateWindowStr = sprintf("x_duplicate_window=%s", $this->getDuplicateWindow());
+            $node->appendChild($nodeOwner->createCDATASection($duplicateWindowStr));
+        }
+        return $data;
+    }
+
+    /**
+     * @return mixed|\SimpleXMLElement
+     * @throws \Omnipay\Common\Exception\InvalidRequestException
+     */
+    public function getBaseData()
+    {
+        $data = new \SimpleXMLElement('<createTransactionRequest/>');
+        $data->addAttribute('xmlns', 'AnetApi/xml/v1/schema/AnetApiSchema.xsd');
+
+        // Credentials
+        $data->merchantAuthentication->name = $this->getApiLoginId();
+        $data->merchantAuthentication->transactionKey = $this->getTransactionKey();
+
+        // User-assigned transaction ID
+        $txnId = $this->getTransactionId();
+        if (!empty($txnId)) {
+            $data->refId = $this->getTransactionId();
+        }
+
+        // Transaction type
+        if (!$this->action) {
+            // The extending class probably hasn't specified an "action"
+            throw new InvalidRequestException();
+        }
+        $data->transactionRequest->transactionType = $this->action;
+
+        return $data;
+    }
+
+    /**
+     * Adds billing data to a partially filled request data object.
+     *
+     * @param \SimpleXMLElement $data
+     *
+     * @return \SimpleXMLElement
+     */
+    protected function addBillingData(\SimpleXMLElement $data)
+    {
+        /** @var mixed $req */
+        $req = $data->transactionRequest;
+
+        // Merchant assigned customer ID
+        $customer = $this->getCustomerId();
+        if (!empty($customer)) {
+            $req->customer->id = $customer;
+        }
+
+        /** @var CreditCard $card */
+        if ($card = $this->getCard()) {
+            // A card is present, so include billing and shipping details
+            $req->billTo->firstName = $card->getBillingFirstName();
+            $req->billTo->lastName = $card->getBillingLastName();
+            $req->billTo->company = $card->getBillingCompany();
+            $req->billTo->address = trim($card->getBillingAddress1() . " \n" . $card->getBillingAddress2());
+            $req->billTo->city = $card->getBillingCity();
+            $req->billTo->state = $card->getBillingState();
+            $req->billTo->zip = $card->getBillingPostcode();
+            $req->billTo->country = $card->getBillingCountry();
+
+            $req->shipTo->firstName = $card->getShippingLastName();
+            $req->shipTo->lastName = $card->getShippingLastName();
+            $req->shipTo->company = $card->getShippingCompany();
+            $req->shipTo->address = trim($card->getShippingAddress1() . " \n" . $card->getShippingAddress2());
+            $req->shipTo->city = $card->getShippingCity();
+            $req->shipTo->state = $card->getShippingState();
+            $req->shipTo->zip = $card->getShippingPostcode();
+            $req->shipTo->country = $card->getShippingCountry();
+        }
+
+        return $data;
+    }
+
+    protected function addTestModeSetting(\SimpleXMLElement $data)
+    {
+        // Test mode setting
+        $data->transactionRequest->transactionSettings->setting->settingName = 'testRequest';
+        $data->transactionRequest->transactionSettings->setting->settingValue = $this->getTestMode() ? 'true' : 'false';
+
+        return $data;
+    }
+
+    public function sendData($data)
+    {
+        $headers = array('Content-Type' => 'text/xml; charset=utf-8');
+        $data = $data->saveXml();
+        $httpResponse = $this->httpClient->post($this->getEndpoint(), $headers, $data)->send();
+
+        return $this->response = new AIMResponse($this, $httpResponse->getBody());
+    }
+
+    public function getLiveEndpoint()
+    {
+        return $this->getParameter('liveEndpoint');
+    }
+
+    public function setLiveEndpoint($value)
+    {
+        return $this->setParameter('liveEndpoint', $value);
+    }
+
+    public function getDeveloperEndpoint()
+    {
+        return $this->getParameter('developerEndpoint');
+    }
+
+    public function setDeveloperEndpoint($value)
+    {
+        return $this->setParameter('developerEndpoint', $value);
+    }
+
+    public function getEndpoint()
+    {
+        return $this->getDeveloperMode() ? $this->getDeveloperEndpoint() : $this->getLiveEndpoint();
+    }
+}