Adding Template Resolvers for response generations (#114)

Author: Shreyas-vgr

ask-sdk-core/.gitignore

@@ -65,3 +65,4 @@ target/
 
 # IntelliJ configs
 *.iml
+.idea/

ask-sdk-core/CHANGELOG.rst

@@ -131,7 +131,7 @@ This release contains the following :
 1.10.2
 ^^^^^^^
 
-This release contains the following changes : 
+This release contains the following changes :
 
-- `Bug fix <https://github.com/alexa/alexa-skills-kit-sdk-for-python/pull/99>`__ on delete persistence attributes, to delete attributes without checking if they are set. 
+- `Bug fix <https://github.com/alexa/alexa-skills-kit-sdk-for-python/pull/99>`__ on delete persistence attributes, to delete attributes without checking if they are set.
 - Fix `type hints <https://github.com/alexa/alexa-skills-kit-sdk-for-python/pull/95>`__ on lambda_handler.

ask-sdk-core/README.rst

@@ -1,4 +1,4 @@
-====================================================
+ ====================================================
 ASK SDK Core - Base components of Python ASK SDK
 ====================================================
 
@@ -40,7 +40,7 @@ Usage and Getting Started
 -------------------------
 
 Getting started guides, SDK Features, API references, samples etc. can
-be found in the `technical documentation <https://developer.amazon.com/docs/alexa-skills-kit-sdk-for-python/overview.html>`_
+be found at `Read The Docs <https://alexa-skills-kit-python-sdk.readthedocs.io/en/latest/>`_
 
 
 Got Feedback?

ask-sdk-core/ask_sdk_core/dispatch_components/py.typed

@@ -103,7 +103,7 @@ def process(self, handler_input, response):
         :type handler_input: HandlerInput
         :param response: Execution result of the Handler on
             handler input.
-        :type response: Union[None, :py:class:`ask_sdk_model.Response`]
+        :type response: Union[None, :py:class:`ask_sdk_model.response.Response`]
         :rtype: None
         """
         raise NotImplementedError

ask-sdk-core/ask_sdk_core/dispatch_components/request_components.py

@@ -39,3 +39,13 @@ class PersistenceException(AskSdkException):
 class ApiClientException(AskSdkException):
     """Exception class for ApiClient Adapter processing."""
     pass
+
+
+class TemplateLoaderException(AskSdkException):
+    """Exception class for Template Loaders"""
+    pass
+
+
+class TemplateRendererException(AskSdkException):
+    """Exception class for Template Renderer"""
+    pass

ask-sdk-core/ask_sdk_core/exceptions.py

@@ -17,10 +17,12 @@
 #
 import typing
 from .response_helper import ResponseFactory
+from .view_resolvers import TemplateFactory
 
 if typing.TYPE_CHECKING:
-    from typing import Any
+    from typing import Any, Dict
     from ask_sdk_model import RequestEnvelope
+    from ask_sdk_model.response import Response
     from ask_sdk_model.services import ServiceClientFactory
     from .attributes_manager import AttributesManager
 
@@ -48,11 +50,13 @@ class HandlerInput(object):
         for calling Alexa services
     :type service_client_factory:
         ask_sdk_model.services.service_client_factory.ServiceClientFactory
+    :param template_factory: Template Factory to chain loaders and renderer
+    :type template_factory: :py:class:`ask_sdk_core.view_resolver.TemplateFactory`
     """
     def __init__(
             self, request_envelope, attributes_manager=None,
-            context=None, service_client_factory=None):
-        # type: (RequestEnvelope, AttributesManager, Any, ServiceClientFactory) -> None
+            context=None, service_client_factory=None, template_factory=None):
+        # type: (RequestEnvelope, AttributesManager, Any, ServiceClientFactory, TemplateFactory) -> None
         """Input to Request Handler, Exception Handler and Interceptors.
 
         :param request_envelope: Request Envelope passed from Alexa
@@ -68,12 +72,15 @@ def __init__(
             for calling Alexa services
         :type service_client_factory:
             ask_sdk_model.services.service_client_factory.ServiceClientFactory
+        :param template_factory: Template Factory to chain loaders and renderer
+        :type template_factory: :py:class:`ask_sdk_core.view_resolver.TemplateFactory`
         """
         self.request_envelope = request_envelope
         self.context = context
         self.service_client_factory = service_client_factory
         self.attributes_manager = attributes_manager
         self.response_builder = ResponseFactory()
