screwgoth / jugheadbot Goto Github PK

JugheadBot is Facebook Messenger Bot application which fetches information about Restaurants using the Zomato API. It's a Zomato Chatbot

Home Page: https://www.facebook.com/JugheadBot/

License: MIT License

Python 100.00%

python3 django django-rest-framework chatbot chatbot-facebook zomato-api

jugheadbot's Introduction

JugheadBot

JugheadBot is a Facebook Messenger Bot application that I wrote to learn about ChatBots.

What does JugheadBot do

Once you start chatting with JugheadBot, he can basically answer simple questions like:

Where can I find the best restaurants in Mahim, Mumbai
Where can I find Chinese restaurants in Kothrud, Pune

JugheadBot Internals

JugheadBot is a Python Django application which uses the Facebook Messenger Platform APIs to chat with users and the Zomato API to fetch information about the Restaurants. It also does NLP and ML using Google's API.ai framework

Licensing

The code in this project is licensed under the MIT License. Please refer to the LICENSE file for more information

Development / Contributing

Author

Raseel Bhagat

Please mail the Author if you are interested in contributing back or have some good ideas to enhance the JugheadBot experience.

jugheadbot's People

Contributors

Stargazers

Watchers

Forkers

cayemites1

jugheadbot's Issues

Create a 1024x1024 pixel JugheadBot App Icon for Facebook

Create a 1024x1024 pixel JugheadBot App Icon for Facebook. This is required for Facebook App Review and for JugheadBot to go public

Accept Postbacks and save them to DB

Accept Postbacks from Facebook, like "Get Started" and Ratings. And save the same in a table in the DB

The Review link in the FB card should redirect to Review page

Currently when a Review FB card is shown, the link redirects to the Menu URL. It should redirect to the Menu URL

Create a "Privacy Policy" document for JugheadBot Facebook App

Create a "Privacy Policy" document for JugheadBot Facebook App. Host it on a URL since the link needs to be used for Facebook App.

Get Restaurants in City by Cuisine

Currently Jughead only gets the Top 5 Restaurants in any city. Enable Jughead to get the Top 5 radius in a radius of 5Km of a specific area, for a specific Cuisine.

Get Reviews of Specific Restaurants

The JugheadBot should be able to get the Reviews of specified Restaurants. For example, if asked "Show we reviews of Mainland China", JugheadBot should be able to return something like "4.5/5" and a link to the Reviews section on Zomato

Add a Help section to the Menu

Add a "Help" section to the messenger menu, so that the user is reminded of the the types of questions he can ask JugheadBot

Create a class for Facebook Responses.

Create a Facebook class for different types of Responses

Check for non-exisiting paramerters in FB userInfo

The call to get Facebook userInfo might not return all the request parameters. For example, an empty "gender" or "last name" field.
Check for existence of the field, before making the DB call.
Use default values wherever possible.

Start saving User info

Start saving all the information of the user who is interacting with JugheadBot. This should be User's FB ID, questions asked, time of chat, etc.

Get Restaurants from Area

Currently, JugheadBot fetches best restaurants for only Cities. Ideally, it should be able to fetch from areas like "Kothrud, Pune" or "Mahim, Mumbai"

Get Zomato user-key from environment

Currently the user-key for Zomato API is hardcoded. Get this from the environment

Response to a new user

When a new user starts interacting with JugheadBot by clicking on the "Get Started" button on FB Messenger, give a short introduction with examples of the kind of questions a user can ask.