feat(kno-3081): add idempotency_key header (#19)

Co-authored-by: Meryl Dakin <[email protected]>

Author: brentjanderson

CHANGELOG.md

@@ -0,0 +1,5 @@
+## v0.5.3
+
+* Introduce `options` parameter for `client.notify` and `workflows.trigger` methods
+    * This parameter can be used to pass in additional options to the request
+    * Pass in an `idempotency_key` value via options to prevent duplicate notifications from being sent to your service

knockapi/client.py

@@ -14,15 +14,19 @@ def __init__(self, api_key, host='https://api.knock.app'):
             'User-Agent': 'Knock Python - {}'.format(self.client_version)
         }
 
-    def request(self, method, endpoint, payload=None):
+    def request(self, method, endpoint, payload=None, options={}):
         url = '{}/v1{}'.format(self.host, endpoint)
 
+        extra_headers = {}
+        if (method in ["post", "put"]) and options.get('idempotency_key') != None:
+            extra_headers['Idempotency-Key'] = options.get('idempotency_key')
+
         r = requests.request(
             method,
             url,
             params=payload if method == 'get' else None,
             json=payload if method != 'get' else None,
-            headers=self.headers,
+            headers={**self.headers, **extra_headers}
         )
 
         # If we got a successful response, then attempt to deserialize as JSON
@@ -88,7 +92,8 @@ def notify(
             data={},
             actor=None,
             cancellation_key=None,
-            tenant=None):
+            tenant=None,
+            options={}):
         """
         Triggers a workflow.
 
@@ -108,6 +113,10 @@ def notify(
 
             cancellation_key (str): A key used to cancel this notify.
 
+            options (dict): An optional dictionary of options to pass to the request.
+            Can include:
+            - idempotency_key (str): An optional key that, if passed, will ensure that the same call is not made twice.
+
         Returns:
             dict: Response from Knock.
         """
@@ -118,4 +127,5 @@ def notify(
             data=data,
             actor=actor,
             cancellation_key=cancellation_key,
-            tenant=tenant)
+            tenant=tenant,
+            options=options)

knockapi/resources/workflows.py

@@ -9,7 +9,8 @@ def trigger(
             data={},
             actor=None,
             cancellation_key=None,
-            tenant=None):
+            tenant=None,
+            options={}):
         """
         Triggers a workflow.
 
@@ -29,6 +30,10 @@ def trigger(
 
             cancellation_key (str): A key used to cancel this notify.
 
+            options (dict): A dictionary of options to pass to the request (optional).
+            Can include:
+            - idempotency_key (str): An optional key that, if passed, will ensure that the same call is not made twice.
+
         Returns:
             dict: Response from Knock.
         """
@@ -42,7 +47,7 @@ def trigger(
             'tenant': tenant
         }
 
-        return self.client.request("post", endpoint, payload=params)
+        return self.client.request("post", endpoint, payload=params, options=options)
 
     def cancel(self, key, cancellation_key, recipients=None):
         """

setup.py

@@ -1,6 +1,6 @@
 import setuptools
 
-version = '0.5.2'
+version = '0.5.3'
 
 with open("README.md", "r") as f:
     long_description = f.read()

tests/test_workflows_class.py

@@ -0,0 +1,18 @@
+from unittest.mock import Mock
+
+from knockapi.resources.workflows import Workflows
+
+# Tests
+
+def test_trigger():
+    mocked_client = Mock()
+    workflows = Workflows(mocked_client)
+    workflows.trigger("workflow-key", ["user-123"], {"foo": "bar"}, actor="actor-123", cancellation_key="cancel-key", tenant="tenant-123", options={"idempotency_key": "123"})
+    mocked_client.request.assert_called_with("post", "/workflows/workflow-key/trigger", payload={
+        "actor": "actor-123",
+        "recipients": ["user-123"],
+        "data": {"foo": "bar"},
+        "cancellation_key": "cancel-key",
+        "tenant": "tenant-123"},
+        options={'idempotency_key': '123'})
+