auth0-python 3.1.4__tar.gz → 3.2.2__tar.gz

usr/local/lib/python3.6/site-packages/auth0/__init__.py

@@ -1 +1 @@
-__version__ = '3.1.4'
+__version__ = '3.2.2'

usr/local/lib/python3.6/site-packages/auth0/v3/authentication/base.py

@@ -3,6 +3,9 @@ import requests
 from ..exceptions import Auth0Error
 
 
+UNKNOWN_ERROR = 'a0.sdk.internal.unknown'
+
+
 class AuthenticationBase(object):
 
     def post(self, url, data=None, headers=None):
@@ -14,13 +17,75 @@ class AuthenticationBase(object):
         return requests.get(url=url, params=params, headers=headers).text
 
     def _process_response(self, response):
+        return self._parse(response).content()
+
+    def _parse(self, response):
+        if not response.text:
+            return EmptyResponse(response.status_code)
         try:
-            text = json.loads(response.text) if response.text else {}
+            return JsonResponse(response)
         except ValueError:
-            return response.text
+            return PlainResponse(response)
+
+
+class Response(object):
+    def __init__(self, status_code, content):
+        self._status_code = status_code
+        self._content = content
+
+    def content(self):
+        if self._is_error():
+            raise Auth0Error(status_code=self._status_code,
+                             error_code=self._error_code(),
+                             message=self._error_message())
+        else:
+            return self._content
+
+    def _is_error(self):
+        return self._status_code is None or self._status_code >= 400
+
+    # Adding these methods to force implementation in subclasses because they are references in this parent class
+    def _error_code(self):
+        raise NotImplementedError
+
+    def _error_message(self):
+        raise NotImplementedError
+
+
+class JsonResponse(Response):
+    def __init__(self, response):
+        content = json.loads(response.text)
+        super(JsonResponse, self).__init__(response.status_code, content)
+
+    def _error_code(self):
+        if 'error' in self._content:
+            return self._content.get('error')
+        elif 'code' in self._content:
+            return self._content.get('code')
         else:
-            if response.status_code is None or response.status_code >= 400:
-                raise Auth0Error(status_code=response.status_code,
-                                 error_code=text.get('error', ''),
-                                 message=text.get('error_description', ''))
-        return text
+            return UNKNOWN_ERROR
+
+    def _error_message(self):
+        return self._content.get('error_description', '')
+
+
+class PlainResponse(Response):
+    def __init__(self, response):
+        super(PlainResponse, self).__init__(response.status_code, response.text)
+
+    def _error_code(self):
+        return UNKNOWN_ERROR
+
+    def _error_message(self):
+        return self._content
+
+
+class EmptyResponse(Response):
+    def __init__(self, status_code):
+        super(EmptyResponse, self).__init__(status_code, '')
+
+    def _error_code(self):
+        return UNKNOWN_ERROR
+
+    def _error_message(self):
+        return ''

usr/local/lib/python3.6/site-packages/auth0/v3/authentication/enterprise.py

