Add BasicCardResponse and SimpleResponse (#35)

* Move basic text response to response object

* Split response into base and text response

* WIP: working card displaying on console

* Simple response now added to testresponse

* Basic Card response.

* SimpleResponse used in today in history.
TodayInHistory tests fixed

* Linting

* Update changelog

Author: andrewgy8

.editorconfig

@@ -0,0 +1,13 @@
+[*]
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+indent_style = space
+
+[*.py]
+indent_size = 4
+max_line_length = 79
+
+[*.{yml,yaml}]
+indent_size = 2

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### Unreleased
+
+- SimpleResponse and BasicCardResponse per the docs
+- Add .editorconfig
+- Update example to use the new response objects
+
 ### v0.3.1
 - Remove nested directories from init command
 

apprentice/format.py

@@ -2,6 +2,8 @@
 
 from flask import Flask, make_response
 
+from .responses import SimpleResponse
+
 
 class Apprentice(Flask):
 
@@ -13,32 +15,15 @@ def generate_text_response(self, reply):
         response_object = self.query_result(reply)
         return self.generate_response(response_object)
 
+    def response_from_object(self, response_obj):
+        return self.generate_response(response_obj.build())
+
     def generate_response(self, data):
         resp = json.dumps(data, indent=4)
         resp = make_response(resp)
         resp.headers['Content-Type'] = 'application/json'
         return resp
 
     def query_result(self, text, expect_user_response=True):
-        return {
-            'fulfillmentText': text,
-            'fulfillmentMessages': [
-                {
-                    "platform": "ACTIONS_ON_GOOGLE",
-                    "text": {
-                        "text": [
-                            text
-                        ]
-                    }
-                }
-            ],
-            'payload': {
-                'google': {
-                    "expect_user_response": expect_user_response,
-                    "is_ssml": True,
-                    "permissions_request": None,
-                }
-            },
-            'outputContexts': [],
-            'source': 'webhook'
-        }
+        response = SimpleResponse(text, expect_user_response)
+        return response.build()

apprentice/responses.py

@@ -0,0 +1,70 @@
+class _BaseResponse:
+
+    def __init__(self, speech, expect_reply, display_text=None):
+        self.speech = speech
+        self.display_text = display_text if display_text else speech
+        self.expect_reply = expect_reply
+        self.base_data = {
+            'payload': {
+                'google': {
+                    'expect_user_response': False,
+                    'is_ssml': True,
+                    'permissions_request': None,
+                    "richResponse": {
+                        "items": []
+                    }
+                }
+            },
+            'source': 'webhook'
+        }
+
+    def build(self):
+        message = {
+            "simpleResponse": {
+                "textToSpeech": self.speech,
+                "displayText": self.display_text
+            }
+        }
+        payload = self.base_data['payload']['google']
+        payload['richResponse']['items'].append(message)
+        payload['expect_user_response'] = self.expect_reply
+        return self.base_data
+
+
+class SimpleResponse(_BaseResponse):
+    """ Simple text response.
+    Simple response with both text to speech and display settings.
+    """
+    pass
+
+
+class BasicCardResponse(_BaseResponse):
+
+    def __init__(self,
+                 speech,
+                 title,
+                 image_url,
+                 image_accessibility_text,
+                 button,
+                 expect_reply):
+        super().__init__(speech, expect_reply)
+        self.title = title
+        self.image_uri = image_url
+        self.image_accessibility_text = image_accessibility_text
+        self.button = button
+
+    def build(self):
+        super().build()
+        message = {
+            "basicCard": {
+                "buttons": [self.button],
+                "image": {
+                    "url": self.image_uri,
+                    "accessibilityText": self.image_accessibility_text
+                },
+                "title": self.title
+            }
+        }
+        payload = self.base_data['payload']['google']
+        payload['richResponse']['items'].append(message)
+        return self.base_data

example/main.py

@@ -2,7 +2,7 @@
 
 import requests
 
-from apprentice import Apprentice
+from apprentice import Apprentice, SimpleResponse
 
 apr = Apprentice(__name__)
 
@@ -32,7 +32,8 @@
 @apr.route('/', methods=['POST'])
 def cool_fact_generator(*args, **kwargs):
     reply = _fact_response('name')
-    return apr.generate_text_response(reply)
+    obj = SimpleResponse(speech=reply, expect_reply=True)
+    return apr.response_from_object(obj)
 
 
 def _fact_response(entity):

example/test_webhook.py

@@ -20,35 +20,38 @@ def test_returns_response_with_json_when_called(self, birth_post_data):
             res = c.post('/', json=birth_post_data)
 
         assert res.json == {
-            'fulfillmentMessages': [
-                {
-                    'platform': 'ACTIONS_ON_GOOGLE',
-                    'text': {
-                        'text': [
-                            'Today in the year 308, At '
-                            'Carnuntum, Emperor emeritus '
-                            'Diocletian confers with Galerius, '
-                            'Augustus of the East, and '
-                            'Maximianus, the recently returned '
-                            'former Augustus of the West, in '
-                            'an attempt to end the civil wars '
-                            'of the Tetrarchy.'
-                        ]
-                    }
-                }
-            ],
-            'fulfillmentText': 'Today in the year 308, At Carnuntum, Emperor '
-                               'emeritus Diocletian confers with Galerius, '
-                               'Augustus of the East, and Maximianus, the '
-                               'recently returned former Augustus of the '
-                               'West, in an attempt to end the civil wars of '
-                               'the Tetrarchy.',
-            'outputContexts': [],
             'payload': {
                 'google': {
                     'expect_user_response': True,
                     'is_ssml': True,
-                    'permissions_request': None
+                    'permissions_request': None,
+                    'richResponse': {
+                        'items': [
+                            {
+                                'simpleResponse': {
+                                    'textToSpeech':
+                                        'Today in the year 308, At '
+                                        'Carnuntum, Emperor emeritus '
+                                        'Diocletian confers with Galerius, '
+                                        'Augustus of the East, and '
+                                        'Maximianus, the recently returned '
+                                        'former Augustus of the West, in '
+                                        'an attempt to end the civil wars '
+                                        'of the Tetrarchy.',
+                                    'displayText':
+                                        'Today in the year 308, At '
+                                        'Carnuntum, Emperor emeritus '
+                                        'Diocletian confers with Galerius, '
+                                        'Augustus of the East, and '
+                                        'Maximianus, the recently returned '
+                                        'former Augustus of the West, in '
+                                        'an attempt to end the civil wars '
+                                        'of the Tetrarchy.'
+
+                                }
+                            }
+                        ]
+                    }
                 }
             },
             'source': 'webhook'

tests/test_core.py

@@ -11,26 +11,25 @@ def test_returns_object_when_given_text(self):
         json_response = apr.query_result(text, expect_user_response=True)
 
         assert json_response == {
-            'outputContexts': [],
             'payload': {
                 'google': {
                     'expect_user_response': True,
                     'is_ssml': True,
-                    'permissions_request': None
-                },
-            },
-            'fulfillmentMessages': [
-                {
-                    "platform": "ACTIONS_ON_GOOGLE",
-                    "text": {
-                        "text": [
-                            'Hello world'
+                    'permissions_request': None,
+                    'richResponse': {
+                        'items': [
+                            {
+                                "simpleResponse": {
+                                    "textToSpeech": 'Hello world',
+                                    "displayText": 'Hello world'
+
+                                }
+                            }
                         ]
                     }
-                }
-            ],
+                },
+            },
             'source': 'webhook',
-            'fulfillmentText': 'Hello world'
         }
 
     def test_returns_expect_user_response_when_set_to_false(self):
@@ -39,26 +38,25 @@ def test_returns_expect_user_response_when_set_to_false(self):
         json_response = apr.query_result(text, expect_user_response=False)
 
         assert json_response == {
-            'outputContexts': [],
             'payload': {
                 'google': {
                     'expect_user_response': False,
                     'is_ssml': True,
-                    'permissions_request': None
-                },
-            },
-            'fulfillmentMessages': [
-                {
-                    "platform": "ACTIONS_ON_GOOGLE",
-                    "text": {
-                        "text": [
-                            'Hello world'
+                    'permissions_request': None,
+                    'richResponse': {
+                        'items': [
+                            {
+                                "simpleResponse": {
+                                    "textToSpeech": 'Hello world',
+                                    "displayText": 'Hello world'
+
+                                }
+                            }
                         ]
                     }
-                }
-            ],
+                },
+            },
             'source': 'webhook',
-            'fulfillmentText': 'Hello world'
         }