Added card type and card mask fields to parsed status response

Author: OlegGS

README.md

@@ -350,6 +350,12 @@ Main exception, that can be thrown by the library is the `GatewayException`. Fol
 - `DigestMissingException` - will be thrown if response missing Authorization header (corrupted response).
 - `DigestMismatchException` - will be thrown if response digest validation fail (corrupted response).
 
+### Useful constants
+
+`\TransactPro\Gateway\Responses\Constants\ErrorCode` - error codes
+`\TransactPro\Gateway\Responses\Constants\Status` - transaction statuses
+`\TransactPro\Gateway\Responses\Constants\CardFamily` - card families
+
 ## About
 
 ### Requirements

src/Gateway/Responses/Constants/CardFamily.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types = 1);
+
+/*
+ * This file is part of the transact-pro/gw3-client package.
+ *
+ * (c) Transact Pro
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace TransactPro\Gateway\Responses\Constants;
+
+class CardFamily
+{
+    const VISA = 'VISA';
+    const MASTER_CARD = 'MC';
+    const MAESTRO = 'MA';
+    const AMERICAN_EXPRESS = 'AMEX';
+}

src/Gateway/Responses/Parts/Info/TransactionStatus.php

@@ -17,18 +17,26 @@ class TransactionStatus
 {
     public $error;
     public $gatewayTransactionId;
+
     public $statusCode;
     public $statusCodeGeneral;
     public $statusText;
     public $statusTextGeneral;
 
+    public $cardFamily;
+    public $cardMask;
+
     public function __construct(array $rawDecoded = null)
     {
         $this->error = !empty($rawDecoded['error']) ? new Error($rawDecoded['error']) : null;
         $this->gatewayTransactionId = strval($rawDecoded['gateway-transaction-id'] ?? null);
+
         $this->statusCode = intval($rawDecoded['status'][0]['status-code'] ?? null);
         $this->statusCodeGeneral = intval($rawDecoded['status'][0]['status-code-general'] ?? null);
         $this->statusText = strval($rawDecoded['status'][0]['status-text'] ?? null);
         $this->statusTextGeneral = strval($rawDecoded['status'][0]['status-text-general'] ?? null);
+
+        $this->cardFamily = strval($rawDecoded['status'][0]['card-family'] ?? null);
+        $this->cardMask = strval($rawDecoded['status'][0]['card-mask'] ?? null);
     }
 }

tests/Gateway/Operations/Info/StatusTest.php

@@ -15,6 +15,7 @@
 use TransactPro\Gateway\DataSets\DataSet;
 use TransactPro\Gateway\DataSets\Info;
 use TransactPro\Gateway\Http\Response;
+use TransactPro\Gateway\Responses\Constants\CardFamily;
 use TransactPro\Gateway\Responses\Constants\Status as StatusCode;
 use TransactPro\Gateway\Validator\Validator;
 
@@ -42,9 +43,10 @@ public function testSuccess(): void
     public function testParseStatusResponse(): void
     {
         $body = "{\"transactions\":[{\"gateway-transaction-id\":\"cd7b8bdf-3c78-4540-95d0-68018d2aba97\",\"status\":" .
-            "[{\"gateway-transaction-id\":\"cd7b8bdf-3c78-4540-95d0-68018d2aba97\",\"status-code\":7,\"status-code-general\":8," .
-            "\"status-text\":\"SUCCESS\",\"status-text-general\":\"EXPIRED\"}]},{\"gateway-transaction-id\":\"37908991-789b-4d79-8c6a-f90ba0ce12b6\"," .
-            "\"status\":[{\"gateway-transaction-id\":\"37908991-789b-4d79-8c6a-f90ba0ce12b6\",\"status-code\":8,\"status-code-general\":7," .
+            "[{\"card-mask\":\"534219*5267\",\"card-family\":\"MC\",\"gateway-transaction-id\":\"cd7b8bdf-3c78-4540-95d0-68018d2aba97\"," .
+            "\"status-code\":7,\"status-code-general\":8,\"status-text\":\"SUCCESS\",\"status-text-general\":\"EXPIRED\"}]}," .
+            "{\"gateway-transaction-id\":\"37908991-789b-4d79-8c6a-f90ba0ce12b6\",\"status\":[" .
+            "{\"gateway-transaction-id\":\"37908991-789b-4d79-8c6a-f90ba0ce12b6\",\"status-code\":8,\"status-code-general\":7," .
             "\"status-text\":\"EXPIRED\",\"status-text-general\":\"SUCCESS\"}]}," .
             "{\"error\":{\"code\":400,\"message\":\"Failed to fetch data for transaction with gateway id: 99900000-789b-4d79-8c6a-f90ba0ce12b0\"}," .
             "\"gateway-transaction-id\":\"99900000-789b-4d79-8c6a-f90ba0ce12b0\"}]}";
@@ -59,6 +61,8 @@ public function testParseStatusResponse(): void
         $this->assertEquals(StatusCode::EXPIRED, $tr1->statusCodeGeneral);
         $this->assertEquals("SUCCESS", $tr1->statusText);
         $this->assertEquals("EXPIRED", $tr1->statusTextGeneral);
+        $this->assertEquals(CardFamily::MASTER_CARD, $tr1->cardFamily);
+        $this->assertEquals("534219*5267", $tr1->cardMask);
 
         $tr2 = $parsedResponse->transactions[1];
         $this->assertEquals("37908991-789b-4d79-8c6a-f90ba0ce12b6", $tr2->gatewayTransactionId);