Add support for proxying requests

Author: gmazoyer

pyixapi/core/api.py

@@ -48,6 +48,7 @@ def __init__(
         access_token="",
         refresh_token="",
         user_agent=f"pyixapi/{__version__}",
+        proxies=None,
     ):
         self.url = url.rstrip("/")
         self.key = key
@@ -56,6 +57,7 @@ def __init__(
         self.refresh_token = Token.from_jwt(refresh_token) if refresh_token else None
         self.http_session = requests.Session()
         self.user_agent = user_agent
+        self.proxies = proxies
 
         self.auth = Endpoint(self, "auth")
         self.connections = Endpoint(self, "connections", model=Connection)
@@ -84,7 +86,13 @@ def version(self):
         """
         Get the API version of IX-API.
         """
-        return Request(base=self.url, token=self.access_token, http_session=self.http_session).get_version()
+        return Request(
+            base=self.url,
+            token=self.access_token,
+            http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
+        ).get_version()
 
     @property
     def accounts(self):
@@ -116,9 +124,12 @@ def authenticate(self):
         if self.refresh_token and not self.refresh_token.is_expired:
             return self.refresh_authentication()
 
-        r = Request(cat(self.url, "auth", "token"), http_session=self.http_session).post(
-            data={"api_key": self.key, "api_secret": self.secret}
-        )
+        r = Request(
+            cat(self.url, "auth", "token"),
+            http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
+        ).post(data={"api_key": self.key, "api_secret": self.secret})
 
         self.access_token = Token.from_jwt(r["access_token"])
         self.refresh_token = Token.from_jwt(r["refresh_token"])
@@ -133,6 +144,8 @@ def refresh_authentication(self):
             cat(self.url, "auth", "refresh"),
             token=self.refresh_token.encoded,
             http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
         ).post(data={"refresh_token": self.refresh_token.encoded})
 
         self.access_token = Token.from_jwt(r["access_token"])
@@ -149,4 +162,10 @@ def health(self):
         if self.version == 1:
             return {}
 
-        return Request(base=self.url, token=self.access_token, http_session=self.http_session).get_health()
+        return Request(
+            base=self.url,
+            token=self.access_token,
+            http_session=self.http_session,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
+        ).get_health()

pyixapi/core/endpoint.py

@@ -28,6 +28,8 @@ def all(self):
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         )
         return RecordSet(self, r)
 
@@ -41,6 +43,8 @@ def filter(self, *args, **kwargs):
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         )
         return RecordSet(self, r)
 
@@ -74,6 +78,8 @@ def get(self, *args, **kwargs):
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         )
         try:
             return next(RecordSet(self, r), None)
@@ -94,6 +100,8 @@ def create(self, *args, **kwargs):
             base=self.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         ).post(args[0] if args else kwargs)
 
         return self.return_obj(req, self.api, self)

pyixapi/core/query.py

@@ -61,14 +61,24 @@ class Request(object):
         dict.
     """
 
-    def __init__(self, base, http_session, filters=None, key=None, token=None, user_agent=None):
+    def __init__(
+        self,
+        base,
+        http_session,
+        filters=None,
+        key=None,
+        token=None,
+        user_agent=None,
+        proxies=None,
+    ):
         self.base = base
         self.filters = filters or None
         self.key = key
         self.token = token
         self.http_session = http_session
         self.url = self.base if not key else cat(self.base, key)
         self.user_agent = user_agent
+        self.proxies = proxies
 
     def get_openapi(self):
         """
@@ -124,7 +134,14 @@ def _make_call(self, verb="get", url_override=None, add_params=None, data=None):
             if add_params:
                 params.update(add_params)
 
-        r = getattr(self.http_session, verb)(url_override or self.url, headers=headers, params=params, json=data)
+        r = getattr(self.http_session, verb)(
+            url_override or self.url,
+            headers=headers,
+            params=params,
+            json=data,
+            user_agent=self.user_agent,
+            proxies=self.proxies,
+        )
 
         if verb == "delete":
             if r.ok:

pyixapi/core/response.py

@@ -290,6 +290,8 @@ def save(self):
                 base=self.endpoint.url,
                 token=self.api.access_token,
                 http_session=self.api.http_session,
+                user_agent=self.user_agent,
+                proxies=self.api.proxies,
             )
             if r.patch(updates):
                 return True
@@ -316,5 +318,7 @@ def delete(self):
             base=self.endpoint.url,
             token=self.api.access_token,
             http_session=self.api.http_session,
+            user_agent=self.user_agent,
+            proxies=self.api.proxies,
         )
         return True if r.delete() else False