Merge pull request #141 from treethought/platform-responses

Initial support for dialogflow messenger integration

Author: treethought

Pipfile

@@ -18,12 +18,12 @@ idna = "==2.8"
 itsdangerous = "==1.1.0"
 requests = "==2.21.0"
 urllib3 = "==1.24.2"
-Flask = "==1.0.2"
-Jinja2 = "==2.10"
+Flask = "==1.1.1"
 MarkupSafe = "==1.1.0"
 "ruamel.yaml" = "==0.15.81"
 Werkzeug = "==0.15.3"
 google-auth = "*"
+dialogflow = "*"
 
 [requires]
 python_version = "3.7"

README.md

@@ -36,14 +36,14 @@ from flask import Flask
 from flask_assistant import Assistant, ask
 
 app = Flask(__name__)
-assist = Assistant(app, project_id='GOOGLE_CLOUD_PROJECT_ID')
+assist = Assistant(app, project_id="GOOGLE_CLOUD_PROJECT_ID")
 
-@assist.action('Demo')
+@assist.action("Demo")
 def hello_world():
-    speech = 'Microphone check 1, 2 what is this?'
+    speech = "Microphone check 1, 2 what is this?"
     return ask(speech)
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     app.run(debug=True)
 ```
 

flask_assistant/__init__.py

@@ -23,11 +23,17 @@
     storage,
     session_id,
     context_in,
-    profile
+    profile,
 )
 
 from flask_assistant.response import (
-    ask, tell, event, build_item, permission, sign_in, build_button
+    ask,
+    tell,
+    event,
+    build_item,
+    permission,
+    sign_in,
+    build_button,
 )
 
 from flask_assistant.manager import Context

flask_assistant/core.py

@@ -100,19 +100,13 @@ def __init__(
 
         self.api = ApiAi(dev_token, client_token)
 
-        if route is None and app is not None:
-            self._route = "/"
-
         if app is not None:
             self.init_app(app)
+
         elif blueprint is not None:
             self.init_blueprint(blueprint)
-        else:
-            raise ValueError(
-                "Assistant object must be intialized with either an app or blueprint"
-            )
 
-        if self.client_id is None:
+        if self.client_id is None and self.app is not None:
             self.client_id = self.app.config.get("AOG_CLIENT_ID")
 
         if project_id is None:
@@ -126,14 +120,17 @@ def __init__(
             )
 
     def init_app(self, app):
+        self.app = app
 
         if self._route is None:
-            raise TypeError("route is a required argument when app is not None")
+            self._route = "/"
 
         app.assist = self
         app.add_url_rule(
             self._route, view_func=self._flask_assitant_view_func, methods=["POST"]
         )
+        if self.client_id is None and self.app is not None:
+            self.client_id = self.app.config.get("AOG_CLIENT_ID")
 
     # Taken from Flask-ask courtesy of @voutilad
     def init_blueprint(self, blueprint, path="templates.yaml"):
@@ -160,7 +157,10 @@ def init_blueprint(self, blueprint, path="templates.yaml"):
         blueprint.add_url_rule(
             "", view_func=self._flask_assitant_view_func, methods=["POST"]
         )
+
         # blueprint.jinja_loader = ChoiceLoader([YamlLoader(blueprint, path)])
+        if self.client_id is None and self.app is not None:
+            self.client_id = self.app.config.get("AOG_CLIENT_ID")
 
     @property
     def request(self):
@@ -396,18 +396,15 @@ def _set_user_profile(self):
 
             token = self.user["idToken"]
             decode_resp = decode_token(token, self.client_id)
-            if decode_resp["status"]=="BAD":
+            if decode_resp["status"] == "BAD":
                 return
-            else: #decode_resp["status"]=="OK"
+            else:  # decode_resp["status"]=="OK"
                 profile_payload = decode_resp["output"]
             for k in ["sub", "iss", "aud", "iat", "exp"]:
                 profile_payload.pop(k)
 
             self.profile = profile_payload
 
-
-
-    
     def _flask_assitant_view_func(self, nlp_result=None, *args, **kwargs):
         if nlp_result:  # pass API query result directly
             self.request = nlp_result

flask_assistant/manager.py

@@ -7,7 +7,7 @@ def parse_context_name(context_obj):
 
 
 class Context(dict):
-    """docstring for _Context"""
+    """This is a docstring for _Context"""
 
     def __init__(self, name, parameters={}, lifespan=5):
 

flask_assistant/response/__init__.py

@@ -0,0 +1,2 @@
+from .base import _Response, _ListSelector, ask, tell, event, permission
+from .base import *

flask_assistant/response/actions.py

@@ -0,0 +1,25 @@
+def build_card(
+    text,
+    title,
+    img_url=None,
+    img_alt=None,
+    subtitle=None,
+    link=None,
+    link_title=None,
+    buttons=None,
+):
+
+    card_payload = {"title": title, "subtitle": subtitle, "formattedText": text}
+
+    if buttons:
+        card_payload["buttons"] = buttons
+
+    elif link and link_title:
+        btn_payload = [{"title": link_title, "openUriAction": {"uri": link}}]
+        card_payload["buttons"] = btn_payload
+
+    if img_url:
+        img_payload = {"imageUri": img_url, "accessibilityText": img_alt or img_url}
+        card_payload["image"] = img_payload
+
+    return {"platform": "ACTIONS_ON_GOOGLE", "basicCard": card_payload}

flask_assistant/response.py flask_assistant/response/base.pyflask_assistant/response.py renamed to flask_assistant/response/base.py

@@ -1,5 +1,6 @@
 from flask import json, make_response, current_app
-from . import logger
+from flask_assistant import logger
+from flask_assistant.response import actions, dialogflow, hangouts, df_messenger
 
 
 class _Response(object):
@@ -11,6 +12,8 @@ def __init__(self, speech, display_text=None, is_ssml=False):
         self._display_text = display_text
         self._integrations = current_app.config.get("INTEGRATIONS", [])
         self._messages = [{"text": {"text": [speech]}}]
+        self._platform_messages = {}
+        self._render_func = None
         self._is_ssml = is_ssml
         self._response = {
             "fulfillmentText": speech,
@@ -27,12 +30,16 @@ def __init__(self, speech, display_text=None, is_ssml=False):
             "followupEventInput": None,  # TODO
         }
 
+        for i in self._integrations:
+            self._platform_messages[i] = []
+
         if "ACTIONS_ON_GOOGLE" in self._integrations:
             self._set_user_storage()
             self._integrate_with_actions(self._speech, self._display_text, is_ssml)
 
     def add_msg(self, speech, display_text=None, is_ssml=False):
         self._messages.append({"text": {"text": [speech]}})
+
         if "ACTIONS_ON_GOOGLE" in self._integrations:
             self._integrate_with_actions(speech, display_text, is_ssml)
 
@@ -55,9 +62,32 @@ def _set_user_storage(self):
 
         self._response["payload"]["google"]["userStorage"] = user_storage
 
+    def _integrate_with_df_messenger(self, speech=None, display_text=None):
+
+        logger.debug("Integrating with dialogflow messenger")
+
+        content = {"richContent": [[]]}
+        for m in self._platform_messages.get("DIALOGFLOW_MESSENGER", []):
+            content["richContent"][0].append(m)
+
+        payload = {"payload": content}
+
+        self._messages.append(payload)
+
+    def _integrate_with_hangouts(self, speech=None, display_text=None, is_ssml=False):
+        if display_text is None:
+            display_text = speech
+
+        self._messages.append(
+            {"platform": "GOOGLE_HANGOUTS", "text": {"text": [display_text]},}
+        )
+        for m in self._platform_messages.get("GOOGLE_HANGOUTS", []):
+            self._messages.append(m)
+
     def _integrate_with_actions(self, speech=None, display_text=None, is_ssml=False):
         if display_text is None:
             display_text = speech
+
         if is_ssml:
             ssml_speech = "<speak>" + speech + "</speak>"
             self._messages.append(
@@ -90,6 +120,11 @@ def _include_contexts(self):
 
     def render_response(self):
         self._include_contexts()
+        if self._render_func:
+            self._render_func()
+
+        self._integrate_with_df_messenger()
+        self._integrate_with_hangouts(self._speech, self._display_text)
         logger.debug(json.dumps(self._response, indent=2))
         resp = make_response(json.dumps(self._response))
         resp.headers["Content-Type"] = "application/json"
@@ -102,21 +137,14 @@ def suggest(self, *replies):
         for r in replies:
             chips.append({"title": r})
 
-        # NOTE: both of these formats work in the dialogflow console,
-        # but only the first (suggestions) appears in actual Google Assistant
-
         # native chips for GA
         self._messages.append(
             {"platform": "ACTIONS_ON_GOOGLE", "suggestions": {"suggestions": chips}}
         )
 
-        # # quick replies for other platforms
-        # self._messages.append(
-        #     {
-        #         "platform": "ACTIONS_ON_GOOGLE",
-        #         "quickReplies": {"title": None, "quickReplies": replies},
-        #     }
-        # )
+        if "DIALOGFLOW_MESSENGER" in self._integrations:
+            chip_resp = df_messenger._build_suggestions(*replies)
+            self._platform_messages["DIALOGFLOW_MESSENGER"].append(chip_resp)
 
         return self
 
@@ -142,32 +170,33 @@ def card(
         link_title=None,
         buttons=None,
     ):
-        """
-        :param: link and :param: link_title supports only one button per card
-        in future versions should be deleted
-        and from now deprecated
+        df_card = dialogflow.build_card(
+            text, title, img_url, img_alt, subtitle, link, link_title
+        )
+        self._messages.append(df_card)
 
-        :param link:
-        :param link_title:
-        :return:
-        """
+        # df_messengar car is a combo of description + button
+        if "DIALOGFLOW_MESSENGER" in self._integrations:
 
-        card_payload = {"title": title, "subtitle": subtitle, "formattedText": text}
+            description = df_messenger._build_description_response(text, title)
+            self._platform_messages["DIALOGFLOW_MESSENGER"].append(description)
 
-        if buttons:
-            card_payload["buttons"] = buttons
-        elif link and link_title:
-            logger.info('use button parameter instead of link and link_title')
-            buttons = [build_button(title=link_title, link=link)]
-            card_payload["buttons"] = buttons
+            if link:
+                btn = df_messenger._build_button(link, link_title)
+                self._platform_messages["DIALOGFLOW_MESSENGER"].append(btn)
 
-        if img_url:
-            img_payload = {"imageUri": img_url, "accessibilityText": img_alt or img_url}
-            card_payload["image"] = img_payload
+        if "GOOGLE_HANGOUTS" in self._integrations:
+            hangouts_card = hangouts.build_card(
+                text, title, img_url, img_alt, subtitle, link, link_title
+            )
+            self._platform_messages["GOOGLE_HANGOUTS"].append(hangouts_card)
 
-        self._messages.append(
-            {"platform": "ACTIONS_ON_GOOGLE", "basicCard": card_payload}
-        )
+        if "ACTIONS_ON_GOOGLE" in self._integrations:
+            actions_card = actions.build_card(
+                text, title, img_url, img_alt, subtitle, link, link_title, buttons
+            )
+
+            self._messages.append(actions_card)
 
         return self
 
@@ -255,10 +284,7 @@ def add_media(self, url, name, description=None, icon_url=None, icon_alt=None):
 
 
 def build_button(title, link):
-    return {
-        "title": title,
-        "openUriAction": {"uri": link}
-    }
+    return {"title": title, "openUriAction": {"uri": link}}
 
 
 def build_item(
@@ -290,7 +316,7 @@ class _CardWithItems(_Response):
     def __init__(self, speech, display_text=None, items=None):
         super(_CardWithItems, self).__init__(speech, display_text)
         self._items = items or list()
-        self._add_message()  # possibly call this later?
+        self._render_func = self._add_message
 
     def _add_message(self):
         raise NotImplementedError
@@ -332,12 +358,20 @@ def __init__(self, speech, display_text=None, title=None, items=None):
         super(_ListSelector, self).__init__(speech, display_text, items)
 
     def _add_message(self):
+
         self._messages.append(
             {
                 "platform": "ACTIONS_ON_GOOGLE",
                 "listSelect": {"title": self._title, "items": self._items},
             }
         )
+        self._add_platform_msgs()
+
+    def _add_platform_msgs(self):
+
+        if "DIALOGFLOW_MESSENGER" in self._integrations:
+            list_resp = df_messenger._build_list(self._title, self._items)
+            self._platform_messages["DIALOGFLOW_MESSENGER"].extend(list_resp)
 
 
 class _CarouselCard(_ListSelector):
@@ -453,5 +487,3 @@ def __init__(self, reason=None):
                 }
             }
         }
-
-