Support timeout configuration

Author: rafaelcaricio

elemental/client.py

@@ -32,10 +32,11 @@ class InvalidResponse(ElementalException):
 
 
 class ElementalLive():
-    def __init__(self, server_ip, user=None, api_key=None):
+    def __init__(self, server_ip, user=None, api_key=None, timeout=5):
         self.server_ip = server_ip
         self.user = user
         self.api_key = api_key
+        self.timeout = timeout
 
     def generate_headers(self, url=""):
         # Generate headers according to how users create ElementalLive class
@@ -61,11 +62,12 @@ def generate_headers(self, url=""):
                 'Content-Type': 'application/xml'
             }
 
-    def send_request(self, http_method, url, headers, body=""):
+    def send_request(self, http_method, url, headers, body="", timeout=None):
         # Send request according to different methods
         try:
+            timeout = timeout or self.timeout
             response = requests.request(
-                method=http_method, url=url, data=body, headers=headers)
+                method=http_method, url=url, data=body, headers=headers, timeout=timeout)
 
         except requests.exceptions.RequestException as e:
             raise InvalidRequest(f"{http_method}: {url} failed\n{e}")
@@ -75,7 +77,7 @@ def send_request(self, http_method, url, headers, body=""):
                 f"{response.status_code}\n{response.text}")
         return response
 
-    def create_event(self, options):
+    def create_event(self, options, timeout=None):
 
         # Initiate url
         url = f'{self.server_ip}/live_events'
@@ -92,7 +94,7 @@ def create_event(self, options):
 
         # Send request and do exception handling
         response = self.send_request(
-            http_method="POST", url=url, headers=headers, body=body)
+            http_method="POST", url=url, headers=headers, body=body, timeout=timeout)
 
         # Find newly created event id
         xml_root = ET.fromstring(response.content)
@@ -101,7 +103,7 @@ def create_event(self, options):
 
         return {'id': event_id}
 
-    def delete_event(self, event_id):
+    def delete_event(self, event_id, timeout=None):
 
         # Initial url
         url = f'{self.server_ip}/live_events/{event_id}'
@@ -110,9 +112,9 @@ def delete_event(self, event_id):
         headers = self.generate_headers(url)
 
         # Send request and do exception handling
-        self.send_request(http_method="DELETE", url=url, headers=headers)
+        self.send_request(http_method="DELETE", url=url, headers=headers, timeout=timeout)
 
-    def start_event(self, event_id):
+    def start_event(self, event_id, timeout=None):
         # Initail url
         url = f'{self.server_ip}/live_events/{event_id}/start'
 
@@ -124,9 +126,9 @@ def start_event(self, event_id):
 
         # Send request and do exception handling
         self.send_request(http_method="POST", url=url,
-                          headers=headers, body=body)
+                          headers=headers, body=body, timeout=timeout)
 
-    def stop_event(self, event_id):
+    def stop_event(self, event_id, timeout=None):
         # Initail url
         url = f'{self.server_ip}/live_events/{event_id}/stop'
 
@@ -138,15 +140,15 @@ def stop_event(self, event_id):
 
         # Send request and do exception handling
         self.send_request(http_method="POST", url=url,
-                          headers=headers, body=body)
+                          headers=headers, body=body, timeout=timeout)
 
-    def describe_event(self, event_id):
+    def describe_event(self, event_id, timeout=None):
         url = f'{self.server_ip}/live_events/{event_id}'
 
         headers = self.generate_headers(url)
 
         response = self.send_request(http_method="GET", url=url,
-                                     headers=headers)
+                                     headers=headers, timeout=timeout)
         # print(response.text)
         event_info = {}
 
@@ -159,11 +161,11 @@ def describe_event(self, event_id):
 
         return event_info
 
-    def find_devices_in_use(self):
+    def find_devices_in_use(self, timeout=None):
         events_url = f'{self.server_ip}/live_events?filter=active'
         events_headers = self.generate_headers(events_url)
         events = self.send_request(
-            http_method="GET", url=events_url, headers=events_headers)
+            http_method="GET", url=events_url, headers=events_headers, timeout=timeout)
         events_list = ET.fromstring(events.text)
 
         # Find in use devices from active events
@@ -173,11 +175,11 @@ def find_devices_in_use(self):
 
         return in_use_devices
 
-    def get_input_devices(self):
+    def get_input_devices(self, timeout=None):
         devices_url = f'{self.server_ip}/devices'
         devices_headers = self.generate_headers(devices_url)
         devices = self.send_request(
-            http_method="GET", url=devices_url, headers=devices_headers)
+            http_method="GET", url=devices_url, headers=devices_headers, timeout=timeout)
         devices_info = xmltodict.parse(devices.text)[
             'device_list']['device']
 
@@ -192,19 +194,19 @@ def get_input_devices(self):
             devices_info, key=lambda d: int(d["id"]))
         return [dict(d) for d in devices_info]
 
-    def get_input_device_by_id(self, input_device_id):
+    def get_input_device_by_id(self, input_device_id, timeout=None):
         devices_url = f'{self.server_ip}/devices/{input_device_id}'
         devices_headers = self.generate_headers(devices_url)
         devices = self.send_request(
-            http_method="GET", url=devices_url, headers=devices_headers)
+            http_method="GET", url=devices_url, headers=devices_headers, timeout=timeout)
         device_info = xmltodict.parse(devices.text)['device']
         devices_in_use = self.find_devices_in_use()
         device_info['availability'] = (device_info['device_name']
                                        not in devices_in_use)
         device_info.pop('@href')
         return dict(device_info)
 
