ciolt / ntwitbot

Node.js Twitter ebooks bot

NTwitBot |

NTwitBot is an ongoing twitter ebooks bot project written in Node. It generates sentences from other user's tweet using a Markov's chain.

It is currently in beta stage and therefore might carry bugs and unintended actions (example: replying to every mention that exists on a clean run all at once [will be fixed]..)

Features

• JSON based configuration
• Track multiple users (bot tracks tweets of any user that it's following)
• Replies to mentions
• More features coming..

Installation & Setup

$ git clone https://github.com/jordansne/ntwitbot
$ cd ntwitbot
$ npm install

Next you will need to create an app with Twitter. Twitter will provide you with a consumer key & secret and access key & secret. This should be added to config/secret.js. Example:

// config/secret.js
module.exports = {
    "consumer_key" : "SQzVswCxkuZxkSsIilpkaeZOVVyDxRrWVFpHQjzI",
    "consumer_secret": "nNguyAftInTJxCdVxliBCgClETnkfZFuJABHgyKh",
    "access_token_key": "jkiUfXmRegiPHEZemJwsUFZmCWPokCxEJAnpmIdz",
    "access_token_secret": "ILdlTtmPABFfixUBfivuMbFRojKkrlKkoLzhSZAn"
};

Usage

$ npm start

Contributing

Pull requests are welcome. Before a PR please npm run test to ensure all tests pass.

License

This app is licensed under MIT.

ntwitbot's Issues

Document all functions in detail with JSDoc

Note: The ESLint style guide generates errors for missing or improper JSDoc comments.

Unacceptable Garbage

Stop this madness

This is too much for the Twitter API to handle, will get rate limited within seconds.

Add additional options for configuration

There is configuration missing for:

• Tweet capitalization
• Tweeting interval
• Option to use Markov or classic Tweet generation
• Minimum word count (no more than 140, and no less than 1)
• Maximum character count (no more than 280, and no less than 1)
• Callbacks for onMention, onRetweet, onLike, onFollow, etc.

A

Change how data updates work

Stream mentions and timeline instead of using a GET request every interval update.

Add option to choose who gets tracked

Include an option in the configuration to supply tracked users as either a static list (only @github and @microsoft), or a dynamic list (users on home timeline, etc.)

Add documentation with Twauth

Include instructions on how to obtain API keys with twauth in the README

Expand documentation

Document every function of the package in a docs/ folder