Merge pull request #48 from hyperwallet/feature/DTPAYHWBM-1-V3-python-adding-reject-reasons

feature/DTPAYHWBM-1-V3-python-adding-reject-reasons

Author: hlahlou-pp-dev

hyperwallet/__init__.py

@@ -32,7 +32,10 @@
     StatusTransition,                                                    # noqa
     TransferMethodConfiguration,                                         # noqa
     Webhook,                                                             # noqa
-    TransferRefunds                                                     # naqa
+    TransferRefunds,                                                     # naqa
+    HyperwalletVerificationDocument,
+    HyperwalletVerificationDocumentReason,
+    RejectReason,
 )
 
 from .api import Api                                                     # noqa

hyperwallet/api.py

@@ -23,7 +23,10 @@
     StatusTransition,
     TransferMethodConfiguration,
     Webhook,
-    TransferRefunds
+    TransferRefunds,
+    HyperwalletVerificationDocument,
+    HyperwalletVerificationDocumentReason,
+    RejectReason
 )
 
 
@@ -2761,6 +2764,38 @@ def listWebhookNotifications(self,
     def __buildUrl(self, *paths):
         return '/'.join(s.strip('/') for s in paths)
 
+    def setDocumentAndReasonFromResponseHelper(self,
+                               data=None):
+        '''
+        Helper to modify dictionary with Document and Reason classes
+
+        :param data:
+            A dictionary containing data for either a User
+            sample data:
+            jsonData={'data': ['{"documents": [{"type": "DRIVERS_LICENSE", "country": "US", "category": "IDENTIFICATION", "reasons": {"name": 0, "description": "STRING_VAL"}}]}']};
+        :returns:
+            A Dictionary with documents and reasons information
+        '''
+
+        if "documents" in data.keys():
+            documents = data["documents"]
+            listOfDocs = []
+            for dVal in documents:
+                if "reasons" in dVal.keys():
+                    reasons = dVal["reasons"]
+                    dVal["reasons"] = []
+                    for rVal in reasons:
+                        if type(rVal["name"]) == str:
+                            rVal["name"] = RejectReason[rVal["name"]]
+                        else:
+                            rVal["name"] = RejectReason(rVal["name"])
+                        rVal = HyperwalletVerificationDocumentReason(rVal)
+                        dVal["reasons"].append(rVal)
+                dVal = HyperwalletVerificationDocument(dVal)
+                listOfDocs.append(dVal)
+            data["documents"] = listOfDocs
+        return data
+
     def uploadDocumentsForUser(self,
                                userToken=None,
                                data=None,
@@ -2796,7 +2831,7 @@ def uploadDocumentsForUser(self,
             data,
             files
         )
-
+        response = self.setDocumentAndReasonFromResponseHelper(response)
         return User(response)
 
     '''

hyperwallet/models.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
 import json
-
+from enum import Enum
 
 class HyperwalletModel(object):
     '''
@@ -129,6 +129,76 @@ def __repr__(self):
             token=self.token
         )
 
+class HyperwalletVerificationDocument(HyperwalletModel):
+    '''
+    The HyperwalletVerificationDocument Model.
+
+    :param data:
+        A dictionary containing the attributes for the HyperwalletVerificationDocument.
+    '''
+
+    def __init__(self, data):
+        '''
+        Create a new HyperwalletVerificationDocument with the provided attributes.
+        '''
+
+        super(HyperwalletVerificationDocument, self).__init__(data)
+
+        self.defaults = {
+            'category': None,
+            'type': None,
+            'status': None,
+            'country': None,
+            'reasons': None,
+            'createdOn': None,
+            'uploadFiles': None,
+        }
+
+        for (param, default) in self.defaults.items():
+            setattr(self, param, data.get(param, default))
+
+    def __repr__(self):
+        return "HyperwalletVerificationDocument({category}, {createdOn})".format(
+            createdOn=self.createdOn, category=self.category
+        )
+
+class HyperwalletVerificationDocumentReason(HyperwalletModel):
+    '''
+    The HyperwalletVerificationDocumentReason Model.
+
+    :param data:
+        A dictionary containing the attributes for the HyperwalletVerificationDocumentReason.
+    '''
+
+    def __init__(self, data):
+        '''
+        Create a new HyperwalletVerificationDocumentReason with the provided attributes.
+        '''
+
+        super(HyperwalletVerificationDocumentReason, self).__init__(data)
+
+        self.defaults = {
+            'name': None,
+            'description': None,
+        }
+
+        for (param, default) in self.defaults.items():
+            setattr(self, param, data.get(param, default))
+
+    def __repr__(self):
+        return "HyperwalletVerificationDocumentReason({name}, {description})".format(
+            name=self.name, description=self.description
+        )
+
+class RejectReason(Enum):
+    DOCUMENT_EXPIRED = 0
+    DOCUMENT_NOT_RELATED_TO_PROFILE = 1
+    DOCUMENT_NOT_READABLE = 2
+    DOCUMENT_NOT_DECISIVE = 3
+    DOCUMENT_NOT_COMPLETE = 4
+    DOCUMENT_CORRECTION_REQUIRED = 5
+    DOCUMENT_NOT_VALID_WITH_NOTES = 6
+    DOCUMENT_TYPE_NOT_VALID = 7
 
 class AuthenticationToken(HyperwalletModel):
     '''

hyperwallet/tests/test_api.py

@@ -64,6 +64,37 @@ def setUp(self):
             'currencies': ['USD'],
             'type': 'INDIVIDUAL'
         }
+        
+        self.uploadSuccessData = {
+            'token': 'tkn-12345',
+            "documents": [{
+                "category": "IDENTIFICATION",
+                "type": "DRIVERS_LICENSE",
+                "country": "AL",
+                "status": "NEW"
+            }]
+        }
+
+        self.uploadRejectionData = {
+            'token': 'tkn-12345',
+            "documents": [{
+                "category": "IDENTIFICATION",
+                "type": "DRIVERS_LICENSE",
+                "country": "AL",
+                "status": "INVALID",
+                "reasons": [
+                    {
+                    "name": "DOCUMENT_CORRECTION_REQUIRED",
+                    "description": "Document requires correction"
+                    },
+                    {
+                    "name": "DOCUMENT_NOT_DECISIVE",
+                    "description": "Decision cannot be made based on document. Alternative document required"
+                    }
+                ],
+                "createdOn": "2020-11-24T19:05:02"
+            }]
+        }
 
         self.value = {
             'data': ['{"documents": [{"type": "DRIVERS_LICENSE", "country": "AL", "category": "IDENTIFICATION"}]}']
@@ -2637,6 +2668,30 @@ def test_uploadDocumentsForUser_success(self, mock_put):
 
         self.assertTrue(response.token, self.data.get('token'))
 
+    @mock.patch('hyperwallet.utils.ApiClient._makeRequest')
+    def test_uploadDocumentsForUserAndParse_success(self, mock_put):
+
+        mock_put.return_value = self.uploadSuccessData
+        response = self.api.uploadDocumentsForUser('token', self.value)
+
+        self.assertEqual(response.token, self.uploadSuccessData.get('token'))
+        self.assertEqual(response.documents[0].type, self.uploadSuccessData.get("documents")[0].type)
+
+
+    @mock.patch('hyperwallet.utils.ApiClient._makeRequest')
+    def test_uploadDocumentsForUserAndParseRejection_success(self, mock_put):
+
+        mock_put.return_value = self.uploadRejectionData
+        response = self.api.uploadDocumentsForUser('token', self.value)
+
+        # print(response.documents)
+        # print(response.documents[0].reasons[0].name.name)
+
+        self.assertEqual(response.token, self.uploadRejectionData.get('token'))
+        self.assertEqual(response.documents[0].reasons[0].name.name, self.uploadRejectionData.get("documents")[0].reasons[0].name.name)
+        self.assertEqual(response.documents[0].reasons[1].name.name, self.uploadRejectionData.get("documents")[0].reasons[1].name.name)
+        self.assertEqual(response.documents[0].type, self.uploadRejectionData.get("documents")[0].type)
+
     '''
 
     Transfer Refunds