RTwitterBot

Bot for Twitter

Setup

Create Twitter application at https://apps.twitter.com/
Download Project / unzip / go to directory
Install dependances with npm install
Rename conf.twitter.app.sample.js to conf.twitter.app.js
Fill the file with name , consumer_key , consumer_secret , access_token_key , access_token_secret (callback_url is for user authentification)

Example

Once your twitter application created you can run the read job (you have to be in the project folder for launching it)

node job timeline "livecodingtv"

How to write job

Create a file in jobs folder, the filename is the job name
In job get a Twitter app by using getTwitterApp(name, endpoints)

if you provide no arguments the first Twitter app is returned
name (string or undefined - optionnal) : using a specific Twitter app
endpoints (array - optionnal) : return an available Twitter app which can use thoses endpoints (rate limit)

Documentation for the Twitter Client used here

PID watcher and killer

Jobs'list running (pid + job + options)

node pid

Kill a job

node pid kill {pidId}

Kill all jobs

node pid kill all

JOBS

hoover [word] -> use stream api to read tweets and download medias in medias folder
live [word] -> use stream pi to read tweets
onetweet [statuses_id] -> get one tweet with statuses id
retweet_all [word] -> use stream api to retweet all on your account
timeline [profile_name] -> read last tweet of someone
trend [woeid] -> list trend (if no woeid take WorldWide trend)
tweet [my tweet to tweet] -> push tweet

Tweet Model

var _tweet = new Tweet(tweet);

getJson()
getCreatedAt()
getTimestamp()
getLocalTimestamp()
getId()
getText()
getSource()
isTruncated()
isReply()
getReplyToId()
getReplyToUserId()
getReplyToUserScreenName()
getReplyToUser()
getUser()
getUserJson()
getHashtags()
getSymbols()
getMentions()
getMentionsId()
getMentionsScreenName()
getMentionsName()
getUrls()
getMedias()
getCoordinates()
getPlace()
getPlaceName()
getPlaceFullName()
getCountry()
getCountryCode()
getContributors()
isRetweet()
getRetweet()
getRetweetJson()
getRetweetCount()
getFavoriteCount()
isFavoritedByMe()
isRetweetedByMe()
isSensitive()
getLang()
isMyLang()
getTwitterUrl()

User Model

var _user = new User(tweet.user);

getId()
getName()
getScreeName()
getLocation()
getDescription()
getUrl()
getUrls()
isProtected()
getFollowersCount()
getFriendsCount()
getListedCount()
getAvatar()
getCreatedAt()
getTimestamp()
getLocalTimestamp()
getFavoritesCount()
getUtcOffset()
getTimeZone()
hasGeo()
isVerified()
getTweetCount()
getLang()
isMyLang()
hasContributors()
isTranslator()
isTranslationEnabled()
getProfileBackgroundColor()
getProfileBackgroundImageUrl()
isProfileBackgroundTile()
getAvatar()
getBanner()
getProfileLinkColor()
getProfileSidebarBorderColor()
getProfileSidebarFillColor()
getProfileTextColor()
hasProfileBackgroundImage()
hasExtendedProfile()
hasDefaultProfile()
hasDefaultProfileImage()
isFollowingMe()
sentFollowRequest()

Twitter User Authentification

Getting access token for external user with an app.

node save_oauth "myapp"

(if app name argument is not provided the first one in conf is picked)
A server will be up at 127.0.0.1 on port 3000.
When callback is done a file is created in oauth_access_cache like this: screen_name.tok
It will contain the app name, access token and access token secret.

Optionnal arguments

// user to use (require getting access token)
-u OR --user "myuser"
// twitter app to use
-a OR --app "myapp"
// file to upload
-f OR --file "/path/to/file"

for user argument use in lower case the screen name of the account

Documentation Twitter API

List of endpoints (GET and POST)

node doc

List of endpoints (GET only)

node doc get

List of endpoints (POST only)

node doc post

Endpoint details

node doc "statuses/home_timeline"

List of parameters

node doc parameters

Test endpoint (GET and POST)

node doc test "statuses/home_timeline"

TODO

complete doc.js
add search in doc (use arguments for url, description search)
npm install copy the conf.twitter.app.js
add video on "How to create application in Twitter"

Nota Bene

JSON informations

tweet geo is deprecated
user notifications is deprecated
possibly_sensitive_appealable is not used
no endpoint for poll tweet
if you want to tweet symbol, escape $ like this $MYSYMBOL

rancoud / RTwitterBot