feat: add support for assistant-event directive (#12)

* feat: add support for assistant-event directive * feat: add unit test Co-authored-by: Brady Lenz <[email protected]>
cisco · Jul 7, 2021 · 41d52df · 41d52df
1 parent ebffc2d
commit 41d52df
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Implemented `new` CLI command
+- Implemented `assistant-event` directive
 
 ### Changed
 

diff --git a/tests/test_responder.py b/tests/test_responder.py
@@ -105,3 +105,15 @@ def test_long_reply(responder: SkillResponder, query: str, remove_hyphens: bool,
     assert responder.directives[0]['type'] == 'view'
     assert responder.directives[1]['payload']['text'] == text
     assert responder.directives[1]['name'] == 'speak'
+
+def test_assistant_event(responder: SkillResponder):
+    expected_name = 'test'
+    expected_payload = { 'foo': 'bar' }
+
+    responder.send_assistant_event(expected_name, expected_payload)
+
+    directive = responder.directives[0]
+
+    assert directive['name'] == responder.DirectiveNames.ASSISTANT_EVENT
+    assert directive['payload']['name'] == expected_name
+    assert directive['payload']['payload'] == expected_payload
diff --git a/webex_assistant_sdk/dialogue.py b/webex_assistant_sdk/dialogue.py
@@ -24,6 +24,9 @@ class AssistantDirectiveNames(DirectiveNames):
     DISPLAY = 'display'
     """A generic display directive."""
 
+    ASSISTANT_EVENT = 'assistant-event'
+    """A directive to forward a generic payload"""
+
 
 class DirectiveNotSupportedError(Exception):
     pass
@@ -224,6 +227,18 @@ def long_reply(
         if not success:
             raise DirectiveNotSupportedError
 
+    def send_assistant_event(self, name, payload=None):
+        """Sends a 'assistant-event' directive
+
+        Args:
+            name (string): Used to identify the source of the event
+            payload (json object, optional): Payload to forward
+        """
+        self.act(self.DirectiveNames.ASSISTANT_EVENT, {
+            'name': name,
+            'payload': payload,
+        })
+
     @property
     def supported_directives(self):
         return [