Merge pull request #61 from livechat/API-10249/Add-proxy-support

Add support to use proxy in httpx client

Author: zuczkows

changelog.md

@@ -1,6 +1,13 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.1.11] - Unreleased
+
+### Added
+
+- Added proxy support to web interfaces
+
+
 ## [0.1.10] - 2021-12-02
 
 ### Added

livechat/agent/web/client.py

@@ -49,16 +49,23 @@ def get_client(access_token: str,
 
 class AgentWebInterface(metaclass=ABCMeta):
     ''' Main class containing API methods. '''
-    def __init__(self, access_token: str, version: str, base_url: str,
-                 http2: bool) -> AgentWebInterface:
+    def __init__(self,
+                 access_token: str,
+                 version: str,
+                 base_url: str,
+                 http2: bool,
+                 proxies=None,
+                 verify: bool = True) -> AgentWebInterface:
         logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/agent/action'
         self.session = httpx.Client(http2=http2,
                                     headers={'Authorization': access_token},
                                     event_hooks={
                                         'request': [logger.log_request],
                                         'response': [logger.log_response]
-                                    })
+                                    },
+                                    proxies=proxies,
+                                    verify=verify)
 
     def modify_header(self, header: dict) -> None:
         ''' Modifies provided header in session object.

livechat/configuration/client.py

@@ -46,16 +46,23 @@ def get_client(token: str,
 
 class ConfigurationApiInterface(metaclass=ABCMeta):
     ''' Interface class. '''
-    def __init__(self, token: str, version: str, base_url: str,
-                 http2: bool) -> ConfigurationApiInterface:
+    def __init__(self,
+                 token: str,
+                 version: str,
+                 base_url: str,
+                 http2: bool,
+                 proxies=None,
+                 verify: bool = True) -> ConfigurationApiInterface:
         logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/configuration/action'
         self.session = httpx.Client(http2=http2,
                                     headers={'Authorization': token},
                                     event_hooks={
                                         'request': [logger.log_request],
                                         'response': [logger.log_response]
-                                    })
+                                    },
+                                    proxies=proxies,
+                                    verify=verify)
 
     def modify_header(self, header: dict) -> None:
         ''' Modifies provided header in session object.

livechat/customer/web/client.py

@@ -27,7 +27,7 @@ def get_client(license_id: int = None,
 
             Args:
                 license_id (int): License ID. Required to use API v3.3.
-                token (str): Full token with type (Bearer/Basic) that will be
+                token (str): Full token with type (Bearer) that will be
                                 used as `Authorization` header in requests to API.
                 version (str): API's version. Defaults to `3.3`.
                 base_url (str): API's base url. Defaults to `api.livechatinc.com`.
@@ -66,8 +66,13 @@ def get_client(license_id: int = None,
 
 class CustomerWebInterface(metaclass=ABCMeta):
     ''' Main class containing API methods. '''
-    def __init__(self, access_token: str, version: str, base_url: str,
-                 http2: bool) -> CustomerWebInterface:
+    def __init__(self,
+                 access_token: str,
+                 version: str,
+                 base_url: str,
+                 http2: bool,
+                 proxies=None,
+                 verify: bool = True) -> CustomerWebInterface:
         logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/customer/action'
         if all([access_token, isinstance(access_token, str)]):
@@ -77,7 +82,9 @@ def __init__(self, access_token: str, version: str, base_url: str,
                 event_hooks={
                     'request': [logger.log_request],
                     'response': [logger.log_response]
-                })
+                },
+                proxies=proxies,
+                verify=verify)
         else:
             raise ValueError(
                 'Incorrect or missing `access_token` argument (should be of type str.)'

livechat/reports/client.py

@@ -47,16 +47,23 @@ def get_client(token: str,
 
 class ReportsApiInterface(metaclass=ABCMeta):
     ''' Interface class. '''
-    def __init__(self, token: str, version: str, base_url: str,
-                 http2: bool) -> ReportsApiInterface:
+    def __init__(self,
+                 token: str,
+                 version: str,
+                 base_url: str,
+                 http2: bool,
+                 proxies=None,
+                 verify: bool = True) -> ReportsApiInterface:
         logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/reports'
         self.session = httpx.Client(http2=http2,
                                     headers={'Authorization': token},
                                     event_hooks={
                                         'request': [logger.log_request],
                                         'response': [logger.log_response]
-                                    })
+                                    },
+                                    proxies=proxies,
+                                    verify=verify)
 
     def modify_header(self, header: dict) -> None:
         ''' Modifies provided header in session object.