├── .gitignore
├── LICENSE
├── Procfile
├── README.md
├── app.json
├── app.py
├── app.yaml
├── requirements.txt
└── runtime.txt
/.gitignore:
--------------------------------------------------------------------------------
1 | ### Python template
2 | # Byte-compiled / optimized / DLL files
3 | __pycache__/
4 | *.py[cod]
5 | *$py.class
6 |
7 | # C extensions
8 | *.so
9 |
10 | # Distribution / packaging
11 | .Python
12 | env/
13 | build/
14 | develop-eggs/
15 | dist/
16 | downloads/
17 | eggs/
18 | .eggs/
19 | lib/
20 | lib64/
21 | parts/
22 | sdist/
23 | var/
24 | *.egg-info/
25 | .installed.cfg
26 | *.egg
27 |
28 | # PyInstaller
29 | # Usually these files are written by a python script from a template
30 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
31 | *.manifest
32 | *.spec
33 |
34 | # Installer logs
35 | pip-log.txt
36 | pip-delete-this-directory.txt
37 |
38 | # Unit test / coverage reports
39 | htmlcov/
40 | .tox/
41 | .coverage
42 | .coverage.*
43 | .cache
44 | nosetests.xml
45 | coverage.xml
46 | *,cover
47 |
48 | # Translations
49 | *.mo
50 | *.pot
51 |
52 | # Django stuff:
53 | *.log
54 |
55 | # Sphinx documentation
56 | docs/_build/
57 |
58 | # PyBuilder
59 | target/
60 |
61 | # Created by .ignore support plugin (hsz.mobi)
62 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/Procfile:
--------------------------------------------------------------------------------
1 | web: python app.py
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Dialogflow - sample webhook implementation in Python
2 |
3 | This is a really simple webhook implementation that gets Dialogflow classification JSON (i.e. a JSON output of Dialogflow /query endpoint) and returns a fulfillment response.
4 |
5 | More info about Dialogflow webhooks could be found here:
6 | [Dialogflow Webhook](https://dialogflow.com/docs/fulfillment)
7 |
8 | # Deploy to:
9 | [](https://heroku.com/deploy)
10 |
11 | # Deploy to Google Cloud Platform App Engine
12 |
13 | Create an account on [Google Cloud Platform](http://console.cloud.google.com)
14 | Open the Cloud Shell (Top Right Corner)
Select the Project.
15 |
16 | ```
17 | git clone https://github.com/xVir/apiai-python-webhook
18 | cd apiai-python-webhook
19 | gcloud app create
20 | gcloud app deploy
21 | gcloud app browse
22 | ```
23 | you will get the URL (append /webhook) =>http://[your-project-id].appspot.com/webhook
24 |
25 | # What does the service do?
26 | It's a weather information fulfillment service that uses [Yahoo! Weather API](https://developer.yahoo.com/weather/).
27 | The services takes the `geo-city` parameter from the action, performs geolocation for the city and requests weather information from Yahoo! Weather public API.
28 |
29 | The service packs the result in the Dialogflow webhook-compatible response JSON and returns it to Dialogflow.
30 |
--------------------------------------------------------------------------------
/app.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Dialogflow webhook",
3 | "description": "Dialogflow webhook demonstration",
4 | "repository": "https://github.com/api-ai/apiai-weather-webhook-sample",
5 | "logo": "http://xvir.github.io/img/apiai.png",
6 | "keywords": ["api.ai", "dialogflow", "natural language"]
7 | }
8 |
--------------------------------------------------------------------------------
/app.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 |
3 | import urllib
4 | import json
5 | import os
6 |
7 | from flask import Flask
8 | from flask import request
9 | from flask import make_response
10 |
11 | # Flask app should start in global layout
12 | app = Flask(__name__)
13 |
14 |
15 | @app.route('/webhook', methods=['POST'])
16 | def webhook():
17 | req = request.get_json(silent=True, force=True)
18 |
19 | print("Request:")
20 | print(json.dumps(req, indent=4))
21 |
22 | res = processRequest(req)
23 |
24 | res = json.dumps(res, indent=4)
25 | # print(res)
26 | r = make_response(res)
27 | r.headers['Content-Type'] = 'application/json'
28 | return r
29 |
30 |
31 | def processRequest(req):
32 | if req.get("result").get("action") != "yahooWeatherForecast":
33 | return {}
34 | baseurl = "https://query.yahooapis.com/v1/public/yql?"
35 | yql_query = makeYqlQuery(req)
36 | if yql_query is None:
37 | return {}
38 | yql_url = baseurl + urllib.urlencode({'q': yql_query}) + "&format=json"
39 | print(yql_url)
40 |
41 | result = urllib.urlopen(yql_url).read()
42 | print("yql result: ")
43 | print(result)
44 |
45 | data = json.loads(result)
46 | res = makeWebhookResult(data)
47 | return res
48 |
49 |
50 | def makeYqlQuery(req):
51 | result = req.get("result")
52 | parameters = result.get("parameters")
53 | city = parameters.get("geo-city")
54 | if city is None:
55 | return None
56 |
57 | return "select * from weather.forecast where woeid in (select woeid from geo.places(1) where text='" + city + "')"
58 |
59 |
60 | def makeWebhookResult(data):
61 | query = data.get('query')
62 | if query is None:
63 | return {}
64 |
65 | result = query.get('results')
66 | if result is None:
67 | return {}
68 |
69 | channel = result.get('channel')
70 | if channel is None:
71 | return {}
72 |
73 | item = channel.get('item')
74 | location = channel.get('location')
75 | units = channel.get('units')
76 | if (location is None) or (item is None) or (units is None):
77 | return {}
78 |
79 | condition = item.get('condition')
80 | if condition is None:
81 | return {}
82 |
83 | # print(json.dumps(item, indent=4))
84 |
85 | speech = "Today in " + location.get('city') + ": " + condition.get('text') + \
86 | ", the temperature is " + condition.get('temp') + " " + units.get('temperature')
87 |
88 | print("Response:")
89 | print(speech)
90 |
91 | slack_message = {
92 | "text": speech,
93 | "attachments": [
94 | {
95 | "title": channel.get('title'),
96 | "title_link": channel.get('link'),
97 | "color": "#36a64f",
98 |
99 | "fields": [
100 | {
101 | "title": "Condition",
102 | "value": "Temp " + condition.get('temp') +
103 | " " + units.get('temperature'),
104 | "short": "false"
105 | },
106 | {
107 | "title": "Wind",
108 | "value": "Speed: " + channel.get('wind').get('speed') +
109 | ", direction: " + channel.get('wind').get('direction'),
110 | "short": "true"
111 | },
112 | {
113 | "title": "Atmosphere",
114 | "value": "Humidity " + channel.get('atmosphere').get('humidity') +
115 | " pressure " + channel.get('atmosphere').get('pressure'),
116 | "short": "true"
117 | }
118 | ],
119 |
120 | "thumb_url": "http://l.yimg.com/a/i/us/we/52/" + condition.get('code') + ".gif"
121 | }
122 | ]
123 | }
124 |
125 | facebook_message = {
126 | "attachment": {
127 | "type": "template",
128 | "payload": {
129 | "template_type": "generic",
130 | "elements": [
131 | {
132 | "title": channel.get('title'),
133 | "image_url": "http://l.yimg.com/a/i/us/we/52/" + condition.get('code') + ".gif",
134 | "subtitle": speech,
135 | "buttons": [
136 | {
137 | "type": "web_url",
138 | "url": channel.get('link'),
139 | "title": "View Details"
140 | }
141 | ]
142 | }
143 | ]
144 | }
145 | }
146 | }
147 |
148 | print(json.dumps(slack_message))
149 |
150 | return {
151 | "speech": speech,
152 | "displayText": speech,
153 | "data": {"slack": slack_message, "facebook": facebook_message},
154 | # "contextOut": [],
155 | "source": "apiai-weather-webhook-sample"
156 | }
157 |
158 |
159 | if __name__ == '__main__':
160 | port = int(os.getenv('PORT', 5000))
161 |
162 | print("Starting app on port %d" % (port))
163 |
164 | app.run(debug=False, port=port, host='0.0.0.0')
165 |
--------------------------------------------------------------------------------
/app.yaml:
--------------------------------------------------------------------------------
1 | runtime: python
2 | env: flex
3 | entrypoint: python app.py
4 |
5 | runtime_config:
6 | python_version: 2
7 |
8 | # This sample incurs costs to run on the App Engine flexible environment.
9 | # The settings below are to reduce costs during testing and are not appropriate
10 | # for production use. For more information, see:
11 | # https://cloud.google.com/appengine/docs/flexible/python/configuring-your-app-with-app-yaml
12 | manual_scaling:
13 | instances: 1
14 | resources:
15 | cpu: 1
16 | memory_gb: 0.5
17 | disk_size_gb: 10
18 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | Flask==0.12.3
2 |
--------------------------------------------------------------------------------
/runtime.txt:
--------------------------------------------------------------------------------
1 | python-2.7.15
2 |
--------------------------------------------------------------------------------