├── .github └── FUNDING.yml ├── .gitignore ├── LICENSE.txt ├── Procfile ├── README.md ├── bot.js ├── config.js └── package.json /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | ko_fi: nisrulz 4 | liberapay: nisrulz 5 | custom: https://www.paypal.me/nisrulz/5usd 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2016 Nishant Srivastava 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /Procfile: -------------------------------------------------------------------------------- 1 | worker: node bot.js -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # **TwitterBot-NodeJS** 2 | 3 | ### Show some :heart: 4 | [![GitHub stars](https://img.shields.io/github/stars/nisrulz/twitterbot-nodejs.svg?style=social&label=Star)](https://github.com/nisrulz/twitterbot-nodejs) [![GitHub forks](https://img.shields.io/github/forks/nisrulz/twitterbot-nodejs.svg?style=social&label=Fork)](https://github.com/nisrulz/twitterbot-nodejs/fork) [![GitHub watchers](https://img.shields.io/github/watchers/nisrulz/twitterbot-nodejs.svg?style=social&label=Watch)](https://github.com/nisrulz/twitterbot-nodejs) [![GitHub followers](https://img.shields.io/github/followers/nisrulz.svg?style=social&label=Follow)](https://github.com/nisrulz/twitterbot-nodejs) 5 | [![Twitter Follow](https://img.shields.io/twitter/follow/nisrulz.svg?style=social)](https://twitter.com/nisrulz) 6 | 7 | Yeah it pretty much does what it says in the title. Its a twitter bot which can post tweets, retweet other tweets and possibly fav tweets. 8 | 9 | This is a simple bot , to build which I had to go through a lot of information on the internet possibly because it wasn't updated/consistent. Plus I wanted to learn how build a bot anyhow ;) 10 | 11 | Currently active bot using the same code is [GDGND Bot](https://twitter.com/gdgndbot). 12 | Hopefully it helps some other people who want to build their own bot. 13 | 14 | Simple.Easy.Cute (Ok, last one didnot go with the flow..) 15 | 16 | > It attempts to retweet once per hour 17 | 18 | 19 | ## Installation 20 | 21 | + Install [Node.js](http://nodejs.org/) 22 | + Clone this repo 23 | 24 | ```bash 25 | git clone https://github.com/nisrulz/twitterbot-nodejs.git 26 | ``` 27 | + Run 28 | ```bash 29 | npm install 30 | ``` 31 | 32 | > It will install [Twit](https://github.com/ttezel/twit), the library that lets us talk to Twitter. 33 | 34 | ## Connecting to Twitter 35 | 36 | 1. Register a Twitter account and also get its "app info". 37 | >Twitter doesn't allow you to register multiple twitter accounts on the same email address. I recommend you create a brand new email address (perhaps using Gmail) for the Twitter account. Once you register the account to that email address, wait for the confirmation email. 38 | 39 | 1. Now go [here](https://dev.twitter.com/apps/new) and log in as the Twitter account for your bot: 40 | 1. Fill up the form and submit. 41 | 1. Next once the submission completes you will be taken to a page which has the 42 | + "Settings" tab : Update details here 43 | + "Permissons" tab : Enable `Read and Write` 44 | + "Key and Access Token" tab : Click on `Create my access token`. 45 | 1. Use the generated tokens in the "Key and Access Token" tab to fill the fields under the `config.js` file in your app directory. 46 | It should look like this: 47 | 48 | ```javascript 49 | module.exports = { 50 | consumer_key: 'blah', 51 | consumer_secret: 'blah', 52 | access_token: 'blah', 53 | access_token_secret: 'blah' 54 | } 55 | ``` 56 | 1. Update the code under `bot.js` , with the your values. Best of all modify the code, tinker with it. 57 | 1. Now type the following in the command line in your project directory: 58 | 59 | ```bash 60 | node bot.js 61 | ``` 62 | 63 | Hopefully at this point you see a message like "Success! Check your bot, it should have retweeted something." 64 | Ok it won't say that, you have to code that in. Its simple as 65 | 66 | ```javascript 67 | console.log("Success! Check your bot, it should have retweeted something."); 68 | ``` 69 | 70 | Check the Twitter account for your bot, and it should have retweeted a tweet with the provided hashtag. 71 | 72 | 73 | ### **Whats Next** 74 | 75 | You might want to push this app to a running server , probably [heroku](https://www.heroku.com/). 76 | 77 | > Note : Heroku servers would go back to sleep if there is no activity after some time, so you can have a look at [Kaffeine](https://kaffeine.herokuapp.com/) , to keep your server active. 78 | > 79 | > Do not misuse the twitter api to spam or burden the server load for twitter api , as twitter follows a strict rule of closing down accounts that do that. Please read [here for the rules](https://support.twitter.com/articles/18311) 80 | 81 | ### Contribute 82 | + **Star** - If you like it 83 | + **Fork** - If you like to build your own version 84 | + **File an issue** - If you found a bug 85 | + **Send a pull request** - If you want to contribute 86 | 87 | #### Credits 88 | [Twit Library](https://github.com/ttezel/twit) 89 | 90 | 91 | If you appreciate my work, consider [buying me](https://www.paypal.me/nisrulz/5usd) a cup of :coffee: to keep me recharged :metal: [[PayPal](https://www.paypal.me/nisrulz/5usd)] 92 | 93 | License 94 | ======= 95 | 96 | Copyright 2016 Nishant Srivastava 97 | 98 | Licensed under the Apache License, Version 2.0 (the "License"); 99 | you may not use this file except in compliance with the License. 100 | You may obtain a copy of the License at 101 | 102 | http://www.apache.org/licenses/LICENSE-2.0 103 | 104 | Unless required by applicable law or agreed to in writing, software 105 | distributed under the License is distributed on an "AS IS" BASIS, 106 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 107 | See the License for the specific language governing permissions and 108 | limitations under the License. 109 | 110 | -------------------------------------------------------------------------------- /bot.js: -------------------------------------------------------------------------------- 1 | // Debug flag 2 | 3 | var debug = false 4 | 5 | // Twitter library 6 | var Twit = require('twit') 7 | 8 | //Check config file is filled. 9 | var config = require('./config.js') 10 | if(config.consumer_key == 'blah' || 11 | config.consumer_secret == 'blah' || 12 | config.access_token == 'blah' || 13 | config.access_token_secret == 'blah'){ 14 | 15 | console.log("You must fill your configuration file which is located /config.js"); 16 | return; 17 | } 18 | 19 | // We need to include our configuration file 20 | var T = new Twit(require('./config.js')) 21 | 22 | // This is the URL of a search for the latest tweets on the #hashtag. 23 | var hastagSearch = { q: '#hashtag', count: 10, result_type: 'recent' } 24 | 25 | // A user stream 26 | var stream = T.stream('user') 27 | // When someone follows the user 28 | stream.on('follow', followed) 29 | stream.on('tweet', tweetEvent) 30 | 31 | // In this callback we can see the name and screen name 32 | function followed (event) { 33 | var name = event.source.name 34 | var screenName = event.source.screen_name 35 | var response = 'Thanks for following me, ' + name + ' @' + screenName 36 | // Post that tweet! 37 | T.post('statuses/update', { status: response }, tweeted) 38 | 39 | console.log('I was followed by: ' + name + ' @' + screenName) 40 | } 41 | 42 | // Here a tweet event is triggered! 43 | function tweetEvent (tweet) { 44 | // If we wanted to write a file out 45 | // to look more closely at the data 46 | // var fs = require('fs') 47 | // var json = JSON.stringify(tweet,null,2) 48 | // fs.writeFile("tweet.json", json, output) 49 | 50 | // Who is this in reply to? 51 | var reply_to = tweet.in_reply_to_screen_name 52 | // Who sent the tweet? 53 | var name = tweet.user.screen_name 54 | // What is the text? 55 | var txt = tweet.text 56 | 57 | // Ok, if this was in reply to me 58 | // Replace selftwitterhandle with your own twitter handle 59 | console.log(reply_to, name, txt) 60 | if (reply_to === 'selftwitterhandle') { 61 | 62 | // Get rid of the @ mention 63 | txt = txt.replace(/@selftwitterhandle/g, '') 64 | 65 | // Start a reply back to the sender 66 | var reply = 'Hi @' + name + ' ' + ', Thanks for the mention :)' 67 | 68 | console.log(reply) 69 | // Post that tweet! 70 | T.post('statuses/update', { status: reply }, tweeted) 71 | } 72 | } 73 | 74 | // This function finds the latest tweet with the #hashtag, and retweets it. 75 | function retweetLatest () { 76 | T.get('search/tweets', hastagSearch, function (error, data) { 77 | var tweets = data.statuses 78 | for (var i = 0; i < tweets.length; i++) { 79 | console.log(tweets[i].text) 80 | } 81 | // If our search request to the server had no errors... 82 | if (!error) { 83 | // ...then we grab the ID of the tweet we want to retweet... 84 | var retweetId = data.statuses[0].id_str 85 | // ...and then we tell Twitter we want to retweet it! 86 | T.post('statuses/retweet/' + retweetId, {}, tweeted) 87 | } 88 | // However, if our original search request had an error, we want to print it out here. 89 | else { 90 | if (debug) { 91 | console.log('There was an error with your hashtag search:', error) 92 | } 93 | } 94 | }) 95 | } 96 | 97 | // Make sure it worked! 98 | function tweeted (err, reply) { 99 | if (err !== undefined) { 100 | console.log(err) 101 | } else { 102 | console.log('Tweeted: ' + reply) 103 | } 104 | } 105 | 106 | // Try to retweet something as soon as we run the program... 107 | retweetLatest() 108 | // ...and then every hour after that. Time here is in milliseconds, so 109 | // 1000 ms = 1 second, 1 sec * 60 = 1 min, 1 min * 60 = 1 hour --> 1000 * 60 * 60 110 | setInterval(retweetLatest, 1000 * 60 * 12) 111 | -------------------------------------------------------------------------------- /config.js: -------------------------------------------------------------------------------- 1 | // Put your own Twitter App keys here. See README.md for more detail. 2 | module.exports = { 3 | consumer_key: 'blah', 4 | consumer_secret: 'blah', 5 | access_token: 'blah', 6 | access_token_secret: 'blah' 7 | } 8 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "bot", 3 | "version": "1.0.0", 4 | "description": "Twitter Bot - NodeJS", 5 | "author": "Nishant Srivastava ", 6 | "dependencies": { 7 | "twit": "*" 8 | }, 9 | "scripts": { 10 | "start": "node bot.js" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "git://github.com/nisrulz/twitterbot-nodejs.git" 15 | }, 16 | "analyze": true, 17 | "license": "Apache-2.0" 18 | } 19 | --------------------------------------------------------------------------------