Creating ask-sdk-model-runtime package (#6)

* Created ask-sdk-model-runtime package which contains the defintions of LWA servies, implementations of ApiClient and its componenets, also default Serializer definitions. This package can be reused across multiple models released by ask sdk team in future, also the current ask-sdk-models (python) can add this as dependency.

* Adding Optional in serializer for mypy test success and doc reference fix

* Bug fix on api_client, using 'is not' with literal

Author: Shreyas-vgr

ask-sdk-model-runtime/CHANGELOG.rst

@@ -0,0 +1,8 @@
+=========
+CHANGELOG
+=========
+
+1.0
+-------
+
+* Initial release of alexa sdk model runtime.

ask-sdk-model-runtime/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.rst
+include CHANGELOG.rst
+include LICENSE
+include requirements.txt
+recursive-exclude tests *
+recursive-include ask_sdk_model_runtime py.typed

ask-sdk-model-runtime/README.rst

@@ -0,0 +1,52 @@
+====================================================
+ASK SDK Model Runtime - Base components of ASK SDK
+====================================================
+
+ask-sdk-model-runtime is the common models package by
+the Software Development Kit (SDK) team for Python that
+provides common implementations like Serializer, ApiClient
+BaseServiceClient, Authentication Configuration etc.
+that is used by the SDK models.
+
+Quick Start
+-----------
+
+Installation
+~~~~~~~~~~~~~~~
+Assuming that you have Python and ``virtualenv`` installed, you can
+install the package and it's dependencies from PyPi
+as follows:
+
+.. code-block:: sh
+
+    $ virtualenv venv
+    $ . venv/bin/activate
+    $ pip install ask-sdk-model-runtime
+
+
+You can also install the whole standard package locally by following these steps:
+
+.. code-block:: sh
+
+    $ git clone https://github.com/alexa/alexa-apis-for-python.git
+    $ cd ask_sdk_model_runtime
+    $ virtualenv venv
+    ...
+    $ . venv/bin/activate
+    $ python setup.py install
+
+
+Usage and Getting Started
+-------------------------
+
+Getting started guides, SDK Features, API references, samples etc. can
+be found at `Read The Docs <https://alexa-skills-kit-python-sdk.readthedocs.io/en/latest/>`_
+
+
+Got Feedback?
+-------------
+
+- We would like to hear about your bugs, feature requests, questions or quick feedback.
+  Please search for the `existing issues <https://github.com/alexa/alexa-skills-kit-sdk-for-python/issues>`_ before opening a new one. It would also be helpful
+  if you follow the templates for issue and pull request creation. Please follow the `contributing guidelines <https://github.com/alexa/alexa-skills-kit-sdk-for-python/blob/master/CONTRIBUTING.md>`_!
+- Request and vote for `Alexa features <https://alexa.uservoice.com/forums/906892-alexa-skills-developer-voice-and-vote>`_!

ask-sdk-model-runtime/ask_sdk_model_runtime/__init__.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights
+# Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
+# OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the
+# License.
+#
+from __future__ import absolute_import
+
+from .api_client_message import ApiClientMessage
+from .api_client_request import ApiClientRequest
+from .api_client_response import ApiClientResponse
+from .api_client import DefaultApiClient, ApiClient
+from .api_configuration import ApiConfiguration
+from .api_response import ApiResponse
+from .authentication_configuration import AuthenticationConfiguration
+from .base_service_client import BaseServiceClient
+from .serializer import DefaultSerializer, Serializer
+from .exceptions import (
+    ServiceException, SerializationException, ApiClientException)
+from .service_client_response import ServiceClientResponse

ask-sdk-model-runtime/ask_sdk_model_runtime/__version__.py

@@ -0,0 +1,29 @@
+#
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights
+# Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
+# OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the
+# License.
+#
+
+__pip_package_name__ = 'ask-sdk-model-runtime'
+__description__ = ('The ASK SDK Model Runtime package provides common provides '
+                   'common implementations like Serializer, ApiClient, '
+                   'Authentication Configuration etc that is used by the SDK '
+                   'models.')
+__url__ = 'https://github.com/alexa/alexa-apis-for-python'
+__version__ = '1.0.0'
+__author__ = 'Alexa Skills Kit'
+__author_email__ = '[email protected]'
+__license__ = 'Apache 2.0'
+__keywords__ = ['ASK SDK Model Runtime', 'Alexa Skills Kit', 'Alexa', 'Model', 'Runtime']
+__install_requires__ = ["requests", "python_dateutil"]

ask-sdk-model-runtime/ask_sdk_model_runtime/api_client.py

@@ -0,0 +1,167 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights
+# Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License").
+# You may not use this file except in compliance with the License.
+# A copy of the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
+# OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the
+# License.
+#
+import typing
+import requests
+import six
+import json
+
+from abc import ABCMeta, abstractmethod
+from urllib3.util import parse_url
+
+from .api_client_response import ApiClientResponse
+
+from .exceptions import ApiClientException
+
+if typing.TYPE_CHECKING:
+    from typing import Callable, Dict, List, Tuple
+    from ask_sdk_model_runtime import ApiClientRequest, ApiClientResponse
+
+
+class ApiClient(object):
+    """Represents a basic contract for API request invocation."""
+    __metaclass__ = ABCMeta
+
+    @abstractmethod
+    def invoke(self, request):
+        # type: (ApiClientRequest) -> ApiClientResponse
+        """Dispatches a request to an API endpoint described in the request.
+        The ApiClient is expected to resolve in the case an API returns
+        a non-200 HTTP status code. The responsibility of translating a
+        particular response code to an error lies with the caller.
+        :param request: Request to dispatch to the ApiClient
+        :type request: ApiClientRequest
+        :return: Response from the client call
+        :rtype: ApiClientResponse
+        """
+        pass
+
+
+class DefaultApiClient(ApiClient):
+    """Default ApiClient implementation of
+    :py:class:`ask_sdk_model_runtime.api_client.ApiClient` using the
+    `requests` library.
+    """
+
+    def invoke(self, request):
+        # type: (ApiClientRequest) -> ApiClientResponse
+        """Dispatches a request to an API endpoint described in the
+        request.
+        Resolves the method from input request object, converts the
+        list of header tuples to the required format (dict) for the
+        `requests` lib call and invokes the method with corresponding
+        parameters on `requests` library. The response from the call is
+        wrapped under the `ApiClientResponse` object and the
+        responsibility of translating a response code and response/
+        error lies with the caller.
+        :param request: Request to dispatch to the ApiClient
+        :type request: ApiClientRequest
+        :return: Response from the client call
+        :rtype: ApiClientResponse
+        :raises: :py:class:`ask_sdk_model_runtime.exceptions.ApiClientException`
+        """
+        try:
+            http_method = self._resolve_method(request)
+            http_headers = self._convert_list_tuples_to_dict(
+                headers_list=request.headers)
+
+            parsed_url = parse_url(request.url)
+            if parsed_url.scheme is None or parsed_url.scheme != "https":
+                raise ApiClientException(
+                    "Requests against non-HTTPS endpoints are not allowed.")
+
+            if request.body:
+                body_content_type = http_headers.get("Content-type", None)
+                if (body_content_type is not None and
+                        "json" in body_content_type):
+                    raw_data = json.dumps(request.body)
+                else:
+                    raw_data = request.body
+            else:
+                raw_data = None
+
+            http_response = http_method(
+                url=request.url, headers=http_headers, data=raw_data)
+
+            return ApiClientResponse(
+                headers=self._convert_dict_to_list_tuples(
+                    http_response.headers),
+                status_code=http_response.status_code,
+                body=http_response.text)
+        except Exception as e:
+            raise ApiClientException(
+                "Error executing the request: {}".format(str(e)))
+
+    def _resolve_method(self, request):
+        # type: (ApiClientRequest) -> Callable
+        """Resolve the method from request object to `requests` http
+        call.
+        :param request: Request to dispatch to the ApiClient
+        :type request: ApiClientRequest
+        :return: The HTTP method that maps to the request call.
+        :rtype: Callable
+        :raises :py:class:`ask_sdk_model_runtime.exceptions.ApiClientException`
+            if invalid http request method is being called
+        """
+        try:
+            return getattr(requests, request.method.lower())
+        except AttributeError:
+            raise ApiClientException(
+                "Invalid request method: {}".format(request.method))
+
+    def _convert_list_tuples_to_dict(self, headers_list):
+        # type: (List[Tuple[str, str]]) -> Dict[str, str]
+        """Convert list of tuples from headers of request object to
+        dictionary format.
+        :param headers_list: List of tuples made up of two element
+            strings from `ApiClientRequest` headers variable
+        :type headers_list: List[Tuple[str, str]]
+        :return: Dictionary of headers in keys as strings and values
+            as comma separated strings
+        :rtype: Dict[str, str]
+        """
+        headers_dict = {}  # type: Dict
+        if headers_list is not None:
+            for header_tuple in headers_list:
+                key, value = header_tuple[0], header_tuple[1]
+                if key in headers_dict:
+                    headers_dict[key] = "{}, {}".format(
+                        headers_dict[key], value)
+                else:
+                    headers_dict[header_tuple[0]] = value
+        return headers_dict
+
+    def _convert_dict_to_list_tuples(self, headers_dict):
+        # type: (Dict[str, str]) -> List[Tuple[str, str]]
+        """Convert headers dict to list of string tuples format for
+        `ApiClientResponse` headers variable.
+        :param headers_dict: Dictionary of headers in keys as strings
+            and values as comma separated strings
+        :type headers_dict: Dict[str, str]
+        :return: List of tuples made up of two element strings from
+            headers of client response
+        :rtype: List[Tuple[str, str]]
+        """
+        headers_list = []
+        if headers_dict is not None:
+            for key, values in six.iteritems(headers_dict):
+                for value in values.split(","):
+                    value = value.strip()
+                    if value is not None and value != '':
+                        headers_list.append((key, value.strip()))
+        return headers_list
+

ask-sdk-model-runtime/ask_sdk_model_runtime/api_client_message.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may
+# not use this file except in compliance with the License. A copy of the
+# License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is distributed
+# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+# express or implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+import typing
+
+if typing.TYPE_CHECKING:
+    from typing import List, Tuple
+
+
+class ApiClientMessage(object):
+    """Represents the interface between
+    :py:class:`ask_sdk_model_runtime.api_client.ApiClient` implementation
+    and a Service Client.
+
+    :param headers: List of header tuples
+    :type headers: list[tuple[str, str]]
+    :param body: Body of the message
+    :type body: str
+    """
+
+    def __init__(self, headers=None, body=None):
+        # type: (List[Tuple[str, str]], str) -> None
+        """Represents the interface between
+        :py:class:`ask_sdk_model_runtime.api_client.ApiClient`
+        implementation and a Service Client.
+
+        :param headers: List of header tuples
+        :type headers: list[tuple[str, str]]
+        :param body: Body of the message
+        :type body: str
+        """
+        if headers is None:
+            headers = []
+        self.headers = headers
+        self.body = body