Merge pull request #2 from hyperwallet/master

akreisman-epam · web-flow · commit c71cf4d2d002 · 2018-12-17T19:41:38.000+02:00
Merge master
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,7 +1,12 @@
 Changelog
 =========
 
-1.1.4 (current)
+1.1.5 (current)
+------------------
+
+- Added Client Token endpoint
+
+1.1.4 (2018-12-04)
 ------------------
 
 - Added PayPal account endpoint
diff --git a/hyperwallet/__init__.py b/hyperwallet/__init__.py
@@ -6,7 +6,7 @@
 __email__           = 'devsupport@hyperwallet.com'
 __copyright__       = 'Copyright (c) 2017 Hyperwallet'
 __license__         = 'MIT'
-__version__         = '1.1.4'
+__version__         = '1.1.5'
 __url__             = 'https://github.com/hyperwallet/python-sdk'
 __download_url__    = 'https://pypi.python.org/pypi/hyperwallet-sdk'
 __description__     = 'A Python wrapper around the Hyperwallet API'
@@ -21,6 +21,7 @@
     PrepaidCard,                                                         # noqa
     PaperCheck,                                                          # noqa
     Transfer,                                                            # noqa
+    ClientToken,                                                         # noqa
     PayPalAccount,                                                       # noqa
     Payment,                                                             # noqa
     Balance,                                                             # noqa
diff --git a/hyperwallet/api.py b/hyperwallet/api.py
@@ -14,6 +14,7 @@
     PrepaidCard,
     PaperCheck,
     Transfer,
+    ClientToken,
     PayPalAccount,
     Payment,
     Balance,
@@ -1654,6 +1655,32 @@ def listPayPalAccounts(self,
 
     '''
 
+    ClientToken
+
+    '''
+
+    def getClientToken(self,
+                       userToken=None):
+        '''
+        Get a ClientToken.
+        :param userToken:
+             A user token. **REQUIRED**
+        :returns:
+            A ClientToken.
+        '''
+
+        if not userToken:
+            raise HyperwalletException('userToken is required')
+
+        response = self.apiClient.doPost(
+            os.path.join('users', userToken, 'client-token'),
+            None
+        )
+
+        return ClientToken(response)
+
+    '''
+
     Payments
     https://portal.hyperwallet.com/docs/api/v3/resources/payments
 
diff --git a/hyperwallet/models.py b/hyperwallet/models.py
@@ -125,6 +125,34 @@ def __repr__(self):
         )
 
 
+class ClientToken(HyperwalletModel):
+    '''
+    The ClientToken Model.
+
+    :param data:
+        A dictionary containing the attributes for the Client Token.
+    '''
+
+    def __init__(self, data):
+        '''
+        Create a new Client Token with the provided attributes.
+        '''
+
+        super(ClientToken, self).__init__(data)
+
+        self.defaults = {
+            'value': None,
+        }
+
+        for (param, default) in self.defaults.items():
+            setattr(self, param, data.get(param, default))
+
+    def __repr__(self):
+        return "ClientToken({value})".format(
+            value=self.value
+        )
+
+
 class TransferMethod(HyperwalletModel):
     '''
     The TransferMethod Model.
diff --git a/hyperwallet/tests/test_api.py b/hyperwallet/tests/test_api.py
@@ -1366,6 +1366,30 @@ def test_list_paypal_accounts_success(self, mock_get):
 
     '''
 
+    ClientToken
+
+    '''
+
+    def test_get_client_token_fail_need_user_token(self):
+
+        with self.assertRaises(HyperwalletException) as exc:
+            self.api.getClientToken()
+
+        self.assertEqual(exc.exception.message, 'userToken is required')
+
+    @mock.patch('hyperwallet.utils.ApiClient._makeRequest')
+    def test_get_client_token_success(self, mock_post):
+
+        client_token_data = {
+            'value': 'test-value'
+        }
+        mock_post.return_value = client_token_data
+        response = self.api.getClientToken('user-token')
+
+        self.assertTrue(response.value, client_token_data.get('value'))
+
+    '''
+
     Payments
 
     '''
diff --git a/hyperwallet/tests/test_client.py b/hyperwallet/tests/test_client.py
@@ -45,7 +45,10 @@ def test_receive_non_json_response(self, session_mock):
 
         session_mock.return_value = mock.MagicMock(
             status_code=404,
-            content=data
+            content=data,
+            headers={
+                "Content-Type": "application/json"
+            }
         )
 
         with self.assertRaises(HyperwalletAPIException) as exc:
@@ -62,13 +65,18 @@ def test_receive_valid_json_error_response(self, session_mock):
         data = {
             "errors": [{
                 "message": "Houston, we have a problem",
-                "code": "FORBIDDEN"
+                "code": "FORBIDDEN",
+                "relatedResources": ["trm-f3d38df1-adb7-4127-9858-e72ebe682a79",
+                    "trm-601b1401-4464-4f3f-97b3-09079ee7723b"]
             }]
         }
 
         session_mock.return_value = mock.MagicMock(
             status_code=400,
-            content=json.dumps(data)
+            content=json.dumps(data),
+            headers={
+                "Content-Type": "application/json"
+            }
         )
 
         with self.assertRaises(HyperwalletAPIException) as exc:
@@ -79,6 +87,16 @@ def test_receive_valid_json_error_response(self, session_mock):
             'FORBIDDEN'
         )
 
+        self.assertEqual(
+            exc.exception.message.get('errors')[0].get('relatedResources')[0],
+            'trm-f3d38df1-adb7-4127-9858-e72ebe682a79'
+        )
+
+        self.assertEqual(
+            exc.exception.message.get('errors')[0].get('relatedResources')[1],
+            'trm-601b1401-4464-4f3f-97b3-09079ee7723b'
+        )
+
     @mock.patch('requests.Session.request')
     def test_receive_valid_json_response(self, session_mock):
 
