Added card type and card mask fields to parsed status response; added merchant-transaction-ids to info requests

Author: OlegGS

gateway/builders/info_data_builder.py

@@ -65,3 +65,24 @@ def add_gateway_transaction_ids(self, list_of_gate_transaction_id=None):
             new_key=self.__INFO_COMMAND_DATA_KEY,
             new_dict={self.__data_sets.COMMAND_DATA_GATEWAY_TRANSACTION_IDS: list_of_gate_transaction_id}
         )
+
+    def add_merchant_transaction_ids(self, list_of_merchant_transaction_id=None):
+        """
+        Add previously sent merchant transaction IDs
+
+        Example -> ["2d4b377c-648c-432b-a4dc-b386901116d7", "2323377c-548c-4scb-a6dc-b3899kxah520"]
+
+        Args:
+            list_of_merchant_transaction_id (list): Previously sent merchant transaction IDs
+        """
+        if list_of_merchant_transaction_id is None:
+            list_of_merchant_transaction_id = []
+
+        self.__payment_mandatory_fields[self.__data_sets.COMMAND_DATA_MERCHANT_TRANSACTION_IDS] = self.__data_types.COMMAND_DATA_MERCHANT_TRANSACTION_IDS
+
+        self.__data_structure_util.add_to_dict(
+            source_dict=self.__payment_data_set,
+            working_dict=self.__command_data_structure,
+            new_key=self.__INFO_COMMAND_DATA_KEY,
+            new_dict={self.__data_sets.COMMAND_DATA_MERCHANT_TRANSACTION_IDS: list_of_merchant_transaction_id}
+        )

gateway/responses/lists.py

@@ -21,6 +21,7 @@
 # THE SOFTWARE.
 import datetime
 from typing import Sequence
+from enum import Enum
 
 from gateway.responses.constants import Status
 from gateway.responses.generic import GenericResponse
@@ -96,6 +97,13 @@ def __init__(self, data: dict = None) -> None:
         super().__init__(TransactionResult, data)
 
 
+class CardFamily(Enum):
+    VISA = 'VISA'
+    MASTER_CARD = 'MC'
+    MAESTRO = 'MA'
+    AMERICAN_EXPRESS = 'AMEX'
+
+
 class TransactionStatus(TransactionsListElement):
     def __init__(self, data: dict = None) -> None:
         super().__init__(data)
@@ -108,6 +116,8 @@ def __init__(self, data: dict = None) -> None:
         self.status_code_general = get_value(status_data, 'status-code-general', Status)
         self.status_text = get_value(status_data, 'status-text', str, '')
         self.status_text_general = get_value(status_data, 'status-text-general', str, '')
+        self.card_family = get_value(status_data, 'card-family', CardFamily)
+        self.card_mask = get_value(status_data, 'card-mask', str, '')
 
 
 class StatusResponse(TransactionsList):

setup.py

