Add Triggers endpoint

kbcstorage/base.py

@@ -120,6 +120,32 @@ def _post(self, *args, **kwargs):
         else:
             return r.json()
 
+    def _put(self, *args, **kwargs):
+        """
+        Construct a requests PUT call with args and kwargs and process the
+        results.
+
+        Args:
+            *args: Positional arguments to pass to the post request.
+            **kwargs: Key word arguments to pass to the post request.
+
+        Returns:
+            body: Response body parsed from json.
+
+        Raises:
+            requests.HTTPError: If the API request fails.
+        """
+        headers = kwargs.pop('headers', {})
+        headers.update(self._auth_header)
+        r = requests.put(headers=headers, *args, **kwargs)
+        try:
+            r.raise_for_status()
+        except requests.HTTPError:
+            # Handle different error codes
+            raise
+        else:
+            return r.json()
+
     def _delete(self, *args, **kwargs):
         """
         Construct a requests DELETE call with args and kwargs and process the

kbcstorage/triggers.py

@@ -0,0 +1,114 @@
+"""
+Manages calls to the Storage API relating to triggers
+
+Full documentation `here`.
+
+.. _here:
+    http://docs.keboola.apiary.io/#reference/triggers/
+"""
+from kbcstorage.base import Endpoint
+
+
+class Triggers(Endpoint):
+    """
+    Triggers Endpoint
+    """
+
+    def __init__(self, root_url, token):
+        """
+        Create a Triggers endpoint.
+
+        Args:
+            root_url (:obj:`str`): The base url for the API.
+            token (:obj:`str`): A storage API key.
+        """
+        super().__init__(root_url, 'triggers', token)
+
+    def list(self):
+        """
+        List all triggers in project.
+
+        Returns:
+            response_body: The parsed json from the HTTP response.
+
+        Raises:
+            requests.HTTPError: If the API request fails.
+        """
+
+        return self._get(self.base_url)
+
+    def detail(self, trigger_id):
+        """
+        Retrieves information about a given trigger.
+
+        Args:
+            trigger_id (str): The id of the trigger.
+
+        Raises:
+            requests.HTTPError: If the API request fails.
+        """
+        url = '{}/{}'.format(self.base_url, trigger_id)
+
+        return self._get(url)
+
+    def create(self, runWithTokenId, component, configurationId, coolDownPeriodMinutes, tableIds):
+        """
+        Create a new trigger.
+
+        Args:
+            runWithTokenId (int): ID of token used for running configured component.
+            component (str): For now we support only 'orchestration'.
+            configurationId (int): Id of component configuration.
+            coolDownPeriodMinutes (int): Minimal cool down period before
+                firing action again in minutes (min is 1 minute).
+            tableIds (list[str]) IDs of tables.
+        Returns:
+            response_body: The parsed json from the HTTP response.
+
+        Raises:
+            requests.HTTPError: If the API request fails.
+        """
+        # Separating create and link into two distinct functions...
+        # Need to check args...
+        body = {
+            "runWithTokenId": runWithTokenId,
+            "component": component,
+            "configurationId": configurationId,
+            "coolDownPeriodMinutes": coolDownPeriodMinutes,
+            "tableIds": tableIds
+        }
+
+        return self._post(self.base_url, data=body)
+
+    def delete(self, trigger_id):
+        """
+        Delete a trigger referenced by ``trigger_id``.
+
+        Args:
+            trigger_id (int): The id of the trigger to be deleted.
+
+        """
+        url = '{}/{}'.format(self.base_url, trigger_id)
+        self._delete(url)
+
+    def update(self, trigger_id, runWithTokenId=None, component=None, configurationId=None,
+               coolDownPeriodMinutes=None, tableIds=None):
+        """
+        Delete a trigger referenced by ``trigger_id``.
+
+        Args:
+            trigger_id (int): The id of the trigger to be deleted.
+
+        """
+        url = '{}/{}'.format(self.base_url, trigger_id)
+        body = {
+            k: v for k, v in {
+                "runWithTokenId": runWithTokenId,
+                "component": component,
+                "configurationId": configurationId,
+                "coolDownPeriodMinutes": coolDownPeriodMinutes,
+                "tableIds": tableIds
+            }.items()
+            if v is not None
+        }
+        return self._put(url, data=body)

tests/mocks/test_triggers.py

@@ -0,0 +1,98 @@
+import unittest
+import responses
+from kbcstorage.triggers import Triggers
+from .triggers_responses import list_response, detail_response, create_response, update_response
+
+
+class TestTriggersWithMocks(unittest.TestCase):
+    def setUp(self):
+        token = 'dummy_token'
+        base_url = 'https://connection.keboola.com/'
+        self.triggers = Triggers(base_url, token)
+
+    @responses.activate
+    def test_list(self):
+        """
+        triggers mocks list correctly.
+        """
+        responses.add(
+            responses.Response(
+                method='GET',
+                url='https://connection.keboola.com/v2/storage/triggers',
+                json=list_response
+            )
+        )
+        triggers_list = self.triggers.list()
+        assert isinstance(triggers_list, list)
+
+    @responses.activate
+    def test_detail_by_id(self):
+        """
+        triggers mocks detail by integer id correctly.
+        """
+        responses.add(
+            responses.Response(
+                method='GET',
+                url='https://connection.keboola.com/v2/storage/triggers/3',
+                json=detail_response
+            )
+        )
+        trigger_id = '3'
+        trigger_detail = self.triggers.detail(trigger_id)
+        assert trigger_detail['id'] == '3'
+
+    @responses.activate
+    def test_delete(self):
+        """
+        Triggers mock deletes trigger by id.
+        """
+        responses.add(
+            responses.Response(
+                method='DELETE',
+                url='https://connection.keboola.com/v2/storage/triggers/1',
+                json={}
+            )
+        )
+        trigger_id = 1
+        deleted_detail = self.triggers.delete(trigger_id)
+        assert deleted_detail is None
+
+    @responses.activate
+    def test_update(self):
+        """
+        Triggers mock update trigger by id.
+        """
+        responses.add(
+            responses.Response(
+                method='PUT',
+                url='https://connection.keboola.com/v2/storage/triggers/1',
+                json=update_response
+            )
+        )
+        trigger_id = 1
+        updated_detail = self.triggers.update(trigger_id, runWithTokenId=100)
+        assert updated_detail['id'] == '3'
+
+    @responses.activate
+    def test_create(self):
+        """
+        Triggers mock creates new trigger.
+        """
+        responses.add(
+            responses.Response(
+                method='POST',
+                url='https://connection.keboola.com/v2/storage/triggers',
+                json=create_response
+            )
+        )
+        created_detail = self.triggers.create(
+            runWithTokenId=123,
+            component="orchestration",
+            configurationId=123,
+            coolDownPeriodMinutes=20,
+            tableIds=[
+                "in.c-test.watched-1",
+                "in.c-prod.watched-5"
+            ]
+        )
+        assert created_detail['runWithTokenId'] == 123

tests/mocks/triggers_responses.py

@@ -0,0 +1,75 @@
+list_response = [
+    {
+        "id": "3",
+        "runWithTokenId": 123,
+        "component": "orchestration",
+        "configurationId": "config-100",
+        "lastRun": "2017-02-13T16:42:00+0100",
+        "coolDownPeriodMinutes": 20,
+        "creatorToken": {
+            "id": 1,
+            "description": "[email protected]"
+        },
+        "tables": [
+            {
+                "tableId": "in.c-test.watched-1"
+            },
+            {
+                "tableId": "in.c-prod.watched-5"
+            }
+        ]
+    }
+]
+
+detail_response = {
+    "id": "3",
+    "runWithTokenId": 123,
+    "component": "orchestration",
+    "configurationId": "config-100",
+    "lastRun": "2017-02-13T16:42:00+0100",
+    "coolDownPeriodMinutes": 20,
+    "creatorToken": {
+        "id": 1,
+        "description": "[email protected]"
+    },
+    "tables": [
+        {
+            "tableId": "in.c-test.watched-1"
+        },
+        {
+            "tableId": "in.c-prod.watched-5"
+        }
+    ]
+}
+
+update_response = {
+    "id": "3",
+    "runWithTokenId": 123,
+    "component": "orchestration",
+    "configurationId": "config-100",
+    "lastRun": "2017-02-13T16:42:00+0100",
+    "coolDownPeriodMinutes": 20,
+    "creatorToken": {
+        "id": 1,
+        "description": "[email protected]"
+    },
+    "tables": [
+        {
+            "tableId": "in.c-test.watched-1"
+        },
+        {
+            "tableId": "in.c-prod.watched-5"
+        }
+    ]
+}
+
+create_response = {
+    "runWithTokenId": 123,
+    "component": "orchestration",
+    "configurationId": 123,
+    "coolDownPeriodMinutes": 20,
+    "tableIds": [
+        "in.c-test.watched-1",
+        "in.c-prod.watched-5"
+    ]
+}