Compatibility with omnipay-common:^3.0

.travis.yml

@@ -5,14 +5,6 @@ php:
   - "7.1"
   - "7.0"
   - "5.6"
-  - "5.5"
-  - "5.4"
-  - hhvm
-
-matrix:
-  include:
-    - php: "5.3"
-      dist: precise
 
 before_script:
   - composer install -n --dev --prefer-source

README.md

@@ -17,7 +17,7 @@ to your `composer.json` file:
 ```json
 {
     "require": {
-        "omnipay/worldpay": "~2.0"
+        "omnipay/worldpay": "~3.0"
     }
 }
 ```
@@ -32,6 +32,7 @@ And run composer to update your dependencies:
 The following gateways are provided by this package:
 
 * WorldPay
+* WorldPay_Json
 
 For general usage instructions, please see the main [Omnipay](https://github.com/thephpleague/omnipay)
 repository.

composer.json

@@ -26,14 +26,17 @@
         "psr-4": { "Omnipay\\WorldPay\\" : "src/" }
     },
     "require": {
-        "omnipay/common": "~2.0"
+        "omnipay/common": "~3.0"
     },
     "require-dev": {
-        "omnipay/tests": "~2.0"
+        "omnipay/tests": "~3.0",
+        "squizlabs/php_codesniffer": "~3.0"
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.0.x-dev"
+            "dev-master": "3.0.x-dev"
         }
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

src/JsonGateway.php

@@ -2,20 +2,31 @@
 
 namespace Omnipay\WorldPay;
 
+use Http\Adapter\Guzzle6\Client;
 use Omnipay\Common\AbstractGateway;
 
 /**
  * WorldPay Gateway
  *
- * @link http://www.worldpay.com/support/kb/bg/htmlredirect/rhtml.html
+ * @link https://developer.worldpay.com/jsonapi/docs
  */
 class JsonGateway extends AbstractGateway
 {
+    /**
+     * Name of the gateway
+     *
+     * @return string
+     */
     public function getName()
     {
         return 'WorldPay JSON';
     }
 
+    /**
+     * Setup the default parameters
+     *
+     * @return string[]
+     */
     public function getDefaultParameters()
     {
         return array(
@@ -25,53 +36,123 @@ public function getDefaultParameters()
         );
     }
 
+    /**
+     * Get the stored service key
+     *
+     * @return string
+     */
     public function getServiceKey()
     {
         return $this->getParameter('serviceKey');
     }
 
+    /**
+     * Set the stored service key
+     *
+     * @param string $value  Service key to store
+     */
     public function setServiceKey($value)
     {
         return $this->setParameter('serviceKey', $value);
     }
 
+    /**
+     * Get the stored merchant ID
+     *
+     * @return string
+     */
     public function getMerchantId()
     {
         return $this->getParameter('merchantId');
     }
 
+    /**
+     * Set the stored merchant ID
+     *
+     * @param string $value  Merchant ID to store
+     */
     public function setMerchantId($value)
     {
         return $this->setParameter('merchantId', $value);
     }
 
+    /**
+     * Get the stored client key
+     *
+     * @return string
+     */
     public function getClientKey()
     {
         return $this->getParameter('clientKey');
     }
 
+    /**
+     * Set the stored client key
+     *
+     * @param string $value  Client key to store
+     */
     public function setClientKey($value)
     {
         return $this->setParameter('clientKey', $value);
     }
 
+    /**
+     * Create purchase request
+     *
+     * @param array $parameters
+     *
+     * @return \Omnipay\WorldPay\Message\JsonPurchaseRequest
+     */
     public function purchase(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\WorldPay\Message\JsonPurchaseRequest', $parameters);
     }
 
+    /**
+     * Create authorize request
+     *
+     * @param array $parameters
+     *
+     * @return \Omnipay\WorldPay\Message\JsonAuthorizeRequest
+     */
     public function authorize(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\WorldPay\Message\JsonAuthorizeRequest', $parameters);
     }
 
+    /**
+     * Create refund request
+     *
+     * @param array $parameters
+     *
+     * @return \Omnipay\WorldPay\Message\JsonRefundRequest
+     */
     public function refund(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\WorldPay\Message\JsonRefundRequest', $parameters);
     }
 
+    /**
+     * Create capture request
+     *
+     * @param array $parameters
+     *
+     * @return \Omnipay\WorldPay\Message\JsonCaptureRequest
+     */
     public function capture(array $parameters = array())
     {
         return $this->createRequest('\Omnipay\WorldPay\Message\JsonCaptureRequest', $parameters);
     }
+
+    protected function getDefaultHttpClient()
+    {
+        $guzzleClient = Client::createWithConfig([
+            'curl.options' => [
+                CURLOPT_SSLVERSION => 6
+            ]
+        ]);
+
+
+        return new \Omnipay\Common\Http\Client($guzzleClient);
+    }
 }

