Merge pull request #7 from TransactPRO/custom-return-url

Add possibility to use custom return URL

Author: dmitryakadiamond

README.md

@@ -44,6 +44,9 @@ This `README` provide introduction to the library usage.
   - Verify 3-D Secure enrollment
   - Complete card verification
 
+- Tokenization
+  - Create payment data token
+
 #### Basic usage
 You can find several examples realisation in examples folder:
 [ExampleScripts](https://github.com/TransactPRO/gw3-python-client/blob/master/examples/)

gateway/builders/merchant_order_builder.py

@@ -187,3 +187,19 @@ def add_custom_3d_return_url(self, custom_3d_return_url=None):
                 self.__req_params.GENERAL_DATA_ORDER_DATA_CUSTOM_3D_RETURN_URL: custom_3d_return_url
             }
         )
+
+    def add_custom_return_url(self, custom_return_url=None):
+        """
+        Add custom return url
+
+        Args:
+            custom_return_url (str): custom return url
+        """
+        self.__data_structure_util.add_to_dict(
+            source_dict=self.__general_data_set[self.__GENERAL_DATA_KEY],
+            working_dict=self.__order_data_structure,
+            new_key=self.__ORDER_DATA_KEY,
+            new_dict={
+                self.__req_params.GENERAL_DATA_ORDER_DATA_CUSTOM_RETURN_URL: custom_return_url
+            }
+        )

gateway/data_sets/request_parameters.py

@@ -69,6 +69,7 @@ class RequestParameters:
     GENERAL_DATA_ORDER_DATA_RECIPIENT_NAME = 'recipient-name'
     GENERAL_DATA_ORDER_DATA_MERCHANT_REFERRING_NAME = 'merchant-referring-name'
     GENERAL_DATA_ORDER_DATA_CUSTOM_3D_RETURN_URL = 'custom-3d-return-url'
+    GENERAL_DATA_ORDER_DATA_CUSTOM_RETURN_URL = 'custom-return-url'
 
     # Payment data sets
     PAYMENT_METHOD_DATA_PAN = 'pan'
@@ -136,6 +137,7 @@ class RequestParametersTypes(RequestParameters):
     GENERAL_DATA_ORDER_DATA_RECIPIENT_NAME = str
     GENERAL_DATA_ORDER_DATA_MERCHANT_REFERRING_NAME = str
     GENERAL_DATA_ORDER_DATA_CUSTOM_3D_RETURN_URL = str
+    GENERAL_DATA_ORDER_DATA_CUSTOM_RETURN_URL = str
 
     # Payment data sets
     PAYMENT_METHOD_DATA_PAN = str

tests/builders/test_merchant_order_builder.py

@@ -110,6 +110,13 @@ def test_build_with_add_custom_3d_return_url(self):
             new.add_custom_3d_return_url('Lorem Ipsum is simply dummy text.')
         mock.assert_called_once_with('Lorem Ipsum is simply dummy text.')
 
+    def test_build_with_add_custom_return_url(self):
+        """Will succeed"""
+        new = self.BUILDER
+        with patch.object(new, 'add_custom_return_url') as mock:
+            new.add_custom_return_url('Lorem Ipsum is simply dummy text.')
+        mock.assert_called_once_with('Lorem Ipsum is simply dummy text.')
+
     def test_merchant_data_structure_build(self):
         valid_data_structure = {
             'general-data': {
@@ -121,6 +128,7 @@ def test_merchant_data_structure_build(self):
                     'recipient-name': 'Jone Doe',
                     'merchant-referring-name': 'REF NAME',
                     'custom-3d-return-url': 'https://example.com',
+                    'custom-return-url': 'https://another-example.com',
                     'order-meta': {
                         'url': 'nice.example.com',
                         'sequence': '0',
@@ -140,6 +148,7 @@ def test_merchant_data_structure_build(self):
         new.add_recipient_name('Jone Doe')
         new.add_merchant_referring_name('REF NAME')
         new.add_custom_3d_return_url('https://example.com')
+        new.add_custom_return_url('https://another-example.com')
         new.add_merchant_order_meta(
             json_object={
                 'f_name': 'Jane',