├── bot_db.txt ├── package.json ├── README.md ├── bot.js └── LICENSE /bot_db.txt: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Bot.js", 3 | "version": "1.0.0", 4 | "description": "A Node JS Twitter bot that periodically searches for tweets and then like, reply and follow automatically.", 5 | "main": "bot.js", 6 | "scripts": { 7 | "start": "node bot.js", 8 | "test": "node bot.js" 9 | }, 10 | "keywords": [ 11 | "node", 12 | "js", 13 | "twitter", 14 | "bot", 15 | "carlos", 16 | "torres" 17 | ], 18 | "author": "Carlos E. Torres (carlos.torres@cacira.com)", 19 | "license": "http://www.apache.org/licenses/LICENSE-2.0", 20 | "dependencies": { 21 | "twit": "^2.2.5" 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Twitter Bot 2 | 3 | A Node JS Twitter bot that periodically searches for tweets and then like, reply and follow automatically. 4 | It can be used for advertisement, promotions etc. But please use it carefully to avoid spam. 5 | 6 | * Bot saves tweets ids already processed to avoid interact with the same ones again. 7 | * Bot randomly selects each time from the list TWEETS_TO_REPLY one tweet to reply. 8 | * Bot automatically adds the original tweet's user handle to the reply, as a mention. 9 | * Bot logs to the console the tweet's id's that were processed each time. 10 | 11 | ## Configuration 12 | 13 | These are the configuration settings you should change accordingly to what you need. Twitter API keys must be entered. You have to create a Twitter app accessing [Twitter Application Management website](https://apps.twitter.com/). From there you can get the four keys to enter in the configuration. 14 | 15 | ```javascript 16 | // Set Twitter API keys 17 | var TWITTER_CONSUMER_KEY = ''; 18 | var TWITTER_CONSUMER_SECRET = ''; 19 | var TWITTER_ACCESS_TOKEN = ''; 20 | var TWITTER_ACCESS_TOKEN_SECRET = ''; 21 | 22 | // Database file 23 | var DB_FILE = "bot_db.txt"; 24 | 25 | // Set interval time. Try to use a not so small interval to avoid Twitter to lock your account. 26 | var INTERVAL = 3*60*60*1000; // 3 hours 27 | 28 | // Set Twitter search phrase. You can use hash tags or simples text. Hash tags works better. Separate with OR or AND. 29 | var TWITTER_SEARCH_PHRASE = '#AGoodHashTag OR #AnotherOne OR #MyGreatSearch'; 30 | 31 | // Set max number of tweets to get on the search results each time 32 | var TWITTER_SEARCH_MAX_RESULTS = 20; 33 | 34 | // Set tweets to reply 35 | var TWEETS_TO_REPLY = [ 36 | "Write something to reply.", 37 | "Bot will randomly pick one of the tweets to send.", 38 | "Try to be very natural and human like on the replies.", 39 | "Use the main Twitter handle you want to promote in all options. @MyHandle", 40 | "Create 5 to 10 replies. The more options the more natural bot will look." 41 | ]; 42 | ``` 43 | 44 | You can also tweak the Twitter query to better suit your needs. I'm querying for most recent tweets in English. But you can change the result_type and lang. 45 | 46 | ```javascript 47 | var query = { 48 | q: TWITTER_SEARCH_PHRASE, 49 | result_type: "recent", 50 | lang: 'en', 51 | count: TWITTER_SEARCH_MAX_RESULTS 52 | } 53 | ``` 54 | 55 | ## Installation 56 | 57 | You should have [Node](https://nodejs.org/en/) installed on your system. 58 | I'm using the [Twit](https://github.com/ttezel/twit) module for Twitter API access. 59 | But don't worry, you just have to run this command to install all dependencies. 60 | 61 | ``` 62 | npm install 63 | ``` 64 | 65 | ## Usage 66 | 67 | Just run the following command and bot will start and stay in memory running until you want stop it, by typing CTRL+C. 68 | 69 | ``` 70 | npm start 71 | ``` 72 | 73 | ## Contributing 74 | 75 | * Create something great, make the code better, add some functionality, 76 | whatever (this is the hardest part). 77 | * [Fork it](http://help.github.com/forking/) 78 | * Create new branch to make your changes 79 | * Commit all your changes to your branch 80 | * Submit a [pull request](http://help.github.com/pull-requests/) 81 | 82 | ## Contact 83 | 84 | Feel free to get in touch. 85 | 86 | * Website: 87 | * My company (Cacira): 88 | * Twitter: [@cetorres](http://twitter.com/cetorres) 89 | -------------------------------------------------------------------------------- /bot.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * Bot.js 3 | * A Node JS Twitter bot that periodically searches for tweets and then like, reply and follow automatically. 4 | * The bot saves tweets ids already processed to avoid interact with the same ones again. 5 | * Version 1.0.0 6 | * Created by Carlos E. Torres (carlos.torres@cacira.com) 7 | * http://cacira.com 8 | * http://cetorres.com 9 | * Date: 02/09/2017 10 | */ 11 | 12 | // Create object reference to libs 13 | var Twit = require('twit'); 14 | var fs = require('fs'); 15 | 16 | // Set Twitter API keys 17 | var TWITTER_CONSUMER_KEY = ''; 18 | var TWITTER_CONSUMER_SECRET = ''; 19 | var TWITTER_ACCESS_TOKEN = ''; 20 | var TWITTER_ACCESS_TOKEN_SECRET = ''; 21 | 22 | // Database file 23 | var DB_FILE = "bot_db.txt"; 24 | 25 | // Set interval time. Try to use a not so small interval to avoid Twitter to lock your account. 26 | var INTERVAL = 3*60*60*1000; // 3 hours 27 | 28 | // Set Twitter search phrase. You can use hash tags or simples text. Hash tags works better. Separate with OR or AND. 29 | var TWITTER_SEARCH_PHRASE = '#AGoodHashTag OR #AnotherOne OR #MyGreatSearch'; 30 | 31 | // Set max number of tweets to get on the search results each time 32 | var TWITTER_SEARCH_MAX_RESULTS = 20; 33 | 34 | // Set tweets to reply 35 | var TWEETS_TO_REPLY = [ 36 | "Write something to reply.", 37 | "Bot will randomly pick one of the tweets to send.", 38 | "Try to be very natural and human like on the replies.", 39 | "Use the main Twitter handle you want to promote in all options. @MyHandle", 40 | "Create 5 to 10 replies. The more options the more natural bot will look." 41 | ]; 42 | 43 | // Init Twit lib 44 | var Bot = new Twit({ 45 | consumer_key: TWITTER_CONSUMER_KEY, 46 | consumer_secret: TWITTER_CONSUMER_SECRET, 47 | access_token: TWITTER_ACCESS_TOKEN, 48 | access_token_secret: TWITTER_ACCESS_TOKEN_SECRET 49 | }); 50 | 51 | function BotStart() { 52 | 53 | var query = { 54 | q: TWITTER_SEARCH_PHRASE, 55 | result_type: "recent", 56 | lang: 'en', 57 | count: TWITTER_SEARCH_MAX_RESULTS 58 | } 59 | 60 | console.log("> Twitter bot is running (" + Date() + ")...") 61 | 62 | Bot.get('search/tweets', query, BotQueryResults); 63 | 64 | function BotQueryResults (error, data, response) { 65 | if (error) { 66 | console.log('Bot could not find tweets matching the query: ' + error); 67 | } 68 | else { 69 | 70 | // DB file 71 | var bot_db = []; 72 | 73 | // If db file doesn't exist, create empty file 74 | if (!fs.existsSync(DB_FILE)) { 75 | fs.closeSync(fs.openSync(DB_FILE, 'w')); 76 | } 77 | 78 | fs.readFile(DB_FILE, 'utf8', function (err, fileData) { 79 | if (!err) { 80 | fileData = fileData.trim(); 81 | if (fileData != "") { 82 | bot_db = fileData.split("\n"); 83 | } 84 | 85 | var processed_tweets = []; 86 | 87 | for (var i = 0; i < data.statuses.length; i++) { 88 | 89 | // Tweet id 90 | var id = data.statuses[i].id_str; 91 | 92 | // User id and handle 93 | var userId = data.statuses[i].user.id_str; 94 | var userHandle = data.statuses[i].user.screen_name; 95 | 96 | // If id doesn't exist on database, process it 97 | if (bot_db.indexOf(id) == -1) { 98 | 99 | processed_tweets.push(id); 100 | 101 | fs.appendFile(DB_FILE, id + "\n", function (err) { 102 | if (err) { 103 | console.log("Error on save to '" + DB_FILE + "' file."); 104 | } 105 | }); 106 | 107 | // Like 108 | Bot.post('favorites/create', {id: id}, function(err, response){ 109 | if (err) { 110 | console.log("> Error: Tweet " + id + " could not be favorited. " + err); 111 | } 112 | }); 113 | 114 | // Reply 115 | var textToReply = TWEETS_TO_REPLY[Math.floor(Math.random()*TWEETS_TO_REPLY.length)]; 116 | textToReply = "Hey @" + userHandle + ". " + textToReply; 117 | Bot.post('statuses/update', {status: textToReply, in_reply_to_status_id: id}, function(err, response){ 118 | if (err) { 119 | console.log("> Error: Status could not be updated. " + err); 120 | } 121 | }); 122 | 123 | // Follow 124 | Bot.post('friendships/create', {user_id: userId, follow: "true"}, function(err, response){ 125 | if (err) { 126 | console.log("> Error: Could not follow user " + userId + ". " + err); 127 | } 128 | }); 129 | 130 | } 131 | 132 | } 133 | 134 | // Log of processed tweets 135 | if (processed_tweets.length > 0) { 136 | console.log("> Tweets processed: " + processed_tweets); 137 | } 138 | else { 139 | console.log("> No tweets processed."); 140 | } 141 | 142 | } 143 | }); 144 | 145 | } 146 | 147 | } 148 | 149 | } 150 | 151 | // Start bot and timer 152 | BotStart(); 153 | setInterval(BotStart, INTERVAL); 154 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------