src/Message/JsonAbstractRequest.php

@@ -2,77 +2,115 @@
 
 namespace Omnipay\WorldPay\Message;
 
+use Guzzle\Http\Message\Response as HttpResponse;
 use Omnipay\Common\Message\AbstractRequest;
+use Omnipay\Common\Message\ResponseInterface;
 
 abstract class JsonAbstractRequest extends AbstractRequest
 {
+    /**
+     * @var string  API endpoint base to connect to
+     */
     protected $endpoint = 'https://api.worldpay.com/v1';
 
+    /**
+     * Method required to override for getting the specific request endpoint
+     *
+     * @return string
+     */
+    abstract public function getEndpoint();
+
+    /**
+     * The HTTP method used to send data to the API endpoint
+     *
+     * @return string
+     */
     public function getHttpMethod()
     {
         return 'POST';
     }
 
+    /**
+     * Get the stored merchant ID
+     *
+     * @return string
+     */
     public function getMerchantId()
     {
         return $this->getParameter('merchantId');
     }
 
+    /**
+     * Set the stored merchant ID
+     *
+     * @param string $value  Merchant ID to store
+     */
     public function setMerchantId($value)
     {
         return $this->setParameter('merchantId', $value);
     }
 
+    /**
+     * Get the stored service key
+     *
+     * @return string
+     */
     public function getServiceKey()
     {
         return $this->getParameter('serviceKey');
     }
 
+    /**
+     * Set the stored service key
+     *
+     * @param string $value  Service key to store
+     */
     public function setServiceKey($value)
     {
         return $this->setParameter('serviceKey', $value);
     }
 
+    /**
+     * Get the stored client key
+     *
+     * @return string
+     */
     public function getClientKey()
     {
         return $this->getParameter('clientKey');
     }
 
+    /**
+     * Set the stored client key
+     *
+     * @param string $value  Client key to store
+     */
     public function setClientKey($value)
     {
         return $this->setParameter('clientKey', $value);
     }
 
-
+    /**
+     * Make the actual request to WorldPay
+     *
+     * @param mixed $data  The data to encode and send to the API endpoint
+     *
+     * @return \Psr\Http\Message\ResponseInterface HTTP response object
+     */
     public function sendRequest($data)
     {
-        $config = $this->httpClient->getConfig();
-        $curlOptions = $config->get('curl.options');
-        $curlOptions[CURLOPT_SSLVERSION] = 6;
-        $config->set('curl.options', $curlOptions);
-        $this->httpClient->setConfig($config);
-
-        // don't throw exceptions for 4xx errors
-        $this->httpClient->getEventDispatcher()->addListener(
-            'request.error',
-            function ($event) {
-                if ($event['response']->isClientError()) {
-                    $event->stopPropagation();
-                }
-            }
-        );
-
         $httpRequest = $this->httpClient->createRequest(
             $this->getHttpMethod(),
             $this->getEndpoint(),
-            null,
+            [],
             json_encode($data)
         );
 
-        $httpResponse = $httpRequest
-            ->setHeader('Authorization', $this->getServiceKey())
-            ->setHeader('Content-type', 'application/json')
-            ->send();
+        $httpRequest = $httpRequest
+            ->withHeader('Authorization', $this->getServiceKey())
+            ->withHeader('Content-type', 'application/json');
+
+        $httpResponse = $this->httpClient->sendRequest($httpRequest);
 
         return $httpResponse;
     }
@@ -86,7 +124,9 @@ public function getResponseClassName()
     }
 
     /**
-     * @param mixed $data
+     * Send the request to the API then build the response object
+     *
+     * @param mixed $data  The data to encode and send to the API endpoint
      *
      * @return JsonResponse
      */

src/Message/JsonAuthorizeRequest.php

@@ -7,6 +7,11 @@
  */
 class JsonAuthorizeRequest extends JsonPurchaseRequest
 {
+    /**
+     * Set up the authorize-specific data
+     *
+     * @return mixed
+     */
     public function getData()
     {
         $data = parent::getData();