Adds proxies parameter to taiga client and requestmaker (#223)

* Add proxies parameter to taiga client

* Update tests to pass proxies argument

Author: hassen-doca

AUTHORS

@@ -25,3 +25,4 @@ Robin Gustafsson <[email protected]>
 Daniel Federschmidt <[email protected]>
 Robert Dyer <[email protected]>
 Patrick Szczepański <[email protected]>
+Hassen Ben Tanfous <[email protected]>

changes/55.feature

@@ -0,0 +1 @@
+Add proxies parameter to taiga client

taiga/client.py

@@ -57,21 +57,31 @@ class TaigaAPI:
     :param token_type: the token type
     :param tls_verify: verify server certificate
     :param auth_type: authentication type identifier
+    :param proxies: a dictionary of proxies to use for requests
     """
 
     def __init__(
-        self, host="https://api.taiga.io", token=None, token_type="Bearer", tls_verify=True, auth_type="normal"
+        self,
+        host="https://api.taiga.io",
+        token=None,
+        token_type="Bearer",
+        tls_verify=True,
+        auth_type="normal",
+        proxies=None,
     ):
         self.host = host
         self.token = token
         self.token_refresh = None
         self.token_type = token_type
         self.tls_verify = tls_verify
         self.auth_type = auth_type
+        self.proxies = proxies
         if not self.tls_verify:
             requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
         if token:
-            self.raw_request = RequestMaker("/api/v1", self.host, self.token, self.token_type, self.tls_verify)
+            self.raw_request = RequestMaker(
+                "/api/v1", self.host, self.token, self.token_type, self.tls_verify, proxies=proxies
+            )
             self._init_resources()
 
     def _init_resources(self):
@@ -137,14 +147,18 @@ def auth(self, username, password):
         payload = {"type": self.auth_type, "username": username, "password": password}
         try:
             full_url = utils.urljoin(self.host, "/api/v1/auth")
-            response = requests.post(full_url, data=json.dumps(payload), headers=headers, verify=self.tls_verify)
+            response = requests.post(
+                full_url, data=json.dumps(payload), headers=headers, verify=self.tls_verify, proxies=self.proxies
+            )
         except RequestException:
             raise exceptions.TaigaRestException(full_url, 400, "NETWORK ERROR", "POST")
         if response.status_code != 200:
             raise exceptions.TaigaRestException(full_url, response.status_code, response.text, "POST")
         self.token = response.json()["auth_token"]
         self.token_refresh = response.json()["refresh"]
-        self.raw_request = RequestMaker("/api/v1", self.host, self.token, "Bearer", self.tls_verify)
+        self.raw_request = RequestMaker(
+            "/api/v1", self.host, self.token, "Bearer", self.tls_verify, proxies=self.proxies
+        )
         self._init_resources()
 
     def auth_app(self, app_id, app_secret, auth_code, state=""):
@@ -159,7 +173,9 @@ def auth_app(self, app_id, app_secret, auth_code, state=""):
         payload = {"application": app_id, "auth_code": auth_code, "state": state}
         try:
             full_url = utils.urljoin(self.host, "/api/v1/application-tokens/validate")
-            response = requests.post(full_url, data=json.dumps(payload), headers=headers, verify=self.tls_verify)
+            response = requests.post(
+                full_url, data=json.dumps(payload), headers=headers, verify=self.tls_verify, proxies=self.proxies
+            )
         except RequestException:
             raise exceptions.TaigaRestException(full_url, 400, "NETWORK ERROR", "POST")
         if response.status_code != 200:
@@ -185,7 +201,9 @@ def auth_app(self, app_id, app_secret, auth_code, state=""):
         if self.token is None:
             raise exceptions.TaigaRestException(full_url, 400, "INVALID TOKEN", "POST")
 
-        self.raw_request = RequestMaker("/api/v1", self.host, self.token, "Application", self.tls_verify)
+        self.raw_request = RequestMaker(
+            "/api/v1", self.host, self.token, "Application", self.tls_verify, proxies=self.proxies
+        )
         self._init_resources()
 
     def refresh_token(self, token_refresh=""):
@@ -205,12 +223,16 @@ def refresh_token(self, token_refresh=""):
         payload = {"refresh": token_refresh}
         try:
             full_url = utils.urljoin(self.host, "/api/v1/auth/refresh")
-            response = requests.post(full_url, data=json.dumps(payload), headers=headers, verify=self.tls_verify)
+            response = requests.post(
+                full_url, data=json.dumps(payload), headers=headers, verify=self.tls_verify, proxies=self.proxies
+            )
         except RequestException:
             raise exceptions.TaigaRestException(full_url, 400, "NETWORK ERROR", "POST")
         if response.status_code != 200:
             raise exceptions.TaigaRestException(full_url, response.status_code, response.text, "POST")
         self.token = response.json()["auth_token"]
         self.token_refresh = response.json()["refresh"]
-        self.raw_request = RequestMaker("/api/v1", self.host, self.token, "Bearer", self.tls_verify)
+        self.raw_request = RequestMaker(
+            "/api/v1", self.host, self.token, "Bearer", self.tls_verify, proxies=self.proxies
+        )
         self._init_resources()

taiga/requestmaker.py

@@ -49,13 +49,16 @@ class RequestMakerException(Exception):  # noqa: N818
 
 
 class RequestMaker:
-    def __init__(self, api_path, host, token, token_type="Bearer", tls_verify=True, enable_pagination=True):
+    def __init__(
+        self, api_path, host, token, token_type="Bearer", tls_verify=True, enable_pagination=True, proxies=None
+    ):
         self.api_path = api_path
         self.host = host
         self.token = token
         self.token_type = token_type
         self.tls_verify = tls_verify
         self.enable_pagination = enable_pagination
+        self.proxies = proxies
         self._cache = RequestCache()
         if not self.tls_verify:
             requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
@@ -99,7 +102,11 @@ def get(self, uri, query=None, cache=False, paginate=True, **parameters):
 
             if not result:
                 result = requests.get(
-                    full_url, headers=self.headers(paginate), params=query or {}, verify=self.tls_verify
+                    full_url,
+                    headers=self.headers(paginate),
+                    params=query or {},
+                    verify=self.tls_verify,
+                    proxies=self.proxies,
                 )
             if cache:
                 self._cache.put(full_url, result)
@@ -124,7 +131,13 @@ def post(self, uri, payload=None, query=None, files=None, **parameters):
         try:
             full_url = self.urljoin(self.host, self.api_path, uri.format(**parameters))
             result = requests.post(
-                full_url, headers=headers, data=data, params=query or {}, files=files, verify=self.tls_verify
+                full_url,
+                headers=headers,
+                data=data,
+                params=query or {},
+                files=files,
+                verify=self.tls_verify,
+                proxies=self.proxies,
             )
         except RequestException:
             raise exceptions.TaigaRestException(full_url, 400, "Network error!", "POST")
@@ -136,7 +149,9 @@ def post(self, uri, payload=None, query=None, files=None, **parameters):
     def delete(self, uri, query=None, **parameters):
         try:
             full_url = self.urljoin(self.host, self.api_path, uri.format(**parameters))
-            result = requests.delete(full_url, headers=self.headers(), params=query or {}, verify=self.tls_verify)
+            result = requests.delete(
+                full_url, headers=self.headers(), params=query or {}, verify=self.tls_verify, proxies=self.proxies
+            )
         except RequestException:
             raise exceptions.TaigaRestException(full_url, 400, "Network error!", "DELETE")
         if not self.is_bad_response(result):
@@ -148,7 +163,12 @@ def put(self, uri, payload=None, query=None, **parameters):
         try:
             full_url = self.urljoin(self.host, self.api_path, uri.format(**parameters))
             result = requests.put(
-                full_url, headers=self.headers(), data=json.dumps(payload), params=query or {}, verify=self.tls_verify
+                full_url,
+                headers=self.headers(),
+                data=json.dumps(payload),
+                params=query or {},
+                verify=self.tls_verify,
+                proxies=self.proxies,
             )
         except RequestException:
             raise exceptions.TaigaRestException(full_url, 400, "Network error!", "PUT")
@@ -161,7 +181,12 @@ def patch(self, uri, payload=None, query=None, **parameters):
         try:
             full_url = self.urljoin(self.host, self.api_path, uri.format(**parameters))
             result = requests.patch(
-                full_url, headers=self.headers(), data=json.dumps(payload), params=query or {}, verify=self.tls_verify
+                full_url,
+                headers=self.headers(),
+                data=json.dumps(payload),
+                params=query or {},
+                verify=self.tls_verify,
+                proxies=self.proxies,
             )
         except RequestException:
             raise exceptions.TaigaRestException(full_url, 400, "Network error!", "PATCH")

tests/test_auth.py

@@ -67,6 +67,7 @@ def test_refresh_token_passed_token(self, requests_post):
             data='{"refresh": "testToken"}',
             headers={"Content-type": "application/json"},
             verify=True,
+            proxies=None,
         )
 
     @patch("taiga.client.requests.post")

tests/test_issue_statuses.py

@@ -25,6 +25,7 @@ def test_delete_issue_statuses(self, requests_delete):
             headers={"Content-type": "application/json", "Authorization": "Bearer f4k3", "x-lazy-pagination": "True"},
             params={"moveTo": 2},
             verify=True,
+            proxies=None,
         )
 
     @patch("taiga.requestmaker.requests.delete")
@@ -37,4 +38,5 @@ def test_delete_issue_status(self, requests_delete):
             headers={"Content-type": "application/json", "Authorization": "Bearer f4k3", "x-lazy-pagination": "True"},
             params={"moveTo": 2},
             verify=True,
+            proxies=None,
         )

tests/test_issue_types.py

@@ -25,6 +25,7 @@ def test_delete_issue_types(self, requests_delete):
             headers={"Content-type": "application/json", "Authorization": "Bearer f4k3", "x-lazy-pagination": "True"},
             params={"moveTo": 2},
             verify=True,
+            proxies=None,
         )
 
     @patch("taiga.requestmaker.requests.delete")
@@ -37,4 +38,5 @@ def test_delete_issue_type(self, requests_delete):
             headers={"Content-type": "application/json", "Authorization": "Bearer f4k3", "x-lazy-pagination": "True"},
             params={"moveTo": 2},
             verify=True,
+            proxies=None,
         )

tests/test_model_base.py

@@ -232,6 +232,7 @@ def test_call_model_base_list_elements_no_paginate_check_requests(self, mock_req
                 "Content-type": "application/json",
                 "Authorization": "Bearer faketoken",
             },
+            proxies=None,
         )
         self.assertEqual(len(f_list), 9)
 
@@ -253,6 +254,7 @@ def test_call_model_base_list_elements_paginate_check_requests(self, mock_reques
                 "Content-type": "application/json",
                 "Authorization": "Bearer faketoken",
             },
+            proxies=None,
         )
         self.assertEqual(len(f_list), 9)
 

tests/test_points.py

@@ -25,6 +25,7 @@ def test_delete_points(self, requests_delete):
             headers={"Content-type": "application/json", "Authorization": "Bearer f4k3", "x-lazy-pagination": "True"},
             params={"moveTo": 2},
             verify=True,
+            proxies=None,
         )
 
     @patch("taiga.requestmaker.requests.delete")
@@ -37,4 +38,5 @@ def test_delete_point(self, requests_delete):
             headers={"Content-type": "application/json", "Authorization": "Bearer f4k3", "x-lazy-pagination": "True"},
             params={"moveTo": 2},
             verify=True,
+            proxies=None,
         )

tests/test_priorities.py

@@ -25,6 +25,7 @@ def test_delete_priorities(self, requests_delete):
             headers={"Content-type": "application/json", "Authorization": "Bearer f4k3", "x-lazy-pagination": "True"},
             params={"moveTo": 2},
             verify=True,
+            proxies=None,
         )
 
     @patch("taiga.requestmaker.requests.delete")
@@ -37,4 +38,5 @@ def test_delete_priority(self, requests_delete):
             headers={"Content-type": "application/json", "Authorization": "Bearer f4k3", "x-lazy-pagination": "True"},
             params={"moveTo": 2},
             verify=True,
+            proxies=None,
         )