fossasia / susi_tweetbot Goto Github PK

View Code? Open in Web Editor NEW

1.5K 15.0 41.0 2.4 MB

Twitter Bot for Susi http://susi.ai

License: GNU Lesser General Public License v2.1

JavaScript 88.09% Shell 11.91%

susi_tweetbot's Introduction

susi_tweetbot

How to chat with Susi AI bot on Twitter

Visit your twitter account and tweet to @SusiAI1 with your query and enjoy a tweet back from the Susi AI bot account!

Also, you can enjoy personal chatting with Susi. Follow the SUSI AI account on twitter here and have a personal chat with it.

Getting Started : Twitter Susi AI Bot Installation

We will make a Susi messenger bot account on Twitter. This account will tweet back when it's name is mentioned in a tweet. Also, 1-on-1 auto chat will be inculcated to our account.

Make a new account, which you want to use as the bot account. You can make one from here.

Prerequisites

To create your account on -:

Twitter
Github
Heroku

Setup your own Messenger Bot

Fork this repository.
Make a new app here, to know the access token and other properties for our application. These properties will help us communicate with Twitter.

Click "modify the app permissions" link, as shown here:

Select the Read, Write and Access direct messages option:

Don't forget to click the update settings button at the bottom.

Click the Generate My Access Token and Token Secret button.

Create a new heroku app here.

This app will accept the requests from Twitter and Susi api.

Create a config variable by switching to settings page of your app.

The name of your first config variable should be HEROKU_URL and its value is the url address of the heroku app created by you.

The other config variables that need to be created will be these:

The corresponding names of these variables in the same order are:
1. Access token
2. Access token secret
3. Consumer key
4. Consumer secret
We need to visit our app from here, the keys and access tokens tab will help us with the values of these variables.
Connect the heroku app to the forked repository.

Connect the app to Github by selecting the name of this forked repository.

Deploy on development branch. If you intend to contribute, it is recommended to Enable Automatic Deploys.

Branch Deployment.

Successful Deployment.

Visit your own personal account and tweet to this new bot account with your query and enjoy a tweet back from the bot account!
Also, you can enjoy personal chatting with Susi.

Feel free to play around with the already made SUSI AI account on twitter here. Follow it, to have a personal chat with it.

susi_tweetbot's People

Contributors

Stargazers

Watchers

susi_tweetbot's Issues

Susi AI tweetbot replies with "undefined" for replies involving tables.

Screenshots of the issue:

Would you like to work on it?
Yes

Susi AI account on twitter doesn't reply to direct messages

Direct messages sent to SUSI AI account i.e. SusiAI1 on twitter.

Screenshots of the issue:

Would you like to work on this issue?
Yes.

To enable quick replies in Twitter SUSI bot.

During direct message, quick replies feature is not available. Something like this:

Screenshots:

Would you like to work on it?
Yes.

Implementing kubernetes deployment for SUSI tweetbot

Actual Behaviour

Currently, tweet bot is not deployed on Google container engine.

Expected Behaviour

It should be deployed on Google container engine using kubernetes.

Would you like to work on the issue?

Yes

SUSI replies to itself repeatedly when a user follows it.

SUSI chatbot falls into an infinite loop of replying with answers to itself when a new user follows the SUSI tweet bot.

Screenshots of the issue

Would you like to work on the issue?
Yes.

Adding GPL 3 License

Currently, there is no GPL3 License in this repository so I will add License.

Fix markdown for yaydoc

Actual Behaviour

The images aren't rendering in the generated docs.

Expected Behaviour

The images should render in the docs

Would you like to work on the issue?

Yes

Suggestions in the issue template should be commented out

Actual Behaviour

Suggestions are simply written in the issue template.

Expected Behaviour

Rather, they should be commented out so that contributor doesn't have to delete them manually.

Would you like to work on the issue?

Yes

Add app.json for heroku deployment and its auto deploy button

Actual Behaviour

Currently, there is no auto deployment button of Heroku and no app.json present.

Expected Behaviour

Adding app.json and thus auto-deployment button for Heroku.

Steps to reproduce it

Add steps to reproduce bugs or add information on the place where the feature should be implemented. Add links to a sample deployment or code.

LogCat for the issue

Provide logs for the crash here

Screenshots of the issue

Where-ever possible attach a screenshot of the issue.

Would you like to work on the issue?

Yes

To introduce buttons to the bot

To introduce buttons to the bot, wherever possible. Like this:

Screenshots of the issue

Would you like to work on the issue?
Yes, working on it.

Remove redundant files and hide config file

As you can see, I am keeping some access token, consumer key, and secret things in config.js.
It would be bad if other people get these code. Please suggest and fix the current situation.

Additionally, I'm wondering if we should keep node_modules folder as it can be generated by some lines of code (?).
:)

Bug in updating deployment image on each commit

Actual Behaviour

Currently, there is a bug due to which updates are not being pushed to kubernetes deployment.

Expected Behaviour

Deployment image should be updated

Would you like to work on the issue?

Yes

Showing location type response in Tweetbot

SUSI tweetbot is not able to show location type response in its replies. I will be following this article to achieve it.

Would you like to work on the issue?
Yes.

Susi tweetbot is not working.

susi_tweetbot is not working.

I tried tweeting to it and got no replies, which can be seen here:

Would you like to work on this issue?
Yes.

Repetetion of time in retweet.

When the susi server is down. The retweet by SUSI includes repetition of time.

Screenshot of the issue:

Would you like to work on it?
yes.

Heroku app constantly crashes

I deployed it on Heroku in order to keep Twitter bot alive. For some reasons, the app constantly crashes, giving the errors as in this screenshot.

Because of this, Susi on Twitter cannot be working.

To show a welcome message to a new user

No welcome message shown to the new users who chat with SUSI.

Would you like to work on the issue?
Yes.

Close issues automatically when a PR is merged

Actual Behaviour

Error in PR template. In PR template it says

Fixes issue #number

Expected Behaviour

Change this to

Fixes #number

This will close the issue automatically when PR is merged.
Title suggestion should be commented out.

Would you like to work on the issue?

Yes

Can't share replies by SUSI AI with other followers

We can't share replies with our followers. Something like the second option in the image below:

Screenshots of the issue

Would you like to work on the issue?
Yes, working on it.

Add auto-deployment button for Docker

Actual Behaviour

Currently, no auto-deployment button is present for Docker.

Expected Behaviour

Adding auto-deployment button for Docker.

Steps to reproduce it

Add steps to reproduce bugs or add information on the place where the feature should be implemented. Add links to a sample deployment or code.

LogCat for the issue

Provide logs for the crash here

Screenshots of the issue

Where-ever possible attach a screenshot of the issue.

Would you like to work on the issue?

Yeah

Tweet back to the user must have buttons with the message

We provide the user with some important buttons in SUSI AI chat window like this:

We should show the same buttons when we tweet back to the user, something like this:

Would you like to work on the issue?
Yes, working on it.

Showing users with fuzzy queries as in SUSI FBbot

Showing fuzzy queries as in SUSI FBbot like this:

Screenshots

Would you like to work on the issue?
Yes.

To show RSS or table replies as clickable links.

The web search results and universities should be shown like this:

Clicking on any result should redirect to the url corresponding to that result.
I will research, if this feature can be added to the SUSI Tweetbot.

Would you like to work on the issue?
Yes, working on it.

template for issues and PR's

No template for issues and PR's present.

To show an option to chat with SUSI.AI with direct messages

When SUSI.AI tweets back to the user with a reply. We can show a link to allow the user to switch to a personal chat if he/she wants to. Something like this:

Screenshots of the issue