Subscriptions and php8 support

* create subscriptions
* fetch customer payment profile details
* start support for creating and getting webhooks
* fix typos
* Travis updates
* unit tests

Author: leith

.travis.yml

@@ -1,14 +1,10 @@
 language: php
 
 php:
-  - 7.0
-  - 7.1
   - 7.2
   - 7.3
-
-# This triggers builds to run on the new TravisCI infrastructure.
-# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
-sudo: false
+  - 7.4
+  - 8.0
 
 ## Cache composer
 cache:
@@ -19,8 +15,17 @@ env:
   global:
     - setup=basic
 
-matrix:
+jobs:
   include:
+    - php: 7.2
+      env: setup=lowest
+  allow_failures:
+    - php: 7.3
+    - php: 7.4
+
+before_install:
+  # Enable Xdebug coverage mode
+  - echo 'xdebug.mode="coverage"' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
 
 install:
   - if [[ $setup = 'basic' ]]; then travis_retry composer install --prefer-dist --no-interaction; fi

README.md

@@ -421,7 +421,7 @@ information.
 The webhooks can be configured in the Authorize.Net account settings page.
 They can also be fully managed through a REST API, so that a merchant
 site can register for all the webhooks that it needs.
-*Note that the webhook management RESTful API has not yet been implemented here.*
+*Note that the webhook management RESTful API is only partially implemented here.*
 
 Your notification handler is set up like this at your webhook endpoint:
 
@@ -431,7 +431,7 @@ $gateway = Omnipay::create('AuthorizeNetApi_Api');
 $gateway->setAuthName($authName);
 $gateway->setTransactionKey($authKey);
 $gateway->setSignatureKey($signatureKey); // HMAC-256
