Merge pull request #70 from cbsinteractive/cancel-method

client: add cancel_event method

Fixes cbsinteractive/propeller#1529

Author: Allison Deal

README.md

@@ -6,3 +6,18 @@
 
 
 Python Client for Elemental On-Premises Appliances
+
+## Run Tests
+
+Before running tests locally, install `tox` and `poetry`.
+
+    pipx install tox
+    pipx install poetry
+
+Run tests using
+
+    make test
+
+To run lint, use
+
+    make lint

elemental/client.py

@@ -108,6 +108,11 @@ def delete_event(self, event_id: str, timeout: Optional[int] = None) -> None:
         headers = self.generate_headers(url)
         self.send_request(http_method="DELETE", url=url, headers=headers, timeout=timeout)
 
+    def cancel_event(self, event_id: str, timeout: Optional[int] = None) -> None:
+        url = f'{self.server_url}/live_events/{event_id}/cancel'
+        headers = self.generate_headers(url)
+        self.send_request(http_method="POST", url=url, headers=headers, timeout=timeout)
+
     def start_event(self, event_id: str, timeout: Optional[int] = None) -> None:
         url = f'{self.server_url}/live_events/{event_id}/start'
         body = "<start></start>"

tests/client_test.py

@@ -157,6 +157,22 @@ def test_delete_event_should_call_send_request_as_expect():
         url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}', headers=HEADERS, timeout=None)
 
 
+def test_cancel_event_should_call_send_request_as_expected():
+    client = ElementalLive(ELEMENTAL_ADDRESS, USER, API_KEY)
+
+    client.generate_headers = mock.Mock()
+    client.generate_headers.return_value = HEADERS
+
+    client.send_request = mock.Mock()
+    client.send_request.return_value = mock_response(status=200)
+
+    event_id = '999'
+    client.cancel_event(event_id)
+    client.send_request.assert_called_once_with(
+        http_method='POST',
+        url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}/cancel', headers=HEADERS, timeout=None)
+
+
 def test_start_event_should_call_send_request_as_expect():
     client = ElementalLive(ELEMENTAL_ADDRESS, USER, API_KEY)