Merge pull request #46 from timothyaaron/canfulfill.intent

Add helper function for matching CanFulfill Intent name

Author: nikhilym

ask-sdk-core/ask_sdk_core/utils/__init__.py

@@ -18,7 +18,7 @@
 import sys
 
 from ..__version__ import __version__
-from .predicate import is_intent_name, is_request_type
+from .predicate import is_canfulfill_intent_name, is_intent_name, is_request_type
 from ask_sdk_runtime.utils import user_agent_info
 
 

ask-sdk-core/ask_sdk_core/utils/predicate.py

@@ -18,12 +18,38 @@
 import typing
 
 from ask_sdk_model import IntentRequest
+from ask_sdk_model.canfulfill import CanFulfillIntentRequest
 
 if typing.TYPE_CHECKING:
     from typing import Callable
     from ..handler_input import HandlerInput
 
 
+def is_canfulfill_intent_name(name):
+    # type: (str) -> Callable[[HandlerInput], bool]
+    """A predicate function returning a boolean, when name matches the
+    intent name in a CanFulfill Intent Request.
+
+    The function can be applied on a
+    :py:class:`ask_sdk_core.handler_input.HandlerInput`, to
+    check if the input is of
+    :py:class:`ask_sdk_model.intent_request.CanFulfillIntentRequest` type and if the
+    name of the request matches with the passed name.
+
+    :param name: Name to be matched with the CanFulfill Intent Request Name
+    :type name: str
+    :return: Predicate function that can be used to check name of the
+        request
+    :rtype: Callable[[HandlerInput], bool]
+    """
+    def can_handle_wrapper(handler_input):
+        # type: (HandlerInput) -> bool
+        return (isinstance(
+            handler_input.request_envelope.request, CanFulfillIntentRequest) and
+                handler_input.request_envelope.request.intent.name == name)
+    return can_handle_wrapper
+
+
 def is_intent_name(name):
     # type: (str) -> Callable[[HandlerInput], bool]
     """A predicate function returning a boolean, when name matches the

ask-sdk-core/tests/unit/test_utils.py

@@ -20,13 +20,62 @@
 
 from ask_sdk_model import (
     IntentRequest, RequestEnvelope, Intent, SessionEndedRequest, Context)
+from ask_sdk_model.canfulfill import CanFulfillIntentRequest
 from ask_sdk_core.utils import (
-    is_intent_name, is_request_type, viewport)
+    is_canfulfill_intent_name, is_intent_name, is_request_type, viewport)
 from ask_sdk_core.handler_input import HandlerInput
 from ask_sdk_core.exceptions import AskSdkException
 from ask_sdk_model.interfaces.viewport import ViewportState, Shape
 
 
+def test_is_canfulfill_intent_name_match():
+    test_canfulfill_intent_name = "TestIntent"
+    test_handler_input = HandlerInput(
+        request_envelope=RequestEnvelope(request=CanFulfillIntentRequest(
+            intent=Intent(name=test_canfulfill_intent_name))))
+
+    canfulfill_intent_name_wrapper = is_canfulfill_intent_name(test_canfulfill_intent_name)
+    assert canfulfill_intent_name_wrapper(
+        test_handler_input), "is_canfulfill_intent_name matcher didn't match with the " \
+                             "correct intent name"
+
+
+def test_is_canfulfill_intent_name_not_match():
+    test_canfulfill_intent_name = "TestIntent"
+    test_handler_input = HandlerInput(
+        request_envelope=RequestEnvelope(request=CanFulfillIntentRequest(
+            intent=Intent(name=test_canfulfill_intent_name))))
+
+    canfulfill_intent_name_wrapper = is_canfulfill_intent_name("TestIntent1")
+    assert not canfulfill_intent_name_wrapper(
+        test_handler_input), "is_canfulfill_intent_name matcher matched with the " \
+                             "incorrect intent name"
+
+
+def test_is_canfulfill_intent_not_match_intent():
+    test_canfulfill_intent_name = "TestIntent"
+    test_canfulfill_handler_input = HandlerInput(
+        request_envelope=RequestEnvelope(request=CanFulfillIntentRequest(
+            intent=Intent(name=test_canfulfill_intent_name))))
+
+    intent_name_wrapper = is_intent_name(test_canfulfill_intent_name)
+    assert not intent_name_wrapper(
+        test_canfulfill_handler_input), "is_intent_name matcher matched with the " \
+                                        "incorrect request type"
+
+
+def test_is_intent_not_match_canfulfill_intent():
+    test_intent_name = "TestIntent"
+    test_handler_input = HandlerInput(
+        request_envelope=RequestEnvelope(request=IntentRequest(
+            intent=Intent(name=test_intent_name))))
+
+    canfulfill_intent_name_wrapper = is_canfulfill_intent_name(test_intent_name)
+    assert not canfulfill_intent_name_wrapper(
+        test_handler_input), "is_canfulfill_intent_name matcher matched with the " \
+                             "incorrect request type"
+
+
 def test_is_intent_name_match():
     test_intent_name = "TestIntent"
     test_handler_input = HandlerInput(
@@ -344,5 +393,3 @@ def test_viewport_map_to_unknown_for_no_viewport(self):
         assert (viewport.get_viewport_profile(test_request_env)
                 is viewport.ViewportProfile.UNKNOWN_VIEWPORT_PROFILE), (
             "Viewport profile couldn't resolve UNKNOWN_VIEWPORT_PROFILE")
-
-