Merge pull request #72 from maxmind/greg/proxy

Allow setting a proxy when creating a client

Author: horgh

HISTORY.rst

@@ -3,6 +3,12 @@
 History
 -------
 
+2.3.0
+++++++++++++++++++
+
+* You may now set a proxy to use when making web service requests by passing
+  the ``proxy`` parameter to the ``AsyncClient`` or ``Client`` constructor.
+
 2.2.0 (2020-10-13)
 ++++++++++++++++++
 

minfraud/webservice.py

@@ -228,6 +228,7 @@ class AsyncClient(BaseClient):
     """Async client for accessing the minFraud web services."""
 
     _existing_session: aiohttp.ClientSession
+    _proxy: Optional[str]
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
@@ -236,6 +237,7 @@ def __init__(  # pylint: disable=too-many-arguments
         host: str = "minfraud.maxmind.com",
         locales: Tuple[str, ...] = ("en",),
         timeout: float = 60,
+        proxy: Optional[str] = None,
     ) -> None:
         """Constructor for AsyncClient.
 
@@ -247,14 +249,18 @@ def __init__(  # pylint: disable=too-many-arguments
         :type host: str
         :param locales: A tuple of locale codes to use in name property
         :type locales: tuple[str]
-        :param timeout: The timeout in seconts to use when waiting on the request.
+        :param timeout: The timeout in seconds to use when waiting on the request.
           This sets both the connect timeout and the read timeout. The default is
           60.
         :type timeout: float
+        :param proxy: The URL of an HTTP proxy to use. It may optionally include
+          a basic auth username and password, e.g.,
+          ``http://username:password@host:port``.
         :return: Client object
         :rtype: Client
         """
         super().__init__(account_id, license_key, host, locales, timeout)
+        self._proxy = proxy
 
     async def factors(
         self, transaction: Dict[str, Any], validate: bool = True
@@ -383,7 +389,7 @@ async def _do_request(
         self, uri: str, data: Dict[str, Any]
     ) -> aiohttp.ClientResponse:
         session = await self._session()
-        return await session.post(uri, json=data)
+        return await session.post(uri, json=data, proxy=self._proxy)
 
     async def _session(self) -> aiohttp.ClientSession:
         if not hasattr(self, "_existing_session"):
@@ -413,6 +419,7 @@ async def __aexit__(self, exc_type: None, exc_value: None, traceback: None) -> N
 class Client(BaseClient):
     """Synchronous client for accessing the minFraud web services."""
 
+    _proxies: Optional[Dict[str, str]]
     _session: requests.Session
 
     def __init__(  # pylint: disable=too-many-arguments
@@ -422,6 +429,7 @@ def __init__(  # pylint: disable=too-many-arguments
         host: str = "minfraud.maxmind.com",
         locales: Tuple[str, ...] = ("en",),
         timeout: float = 60,
+        proxy: Optional[str] = None,
     ) -> None:
         """Constructor for Client.
 
@@ -433,9 +441,12 @@ def __init__(  # pylint: disable=too-many-arguments
         :type host: str
         :param locales: A tuple of locale codes to use in name property
         :type locales: tuple[str]
-        :param timeout: The timeout in seconts to use when waiting on the request.
+        :param timeout: The timeout in seconds to use when waiting on the request.
           This sets both the connect timeout and the read timeout. The default is
           60.
+        :param proxy: The URL of an HTTP proxy to use. It may optionally include
+          a basic auth username and password, e.g.,
+          ``http://username:password@host:port``.
         :type timeout: float
         :return: Client object
         :rtype: Client
@@ -447,6 +458,11 @@ def __init__(  # pylint: disable=too-many-arguments
         self._session.headers["Accept"] = "application/json"
         self._session.headers["User-Agent"] = _REQUEST_UA
 
+        if proxy is None:
+            self._proxies = None
+        else:
+            self._proxies = {"https": proxy}
+
     def factors(self, transaction: Dict[str, Any], validate: bool = True) -> Factors:
         """Query Factors endpoint with transaction data.
 
@@ -562,7 +578,9 @@ def _response_for(
         return self._handle_success(body, uri, model_class)
 
     def _do_request(self, uri: str, data: Dict[str, Any]) -> Response:
-        return self._session.post(uri, json=data, timeout=self._timeout)
+        return self._session.post(
+            uri, json=data, timeout=self._timeout, proxies=self._proxies
+        )
 
     def close(self):
         """Close underlying session

setup.cfg

@@ -9,7 +9,7 @@ max-line-length = 88
 universal = 1
 
 [tox:tox]
-envlist = py36, py37, py38, mypy
+envlist = py36, py37, py38, py39, mypy
 
 [gh-actions]
 python =