@@ -33,7 +33,7 @@
 
 setuptools.setup(
     name='transactpro-gw3-client',
-    version='1.7.4',
+    version='1.7.5',
     description='Transact PRO Gateway3 implementation in Python.',
     long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",

tests/builders/test_info_data_builder.py

@@ -41,14 +41,20 @@ def tearDown(self):
 
     def test_mandatory_and_data_fields(self):
         new = self.BUILDER
-        new.add_gateway_transaction_ids([
-            '16f462cb-9s32-dsv2-b983-fa14da6421f1'
-        ])
+        new.add_gateway_transaction_ids(['16f462cb-9s32-dsv2-b983-fa14da6421f1'])
+        new.add_merchant_transaction_ids(['fa14da6421f1-9s32-dsv2-b983-16f462cb'])
+
         from gateway.data_sets.request_parameters import (RequestParameters, RequestParametersTypes)
         valid_fields = {
-            RequestParameters.COMMAND_DATA_GATEWAY_TRANSACTION_IDS:
-                RequestParametersTypes.COMMAND_DATA_GATEWAY_TRANSACTION_IDS,
+            RequestParameters.COMMAND_DATA_GATEWAY_TRANSACTION_IDS: RequestParametersTypes.COMMAND_DATA_GATEWAY_TRANSACTION_IDS,
+            RequestParameters.COMMAND_DATA_MERCHANT_TRANSACTION_IDS: RequestParametersTypes.COMMAND_DATA_MERCHANT_TRANSACTION_IDS,
         }
         self.assertDictEqual(valid_fields, self.MANDATORY_FIELDS)
-        valid_data_structure = {'command-data': {'gateway-transaction-ids': ['16f462cb-9s32-dsv2-b983-fa14da6421f1']}}
+
+        valid_data_structure = {
+            'command-data': {
+                'gateway-transaction-ids': ['16f462cb-9s32-dsv2-b983-fa14da6421f1'],
+                'merchant-transaction-ids': ['fa14da6421f1-9s32-dsv2-b983-16f462cb'],
+            }
+        }
         self.assertDictEqual(valid_data_structure, self.DATA)

tests/operations/test_operations.py

@@ -26,7 +26,7 @@
 from gateway.operations.operations import Operations
 from gateway.responses.constants import Status, ErrorCode
 from gateway.responses.enrollment import EnrollmentStatus
-from gateway.responses.lists import RefundsListElement, TransactionResult, TransactionStatus
+from gateway.responses.lists import RefundsListElement, TransactionResult, TransactionStatus, CardFamily
 from gateway.responses.parts import TransactionInfo
 from gateway.responses.payment import GW
 from gateway.responses.response import parse_date
@@ -410,9 +410,10 @@ def test_result(self):
 
     def test_status(self):
         body = b"{\"transactions\":[{\"gateway-transaction-id\":\"cd7b8bdf-3c78-4540-95d0-68018d2aba97\",\"status\":" \
-               b"[{\"gateway-transaction-id\":\"cd7b8bdf-3c78-4540-95d0-68018d2aba97\",\"status-code\":7,\"status-code-general\":8," \
-               b"\"status-text\":\"SUCCESS\",\"status-text-general\":\"EXPIRED\"}]},{\"gateway-transaction-id\":\"37908991-789b-4d79-8c6a-f90ba0ce12b6\"," \
-               b"\"status\":[{\"gateway-transaction-id\":\"37908991-789b-4d79-8c6a-f90ba0ce12b6\",\"status-code\":8,\"status-code-general\":7," \
+               b"[{\"card-mask\":\"534219*5267\",\"card-family\":\"MC\",\"gateway-transaction-id\":\"cd7b8bdf-3c78-4540-95d0-68018d2aba97\"," \
+               b"\"status-code\":7,\"status-code-general\":8,\"status-text\":\"SUCCESS\",\"status-text-general\":\"EXPIRED\"}]}," \
+               b"{\"gateway-transaction-id\":\"37908991-789b-4d79-8c6a-f90ba0ce12b6\",\"status\":[" \
+               b"{\"gateway-transaction-id\":\"37908991-789b-4d79-8c6a-f90ba0ce12b6\",\"status-code\":8,\"status-code-general\":7," \
                b"\"status-text\":\"EXPIRED\",\"status-text-general\":\"SUCCESS\"}]}," \
                b"{\"error\":{\"code\":400,\"message\":\"Failed to fetch data for transaction with gateway id: 99900000-789b-4d79-8c6a-f90ba0ce12b0\"}," \
                b"\"gateway-transaction-id\":\"99900000-789b-4d79-8c6a-f90ba0ce12b0\"}]}"
@@ -427,6 +428,8 @@ def test_status(self):
         self.assertEqual(Status.EXPIRED, tr1.status_code_general)
         self.assertEqual("SUCCESS", tr1.status_text)
         self.assertEqual("EXPIRED", tr1.status_text_general)
+        self.assertEqual(CardFamily.MASTER_CARD, tr1.card_family)
+        self.assertEqual("534219*5267", tr1.card_mask)
 
         tr2: TransactionStatus = parsed_response.transactions[1]
         self.assertEqual("37908991-789b-4d79-8c6a-f90ba0ce12b6", tr2.gateway_transaction_id)