pass timeout parameter to requests with a default value 30s

Kilo59 · Shariq Torres · commit a1f7e1dc15d3 · 2022-01-21T00:44:44.000-08:00
diff --git a/.github/workflows/forked_repos.yaml b/.github/workflows/forked_repos.yaml
@@ -0,0 +1,25 @@
+name: Run tests from Forked Repo
+
+on: 
+  pull_request_target:
+    types: [labeled]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: contains(github.event.pull_request.labels.*.name, 'Approved')
+    strategy:
+      matrix:
+        python-version: [ '3.10', '3.9', '3.8', '3.7', '3.6' ]
+    name: Python ${{ matrix.python-version }} sample
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pipenv'
+      - run: pip install pipenv
+      - run: pipenv sync --dev
+      - run: pipenv run tests
+        env:
+          LOB_API_KEY: ${{ secrets.LOB_API_KEY }}
diff --git a/Pipfile b/Pipfile
@@ -15,6 +15,7 @@ setuptools = "*"
 twine = "*"
 pytest = ">=6.2.1"
 pytest-cov = ">=2.11.1"
+requests-mock = ">=1.9.3"
 
 [scripts]
 # these commands can be invoked with `pipenv run <script_name>`
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/lob/api_requestor.py b/lob/api_requestor.py
@@ -6,6 +6,7 @@
 import lob
 from lob import error
 from lob.version import VERSION
+from lob.constants import TIMEOUT_DEFAULT
 
 
 def _is_file_like(obj):
@@ -39,7 +40,7 @@ def parse_response(self, resp):
         else:  # pragma: no cover
             raise error.APIError(payload['error']['message'], resp.content, resp.status_code, resp)
 
-    def request(self, method, url, params=None):
+    def request(self, method, url, params=None, timeout=TIMEOUT_DEFAULT):
         headers = {
             'User-Agent': 'Lob/v1 PythonBindings/%s' % VERSION
         }
@@ -55,13 +56,19 @@ def request(self, method, url, params=None):
             del params['headers']
 
         if method == 'get':
-            return self.parse_response(
-                requests.get(lob.api_base + url, auth=(self.api_key, ''), params=params, headers=headers)
-            )
+            resp = requests.get(
+                lob.api_base + url, 
+                auth=(self.api_key, ''),
+                params=params,
+                headers=headers,
+                timeout=timeout
+                )
+            return self.parse_response(resp)
+           
         elif method == 'delete':
-            return self.parse_response(
-                requests.delete(lob.api_base + url, auth=(self.api_key, ''), headers=headers)
-            )
+            resp = requests.delete(lob.api_base + url, auth=(self.api_key, ''), headers=headers, timeout=timeout)
+            return self.parse_response(resp)
+            
         elif method == 'post':
             query = {}
             data = {}
@@ -93,7 +100,5 @@ def request(self, method, url, params=None):
                                 data[k + '[' + k2 + ']'] = v2
                         else:
                             data[k] = v
-
-            return self.parse_response(
-                requests.post(lob.api_base + url, auth=(self.api_key, ''), params=query, data=data, files=files, headers=headers)
-            )
+            resp = requests.post(lob.api_base + url, auth=(self.api_key, ''), params=query, data=data, files=files, headers=headers, timeout=timeout)
+            return self.parse_response(resp)
diff --git a/lob/constants.py b/lob/constants.py
@@ -0,0 +1 @@
+TIMEOUT_DEFAULT = 30
diff --git a/lob/error.py b/lob/error.py
@@ -24,4 +24,4 @@ class AuthenticationError(LobError):
 
 
 class InvalidRequestError(LobError):
-    pass
+    pass
diff --git a/lob/resource.py b/lob/resource.py
@@ -4,6 +4,7 @@
 
 from lob import api_requestor
 from lob.compat import string_type
+from lob.constants import TIMEOUT_DEFAULT
 
 
 def lob_format(resp):
@@ -86,16 +87,16 @@ def __str__(self):
 
 class APIResource(LobObject):
     @classmethod
-    def retrieve(cls, id, **params):
+    def retrieve(cls, id, timeout=TIMEOUT_DEFAULT, **params):
         requestor = api_requestor.APIRequestor()
-        response = requestor.request('get', '%s/%s' % (cls.endpoint, id), params)
+        response = requestor.request('get', '%s/%s' % (cls.endpoint, id), params, timeout=timeout)
         return lob_format(response)
 
 
 # API Operations
 class ListableAPIResource(APIResource):
     @classmethod
-    def list(cls, **params):
+    def list(cls, timeout=TIMEOUT_DEFAULT, **params):
         for key, value in params.copy().items():
             if isinstance(params[key], dict):
                 for subKey in value:
@@ -105,31 +106,31 @@ def list(cls, **params):
                 params[str(key) + '[]'] = params[key]
                 del params[key]
         requestor = api_requestor.APIRequestor()
