Merge branch 'master' of github.com:superbrave/omnipay-icepay-payments

krijn-sb · krijn-sb · commit 171673a02e44 · 2019-07-09T16:31:36.000+02:00
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -0,0 +1,75 @@
+filter:
+    paths:
+        - src/
+
+    excluded_paths:
+        - bin/
+        - tests
+        - var/
+
+    dependency_paths:
+        - vendor/
+
+checks:
+    php: true
+
+build:
+    dependencies:
+        override:
+            - composer install --no-interaction --prefer-dist --optimize-autoloader
+
+    nodes:
+        composer-file-validation:
+            dependencies:
+                override:
+                    - true
+
+            tests:
+                override:
+                    - composer validate
+
+        code-standards:
+            tests:
+                override:
+                    - ./bin/php-cs-fixer fix --dry-run -v
+
+        security-check:
+            requires:
+                - branch: master
+
+            dependencies:
+                override:
+                    - true
+
+            tests:
+                override:
+                    - if [ -z "$SCRUTINIZER_PR_SOURCE_BRANCH" ]; then curl -o security-checker.phar https://get.sensiolabs.org/security-checker.phar; fi;
+                    - if [ -z "$SCRUTINIZER_PR_SOURCE_BRANCH" ]; then php security-checker.phar security:check; fi;
+
+        phpunit:
+            requires:
+                - node: composer-file-validation
+                - node: code-standards
+
+            tests:
+                override:
+                    - command: ./bin/phpunit --coverage-clover=code-coverage
+                      coverage:
+                          file: code-coverage
+                          format: clover
+
+        static-code-analysis:
+            tests:
+                override:
+                    - php-scrutinizer-run
+
+    environment:
+        php:
+            version: 7.2
+            pecl_extensions:
+                - zip
+
+build_failure_conditions:
+    - 'elements.rating(<= D).new.exists' # No new classes/methods with a rating of D or worse.
+    - 'project.metric("scrutinizer.quality", < 8)' # Code Quality Rating drops below 8.
+    - 'project.metric("scrutinizer.test_coverage", < 0.80)' # Code Coverage drops below 80%.
diff --git a/README.md b/README.md
@@ -1,4 +1,7 @@
 # Omnipay: Icepay Payments (ICEX2.0)
