Can delete (#22)

* add get_input_device_by_id method and delete useless template

* fix avaliability problem

* fix method name

* fix test and lint

* fix preview exception raising logic

* add data file to package

* add new param to template

* remove 'sourceType' param in 'generate_preview' method

* update version

* add describe_event function and delete real password and username

* add 'event_can_delete' method

Author: Spider-Min

elemental/client.py

@@ -140,6 +140,25 @@ def stop_event(self, event_id):
         self.send_request(http_method="POST", url=url,
                           headers=headers, body=body)
 
+    def describe_event(self, event_id):
+        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)
+        # print(response.text)
+        event_info = {}
+
+        destinations = ET.fromstring(response.text).iter('destination')
+        event_info['origin_url'] = next(destinations).find('uri').text
+        event_info['backup_url'] = next(destinations).find('uri').text
+
+        status = ET.fromstring(response.text).find('status')
+        event_info['status'] = status.text
+
+        return event_info
+
     def find_devices_in_use(self):
         events_url = f'{self.server_ip}/live_events?filter=active'
         events_headers = self.generate_headers(events_url)
@@ -211,3 +230,11 @@ def generate_preview(self, input_id):
             preview_url = f'{self.server_ip}/images/thumbs/' \
                           f'p_{response_parse["preview_image_id"]}_job_0.jpg'
             return {'preview_url': preview_url}
+
+    def event_can_delete(self, channel_id):
+        channel_info = self.describe_event(channel_id)
+        if channel_info['status'] in ('pending', 'running',
+                                      'preprocessing', 'postprocessing'):
+            return {'deletable': False}
+        else:
+            return {'deletable': True}

elemental/client_test.py

@@ -385,3 +385,72 @@ def test_get_preview_will_raise_ElementalException_if_preview_unavaliable():
     assert str(exc_info.value).endswith(
         f"Response: 200\n"
         f"{respond_text}")
+
+
+def test_describe_event_will_call_send_request_as_expect():
+    client = ElementalLive(ELEMENTAL_ADDRESS, USER, API_KEY)
+
+    client.generate_headers = mock.Mock()
+    client.generate_headers.return_value = HEADERS
+
+    client.send_request = mock.Mock()
+    response_from_elemental_api = file_fixture('sample_event.xml')
+    client.send_request.return_value = mock_response(
+        status=200, text=response_from_elemental_api)
+
+    event_id = 999
+    client.describe_event(event_id)
+    client.send_request.assert_called_once_with(
+        http_method='GET',
+        url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}',
+        headers=HEADERS)
+
+
+def test_describe_event_will_return_event_info_as_expect():
+    client = ElementalLive(ELEMENTAL_ADDRESS, USER, API_KEY)
+    client.generate_headers = mock.Mock()
+    client.generate_headers.return_value = HEADERS
+    client.send_request = mock.Mock()
+    response_from_elemental_api = file_fixture('sample_event.xml')
+    client.send_request.return_value = mock_response(
+        status=200, text=response_from_elemental_api)
+
+    event_id = '139'
+    event_info = client.describe_event(event_id)
+    assert event_info == {'origin_url':
+                          'https://vmjhch43nfkghi.data.mediastore.us-east-1.'
+                          'amazonaws.com/mortyg3b4/master/mortyg3b4.m3u8',
+                          'backup_url':
+                          'https://vmjhch43nfkghi.data.mediastore.us-east-1.'
+                          'amazonaws.com/mortyg3b4/backup/mortyg3b4.m3u8',
+                          'status': 'complete'}
+
+
+def test_event_can_delete_will_return_False_if_pending():
+    client = ElementalLive(ELEMENTAL_ADDRESS, USER, API_KEY)
+
+    client.describe_event = mock.Mock()
+    client.describe_event.return_value = {
+        'status': 'pending',
+        'origin_url': 'fake_origin',
+        'backup_url': 'fake_backup'
+    }
+    d = client.event_can_delete('123')
+    assert d == {
+        'deletable': False
+    }
+
+
+def test_event_can_delete_will_return_True_if_complete():
+    client = ElementalLive(ELEMENTAL_ADDRESS, USER, API_KEY)
+
+    client.describe_event = mock.Mock()
+    client.describe_event.return_value = {
+        'status': 'complete',
+        'origin_url': 'fake_origin',
+        'backup_url': 'fake_backup'
+    }
+    d = client.event_can_delete('321')
+    assert d == {
+        'deletable': True
+    }