add 'webhook' integration model

Author: snopoke

README.md

@@ -31,7 +31,7 @@ taskbadger.init(
 #### API Example
 
 ```python
-from taskbadger import Task, Action, EmailIntegration
+from taskbadger import Task, Action, EmailIntegration, WebhookIntegration
 
 # create a new task with custom data and an action definition
 task = Task.create(
@@ -40,10 +40,8 @@ task = Task.create(
         "custom": "data"
     },
     actions=[
-        Action(
-            "*/10%,success,error",
-            integration=EmailIntegration(to="me@example.com")
-        )
+        Action("*/10%,success,error", integration=EmailIntegration(to="me@example.com")),
+        Action("cancelled", integration=WebhookIntegration(id="webhook:demo")),
     ]
 )
 

taskbadger/__init__.py

@@ -1,4 +1,4 @@
-from .integrations import Action, EmailIntegration
+from .integrations import Action, EmailIntegration, WebhookIntegration
 from .internal.models import StatusEnum
 from .safe_sdk import create_task_safe, update_task_safe
 from .sdk import Task, create_task, get_task, init, update_task

taskbadger/exceptions.py

@@ -4,3 +4,7 @@ def __init__(self, **kwargs):
 
     def __str__(self):
         return f"Missing configuration parameters: {', '.join(self.missing)}"
+
+
+class TaskbadgerException(Exception):
+    pass

taskbadger/integrations.py

@@ -2,6 +2,7 @@
 from enum import Enum
 from typing import Any, Dict
 
+from taskbadger.exceptions import TaskbadgerException
 from taskbadger.internal.models import ActionRequest, ActionRequestConfig
 
 
@@ -17,7 +18,12 @@ def from_config(integration: Integrations, config: str):
 
 
 class Integration:
-    name: str
+    type: str
+    id: str
+
+    def __post_init__(self):
+        if not self.id.startswith(self.type):
+            raise TaskbadgerException(f"Expected integration ID '{self.id}' to start with '{self.type}'")
 
     def request_config(self):
         raise NotImplementedError
@@ -29,13 +35,23 @@ class Action:
     integration: Integration
 
     def to_dict(self) -> Dict[str, Any]:
-        return ActionRequest(self.trigger, self.integration.name, self.integration.request_config()).to_dict()
+        return ActionRequest(self.trigger, self.integration.id, self.integration.request_config()).to_dict()
 
 
 @dataclasses.dataclass
 class EmailIntegration(Integration):
-    name = "email"
+    type = "email"
+    id = "email"
     to: str  # custom type
 
     def request_config(self) -> ActionRequestConfig:
         return ActionRequestConfig.from_dict({"to": self.to})
+
+
+@dataclasses.dataclass
+class WebhookIntegration(Integration):
+    type = "webhook"
+    id: str
+
+    def request_config(self) -> ActionRequestConfig:
+        return ActionRequestConfig.from_dict({})

tests/test_sdk.py

@@ -3,7 +3,8 @@
 
 import pytest
 
-from taskbadger import Action, EmailIntegration, StatusEnum
+from taskbadger import Action, EmailIntegration, StatusEnum, WebhookIntegration
+from taskbadger.exceptions import TaskbadgerException
 from taskbadger.internal.models import PatchedTaskRequest, PatchedTaskRequestData, TaskRequest, TaskRequestData
 from taskbadger.internal.types import UNSET, Response
 from taskbadger.sdk import Badger, Task, init
@@ -132,17 +133,30 @@ def test_add_actions(settings, patched_update):
 
     patched_update.return_value = Response(HTTPStatus.OK, b"", {}, api_task)
 
-    action = Action("*/10%,success,error", integration=EmailIntegration(to="me@example.com"))
-    task.add_actions([action])
+    task.add_actions(
+        [
+            Action("*/10%,success,error", integration=EmailIntegration(to="me@example.com")),
+            Action("cancelled", integration=WebhookIntegration(id="webhook:123")),
+        ]
+    )
 
     # expected request
     _verify_update(
         settings,
         patched_update,
-        actions=[{"trigger": "*/10%,success,error", "integration": "email", "config": {"to": "me@example.com"}}],
+        actions=[
+            {"trigger": "*/10%,success,error", "integration": "email", "config": {"to": "me@example.com"}},
+            {"trigger": "cancelled", "integration": "webhook:123", "config": {}},
+        ],
     )
 
 
+def test_action_validation():
+    WebhookIntegration(id="webhook:123")
+    with pytest.raises(TaskbadgerException):
+        WebhookIntegration(id="email:123")
+
+
 def _verify_update(settings, patched_update, **kwargs):
     actions = kwargs.pop("actions", None)
     request_params = {