-        response = requestor.request('get', cls.endpoint, params)
+        response = requestor.request('get', cls.endpoint, params, timeout=timeout)
         return lob_format(response)
 
 
 class DeleteableAPIResource(APIResource):
     @classmethod
-    def delete(cls, id):
+    def delete(cls, id, timeout=TIMEOUT_DEFAULT):
         requestor = api_requestor.APIRequestor()
-        response = requestor.request('delete', '%s/%s' % (cls.endpoint, id))
+        response = requestor.request('delete', '%s/%s' % (cls.endpoint, id), timeout=timeout)
         return lob_format(response)
 
 
 class CreateableAPIResource(APIResource):
     @classmethod
-    def create(cls, **params):
+    def create(cls, timeout=TIMEOUT_DEFAULT, **params):
         requestor = api_requestor.APIRequestor()
-        response = requestor.request('post', cls.endpoint, params)
+        response = requestor.request('post', cls.endpoint, params, timeout=timeout)
         return lob_format(response)
 
 
 class VerifiableAPIResource(APIResource):
     @classmethod
-    def verify(cls, id, **params):
+    def verify(cls, id, timeout=TIMEOUT_DEFAULT, **params):
         requestor = api_requestor.APIRequestor()
-        response = requestor.request('post', '%s/%s/verify' % (cls.endpoint, id), params)
+        response = requestor.request('post', '%s/%s/verify' % (cls.endpoint, id), params, timeout=timeout)
         return lob_format(response)
 
 
@@ -150,23 +151,23 @@ class Card(ListableAPIResource, DeleteableAPIResource, CreateableAPIResource):
     endpoint = '/cards'
 
     @classmethod
-    def update(cls, card_id, **params):
+    def update(cls, card_id, timeout=TIMEOUT_DEFAULT, **params):
         requestor = api_requestor.APIRequestor()
-        response = requestor.request('post', '%s/%s' % (cls.endpoint, card_id), params)
+        response = requestor.request('post', '%s/%s' % (cls.endpoint, card_id), params, timeout=timeout)
         return lob_format(response)
 
 
 class CardOrder(ListableAPIResource, CreateableAPIResource):
     endpoint = '/cards/%s/orders'
 
     @classmethod
-    def create(cls, card_id, **params):
+    def create(cls, card_id, timeout=TIMEOUT_DEFAULT, **params):
         requestor = api_requestor.APIRequestor()
-        response = requestor.request('post', cls.endpoint % card_id, params)
+        response = requestor.request('post', cls.endpoint % card_id, params, timeout=timeout)
         return lob_format(response)
 
     @classmethod
-    def list(cls, card_id, **params):
+    def list(cls, card_id, timeout=TIMEOUT_DEFAULT, **params):
         for key, value in params.copy().items():
             if isinstance(params[key], dict):
                 for subKey in value:
@@ -176,67 +177,67 @@ def list(cls, card_id, **params):
                 params[str(key) + '[]'] = params[key]
                 del params[key]
         requestor = api_requestor.APIRequestor()
-        response = requestor.request('get', cls.endpoint % card_id, params)
+        response = requestor.request('get', cls.endpoint % card_id, params, timeout=timeout)
         return lob_format(response)
 
 
 class Check(ListableAPIResource, CreateableAPIResource, DeleteableAPIResource):
     endpoint = '/checks'
 
     @classmethod
-    def create(cls, **params):
+    def create(cls, timeout=TIMEOUT_DEFAULT, **params):
         if isinstance(params, dict):
             if 'to_address' in params:
                 params['to'] = params['to_address']
                 params.pop('to_address')
             if 'from_address' in params:
                 params['from'] = params['from_address']
                 params.pop('from_address')
-        return super(Check, cls).create(**params)
+        return super(Check, cls).create(timeout=timeout, **params)
 
 
 class Letter(ListableAPIResource, CreateableAPIResource, DeleteableAPIResource):
     endpoint = '/letters'
 
     @classmethod
-    def create(cls, **params):
+    def create(cls, timeout=TIMEOUT_DEFAULT, **params):
         if isinstance(params, dict):
             if 'from_address' in params:
                 params['from'] = params['from_address']
                 params.pop('from_address')
             if 'to_address' in params:
                 params['to'] = params['to_address']
                 params.pop('to_address')
-        return super(Letter, cls).create(**params)
+        return super(Letter, cls).create(timeout=timeout, **params)
 
 
 class Postcard(ListableAPIResource, CreateableAPIResource, DeleteableAPIResource):
     endpoint = '/postcards'
 
     @classmethod
-    def create(cls, **params):
+    def create(cls, timeout=TIMEOUT_DEFAULT, **params):
         if isinstance(params, dict):
             if 'from_address' in params:
                 params['from'] = params['from_address']
                 params.pop('from_address')
             if 'to_address' in params:
                 params['to'] = params['to_address']
                 params.pop('to_address')
-        return super(Postcard, cls).create(**params)
+        return super(Postcard, cls).create(timeout=timeout, **params)
 
 class SelfMailer(ListableAPIResource, CreateableAPIResource, DeleteableAPIResource):
     endpoint = '/self_mailers'
 
     @classmethod
