Merge pull request #3 from superbrave/scrutinizer

Adds Scrutinizer to this project.

Author: kiettran

.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%.

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
@@ -88,7 +91,6 @@ $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/)
 
@@ -108,7 +110,7 @@ $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
 $request = $gateway->refund([

src/Message/RefundRequest.php

@@ -30,7 +30,7 @@ public function getData(): array
     /**
      * {@inheritdoc}
      *
-     * @throws InvalidRequestException When transaction reference is not set.
+     * @throws InvalidRequestException when transaction reference is not set
      */
     public function sendData($data): ResponseInterface
     {

tests/Message/RefundResponseTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Omnipay\IcepayPayments\Message;
+
+use Omnipay\IcepayPayments\AbstractTestCase;
+
+/**
+ * Class RefundResponseTest.
+ */
+class RefundResponseTest extends AbstractTestCase
+{
+    /**
+     * @var TransactionStatusRequest
+     */
+    private $request;
+
+    /**
+     * Creates a new TransactionStatusRequest instance.
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->request = new RefundRequest($this->httpClient, $this->httpRequest);
+    }
+
+    /**
+     * Tests if TransactionStatusResponse::isSuccessful will return true with the given json response.
+     */
+    public function testResponseReturnsSuccessful(): void
+    {
+        $responseJsonBody = file_get_contents(__DIR__.'/../Mocks/RefundSuccess.json');
+        $response = new RefundResponse($this->request, json_decode($responseJsonBody, true));
+
+        $expectedResponseBody = [
+            'RefundId' => '7c9cb2f4-83ce-4b10-8d5c-de230181224f',
+            'RefundStatusCode' => AbstractResponse::RESPONSE_STATUS_COMPLETED,
+            'RefundStatusDetails' => '',
+            'AcquirerRefundId' => '',
+        ];
+
+        $this->assertTrue($response->isSuccessful());
+        $this->assertSame($expectedResponseBody, $response->getData());
+    }
+
+    /**
+     * Tests if TransactionStatusResponse::isSuccessful will return false from the json response.
+     */
+    public function testIfResponseReturnNotSuccessful(): void
+    {
+        $responseJsonBody = file_get_contents(__DIR__.'/../Mocks/RefundFail.json');
+        $response = new RefundResponse($this->request, json_decode($responseJsonBody, true));
+
+        $this->assertFalse($response->isSuccessful());
+    }
+}

tests/Message/TransactionStatusResponseTest.php

@@ -22,6 +22,7 @@ protected function setUp(): void
         parent::setUp();
 
         $this->request = new TransactionStatusRequest($this->httpClient, $this->httpRequest);
+        $this->request->setTransactionReference('7c9cb2f4-83ce-4b10-8d5c-de230181224f');
     }
 
     /**
@@ -42,6 +43,7 @@ public function testResponseReturnsSuccessful(): void
 
         $this->assertTrue($response->isSuccessful());
         $this->assertSame($expectedResponseBody, $response->getData());
+        $this->assertSame($expectedResponseBody['transactionId'], $response->getTransactionReference());
     }
 
     /**
@@ -50,7 +52,7 @@ public function testResponseReturnsSuccessful(): void
     public function testIfResponseReturnNotSuccessful(): void
     {
         $responseJsonBody = file_get_contents(__DIR__.'/../Mocks/TransactionStatusFail.json');
-        $response = new CreateTransactionResponse($this->request, json_decode($responseJsonBody, true));
+        $response = new TransactionStatusResponse($this->request, json_decode($responseJsonBody, true));
 
         $this->assertFalse($response->isSuccessful());
     }

tests/Mocks/RefundFail.json

@@ -0,0 +1,3 @@
+{
+    "RefundStatusCode": ""
+}

tests/Mocks/RefundSuccess.json

@@ -0,0 +1,6 @@
+{
+    "RefundId": "7c9cb2f4-83ce-4b10-8d5c-de230181224f",
+    "RefundStatusCode": "COMPLETED",
+    "RefundStatusDetails": "",
+    "AcquirerRefundId": ""
+}