+[![Build Status](https://scrutinizer-ci.com/g/superbrave/omnipay-icepay-payments/badges/build.png?b=master)](https://scrutinizer-ci.com/g/superbrave/omnipay-icepay-payments/build-status/master)
+[![Code Coverage](https://scrutinizer-ci.com/g/superbrave/omnipay-icepay-payments/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/superbrave/omnipay-icepay-payments/?branch=master)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/superbrave/omnipay-icepay-payments/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/superbrave/omnipay-icepay-payments/?branch=master)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
 ## Introduction
@@ -84,37 +87,44 @@ $data = [
     ],
 ];
 
-$response = $gateway->authorize($data)->send()->getData();
+$request = $gateway->authorize($data);
+
+$response = $response->send();
 ```
-This will return the order details as well as the checkout HTML snippet to render on your site.
 
 [API documentation](http://docs2.icepay.com/calling-our-webservice/transaction-functions/)
 
 ### Status
 
 ```php
-$success = $gateway->fetchTransaction([
+$data = [
     'ContractProfileId' => '85cf0581-36e2-45c7-8d8c-a24c6f52902c',
     'AmountInCents' => 1337,
     'CurrencyCode' => 'EUR',
     'Reference' => '829c7998-6497-402c-a049-51801ba33662',
-])->send()
-->isSuccessful();
+];
+
+$request = $gateway->fetchTransaction($data);
+
+$response = $request->send();
 ```
 
 [API documentation](https://icepay2.docs.apiary.io/#reference/0/transaction)
 
 ### Refund
-*Do note: refunds have not been tested in production*
+*Do note: refunds implementation has not been tested.*
 
 ```php
-$success = $gateway->refund([
+$data = [
     'ContractProfileId' => '85cf0581-36e2-45c7-8d8c-a24c6f52902c',
     'AmountInCents' => 1337,
     'CurrencyCode' => 'EUR',
     'Reference' => '829c7998-6497-402c-a049-51801ba33662',
-])->send()
-->isSuccessful();
+];
+
+$request = $gateway->refund($data);
+
+$response = $request->send();
 ```
 
 [API documentation](https://icepay2.docs.apiary.io/#reference/0/transaction/refund)
diff --git a/composer.json b/composer.json
@@ -26,7 +26,7 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Omnipay\\IcepayPayments\\": "tests/"
+            "Omnipay\\IcepayPayments\\Tests\\": "tests/"
         }
     },
     "config": {
diff --git a/src/Gateway.php b/src/Gateway.php
@@ -38,6 +38,8 @@ class Gateway extends AbstractGateway
 
     /**
      * {@inheritdoc}
+     *
+     * @codeCoverageIgnore
      */
     public function getName(): string
     {
diff --git a/src/Message/AbstractRequest.php b/src/Message/AbstractRequest.php
@@ -5,17 +5,13 @@
 use DateTimeInterface;
 use Omnipay\Common\Message\AbstractRequest as OmnipayAbstractRequest;
 use Psr\Http\Message\ResponseInterface;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Class AbstractRequest.
  */
 abstract class AbstractRequest extends OmnipayAbstractRequest
 {
-    /**
-     * @var string
-     */
-    public const METHOD_POST = 'POST';
-
     /**
      * @var string
      */
@@ -47,7 +43,7 @@ protected function sendRequest(string $method, string $urlPath, array $data): Re
         $headers = $this->getAuthenticationHeaders($securityHash);
         $body = null;
 
-        if ($method === self::METHOD_POST) {
+        if ($method === Request::METHOD_POST) {
             $headers['Content-Type'] = 'application/json';
             $body = json_encode($data);
         }
diff --git a/src/Message/CreateTransactionRequest.php b/src/Message/CreateTransactionRequest.php
@@ -3,6 +3,7 @@
 namespace Omnipay\IcepayPayments\Message;
 
 use Omnipay\Common\Message\ResponseInterface;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * The request for creating a transaction at Icepay.
@@ -59,7 +60,7 @@ public function getData(): array
     public function sendData($data): ResponseInterface
     {
         $this->sendRequest(
-            self::METHOD_POST,
+            Request::METHOD_POST,
             '/contract/transaction',
             $data
         );
diff --git a/src/Message/RefundRequest.php b/src/Message/RefundRequest.php
@@ -4,6 +4,7 @@
 
 use Omnipay\Common\Exception\InvalidRequestException;
 use Omnipay\Common\Message\ResponseInterface;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * The request for refunding at Icepay.
@@ -38,7 +39,7 @@ public function sendData($data): ResponseInterface
         }
 
         $this->sendRequest(
-            self::METHOD_POST,
+            Request::METHOD_POST,
             sprintf(
                 '/transaction/%s/refund',
                 $this->getTransactionReference()
diff --git a/src/Message/TransactionStatusRequest.php b/src/Message/TransactionStatusRequest.php
@@ -3,6 +3,7 @@
 namespace Omnipay\IcepayPayments\Message;
 
 use Omnipay\Common\Message\ResponseInterface;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * The request for getting the transaction status at Icepay.
@@ -27,7 +28,7 @@ public function getData(): array
     public function sendData($data): ResponseInterface
     {
         $this->sendRequest(
-            self::METHOD_POST,
+            Request::METHOD_POST,
             sprintf(
                 '/transaction/%s',
                 $this->getTransactionReference()
diff --git a/tests/AbstractTestCase.php b/tests/AbstractTestCase.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Omnipay\IcepayPayments;
+namespace Omnipay\IcepayPayments\Tests;
 
 use Http\Mock\Client as ClientMock;
 use Omnipay\Common\Http\Client;
diff --git a/tests/GatewayTest.php b/tests/GatewayTest.php
@@ -1,26 +1,43 @@
 <?php
 
-namespace Omnipay\IcepayPayments;
+namespace Omnipay\IcepayPayments\Tests;
 
 use Omnipay\Common\GatewayInterface;
-use PHPUnit\Framework\TestCase;
+use Omnipay\IcepayPayments\Gateway;
+use Omnipay\IcepayPayments\Message\CreateTransactionRequest;
+use Omnipay\IcepayPayments\Message\RefundRequest;
+use Omnipay\IcepayPayments\Message\TransactionStatusRequest;
 
 /**
  * Tests the Icepay gateway.
  */
-class GatewayTest extends TestCase
+class GatewayTest extends AbstractTestCase
 {
     /**
      * @var GatewayInterface
      */
     public $gateway;
 
+    /**
+     * @var array
+     */
+    private $options;
+
     /**
      * Creates a new Gateway instance for testing.
      */
     protected function setUp(): void
     {
-        $this->gateway = new Gateway();
+        $this->gateway = new Gateway($this->httpClient, $this->httpRequest);
+        $this->options = [
+            'paymentMethod' => 'IDEAL',
+            'amountInCents' => 1337,
+            'currencyCode' => 'EUR',
+            'languageCode' => 'nl',
+            'countryCode' => 'NL',
+            'issuerCode' => 'ABNAMRO',
+            'reference' => '829c7998-6497-402c-a049-51801ba33662',
+        ];
     }
 
     /**
@@ -50,13 +67,54 @@ public function testFetchTransactionParameters(): void
             $setter = 'set'.ucfirst($this->camelCase($key));
             $value = uniqid();
             $this->gateway->$setter($value);
+            $this->assertSame($value, $this->gateway->$getter());
 
             // request should have matching property, with correct value
             $request = $this->gateway->fetchTransaction();
-            $this->assertSame($value, $request->$getter());
+            $this->assertSame($this->gateway->$getter(), $request->$getter());
         }
     }
 
+    /**
+     * Tests if Gateway::authorize will return an instance of CreateTransactionRequest.
+     */
+    public function testAuthorize(): void
+    {
+        $request = $this->gateway->authorize($this->options);
+
+        $this->assertInstanceOf(CreateTransactionRequest::class, $request);
+    }
+
+    /**
+     * Tests if Gateway::completeAuthorize will return an instance of TransactionStatusRequest.
+     */
+    public function testCompleteAuthorize(): void
+    {
+        $request = $this->gateway->completeAuthorize($this->options);
+
+        $this->assertInstanceOf(TransactionStatusRequest::class, $request);
+    }
+
+    /**
+     * Tests if Gateway::capture will return an instance of TransactionStatusRequest.
+     */
+    public function testCapture(): void
+    {
+        $request = $this->gateway->capture($this->options);
+
+        $this->assertInstanceOf(TransactionStatusRequest::class, $request);
+    }
+
+    /**
+     * Tests if Gateway::refund will return an instance of RefundRequest.
+     */
+    public function testRefund(): void
+    {
+        $request = $this->gateway->refund($this->options);
+
+        $this->assertInstanceOf(RefundRequest::class, $request);
+    }
+
     /**
      * Returns the test cases for @see testInitializeSetsBaseUrlBasedOnTestMode.
      *
diff --git a/tests/Message/CreateTransactionRequestTest.php b/tests/Message/CreateTransactionRequestTest.php
@@ -1,10 +1,13 @@
 <?php
 
-namespace Omnipay\IcepayPayments\Message;
+namespace Omnipay\IcepayPayments\Tests\Message;
 
 use DateTime;
 use GuzzleHttp\Psr7\Request;
-use Omnipay\IcepayPayments\AbstractTestCase;
+use Omnipay\IcepayPayments\Message\CreateTransactionRequest;
+use Omnipay\IcepayPayments\Message\CreateTransactionResponse;
+use Omnipay\IcepayPayments\Tests\AbstractTestCase;
+use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
 
 /**
  * Class CreateTransactionRequestTest.
@@ -126,7 +129,7 @@ public function testSendData(): void
         $this->assertInstanceOf(CreateTransactionResponse::class, $response);
 
         $expectedRequest = new Request(
-            AbstractRequest::METHOD_POST,
+            SymfonyRequest::METHOD_POST,
             'https://www.superbrave.nl/contract/transaction'
         );
 
diff --git a/tests/Message/CreateTransactionResponseTest.php b/tests/Message/CreateTransactionResponseTest.php
@@ -1,8 +1,11 @@
 <?php
 
-namespace Omnipay\IcepayPayments\Message;
+namespace Omnipay\IcepayPayments\Tests\Message;
 
-use Omnipay\IcepayPayments\AbstractTestCase;
+use Omnipay\IcepayPayments\Message\AbstractResponse;
+use Omnipay\IcepayPayments\Message\CreateTransactionRequest;
+use Omnipay\IcepayPayments\Message\CreateTransactionResponse;
+use Omnipay\IcepayPayments\Tests\AbstractTestCase;
 
 /**
  * Class CreateTransactionResponseTest.
diff --git a/tests/Message/RefundRequestTest.php b/tests/Message/RefundRequestTest.php
diff --git a/tests/Message/RefundResponseTest.php b/tests/Message/RefundResponseTest.php
diff --git a/tests/Message/TransactionStatusRequestTest.php b/tests/Message/TransactionStatusRequestTest.php
diff --git a/tests/Message/TransactionStatusResponseTest.php b/tests/Message/TransactionStatusResponseTest.php
diff --git a/tests/Mocks/RefundFail.json b/tests/Mocks/RefundFail.json
diff --git a/tests/Mocks/RefundSuccess.json b/tests/Mocks/RefundSuccess.json

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`},`
`27`	`27`	`"autoload-dev": {`
`28`	`28`	`"psr-4": {`
`29`		`- "Omnipay\\IcepayPayments\\": "tests/"`
	`29`	`+ "Omnipay\\IcepayPayments\\Tests\\": "tests/"`
`30`	`30`	`}`
`31`	`31`	`},`
`32`	`32`	`"config": {`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,8 @@ class Gateway extends AbstractGateway`
`38`	`38`
`39`	`39`	`/**`
`40`	`40`	`* {@inheritdoc}`
	`41`	`+ *`
	`42`	`+ * @codeCoverageIgnore`
`41`	`43`	`*/`
`42`	`44`	`public function getName(): string`
`43`	`45`	`{`