@@ -16,7 +16,7 @@ class Enterprise(AuthenticationBase):
         """Get SAML2.0 Metadata.
 
         Args:
-            client_id (str): Id of the client to get the SAML metadata for.
+            client_id (str): Client Id of the application to get the SAML metadata for.
         """
 
         return self.get(url='https://%s/samlp/metadata/%s' % (self.domain,

usr/local/lib/python3.6/site-packages/auth0/v3/authentication/get_token.py

@@ -92,7 +92,7 @@ class GetToken(AuthenticationBase):
 
         This is the OAuth 2.0 grant that server processes utilize in
         order to access an API. Use this endpoint to directly request
-        an access_token by using the Client Credentials (a Client Id and
+        an access_token by using the Application Credentials (a Client Id and
         a Client Secret).
 
         Args:

usr/local/lib/python3.6/site-packages/auth0/v3/authentication/logout.py

@@ -24,7 +24,7 @@ class Logout(AuthenticationBase):
         The URL should be included in any the appropriate Allowed Logout URLs list:
 
         Args:
-            client_id (str): The client_id of your client.
+            client_id (str): The client_id of your application.
 
             returnTo (str): URL to redirect the user after the logout.
 

usr/local/lib/python3.6/site-packages/auth0/v3/authentication/passwordless.py

@@ -27,7 +27,7 @@ class Passwordless(AuthenticationBase):
             this user using email as username and code as password.
 
         Args:
-            client_id (str): Id of the client.
+            client_id (str): Client Id of the application.
 
             email (str): Email address.
 

usr/local/lib/python3.6/site-packages/auth0/v3/authentication/social.py

@@ -21,7 +21,7 @@ class Social(AuthenticationBase):
         Facebook, Google, Twitter and Weibo.
 
         Args:
-            client_id (str): client name.
+            client_id (str): application's client id.
 
             access_token (str): social provider's access_token.
 

usr/local/lib/python3.6/site-packages/auth0/v3/management/auth0.py

@@ -40,4 +40,4 @@ class Auth0(object):
         self.guardian = Guardian(domain, token)
         self.logs = Logs(domain, token)
         self.resource_servers = ResourceServers(domain, token)
-        self.user_blocks = UserBlocks
+        self.user_blocks = UserBlocks(domain, token)

usr/local/lib/python3.6/site-packages/auth0/v3/management/blacklists.py

@@ -23,7 +23,7 @@ class Blacklists(object):
 
         Args:
             aud (str, optional): The JWT's aud claim. The client_id of the
-                client for which it was issued.
+                application for which it was issued.
         """
 
         params = {
@@ -38,7 +38,7 @@ class Blacklists(object):
         Args:
             jti (str): the jti of the JWT to blacklist.
             aud (str, optional): The JWT's aud claim. The client_id of the
-                client for which it was issued.
+                application for which it was issued.
         """
 
         return self.client.post(self.url, data={'jti': jti, 'aud': aud})

usr/local/lib/python3.6/site-packages/auth0/v3/management/client_grants.py

@@ -50,7 +50,7 @@ class ClientGrants(object):
         """Deletes a client grant.
 
         Args:
-           id (str): Id of client to delete.
+           id (str): Id of client grant to delete.
         """
 
         return self.client.delete(self._url(id))

usr/local/lib/python3.6/site-packages/auth0/v3/management/clients.py

@@ -3,7 +3,7 @@ from .rest import RestClient
 
 class Clients(object):
 
-    """Auth0 client endpoints
+    """Auth0 applications endpoints
 
     Args:
         domain (str): Your Auth0 domain, e.g: 'username.auth0.com'
@@ -25,7 +25,7 @@ class Clients(object):
         return url
 
     def all(self, fields=[], include_fields=True):
-        """Retrieves a list of all client applications.
+        """Retrieves a list of all the applications.
 
         Important: The client_secret and encryption_key attributes can only be
         retrieved with the read:client_keys scope.
@@ -45,23 +45,23 @@ class Clients(object):
         return self.client.get(self._url(), params=params)
 
     def create(self, body):
-        """Create a new client application.
+        """Create a new application.
 
         Args:
-           body (dict): Attributes for the new client application.
+           body (dict): Attributes for the new application.
               See: https://auth0.com/docs/api/v2#!/Clients/post_clients
         """
 
         return self.client.post(self._url(), data=body)
 
     def get(self, id, fields=[], include_fields=True):
-        """Retrieves a client by its id.
+        """Retrieves an application by its id.
 
         Important: The client_secret, encryption_key and signing_keys
         attributes can only be retrieved with the read:client_keys scope.
 
         Args:
-           id (str): Id of the client to get.
+           id (str): Id of the application to get.
 
            fields (list of str, optional): A list of fields to include or
               exclude from the result (depending on include_fields). Empty to
@@ -77,22 +77,22 @@ class Clients(object):
         return self.client.get(self._url(id), params=params)
 
     def delete(self, id):
-        """Deletes a client and all its related assets.
+        """Deletes an application and all its related assets.
 
         Args:
-           id (str): Id of client to delete.
+           id (str): Id of application to delete.
         """
 
         return self.client.delete(self._url(id))
 
     def update(self, id, body):
-        """Modifies a client.
+        """Modifies an application.
 
         Important: The client_secret, encryption_key and signing_keys
         attributes can only be updated with the update:client_keys scope.
 
         Args:
-           id (str): Client id.
+           id (str): Client id of the application.
 
            body (dict): Attributes to modify.
         """

usr/local/lib/python3.6/site-packages/auth0/v3/management/rest.py

@@ -5,6 +5,9 @@ import requests
 from ..exceptions import Auth0Error
 
 
+UNKNOWN_ERROR = 'a0.sdk.internal.unknown'
+
+
 class RestClient(object):
 
     """Provides simple methods for handling all RESTful api endpoints. """
@@ -103,10 +106,71 @@ class RestClient(object):
         return self._process_response(response)
 
     def _process_response(self, response):
-        text = json.loads(response.text) if response.text else {}
+        return self._parse(response).content()
+
+    def _parse(self, response):
+        if not response.text:
+            return EmptyResponse(response.status_code)
+        try:
+            return JsonResponse(response)
+        except ValueError:
+            return PlainResponse(response)
+
+class Response(object):
+    def __init__(self, status_code, content):
+        self._status_code = status_code
+        self._content = content
+
+    def content(self):
+        if self._is_error():
+            raise Auth0Error(status_code=self._status_code,
+                             error_code=self._error_code(),
+                             message=self._error_message())
+        else:
+            return self._content
+
+    def _is_error(self):
+        return self._status_code is None or self._status_code >= 400
+
+    # Adding these methods to force implementation in subclasses because they are references in this parent class
+    def _error_code(self):
+        raise NotImplementedError
+
+    def _error_message(self):
+        raise NotImplementedError
+
+class JsonResponse(Response):
+    def __init__(self, response):
+        content = json.loads(response.text)
+        super(JsonResponse, self).__init__(response.status_code, content)
+
+    def _error_code(self):
+        if 'errorCode' in self._content:
+            return self._content.get('errorCode')
+        elif 'error' in self._content:
+            return self._content.get('error')
+        else:
+            return UNKNOWN_ERROR
+
+    def _error_message(self):
+        return self._content.get('error', self._content.get('message', ''))
+
+class PlainResponse(Response):
+    def __init__(self, response):
+        super(PlainResponse, self).__init__(response.status_code, response.text)
+
+    def _error_code(self):
+        return UNKNOWN_ERROR
+
+    def _error_message(self):
+        return self._content
+
+class EmptyResponse(Response):
+    def __init__(self, status_code):
+        super(EmptyResponse, self).__init__(status_code, '')
+
+    def _error_code(self):
+        return UNKNOWN_ERROR
 
-        if isinstance(text, dict) and 'errorCode' in text:
-            raise Auth0Error(status_code=text['statusCode'],
-                             error_code=text['errorCode'],
-                             message=text['message'])
-        return text
+    def _error_message(self):
+        return ''

usr/local/lib/python3.6/site-packages/auth0/v3/test/authentication/test_base.py

@@ -35,3 +35,65 @@ class TestBase(unittest.TestCase):
             self.assertEqual(context.exception.status_code, error_status)
             self.assertEqual(context.exception.error_code, 'e0')
             self.assertEqual(context.exception.message, 'desc')
+
+    @mock.patch('requests.post')
+    def test_post_error_with_code_property(self, mock_post):
+        ab = AuthenticationBase()
+
+        for error_status in [400, 500, None]:
+            mock_post.return_value.status_code = error_status
+            mock_post.return_value.text = '{"code": "e0",' \
+                                          '"error_description": "desc"}'
+
+            with self.assertRaises(Auth0Error) as context:
+                data = ab.post('the-url', data={'a': 'b'}, headers={'c': 'd'})
+
+            self.assertEqual(context.exception.status_code, error_status)
+            self.assertEqual(context.exception.error_code, 'e0')
+            self.assertEqual(context.exception.message, 'desc')
+
+    @mock.patch('requests.post')
+    def test_post_error_with_no_error_code(self, mock_post):
+        ab = AuthenticationBase()
+
+        for error_status in [400, 500, None]:
+            mock_post.return_value.status_code = error_status
+            mock_post.return_value.text = '{"error_description": "desc"}'
+
+            with self.assertRaises(Auth0Error) as context:
+                data = ab.post('the-url', data={'a': 'b'}, headers={'c': 'd'})
+
+            self.assertEqual(context.exception.status_code, error_status)
+            self.assertEqual(context.exception.error_code, 'a0.sdk.internal.unknown')
+            self.assertEqual(context.exception.message, 'desc')
+
+    @mock.patch('requests.post')
+    def test_post_error_with_text_response(self, mock_post):
+        ab = AuthenticationBase()
+
+        for error_status in [400, 500, None]:
+            mock_post.return_value.status_code = error_status
+            mock_post.return_value.text = 'there has been a terrible error'
+
+            with self.assertRaises(Auth0Error) as context:
+                data = ab.post('the-url', data={'a': 'b'}, headers={'c': 'd'})
+
+            self.assertEqual(context.exception.status_code, error_status)
+            self.assertEqual(context.exception.error_code, 'a0.sdk.internal.unknown')
+            self.assertEqual(context.exception.message,
+                             'there has been a terrible error')
+
+    @mock.patch('requests.post')
+    def test_post_error_with_no_response_text(self, mock_post):
+        ab = AuthenticationBase()
+
+        for error_status in [400, 500, None]:
+            mock_post.return_value.status_code = error_status
+            mock_post.return_value.text = None
+
+            with self.assertRaises(Auth0Error) as context:
+                data = ab.post('the-url', data={'a': 'b'}, headers={'c': 'd'})
+
+            self.assertEqual(context.exception.status_code, error_status)
+            self.assertEqual(context.exception.error_code, 'a0.sdk.internal.unknown')
+            self.assertEqual(context.exception.message, '')

usr/local/lib/python3.6/site-packages/auth0/v3/test/management/test_rest.py

@@ -13,6 +13,7 @@ class TestRest(unittest.TestCase):
         headers = {'Authorization': 'Bearer a-token'}
 
         mock_get.return_value.text = '["a", "b"]'
+        mock_get.return_value.status_code = 200
 
         response = rc.get('the-url')
         mock_get.assert_called_with('the-url', params={}, headers=headers)
@@ -27,7 +28,7 @@ class TestRest(unittest.TestCase):
 
         mock_get.return_value.text = ''
         response = rc.get('the/url')
-        self.assertEqual(response, {})
+        self.assertEqual(response, '')
 
     @mock.patch('requests.get')
     def test_get_errors(self, mock_get):
@@ -37,6 +38,7 @@ class TestRest(unittest.TestCase):
         mock_get.return_value.text = '{"statusCode": 999,' \
                                      ' "errorCode": "code",' \
                                      ' "message": "message"}'
+        mock_get.return_value.status_code = 999
 
         with self.assertRaises(Auth0Error) as context:
             rc.get('the/url')
@@ -55,6 +57,7 @@ class TestRest(unittest.TestCase):
 
         data = {'some': 'data'}
 
+        mock_post.return_value.status_code = 200
         response = rc.post('the/url', data=data)
         mock_post.assert_called_with('the/url', data=json.dumps(data),
                                      headers=headers)
@@ -68,6 +71,7 @@ class TestRest(unittest.TestCase):
         mock_post.return_value.text = '{"statusCode": 999,' \
                                       ' "errorCode": "code",' \
                                       ' "message": "message"}'
+        mock_post.return_value.status_code = 999
 
         with self.assertRaises(Auth0Error) as context:
             rc.post('the-url')
@@ -76,6 +80,68 @@ class TestRest(unittest.TestCase):
         self.assertEqual(context.exception.error_code, 'code')
         self.assertEqual(context.exception.message, 'message')
 
+    @mock.patch('requests.post')
+    def test_post_error_with_code_property(self, mock_post):
+        rc = RestClient(jwt='a-token', telemetry=False)
+
+        for error_status in [400, 500, None]:
+            mock_post.return_value.status_code = error_status
+            mock_post.return_value.text = '{"errorCode": "e0",' \
+                                          '"message": "desc"}'
+
+            with self.assertRaises(Auth0Error) as context:
+                rc.post('the-url')
+
+            self.assertEqual(context.exception.status_code, error_status)
+            self.assertEqual(context.exception.error_code, 'e0')
+            self.assertEqual(context.exception.message, 'desc')
+
+    @mock.patch('requests.post')
+    def test_post_error_with_no_error_code(self, mock_post):
+        rc = RestClient(jwt='a-token', telemetry=False)
+
+        for error_status in [400, 500, None]:
+            mock_post.return_value.status_code = error_status
+            mock_post.return_value.text = '{"message": "desc"}'
+
+            with self.assertRaises(Auth0Error) as context:
+                rc.post('the-url')
+
+            self.assertEqual(context.exception.status_code, error_status)
+            self.assertEqual(context.exception.error_code, 'a0.sdk.internal.unknown')
+            self.assertEqual(context.exception.message, 'desc')
+
+    @mock.patch('requests.post')
+    def test_post_error_with_text_response(self, mock_post):
+        rc = RestClient(jwt='a-token', telemetry=False)
+
+        for error_status in [400, 500, None]:
+            mock_post.return_value.status_code = error_status
+            mock_post.return_value.text = 'there has been a terrible error'
+
+            with self.assertRaises(Auth0Error) as context:
+                rc.post('the-url')
+
+            self.assertEqual(context.exception.status_code, error_status)
+            self.assertEqual(context.exception.error_code, 'a0.sdk.internal.unknown')
+            self.assertEqual(context.exception.message,
+                             'there has been a terrible error')
+
+    @mock.patch('requests.post')
+    def test_post_error_with_no_response_text(self, mock_post):
+        rc = RestClient(jwt='a-token', telemetry=False)
+
+        for error_status in [400, 500, None]:
+            mock_post.return_value.status_code = error_status
+            mock_post.return_value.text = None
+
+            with self.assertRaises(Auth0Error) as context:
+                rc.post('the-url')
+
+            self.assertEqual(context.exception.status_code, error_status)
+            self.assertEqual(context.exception.error_code, 'a0.sdk.internal.unknown')
+            self.assertEqual(context.exception.message, '')
+
     @mock.patch('requests.patch')
     def test_patch(self, mock_patch):
         rc = RestClient(jwt='a-token', telemetry=False)
@@ -83,6 +149,7 @@ class TestRest(unittest.TestCase):
                    'Content-Type': 'application/json'}
 
         mock_patch.return_value.text = '["a", "b"]'
+        mock_patch.return_value.status_code = 200
 
         data = {'some': 'data'}
 
@@ -99,6 +166,7 @@ class TestRest(unittest.TestCase):
         mock_patch.return_value.text = '{"statusCode": 999,' \
                                        ' "errorCode": "code",' \
                                        ' "message": "message"}'
+        mock_patch.return_value.status_code = 999
 
         with self.assertRaises(Auth0Error) as context:
             rc.patch(url='the/url')
@@ -113,6 +181,7 @@ class TestRest(unittest.TestCase):
         headers = {'Authorization': 'Bearer a-token'}
 
         mock_delete.return_value.text = '["a", "b"]'
+        mock_delete.return_value.status_code = 200
 
         response = rc.delete(url='the-url/ID')
         mock_delete.assert_called_with('the-url/ID', headers=headers, params={})
@@ -126,6 +195,7 @@ class TestRest(unittest.TestCase):
         mock_delete.return_value.text = '{"statusCode": 999,' \
                                         ' "errorCode": "code",' \
                                         ' "message": "message"}'
+        mock_delete.return_value.status_code = 999
 
         with self.assertRaises(Auth0Error) as context:
             rc.delete(url='the-url')

usr/local/lib/python3.6/site-packages/{auth0_python-3.1.4-py3.6.egg-info → auth0_python-3.2.2-py3.6.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 1.1
+Metadata-Version: 2.1
 Name: auth0-python
-Version: 3.1.4
+Version: 3.2.2
 Summary: Auth0 Python SDK
 Home-page: https://github.com/auth0/auth0-python
 Author: Auth0
@@ -18,3 +18,4 @@ Classifier: Programming Language :: Python :: 3.2
 Classifier: Programming Language :: Python :: 3.3
 Classifier: Programming Language :: Python :: 3.4
 Classifier: Programming Language :: Python :: 3.5
+Provides-Extra: test