Adds timeout and error handling to request

Author: Justintime50

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v2.2.0 (2021-02-20)
+
+* Adds timeout on HTTP requests 
+* Adds try/except block arround HTTP requests
+* Changes internal function name from `response` to `_make_http_request`
+
 ## v2.1.0 (2021-02-05)
 
 * Changed all classmethods to staticmethods

setup.py

@@ -9,7 +9,7 @@
 
 setuptools.setup(
     name='tuneuptechnology',
-    version='2.1.0',
+    version='2.2.0',
     description='The Python client library for the Tuneup Technology App.',
     long_description=long_description,
     long_description_content_type="text/markdown",

tuneuptechnology/client.py

@@ -1,19 +1,25 @@
 import requests
 
-VERSION = '2.1.0'
-API_BASE_URL = "https://app.tuneuptechnology.com/api/"
-
 
 class Client():
+    VERSION = '2.1.0'
+    API_BASE_URL = "https://app.tuneuptechnology.com/api/"
+
     @staticmethod
-    def response(data, endpoint):
+    def _make_http_request(data, endpoint):
         """Build the API request and return it to the method invoking it"""
         headers = {
-            'User-Agent': f'TuneupTechnologyApp/PythonClient/{VERSION}'
+            'User-Agent': f'TuneupTechnologyApp/PythonClient/{Client.VERSION}'
         }
-        request = requests.post(
-            endpoint,
-            data=data,
-            headers=headers,
-        )
+
+        try:
+            request = requests.post(
+                endpoint,
+                data=data,
+                headers=headers,
+                timeout=10,
+            )
+        except Exception as error:
+            raise Exception(error)
+
         return request

tuneuptechnology/customer.py

@@ -6,33 +6,33 @@ class Customer(Client):
     def create(data):
         """Create a customer based on the data passed"""
         endpoint = f'{Client.API_BASE_URL}customers/create'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def all(data):
         """Retrieve all customers"""
         endpoint = f'{Client.API_BASE_URL}customers'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def retrieve(data):
         """Retrieve a single customer"""
         endpoint = f'{Client.API_BASE_URL}customers/{data["id"]}'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def update(data):
         """Update a customer with the passed params"""
         endpoint = f'{Client.API_BASE_URL}customers/{data["id"]}/update'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def delete(data):
         """Delete a customer with the ID passed"""
         endpoint = f'{Client.API_BASE_URL}customers/{data["id"]}/delete'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()

tuneuptechnology/inventory.py

@@ -6,33 +6,33 @@ class Inventory(Client):
     def create(data):
         """Create an inventory item based on the data passed"""
         endpoint = f'{Client.API_BASE_URL}inventory/create'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def all(data):
         """Retrieve all inventory"""
         endpoint = f'{Client.API_BASE_URL}inventorys'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def retrieve(data):
         """Retrieve a single inventory item"""
         endpoint = f'{Client.API_BASE_URL}inventory/{data["id"]}'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def update(data):
         """Update an inventory item with the passed params"""
         endpoint = f'{Client.API_BASE_URL}inventory/{data["id"]}/update'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def delete(data):
         """Delete an inventory item with the ID passed"""
         endpoint = f'{Client.API_BASE_URL}inventory/{data["id"]}/delete'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()

tuneuptechnology/location.py

@@ -6,33 +6,33 @@ class Location(Client):
     def create(data):
         """Create a location based on the data passed"""
         endpoint = f'{Client.API_BASE_URL}locations/create'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def all(data):
         """Retrieve all locations"""
         endpoint = f'{Client.API_BASE_URL}locations'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def retrieve(data):
         """Retrieve a single location"""
         endpoint = f'{Client.API_BASE_URL}locations/{data["id"]}'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def update(data):
         """Update a location with the passed params"""
         endpoint = f'{Client.API_BASE_URL}locations/{data["id"]}/update'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def delete(data):
         """Delete a location with the ID passed"""
         endpoint = f'{Client.API_BASE_URL}locations/{data["id"]}/delete'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()

tuneuptechnology/ticket.py

@@ -6,33 +6,33 @@ class Ticket(Client):
     def create(data):
         """Create a ticket based on the data passed"""
         endpoint = f'{Client.API_BASE_URL}tickets/create'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def all(data):
         """Retrieve all tickets"""
         endpoint = f'{Client.API_BASE_URL}tickets'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def retrieve(data):
         """Retrieve a single ticket"""
         endpoint = f'{Client.API_BASE_URL}tickets/{data["id"]}'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def update(data):
         """Update a ticket with the passed params"""
         endpoint = f'{Client.API_BASE_URL}tickets/{data["id"]}/update'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()
 
     @staticmethod
     def delete(data):
         """Delete a ticket with the ID passed"""
         endpoint = f'{Client.API_BASE_URL}tickets/{data["id"]}/delete'
-        response = Client.response(data, endpoint)
+        response = Client._make_http_request(data, endpoint)
         return response.json()