-    def generate_preview(self, input_id):
+    def generate_preview(self, input_id, timeout=None):
         url = f'{self.server_ip}/inputs/generate_preview'
         headers = self.generate_headers(url)
 
@@ -219,7 +221,7 @@ def generate_preview(self, input_id):
                f"[input_format]=Auto&live_event[inputs_attributes][0]" \
                f"[device_input_attributes][device_id]={input_id}"
         response = self.send_request(
-            http_method="POST", url=url, headers=headers, body=data)
+            http_method="POST", url=url, headers=headers, body=data, timeout=timeout)
 
         response_parse = ast.literal_eval(response.text)
 
@@ -231,7 +233,7 @@ def generate_preview(self, input_id):
                           f'p_{response_parse["preview_image_id"]}_job_0.jpg'
             return {'preview_url': preview_url}
 
-    def event_can_delete(self, channel_id):
+    def event_can_delete(self, channel_id, timeout=None):
         channel_info = self.describe_event(channel_id)
         if channel_info['status'] in ('pending', 'running',
                                       'preprocessing', 'postprocessing'):

elemental/client_test.py

@@ -13,6 +13,7 @@
 ELEMENTAL_ADDRESS = "FAKE_ADDRESS.com"
 HEADERS = {'Accept': 'application/xml', 'Content-Type': 'application/xml'}
 REQUEST_BODY = "<live_event>FAKE</live_event>"
+TIMEOUT = 10
 
 
 def file_fixture(file_name):
@@ -66,13 +67,14 @@ def test_send_request_should_call_request_as_expected(mock_request):
     mock_request.return_value = mock_response(status=200)
     client = ElementalLive(ELEMENTAL_ADDRESS, USER, API_KEY)
     client.send_request(
-        'POST', f'{ELEMENTAL_ADDRESS}/live_events', HEADERS, REQUEST_BODY)
+        'POST', f'{ELEMENTAL_ADDRESS}/live_events', HEADERS, REQUEST_BODY, timeout=TIMEOUT)
 
     request_to_elemental = mock_request.call_args_list[0][1]
     assert request_to_elemental['url'] == f'{ELEMENTAL_ADDRESS}/live_events'
     assert request_to_elemental['method'] == 'POST'
     assert request_to_elemental['headers']['Accept'] == 'application/xml'
     assert request_to_elemental['headers']['Content-Type'] == 'application/xml'
+    assert request_to_elemental['timeout'] == TIMEOUT
 
 
 @mock.patch('requests.request')
@@ -174,7 +176,7 @@ def test_delete_event_should_call_send_request_as_expect():
     client.delete_event(event_id)
     client.send_request.assert_called_once_with(
         http_method='DELETE',
-        url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}', headers=HEADERS)
+        url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}', headers=HEADERS, timeout=None)
 
 
 def test_start_event_should_call_send_request_as_expect():
@@ -192,7 +194,7 @@ def test_start_event_should_call_send_request_as_expect():
     client.send_request.assert_called_once_with(
         http_method='POST',
         url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}/start',
-        headers=HEADERS, body="<start></start>")
+        headers=HEADERS, body="<start></start>", timeout=None)
 
 
 def test_stop_event_should_call_send_request_as_expect():
@@ -209,7 +211,7 @@ def test_stop_event_should_call_send_request_as_expect():
     client.send_request.assert_called_once_with(
         http_method='POST',
         url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}/stop',
-        headers=HEADERS, body="<stop></stop>")
+        headers=HEADERS, body="<stop></stop>", timeout=None)
 
 
 def send_request_side_effect(**kwargs):
@@ -237,7 +239,7 @@ def test_find_devices_in_use_will_call_send_request_as_expect():
     client.send_request.assert_called_with(http_method="GET",
                                            url=f'{ELEMENTAL_ADDRESS}'
                                            f'/live_events?'
-                                           f'filter=active', headers=HEADERS)
+                                           f'filter=active', headers=HEADERS, timeout=None)
 
 
 def test_find_devices_in_use_will_return_in_used_devices():
@@ -272,7 +274,7 @@ def test_get_input_devices_will_call_send_request_as_expect():
 
     client.send_request.\
         assert_called_with(http_method="GET",
-                           url=f'{ELEMENTAL_ADDRESS}/devices', headers=HEADERS)
+                           url=f'{ELEMENTAL_ADDRESS}/devices', headers=HEADERS, timeout=None)
 
 
 def test_get_input_devices_will_get_right_devices_info():
@@ -321,7 +323,7 @@ def test_get_input_device_by_id_will_call_send_request_as_expect():
     client.send_request.\
         assert_called_with(http_method="GET",
                            url=f'{ELEMENTAL_ADDRESS}/devices/2',
-                           headers=HEADERS)
+                           headers=HEADERS, timeout=None)
 
 
 def test_get_input_device_by_id_will_get_right_devices_info():
@@ -403,7 +405,7 @@ def test_describe_event_will_call_send_request_as_expect():
     client.send_request.assert_called_once_with(
         http_method='GET',
         url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}',
-        headers=HEADERS)
+        headers=HEADERS, timeout=None)
 
 
 def test_describe_event_will_return_event_info_as_expect():