├── .gitignore
├── package.json
├── LICENSE.txt
├── README.md
└── autotweet


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | settings.json


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "autotweet",
 3 |   "version": "1.0.0",
 4 |   "description": "A simple script for automatically generating tweets for twitter",
 5 |   "main": "autotweet.js",
 6 |   "dependencies": {
 7 |     "twitter": "~0.2.7"
 8 |   },
 9 |   "devDependencies": {},
10 |   "scripts": {
11 |     "test": "echo \"Error: no test specified\" && exit 1"
12 |   },
13 |   "repository": {
14 |     "type": "git",
15 |     "url": "https://github.com/WaldoHatesYou/autotweet.git"
16 |   },
17 |   "keywords": [
18 |     "twitter",
19 |     "markov",
20 |     "automatic"
21 |   ],
22 |   "author": "Javed Nissar",
23 |   "license": "BSD-2-Clause",
24 |   "bugs": {
25 |     "url": "https://github.com/WaldoHatesYou/autotweet/issues"
26 |   }
27 | }
28 | 


--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2014, Javed Nissar
 2 | All rights reserved.
 3 | 
 4 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 5 | 
 6 | 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 7 | 
 8 | 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 9 | 
10 | 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11 | 
12 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # autotweet.js
 2 | 
 3 | ## What is it?
 4 | 
 5 | autotweet.js is a simple node.js script that randomly generates some text from a list of sentences (using a [Markov Chain](https://en.wikipedia.org/wiki/Markov_chain)) and
 6 | then posts it as a tweet on twitter.
 7 | 
 8 | ## How Do I use it?
 9 | 
10 | Before you try using autotweet.js, you'll need to have a [twitter](https://twitter.com) account and you'll need to have [node.js](http://nodejs.org) installed on your computer. After you have that done and over with, just clone autotweet.js from github.
11 | ```Batchfile
12 | git clone https://github.com/WaldoHatesYou/autotweet.git
13 | ```
14 | Then, go to the "autotweet" directory and write out a "settings.json" file. The "settings.json" file should contain the information that is required to post to your twitter account (api consumer key, api consumer secret, api access token key, and api access token secret) as well as a list of sentences that is to be included in the corpus field of the "settings.json" file. An example is shown below.
15 | ```Javascript
16 | {
17 | 	"consumer_key":"Insert key here",
18 | 	"consumer_secret":"Insert consumer secret here",
19 | 	"access_token_key":"Insert access token key here",
20 | 	"access_token_secret":"Insert access token secret here",
21 | 	"corpus":[
22 | 		"Hi, I am a sentence in a corpus",
23 | 		"Is this sentence awesome or is this sentence really awesome?",
24 | 		"Strawberry fields forever"
25 | 	]
26 | }
27 | ```
28 | After you're done that, grab the node-twitter library using the following command.
29 | ```Batchfile
30 | npm init
31 | ```
32 | Once that finishes, convert your node.js script file into an executable by executing the following command.
33 | ```Batchfile
34 | chmod+x autotweet
35 | ```
36 | If you finished that step, you can now start sending tweets by typing the following command into your command line.
37 | ```Batchfile
38 | ./autotweet
39 | ```
40 | Of course, if you want to, you can place your settings file in a different location with a name other than
41 | "settings.json". If you do this, you will have to pass the location of the json file to autotweet like this.
42 | ```Batchfile
43 | ./autotweet ~/Documents/settings.json
44 | ```
45 | 


--------------------------------------------------------------------------------
/autotweet:
--------------------------------------------------------------------------------
  1 | #! /usr/local/bin/node
  2 | 
  3 | var twitter=require('twitter');
  4 | var fs=require('fs');
  5 | var util=require('util');
  6 | 
  7 | /* Returns a random integer between min and max
  8 | Using Math.round() will give you a non-uniform distribution!
  9 | This code is from Mozilla Developer Network*/
 10 | function getRandomInt(min, max) {
 11 |   return Math.floor(Math.random() * (max - min + 1)) + min;
 12 | }
 13 | 
 14 | //MARKOV CHAIN CODE
 15 | //Define the initialization of the generator
 16 | function MarkovChainGenerator(corpus){
 17 | 	//create some variables to hold the data we need
 18 | 	this.transitionMatrix={};
 19 | 	var numbers={};
 20 | 	var collection={}
 21 | 	//first get the number of times every word occurs after every other word, we need this for the probability calculations
 22 | 	for(var x=0;x<corpus.length;x++){
 23 | 		//split a sentence from the corpus into tokens
 24 | 		var sentenceTokens=corpus[x].split(" ");
 25 | 		//for every token
 26 | 		for(var y=0;y<sentenceTokens.length;y++){
 27 | 			if(y!==sentenceTokens.length-1){
 28 | 				var token=sentenceTokens[y];
 29 | 				/*create a new array if the token isn't already in the collection
 30 | 				 This array will store every instance of another token appearing after
 31 | 				 this token*/
 32 | 				if(collection[token]===undefined){
 33 | 					collection[token]=[];
 34 | 				}
 35 | 				//add whatever word is after that token
 36 | 				collection[token].push(sentenceTokens[y+1]);
 37 | 			}
 38 | 		}
 39 | 	}
 40 | 	//for every token we found in the first for loop
 41 | 	for(var token in collection){
 42 | 		//grab the list of tokens after that token
 43 | 		var occurences=collection[token];
 44 | 		//create an object to hold the number of occurences of every token that occurs after the token
 45 | 		//ex. {"a":5,"I":6,"am":7}
 46 | 		numbers[token]={};
 47 | 		for(var i=0;i<occurences.length;i++){
 48 | 			occurence=occurences[i];
 49 | 			if(numbers[token][occurence]===undefined){
 50 | 				numbers[token][occurence]=1;
 51 | 			}else{
 52 | 				//increment for every appearance of a token
 53 | 				numbers[token][occurence]++;
 54 | 			}
 55 | 		}
 56 | 	}
 57 | 	//run the final calculations for the transition matrix
 58 | 	for(var token in numbers){
 59 | 		this.transitionMatrix[token]={}
 60 | 		total=Object.keys(numbers[token]).length;
 61 | 		for(var state in numbers[token]){
 62 | 			this.transitionMatrix[token][state]=numbers[token][state]/total;
 63 | 		}
 64 | 	}
 65 | }
 66 | //Define two functions required
 67 | MarkovChainGenerator.prototype={
 68 | 	//generate word
 69 | 	//token is a word in the transition matrix
 70 | 	generateWord:function(token){
 71 | 		//prevent undefined from being entered
 72 | 		if(token!==undefined){
 73 | 			//init object containing all possibilities for this particular state
 74 | 			var possibilities={};
 75 | 			for(var possibility in this.transitionMatrix[token]){
 76 | 				possibilities[possibility]={"probability":0,"complete":false};
 77 | 				possibilities[possibility]["probability"]=Math.round(this.transitionMatrix[token][possibility]*100);
 78 | 			}
 79 | 			//init array to hold a bunch of states
 80 | 			/*the purpose of this array is to essentially be a bag which contains enough of each state that the probability of picking one of those states
 81 | 			from the bag is low*/
 82 | 			/*ex. with states [1,2] where 1 has a probability of 75% and 2 has a probability of 25%, the for loop will produce [1 repeated 75 times]
 83 | 			concatenated with [2 repeated 25 times]*/
 84 | 			var array=[];
 85 | 			var keys=Object.keys(possibilities);
 86 | 			for(var x=0;x<keys.length;x++){
 87 | 				var key=keys[x];
 88 | 				//keep adding this key to array until y exceeds the probability stated
 89 | 				for(var y=0;y<possibilities[key]["probability"];y++){
 90 | 					array.push(key);
 91 | 				}
 92 | 			}
 93 | 			return array[getRandomInt(0,array.length)];
 94 | 		}else{
 95 | 			//if token is not actual token return undefined
 96 | 			return undefined;
 97 | 		}
 98 | 	},
 99 | 	//generate entire sentences
100 | 	generateSentence:function(length){
101 | 		//generate an array where the first element is a random word from the transition matrix
102 | 		var sentence=[Object.keys(this.transitionMatrix)[getRandomInt(0,Object.keys(this.transitionMatrix).length)]];
103 | 		for(var i=1;i<length-1;i++){
104 | 			//generate a word
105 | 			var generatedWord=this.generateWord(sentence[i-1]);
106 | 			//if the word returned is not a word, we've reached the end of the markov chain
107 | 			if(generatedWord===undefined){
108 | 				console.log("reached end of markov chain");
109 | 				return sentence.join(" ");
110 | 			}else{
111 | 				sentence.push(generatedWord);
112 | 			}
113 | 		}
114 | 		return sentence.join(" ");
115 | 	}
116 | }
117 | //read the settings.json file
118 | function readSettings(err,fd){
119 | 	if(err){
120 | 		return console.log(err);
121 | 	}else{
122 | 		var settings=JSON.parse(fd);
123 | 		//authorize using twitter
124 | 		var twit=new twitter({
125 | 			consumer_key:settings.consumer_key,
126 | 			consumer_secret:settings.consumer_secret,
127 | 			access_token_key:settings.access_token_key,
128 | 			access_token_secret:settings.access_token_secret
129 | 		});
130 | 		//set up text generator
131 | 		var generator=new MarkovChainGenerator(settings.corpus);
132 |     //tweet generated sentence
133 | 		twit.verifyCredentials(function(data) {
134 |         	console.log("credentials verified");
135 |     	}).updateStatus(generator.generateSentence(5),
136 |         	function(data) {
137 |             	console.log("tweet sent");
138 |         	}
139 |     	);
140 | 	};
141 | }
142 | //if the user has not input any additional arguments
143 | if(process.argv.length!=3){
144 |   var settingsLocation="./settings.json";
145 | }else{
146 |   var settingsLocation=process.argv[2];
147 | }
148 | 
149 | fs.readFile(settingsLocation,'utf8',readSettings);
150 | 


--------------------------------------------------------------------------------