Share rest client

Author: adamjmcgrath

auth0/v3/management/asyncify.py auth0/v3/asyncify.pyauth0/v3/management/asyncify.py renamed to auth0/v3/asyncify.py

@@ -5,6 +5,8 @@
 
 import requests
 
+from auth0.v3.rest import RestClient, RestClientOptions
+
 from ..exceptions import Auth0Error, RateLimitError
 
 UNKNOWN_ERROR = "a0.sdk.internal.unknown"
@@ -24,132 +26,14 @@ class AuthenticationBase(object):
 
     def __init__(self, domain, telemetry=True, timeout=5.0, protocol="https"):
         self.domain = domain
-        self.timeout = timeout
         self.protocol = protocol
-        self.base_headers = {"Content-Type": "application/json"}
-
-        if telemetry:
-            py_version = platform.python_version()
-            version = sys.modules["auth0"].__version__
-
-            auth0_client = json.dumps(
-                {
-                    "name": "auth0-python",
-                    "version": version,
-                    "env": {
-                        "python": py_version,
-                    },
-                }
-            ).encode("utf-8")
-
-            self.base_headers.update(
-                {
-                    "User-Agent": "Python/{}".format(py_version),
-                    "Auth0-Client": base64.b64encode(auth0_client),
-                }
-            )
+        self.client = RestClient(
+            jwt=None,
+            options=RestClientOptions(telemetry=telemetry, timeout=timeout, retries=0),
+        )
 
     def post(self, url, data=None, headers=None):
-        request_headers = self.base_headers.copy()
-        request_headers.update(headers or {})
-        response = requests.post(
-            url=url, json=data, headers=request_headers, timeout=self.timeout
-        )
-        return self._process_response(response)
+        return self.client.post(url, data, headers)
 
     def get(self, url, params=None, headers=None):
-        request_headers = self.base_headers.copy()
-        request_headers.update(headers or {})
-        response = requests.get(
-            url=url, params=params, headers=request_headers, timeout=self.timeout
-        )
-        return self._process_response(response)
-
-    def _process_response(self, response):
-        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, headers):
-        self._status_code = status_code
-        self._content = content
-        self._headers = headers
-
-    def content(self):
-        if not self._is_error():
-            return self._content
-
-        if self._status_code == 429:
-            reset_at = int(self._headers.get("x-ratelimit-reset", "-1"))
-            raise RateLimitError(
-                error_code=self._error_code(),
-                message=self._error_message(),
-                reset_at=reset_at,
-            )
-
-        raise Auth0Error(
-            status_code=self._status_code,
-            error_code=self._error_code(),
-            message=self._error_message(),
-        )
-
-    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, response.headers
-        )
-
-    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:
-            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, response.headers
-        )
-
-    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 ""
+        return self.client.get(url, params, headers)

auth0/v3/authentication/base.py

@@ -75,10 +75,12 @@ def __init__(self, jwt, telemetry=True, timeout=5.0, options=None):
         self._skip_sleep = False
 
         self.base_headers = {
-            "Authorization": "Bearer {}".format(self.jwt),
             "Content-Type": "application/json",
         }
 
+        if jwt is not None:
+            self.base_headers["Authorization"] = "Bearer {}".format(self.jwt)
+
         if options.telemetry:
             py_version = platform.python_version()
             version = sys.modules["auth0"].__version__
@@ -124,8 +126,9 @@ def MAX_REQUEST_RETRY_DELAY(self):
     def MIN_REQUEST_RETRY_DELAY(self):
         return 100
 
-    def get(self, url, params=None):
-        headers = self.base_headers.copy()
+    def get(self, url, params=None, headers=None):
+        request_headers = self.base_headers.copy()
+        request_headers.update(headers or {})
 
         # Track the API request attempt number
         attempt = 0
@@ -139,7 +142,10 @@ def get(self, url, params=None):
 
             # Issue the request
             response = requests.get(
-                url, params=params, headers=headers, timeout=self.options.timeout
+                url,
+                params=params,
+                headers=request_headers,
+                timeout=self.options.timeout,
             )
 
             # If the response did not have a 429 header, or the attempt number is greater than the configured retries, break
@@ -156,11 +162,12 @@ def get(self, url, params=None):
         # Return the final Response
         return self._process_response(response)
 
-    def post(self, url, data=None):
-        headers = self.base_headers.copy()
+    def post(self, url, data=None, headers=None):
+        request_headers = self.base_headers.copy()
+        request_headers.update(headers or {})
 
         response = requests.post(
-            url, json=data, headers=headers, timeout=self.options.timeout
+            url, json=data, headers=request_headers, timeout=self.options.timeout
         )
         return self._process_response(response)
 