-$gateway->setTestMode(true); // for false
+$gateway->setTestMode(true); // or false
 
 $notification = $gateway->acceptNotification();
 ```
@@ -495,7 +495,7 @@ Validation of the `signature` can be disabled if needed:
 
 For consistency with other Omipay Drivers, this driver *may* make an
 opinionated decision on how the `transactionId` is passed into the
-notification handler, but only after researchign how other people are
+notification handler, but only after researching how other people are
 handling it.
 There is a front-end way to do it through an iframe, but it seems
 vulnerable to user manipulation to me.

composer.json

@@ -23,9 +23,15 @@
             "Omnipay\\AuthorizeNetApi\\": "src/"
         }
     },
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/PatronBase/authorizenet-objects"
+        }
+    ],
     "require": {
         "omnipay/common": "^3",
-        "academe/authorizenet-objects": "~0.7",
+        "academe/authorizenet-objects": "subscription-support-dev",
         "symfony/property-access": "^3.2 || ^4.0"
     },
     "require-dev": {
@@ -34,7 +40,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.0.x-dev"
+            "dev-master": "3.2.x-dev"
         }
     }
 }

src/ApiGateway.php

@@ -14,6 +14,11 @@
 use Omnipay\AuthorizeNetApi\Message\RefundRequest;
 use Omnipay\AuthorizeNetApi\Message\FetchTransactionRequest;
 use Omnipay\AuthorizeNetApi\Message\AcceptNotification;
+use Omnipay\AuthorizeNetApi\Message\AuthenticateTestRequest;
+use Omnipay\AuthorizeNetApi\Message\CustomerProfiles\GetCustomerPaymentProfileRequest;
+use Omnipay\AuthorizeNetApi\Message\RecurringBilling\CreateSubscriptionRequest;
+use Omnipay\AuthorizeNetApi\Message\Webhooks\CreateWebhookRequest;
+use Omnipay\AuthorizeNetApi\Message\Webhooks\GetWebhookRequest;
 
 class ApiGateway extends AbstractGateway
 {
@@ -90,4 +95,59 @@ public function acceptNotification(array $parameters = [])
             $parameters
         );
     }
+
+    /**
+     * Create a subscription
+     */
+    public function createSubscription(array $parameters = [])
+    {
+        return $this->createRequest(
+            CreateSubscriptionRequest::class,
+            $parameters
+        );
+    }
+
+    /**
+     * Fetch a customer payment profile
+     */
+    public function getCustomerPaymentProfile(array $parameters = [])
+    {
+        return $this->createRequest(
+            GetCustomerPaymentProfileRequest::class,
+            $parameters
+        );
+    }
+
+    /**
+     * Test current authentication credentials
+     */
+    public function authenticateTest(array $parameters = [])
+    {
+        return $this->createRequest(
+            AuthenticateTestRequest::class,
+            $parameters
+        );
+    }
+
+    /**
+     * Create a webhook
+     */
+    public function createWebhook(array $parameters = [])
+    {
+        return $this->createRequest(
+            CreateWebhookRequest::class,
+            $parameters
+        );
+    }
+
+    /**
+     * Get a webhook
+     */
+    public function getWebhook(array $parameters = [])
+    {
+        return $this->createRequest(
+            GetWebhookRequest::class,
+            $parameters
+        );
+    }
 }

src/Message/AbstractRequest.php

@@ -13,6 +13,7 @@
 use Academe\AuthorizeNet\TransactionRequestInterface;
 use Academe\AuthorizeNet\Request\CreateTransaction;
 use Academe\AuthorizeNet\Request\AbstractRequest as ApiAbstractRequest;
+use Academe\AuthorizeNet\SubscriptionRequestInterface;
 use Omnipay\AuthorizeNetApi\Traits\HasGatewayParams;
 
 abstract class AbstractRequest extends OmnipayAbstractRequest
@@ -30,7 +31,7 @@ abstract class AbstractRequest extends OmnipayAbstractRequest
      */
     public function getAuth()
     {
-         return new MerchantAuthentication($this->getAuthName(), $this->getTransactionKey());
+        return new MerchantAuthentication($this->getAuthName(), $this->getTransactionKey());
     }
 
     /**

src/Message/AcceptNotification.php

@@ -102,7 +102,7 @@ public function getTransactionReference()
     {
         $this->assertSignature();
 
-        if ($this->getEventTarget() === $this->getParsedData()::EVENT_TARGET_PAYMENT) {
+        if ($this->getEventTarget() === Notification::EVENT_TARGET_PAYMENT) {
             return $this->getPayload()->getTransId();
         }
     }
@@ -123,7 +123,7 @@ public function getTransactionStatus()
         if ($responseCode === TransactionResponse::RESPONSE_CODE_APPROVED) {
             return static::STATUS_COMPLETED;
         } elseif ($responseCode === TransactionResponse::RESPONSE_CODE_PENDING) {
-            return static::STATUS_PENDIND;
+            return static::STATUS_PENDING;
         } elseif ($responseCode !== null) {
             return static::STATUS_FAILED;
         }
@@ -209,7 +209,7 @@ public function getPayload()
      */
     public function getResponseCode()
     {
-        if ($this->getEventTarget() === $this->getParsedData()::EVENT_TARGET_PAYMENT) {
+        if ($this->getEventTarget() === Notification::EVENT_TARGET_PAYMENT) {
             return $this->getPayload()->getResponseCode();
         }
     }
@@ -219,7 +219,7 @@ public function getResponseCode()
      */
     public function getAuthCode()
     {
-        if ($this->getEventTarget() === $this->getParsedData()::EVENT_TARGET_PAYMENT) {
+        if ($this->getEventTarget() === Notification::EVENT_TARGET_PAYMENT) {
             return $this->getPayload()->getAuthCode();
         }
     }
@@ -229,7 +229,7 @@ public function getAuthCode()
      */
     public function getAvsResponse()
     {
-        if ($this->getEventTarget() === $this->getParsedData()::EVENT_TARGET_PAYMENT) {
+        if ($this->getEventTarget() === Notification::EVENT_TARGET_PAYMENT) {
             return $this->getPayload()->getAvsResponse();
         }
     }
@@ -239,7 +239,7 @@ public function getAvsResponse()
      */
     public function getAuthAmount()
     {
-        if ($this->getEventTarget() === $this->getParsedData()::EVENT_TARGET_PAYMENT) {
+        if ($this->getEventTarget() === Notification::EVENT_TARGET_PAYMENT) {
             return $this->getPayload()->getAuthAmount();
         }
     }

src/Message/AuthenticateTestRequest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Omnipay\AuthorizeNetApi\Message;
+
+use Academe\AuthorizeNet\Request\AuthenticateTest;
+
+class AuthenticateTestRequest extends AbstractRequest
+{
+    /**
+     * Return the complete message object.
+     */
+    public function getData()
+    {
+        return [];
+    }
+
+    /**
+     * Accept a subscription and send it as a request.
+     *
+     * @param array $data
+     * @return Response
+     */
+    public function sendData($data)
+    {
+        $request = new AuthenticateTest($this->getAuth());
+        $response_data = $this->sendMessage($request);
+
+        return new Response($this, $response_data);
+    }
+}

src/Message/AuthorizeRequest.php

@@ -394,7 +394,7 @@ public function getOpaqueDataValue()
      */
     public function setOpaqueData($descriptor, $value)
     {
-        $this->setOpaqueDataDataDescriptor($descriptor);
+        $this->setOpaqueDataDescriptor($descriptor);
         $this->setOpaqueDataValue($value);
 
         return $this;

src/Message/CustomerProfiles/GetCustomerPaymentProfileRequest.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Omnipay\AuthorizeNetApi\Message\CustomerProfiles;
+
+use Academe\AuthorizeNet\Request\GetCustomerPaymentProfile;
+use Omnipay\AuthorizeNetApi\Message\AbstractRequest;
+
+/**
+ * Request to fetch the details of a customer payment profile
+ *
+ * @see https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile
+ */
+class GetCustomerPaymentProfileRequest extends AbstractRequest
+{
+    /**
+     * Return the complete message object.
+     * @return GetCustomerPaymentProfile
+     */
+    public function getData()
+    {
+        $this->validate('customerProfileId', 'customerPaymentProfileId');
+
+        $request = new GetCustomerPaymentProfile(
+            $this->getAuth(),
+            $this->getCustomerProfileId(),
+            $this->getCustomerPaymentProfileId()
+        );
+
+        if ($this->getTransactionId()) {
+            $request = $request->withRefId($this->getTransactionId());
+        }
+
+        if ($this->getUnmaskExpirationDate() !== null) {
+            $request = $request->withUnmaskExpirationDate($this->getUnmaskExpirationDate());
+        }
+
+        return $request;
+    }
+
+    /**
+     * Accept payment profile details and send it as a request.
+     *
+     * @param GetCustomerPaymentProfile $data
+     * @return PaymentProfileResponse
+     */
+    public function sendData($data)
+    {
+        $response_data = $this->sendMessage($data);
+
+        return new PaymentProfileResponse($this, $response_data);
+    }
+
+    /**
+     * @param string $value The gateway ID for the customer profile
+     * @return self
+     */
+    public function setCustomerProfileId($value)
+    {
+        return $this->setParameter('customerProfileId', $value);
+    }
+
+    /**
+     * @return string
+     */
+    public function getCustomerProfileId()
+    {
+        return $this->getParameter('customerProfileId');
+    }
+
+    /**
+     * @param string $value The gateway ID for the customer payment profile
+     * @return self
+     */
+    public function setCustomerPaymentProfileId($value)
+    {
+        return $this->setParameter('customerPaymentProfileId', $value);
+    }
+
+    /**
+     * @return string
+     */
+    public function getCustomerPaymentProfileId()
+    {
+        return $this->getParameter('customerPaymentProfileId');
+    }
+
+    /**
+     * @param bool $value Whether or not to return the expiration date unmasked
+     * @return self
+     */
+    public function setUnmaskExpirationDate($value)
+    {
+        return $this->setParameter('unmaskExpirationDate', $value);
+    }
+
+    /**
+     * @return bool
+     */
+    public function getUnmaskExpirationDate()
+    {
+        return $this->getParameter('unmaskExpirationDate');
+    }
+}