@@ -88,7 +106,10 @@ def test_receive_valid_json_response(self, session_mock):
 
         session_mock.return_value = mock.MagicMock(
             status_code=200,
-            content=json.dumps(data)
+            content=json.dumps(data),
+            headers={
+                "Content-Type": "application/json"
+            }
         )
 
         encoded = json.dumps(data)
@@ -100,6 +121,29 @@ def test_receive_valid_json_response(self, session_mock):
             json.loads(encoded)
         )
 
+    @mock.patch('requests.Session.request')
+    def test_receive_json_error_response_when_content_type_is_not_valid(self, session_mock):
+
+        data = {
+            'key': 'value'
+        }
+
+        session_mock.return_value = mock.MagicMock(
+            status_code=200,
+            content=json.dumps(data),
+            headers={
+                "Content-Type": "wrongContentType"
+            }
+        )
+
+        with self.assertRaises(HyperwalletAPIException) as exc:
+            self.client._makeRequest()
+
+        self.assertEqual(
+            exc.exception.message,
+            'Invalid Content-Type specified in Response Header'
+        )
+
 
 if __name__ == '__main__':
     unittest.main()
diff --git a/hyperwallet/tests/test_encryption.py b/hyperwallet/tests/test_encryption.py
@@ -9,8 +9,7 @@
 from jwcrypto.common import json_encode
 from hyperwallet.exceptions import HyperwalletException
 from hyperwallet.utils.encryption import Encryption
-from django.core.validators import URLValidator
-from django.core.exceptions import ValidationError
+from six.moves.urllib.parse import urlparse
 
 
 class EncryptionTest(unittest.TestCase):
@@ -158,19 +157,37 @@ def test_should_throw_exception_when_jws_signature_has_expired(self):
         self.assertEqual(exc.exception.message, 'JWS signature has expired, checked by [exp] JWS header')
 
     def __getJwkKeySet(self, location):
-
+        '''
+        Retrieves JWK key data from given location.
+
+        :param location:
+            Location(can be a URL or path to file) of JWK key data. **REQUIRED**
+        :returns:
+            JWK key set found at given location.
+        '''
         try:
-            URLValidator()(location)
-        except ValidationError:
+            url = urlparse(location)
+            if url.scheme and url.netloc and url.path:
+                return requests.get(location).text
+            raise HyperwalletException('Failed to parse url from string = ' + location)
+        except Exception as e:
             if os.path.isfile(location):
                 with open(location) as f:
                     return f.read()
             else:
                 raise HyperwalletException('Wrong JWK key set location path = ' + location)
 
-        return requests.get(location).text
-
     def __findJwkKeyByAlgorithm(self, jwkKeySet, algorithm):
+        '''
+        Finds JWK key by given algorithm.
+
+        :param jwkKeySet:
+            JSON representation of JWK key set. **REQUIRED**
+        :param algorithm:
+            Algorithm of the JWK key to be found in key set. **REQUIRED**
+        :returns:
+            JWK key with given algorithm.
+        '''
 
         try:
             keySet = json.loads(jwkKeySet)
diff --git a/hyperwallet/tests/test_models.py b/hyperwallet/tests/test_models.py
@@ -12,6 +12,7 @@
     PrepaidCard,
     PaperCheck,
     Transfer,
+    ClientToken,
     PayPalAccount,
     Payment,
     Balance,
@@ -73,6 +74,10 @@ def setUp(self):
             'createdOn': '2017-01-01'
         }
 
+        self.client_token_data = {
+            'value': 'test-client-token'
+        }
+
         self.transfer_method_data = {
             'token': 'trm-12345',
             'createdOn': '2017-01-01'
@@ -243,6 +248,23 @@ def test_transfer_model(self):
 
     '''
 
+    ClientToken
+
+    '''
+
+    def test_client_token_model(self):
+
+        test_client_token = ClientToken(self.client_token_data)
+
+        self.assertEqual(
+            test_client_token.__repr__(),
+            'ClientToken({value})'.format(
+                value=self.client_token_data.get('value')
+            )
+        )
+
+    '''
+
     PayPal Account
 
     '''
diff --git a/hyperwallet/utils/apiclient.py b/hyperwallet/utils/apiclient.py
@@ -41,7 +41,7 @@ def __init__(self, username, password, server, encryptionData=None):
         # Hyperwallet SDK.
         self.baseHeaders = {
             'User-Agent': 'Hyperwallet Python SDK v{}'.format(__version__),
-            'Accept': 'application/json',
+            'Accept': 'application/jose+json' if self.encrypted else 'application/json',
             'Content-Type': 'application/jose+json' if self.encrypted else 'application/json'
         }
 
@@ -113,6 +113,8 @@ def _makeRequest(self,
         if response.status_code is 204:
             return {}
 
+        self.__checkResponseHeaderContentType(response)
+
         content = response.content
         if hasattr(content, 'decode'):  # Python 2
             content = content.decode('utf-8')
@@ -193,6 +195,20 @@ def doPut(self, partialUrl, data):
             data=json.dumps(data).encode('utf-8')
         )
 
+    def __checkResponseHeaderContentType(self, response):
+        '''
+        Check response header Content-Type.
+
+        :param response:
+            Response to be checked. **REQUIRED**
+        '''
+
+        if response is None:
+            return
+        contentType = response.headers['Content-Type']
+        if (not self.encrypted and contentType != 'application/json') or (self.encrypted and contentType != 'application/jose+json'):
+            raise HyperwalletAPIException('Invalid Content-Type specified in Response Header')
+
     def __getRequestData(self, data):
         '''
         If encryption is enabled try to encrypt request data, otherwise no action required.