@@ -281,10 +288,14 @@ def _error_code(self):
             return self._content.get("errorCode")
         elif "error" in self._content:
             return self._content.get("error")
+        elif "code" in self._content:
+            return self._content.get("code")
         else:
             return UNKNOWN_ERROR
 
     def _error_message(self):
+        if "error_description" in self._content:
+            return self._content.get("error_description")
         message = self._content.get("message", "")
         if message is not None and message != "":
             return message

auth0/v3/rest.py

@@ -13,12 +13,13 @@
 class TestBase(unittest.TestCase):
     def test_telemetry_enabled_by_default(self):
         ab = AuthenticationBase("auth0.com")
+        base_headers = ab.client.base_headers
 
-        user_agent = ab.base_headers["User-Agent"]
-        auth0_client_bytes = base64.b64decode(ab.base_headers["Auth0-Client"])
+        user_agent = base_headers["User-Agent"]
+        auth0_client_bytes = base64.b64decode(base_headers["Auth0-Client"])
         auth0_client_json = auth0_client_bytes.decode("utf-8")
         auth0_client = json.loads(auth0_client_json)
-        content_type = ab.base_headers["Content-Type"]
+        content_type = base_headers["Content-Type"]
 
         from auth0 import __version__ as auth0_version
 
@@ -39,7 +40,7 @@ def test_telemetry_enabled_by_default(self):
     def test_telemetry_disabled(self):
         ab = AuthenticationBase("auth0.com", telemetry=False)
 
-        self.assertEqual(ab.base_headers, {"Content-Type": "application/json"})
+        self.assertEqual(ab.client.base_headers, {"Content-Type": "application/json"})
 
     @mock.patch("requests.post")
     def test_post(self, mock_post):
@@ -51,7 +52,7 @@ def test_post(self, mock_post):
         data = ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
 
         mock_post.assert_called_with(
-            url="the-url",
+            "the-url",
             json={"a": "b"},
             headers={"c": "d", "Content-Type": "application/json"},
             timeout=(10, 2),
@@ -70,7 +71,7 @@ def test_post_with_defaults(self, mock_post):
         data = ab.post("the-url")
 
         mock_post.assert_called_with(
-            url="the-url",
+            "the-url",
             json=None,
             headers={"Content-Type": "application/json"},
             timeout=5.0,
@@ -88,8 +89,8 @@ def test_post_includes_telemetry(self, mock_post):
         data = ab.post("the-url", data={"a": "b"}, headers={"c": "d"})
 
         self.assertEqual(mock_post.call_count, 1)
-        call_kwargs = mock_post.call_args[1]
-        self.assertEqual(call_kwargs["url"], "the-url")
+        call_args, call_kwargs = mock_post.call_args
+        self.assertEqual(call_args[0], "the-url")
         self.assertEqual(call_kwargs["json"], {"a": "b"})
         headers = call_kwargs["headers"]
         self.assertEqual(headers["c"], "d")
@@ -228,7 +229,7 @@ def test_get(self, mock_get):
         data = ab.get("the-url", params={"a": "b"}, headers={"c": "d"})
 
         mock_get.assert_called_with(
-            url="the-url",
+            "the-url",
             params={"a": "b"},
             headers={"c": "d", "Content-Type": "application/json"},
             timeout=(10, 2),
@@ -247,7 +248,7 @@ def test_get_with_defaults(self, mock_get):
         data = ab.get("the-url")
 
         mock_get.assert_called_with(
-            url="the-url",
+            "the-url",
             params=None,
             headers={"Content-Type": "application/json"},
             timeout=5.0,
@@ -265,8 +266,8 @@ def test_get_includes_telemetry(self, mock_get):
         data = ab.get("the-url", params={"a": "b"}, headers={"c": "d"})
 
         self.assertEqual(mock_get.call_count, 1)
-        call_kwargs = mock_get.call_args[1]
-        self.assertEqual(call_kwargs["url"], "the-url")
+        call_args, call_kwargs = mock_get.call_args
+        self.assertEqual(call_args[0], "the-url")
         self.assertEqual(call_kwargs["params"], {"a": "b"})
         headers = call_kwargs["headers"]
         self.assertEqual(headers["c"], "d")

auth0/v3/test/authentication/test_base.py

@@ -1,4 +1,3 @@
-import asyncio
 import base64
 import json
 import platform
@@ -12,8 +11,8 @@
 from callee import Attrs
 from mock import ANY, MagicMock
 
+from auth0.v3.asyncify import asyncify
 from auth0.v3.management import Clients, Guardian, Jobs
-from auth0.v3.management.asyncify import asyncify
 
 clients = re.compile(r"^https://example\.com/api/v2/clients.*")
 factors = re.compile(r"^https://example\.com/api/v2/guardian/factors.*")