-    def create(cls, **params):
+    def create(cls, timeout=TIMEOUT_DEFAULT, **params):
         if isinstance(params, dict):
             if 'from_address' in params:
                 params['from'] = params['from_address']
                 params.pop('from_address')
             if 'to_address' in params:
                 params['to'] = params['to_address']
                 params.pop('to_address')
-        return super(SelfMailer, cls).create(**params)
+        return super(SelfMailer, cls).create(timeout=timeout, **params)
 
 
 class USAutocompletion(CreateableAPIResource):
diff --git a/tests/test_timeout.py b/tests/test_timeout.py
@@ -0,0 +1,105 @@
+import unittest
+import lob
+import pytest
+import requests_mock
+class TimeoutTests(unittest.TestCase):
+    def setUp(self):
+        lob.api_key = 'mockAPIkey123'
+    
+    def return_list(self, request, context):
+        return {
+            "data": [
+                {
+                "id": "adr_e68217bd744d65c8",
+                "description": "Harry - Office",
+                "name": "HARRY ZHANG",
+                "company": "LOB",
+                "phone": "5555555555",
+                "email": "harry@lob.com",
+                "address_line1": "210 KING ST STE 6100",
+                "address_line2": None,
+                "address_city": "SAN FRANCISCO",
+                "address_state": "CA",
+                "address_zip": "94107-1741",
+                "address_country": "UNITED STATES",
+                "metadata": {},
+                "date_created": "2019-08-12T00:16:00.361Z",
+                "date_modified": "2019-08-12T00:16:00.361Z",
+                "object": "address"
+                },
+                {
+                "id": "adr_asdi2y3riuasasoi",
+                "description": "Harry - Office",
+                "name": "Harry Zhang",
+                "company": "Lob",
+                "phone": "5555555555",
+                "email": "harry@lob.com",
+                "metadata": {},
+                "address_line1": "370 WATER ST",
+                "address_line2": "",
+                "address_city": "SUMMERSIDE",
+                "address_state": "PRINCE EDWARD ISLAND",
+                "address_zip": "C1N 1C4",
+                "address_country": "CANADA",
+                "date_created": "2019-09-20T00:14:00.361Z",
+                "date_modified": "2019-09-20T00:14:00.361Z",
+                "object": "address"
+                }
+            ],
+            "object": "list",
+            "next_url": "https://api.lob.com/v1/addresses?limit=2&after=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wOC0wN1QyMTo1OTo0Ni43NjRaIiwiaWRPZmZzZXQiOiJhZHJfODMwYmYwZWFiZGFhYTQwOSJ9",
+            "previous_url": None,
+            "count": 2
+        }
+
+    def return_status(self, request, context):
+        return {
+            "id": "adr_123456789",
+            "deleted": True
+        }
+
+    def return_single(self, request, context):
+        return {
+                "id": "adr_d3489cd64c791ab5",
+                "description": "Harry - Office",
+                "name": "HARRY ZHANG",
+                "company": "LOB",
+                "phone": "5555555555",
+                "email": "harry@lob.com",
+                "address_line1": "210 KING ST STE 6100",
+                "address_city": "SAN FRANCISCO",
+                "address_state": "CA",
+                "address_zip": "94107",
+                "address_country": "UNITED STATES",
+                "metadata": {},
+                "date_created": "2017-09-05T17:47:53.767Z",
+                "date_modified": "2017-09-05T17:47:53.767Z",
+                "object": "address"
+            }
+    @requests_mock.Mocker()
+    def test_connection_timeout_on_get_requests(self, adapter):
+        adapter.register_uri('GET', 'https://api.lob.com/v1/addresses', json=self.return_list)
+        lob.Address.list(timeout=3)
+        self.assertEqual(3, adapter.last_request.timeout)
+    
+    @requests_mock.Mocker()
+    def test_connection_timeout_triggers_on_delete_requests(self, adapter):
+        adapter.register_uri('DELETE', 'https://api.lob.com/v1/addresses/adr_12345', json=self.return_single)
+        lob.Address.delete(id='adr_12345', timeout=22)
+        self.assertEqual(22, adapter.last_request.timeout)
+
+
+    @requests_mock.Mocker()
+    def test_connection_timeout_triggers_on_post_requests(self, adapter):
+        adapter.register_uri('POST', 'https://api.lob.com/v1/addresses', json=self.return_status)
+        lob.Address.create(
+            name='Lob',
+            address_line1='185 Berry Street',
+            address_line2='Suite 1510',
+            address_city='San Francisco',
+            address_zip='94017',
+            address_state='CA',
+            address_country='US',
+            timeout=33
+        )
+        self.assertEqual(33, adapter.last_request.timeout)

Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,4 @@ class AuthenticationError(LobError):`
`24`	`24`
`25`	`25`
`26`	`26`	`class InvalidRequestError(LobError):`
`27`		`- pass`
	`27`	`+ pass`