+        self.template_factory = template_factory
 
     @property
     def service_client_factory(self):
@@ -98,3 +105,19 @@ def service_client_factory(self, service_client_factory):
             ServiceClientFactory
         """
         self._service_client_factory = service_client_factory
+
+    def generate_template_response(self, template_name, data_map, **kwargs):
+        # type: (str, Dict, Any) -> Response
+        """Generate response using skill response template and injecting data.
+
+        :param template_name: name of response template
+        :type template_name: str
+        :param data_map: map contains injecting data
+        :type data_map: Dict[str, object]
+        :param kwargs: Additional keyword arguments for loader and renderer.
+        :return: Skill Response output
+        :rtype: :py:class:`ask_sdk_model.response.Response`
+        """
+        return self.template_factory.process_template(
+            template_name=template_name, data_map=data_map, handler_input=self,
+            **kwargs)

ask-sdk-core/ask_sdk_core/handler_input.py

@@ -27,6 +27,7 @@
 from .serialize import DefaultSerializer
 from .handler_input import HandlerInput
 from .attributes_manager import AttributesManager
+from .view_resolvers import TemplateFactory
 from .utils import RESPONSE_FORMAT_VERSION, user_agent_info
 from .__version__ import __version__
 
@@ -137,6 +138,8 @@ def __init__(self, skill_configuration):
         self.serializer = DefaultSerializer()
         self.skill_id = skill_configuration.skill_id
         self.custom_user_agent = skill_configuration.custom_user_agent
+        self.loaders = skill_configuration.loaders
+        self.renderer = skill_configuration.renderer
 
         self.request_dispatcher = GenericRequestDispatcher(
             options=skill_configuration
@@ -185,6 +188,10 @@ def invoke(self, request_envelope, context):
         else:
             factory = None
 
+        template_factory = TemplateFactory(
+            template_loaders=self.loaders,
+            template_renderer=self.renderer)
+
         attributes_manager = AttributesManager(
             request_envelope=request_envelope,
             persistence_adapter=self.persistence_adapter)
@@ -193,7 +200,8 @@ def invoke(self, request_envelope, context):
             request_envelope=request_envelope,
             attributes_manager=attributes_manager,
             context=context,
-            service_client_factory=factory)
+            service_client_factory=factory,
+            template_factory=template_factory)
 
         response = self.request_dispatcher.dispatch(
             handler_input=handler_input)

ask-sdk-core/ask_sdk_core/py.typed

@@ -25,9 +25,11 @@
 from .skill import CustomSkill, SkillConfiguration
 
 if typing.TYPE_CHECKING:
-    from typing import Callable, TypeVar, Dict
+    from typing import Callable, TypeVar, Dict, List
     from ask_sdk_model.services import ApiClient
     from .attributes_manager import AbstractPersistenceAdapter
+    from ask_sdk_runtime.view_resolvers import (
+        AbstractTemplateLoader, AbstractTemplateRenderer)
     T = TypeVar('T')
 
 
@@ -39,7 +41,7 @@ class SkillBuilder(AbstractSkillBuilder):
     def __init__(self):
         # type: () -> None
         super(SkillBuilder, self).__init__()
-        self.custom_user_agent = None
+        self.custom_user_agent = None  # type: str
         self.skill_id = None
 
     @property
@@ -110,6 +112,32 @@ def wrapper(event, context):
             return skill.serializer.serialize(response_envelope)  # type:ignore
         return wrapper
 
+    def add_custom_user_agent(self, user_agent):
+        # type: (str) -> None
+        """Adds the user agent to the skill instance.
+
+        This method adds the passed in user_agent to the skill, which is
+        reflected in the skill's response envelope.
+
+        :param user_agent: Custom User Agent string provided by the developer.
+        :type user_agent: str
+        :rtype: None
+        """
+        if self.custom_user_agent is None:
+            self.custom_user_agent = user_agent
+        else:
+            self.custom_user_agent += " {}".format(user_agent)
+
+    def add_renderer(self, renderer):
+        # type: (AbstractTemplateRenderer) -> None
+        """Register renderer to generate template responses.
+
+        :param renderer: Renderer to render the template
+        :type renderer:  :py:class:`ask_sdk_runtime.view_resolvers.AbstractTemplateRenderer`
+        """
+        super(SkillBuilder, self).add_renderer(renderer)
+        self.add_custom_user_agent("templateResolver")
+
 
 class CustomSkillBuilder(SkillBuilder):
     """Skill Builder with api client and persistence adapter setter