Added card type and card mask fields to parsed status response

Author: OlegGS

README.md

@@ -12,14 +12,14 @@ This library provide ability to make requests to Transact Pro Gateway API v3.
 <dependency>
   <groupId>com.github.transactpro</groupId>
   <artifactId>gateway</artifactId>
-  <version>1.3.5</version>
+  <version>1.3.6</version>
 </dependency>
 ```
 
 #### Gradle
 
 ```groovy
-implementation 'com.github.transactpro:gateway:1.3.5'
+implementation 'com.github.transactpro:gateway:1.3.6'
 ```
 
 ## Documentation
@@ -261,6 +261,13 @@ for (CSVRecord record : parsedCsv) {
 }
 ```
 
+### Useful enumerators
+
+`com.github.transactpro.gateway.model.response.constants.ErrorCode` - error codes
+`com.github.transactpro.gateway.model.response.constants.Status` - transaction statuses
+`com.github.transactpro.gateway.model.response.constants.Enrollment` - card 3-D Secure enrollment statuses
+`com.github.transactpro.gateway.model.response.constants.CardFamily` - card families
+
 ### Customization
 
 If you need to load an HTML form from Gateway instead of cardholder browser redirect, a special operation type may be used:

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.transactpro</groupId>
     <artifactId>gateway</artifactId>
-    <version>1.3.5</version>
+    <version>1.3.6</version>
 
     <name>Transact Pro Gateway v3 Java client library</name>
     <description>A library that provide ability to make requests to Transact Pro Gateway API v3.</description>

src/main/java/com/github/transactpro/gateway/model/response/StatusResponse.java

@@ -1,5 +1,6 @@
 package com.github.transactpro.gateway.model.response;
 
+import com.github.transactpro.gateway.model.response.constants.CardFamily;
 import com.github.transactpro.gateway.model.response.constants.Status;
 import com.google.gson.annotations.SerializedName;
 import lombok.Getter;
@@ -19,6 +20,10 @@ public static class TransactionStatus {
         private String statusText;
         @SerializedName("status-text-general")
         private String statusTextGeneral;
+        @SerializedName("card-mask")
+        private String cardMask;
+        @SerializedName("card-family")
+        private CardFamily cardFamily;
     }
 
     @Getter

src/main/java/com/github/transactpro/gateway/model/response/constants/CardFamily.java

@@ -0,0 +1,22 @@
+package com.github.transactpro.gateway.model.response.constants;
+
+import com.google.gson.annotations.SerializedName;
+import lombok.Getter;
+
+public enum CardFamily {
+    @SerializedName("VISA")
+    VISA(1),
+    @SerializedName("MC")
+    MASTER_CARD(2),
+    @SerializedName("MA")
+    MAESTRO(3),
+    @SerializedName("AMEX")
+    AMERICAN_EXPRESS(4);
+
+    @Getter
+    private final int value;
+
+    CardFamily(int value) {
+        this.value = value;
+    }
+}

src/test/java/com/github/transactpro/gateway/operation/info/StatusTest.java

@@ -3,6 +3,7 @@
 import com.github.transactpro.gateway.model.Request;
 import com.github.transactpro.gateway.model.Response;
 import com.github.transactpro.gateway.model.response.StatusResponse;
+import com.github.transactpro.gateway.model.response.constants.CardFamily;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -59,9 +60,10 @@ void validOperation() {
     @Test
     void parseStatusResponse() {
         String 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\"}]}";
@@ -77,6 +79,8 @@ void parseStatusResponse() {
         assertEquals(com.github.transactpro.gateway.model.response.constants.Status.EXPIRED, tr1.getStatus().get(0).getStatusCodeGeneral());
         assertEquals("SUCCESS", tr1.getStatus().get(0).getStatusText());
         assertEquals("EXPIRED", tr1.getStatus().get(0).getStatusTextGeneral());
+        assertEquals(CardFamily.MASTER_CARD, tr1.getStatus().get(0).getCardFamily());
+        assertEquals("534219*5267", tr1.getStatus().get(0).getCardMask());
 
         StatusResponse.Element tr2 = parsedResponse.getTransactions().get(1);
         assertEquals("37908991-789b-4d79-8c6a-f90ba0ce12b6", tr2.getGatewayTransactionId());