├── .gitignore ├── LICENSE ├── README.md ├── index.js ├── package.json └── twitter.js /.gitignore: -------------------------------------------------------------------------------- 1 | npm-debug.log 2 | node_modules -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2014 René Raab and other contributors 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | this software and associated documentation files (the "Software"), to deal in 7 | the Software without restriction, including without limitation the rights to 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software is furnished to do so, 10 | subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # NO LONGER ACTIVELY MAINTAINED # 2 | Due to a lack of motivation/interest regarding node.js and the Twitter API, I am no longer actively maintaining this project. I feel like I can't provide the time/testing/code necessary to incorporate the pull requests or new changes to the Twitter API. The project and the source code will remain here on GitHub and on npm but there will no longer be any changes from my side. 3 | 4 | 5 | # node-twitter-api # 6 | 7 | Simple module for using Twitter's API in node.js 8 | 9 | 10 | ## Installation ## 11 | 12 | 13 | `npm install node-twitter-api` 14 | 15 | ## Usage ## 16 | 17 | ### Step 1: Initialization ### 18 | ```javascript 19 | var twitterAPI = require('node-twitter-api'); 20 | var twitter = new twitterAPI({ 21 | consumerKey: 'your consumer Key', 22 | consumerSecret: 'your consumer secret', 23 | callback: 'http://yoururl.tld/something' 24 | }); 25 | ``` 26 | 27 | Optionally you can add `x_auth_access_type: "read"` or `x_auth_access_type: "write"` (see: https://dev.twitter.com/oauth/reference/post/oauth/request_token). 28 | ### Step 2: Getting a request token ### 29 | ```javascript 30 | twitter.getRequestToken(function(error, requestToken, requestTokenSecret, results){ 31 | if (error) { 32 | console.log("Error getting OAuth request token : " + error); 33 | } else { 34 | //store token and tokenSecret somewhere, you'll need them later; redirect user 35 | } 36 | }); 37 | ``` 38 | If no error has occured, you now have a `requestToken` and a `requestTokenSecret`. You should store them somewhere (e.g. in a session, if you are using express), because you will need them later to get the current user's access token, which is used for authentication. 39 | 40 | ### Step 3: Getting an Access Token ### 41 | Redirect the user to `https://twitter.com/oauth/authenticate?oauth_token=[requestToken]`. `twitter.getAuthUrl(requestToken, options)` also returns that URL (the options parameter is optional and may contain a boolean `force_login` and a String `screen_name` - see the Twitter API Documentation for more information on these parameters). 42 | If he allows your app to access his data, Twitter will redirect him to your callback-URL (defined in Step 1) containing the get-parameters: `oauth_token` and `oauth_verifier`. You can use `oauth_token` (which is the `requestToken` in Step 2) to find the associated `requestTokenSecret`. You will need `requestToken`, `requestTokenSecret` and `oauth_verifier` to get an Access Token. 43 | ```javascript 44 | twitter.getAccessToken(requestToken, requestTokenSecret, oauth_verifier, function(error, accessToken, accessTokenSecret, results) { 45 | if (error) { 46 | console.log(error); 47 | } else { 48 | //store accessToken and accessTokenSecret somewhere (associated to the user) 49 | //Step 4: Verify Credentials belongs here 50 | } 51 | }); 52 | ``` 53 | If no error occured, you now have an `accessToken` and an `accessTokenSecret`. You need them to authenticate later API-calls. 54 | 55 | ### Step 4: (Optional) Verify Credentials ### 56 | ```javascript 57 | twitter.verifyCredentials(accessToken, accessTokenSecret, params, function(error, data, response) { 58 | if (error) { 59 | //something was wrong with either accessToken or accessTokenSecret 60 | //start over with Step 1 61 | } else { 62 | //accessToken and accessTokenSecret can now be used to make api-calls (not yet implemented) 63 | //data contains the user-data described in the official Twitter-API-docs 64 | //you could e.g. display his screen_name 65 | console.log(data["screen_name"]); 66 | } 67 | }); 68 | ``` 69 | In the above example, `params` is an optional object containing extra parameters to be sent to the Twitter endpoint (see https://dev.twitter.com/rest/reference/get/account/verify_credentials) 70 | 71 | ## Methods ## 72 | (Allmost) all function names replicate the endpoints of the Twitter API 1.1. 73 | If you want to post a status e. g. - which is done by posting data to statuses/update - you can just do the following: 74 | ```javascript 75 | twitter.statuses("update", { 76 | status: "Hello world!" 77 | }, 78 | accessToken, 79 | accessTokenSecret, 80 | function(error, data, response) { 81 | if (error) { 82 | // something went wrong 83 | } else { 84 | // data contains the data sent by twitter 85 | } 86 | } 87 | ); 88 | ``` 89 | 90 | Most of the functions use the scheme: 91 | `twitter.[namespace]([type], [params], [accessToken], [accessTokenSecret], [callback]);` 92 | * _namespace_ is the word before the slash (e.g. "statuses", "search", "direct_messages" etc.) 93 | * _type_ is the word after the slash (e.g. "create", "update", "show" etc.) 94 | * _params_ is an object containing the parameters you want to give to twitter (refer to the Twitter API Documentation for more information) 95 | * _accessToken_ and _accessTokenSecret_ are the token and secret of the authenticated user 96 | * _callback_ is a function with the parameters _error_ (either null or an error object), _data_ (data object) and _response_ (unprocessed response from Twitter) 97 | 98 | For Timelines you can also use the function _getTimeline_ which has the following types: 99 | * `user` or `user_timeline` (Note that you need to either specify user_id or screen_name when using this timeline) 100 | * `home` or `home_timeline` 101 | * `mentions` or `mentions_timeline` 102 | * `retweets` or `retweets_of_me` 103 | 104 | For more information on the different types of timelines see https://dev.twitter.com/rest/reference/get/statuses/home_timeline (analog for the other types) 105 | 106 | For Streams you must use _getStream_ which has two instead of just one callback: a dataCallback and an endCallback. (c.f. data and end events of node's http response) 107 | 108 | ## How to upload media ## 109 | To upload media to Twitter, call `twitter.uploadMedia(params, accessToken, accessTokenSecret, callback)` with params containing the following: 110 | * _media_: Either the raw binary content of the image, the binary base64 encoded (see isBase64 below) or the path to the file containing the image. 111 | * _isBase64_: Set to true, if media contains base64 encoded data 112 | For a example result see https://dev.twitter.com/rest/reference/post/media/upload. You can pass multiple media_ids to the statuses/update endpoint by seperating them with commas (e.g. "[id1],[id2],[id3],[id4]"). 113 | 114 | ## How to upload Video ## 115 | To upload video to Twitter, call `twitter.uploadVideo(params, accessToken, accessTokenSecret, callback)` with params containing the following: 116 | * _media_: Path to the file containing the video. 117 | 118 | You can pass media_id to the statuses/update endpoint and video will be uploaded to twitter. Please note that video should be less than 15mb or 30 sec in length. 119 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | module.exports = require('./twitter'); -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "node-twitter-api", 3 | "version": "1.8.0", 4 | "description": "Simple module for using Twitter's API in node.js", 5 | "keywords": ["twitter", "oauth", "rest", "streaming"], 6 | "homepage": "https://github.com/reneraab/node-twitter-api", 7 | "author": "René Raab", 8 | "licenses": { 9 | "type": "MIT", 10 | "url": "https://raw.github.com/reneraab/node-twitter-api/master/LICENSE" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "https://github.com/reneraab/node-twitter-api.git" 15 | }, 16 | "dependencies": { 17 | "oauth": ">=0.8.4", 18 | "request": "*" 19 | }, 20 | "engines": { 21 | "node": ">=0.4.0" 22 | }, 23 | "main": "./twitter" 24 | } 25 | -------------------------------------------------------------------------------- /twitter.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | var VERSION = "1.8.0", 3 | querystring = require("querystring"), 4 | oauth = require("oauth"), 5 | request = require("request"), 6 | fs = require("fs"); 7 | 8 | var baseUrl = "https://api.twitter.com/1.1/"; 9 | var uploadBaseUrl = "https://upload.twitter.com/1.1/"; 10 | var authUrl = "https://twitter.com/oauth/authenticate?oauth_token="; 11 | 12 | var Twitter = function(options) { 13 | if (!(this instanceof Twitter)) 14 | return new Twitter(options); 15 | 16 | this.consumerKey = options.consumerKey; 17 | this.consumerSecret = options.consumerSecret; 18 | this.callback = options.callback; 19 | 20 | this.x_auth_access_type = options.x_auth_access_type; 21 | 22 | this.oa = new oauth.OAuth("https://twitter.com/oauth/request_token", "https://twitter.com/oauth/access_token", 23 | this.consumerKey, this.consumerSecret, "1.0A", this.callback, "HMAC-SHA1"); 24 | 25 | return this; 26 | }; 27 | Twitter.VERSION = VERSION; 28 | 29 | Twitter.prototype.getRequestToken = function(callback) { 30 | this.oa.getOAuthRequestToken({x_auth_access_type: this.x_auth_access_type}, function(error, oauthToken, oauthTokenSecret, results) { 31 | if (error) { 32 | callback(error); 33 | } else { 34 | callback(null, oauthToken, oauthTokenSecret, results); 35 | } 36 | }); 37 | }; 38 | 39 | Twitter.prototype.getAuthUrl = function(requestToken, options) { 40 | var extraArgs = ""; 41 | if (options && options.force_login) { 42 | extraArgs += "&force_login=1"; 43 | } 44 | if (options && options.screen_name) { 45 | extraArgs += "&screen_name=" + options.screen_name; 46 | } 47 | return authUrl + requestToken + extraArgs; 48 | }; 49 | 50 | Twitter.prototype.getAccessToken = function(requestToken, requestTokenSecret, oauth_verifier, callback) { 51 | this.oa.getOAuthAccessToken(requestToken, requestTokenSecret, oauth_verifier, function(error, oauthAccessToken, oauthAccessTokenSecret, results) { 52 | if (error) { 53 | callback(error); 54 | } else { 55 | callback(null, oauthAccessToken, oauthAccessTokenSecret, results); 56 | } 57 | }); 58 | }; 59 | 60 | Twitter.prototype.verifyCredentials = function(accessToken, accessTokenSecret, params, callback) { 61 | var url = baseUrl + "account/verify_credentials.json"; 62 | if (typeof params == "function") { 63 | callback = params; 64 | } else { 65 | url += '?' + querystring.stringify(params); 66 | } 67 | this.oa.get(url, accessToken, accessTokenSecret, function(error, data, response) { 68 | if (error) { 69 | callback(error); 70 | } else { 71 | try { 72 | var parsedData = JSON.parse(data); 73 | } catch (e) { 74 | callback(e, data, response); 75 | } 76 | callback(null, parsedData, response); 77 | } 78 | }); 79 | }; 80 | 81 | 82 | // Timelines 83 | Twitter.prototype.getTimeline = function(type, params, accessToken, accessTokenSecret, callback) { 84 | type = type.toLowerCase(); 85 | 86 | var url; 87 | switch (type) { 88 | case "home_timeline": 89 | case "home": 90 | url = "home_timeline"; 91 | break; 92 | case "mentions_timeline": 93 | case "mentions": 94 | url = "mentions_timeline"; 95 | break; 96 | case "user_timeline": 97 | case "user": 98 | if (!params.user_id && !params.screen_name) { 99 | callback("Always specify either an user_id or screen_name when requesting a user timeline."); 100 | return false; 101 | } 102 | url = "user_timeline"; 103 | break; 104 | case "retweets_of_me": 105 | case "retweets": 106 | url = "retweets_of_me"; 107 | break; 108 | default: 109 | callback("Please specify an existing type."); 110 | return false; 111 | } 112 | 113 | this.oa.get(baseUrl + "statuses/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 114 | if (error) { 115 | callback(error); 116 | } else { 117 | try { 118 | var parsedData = JSON.parse(data); 119 | } catch (e) { 120 | callback(e, data, response); 121 | } 122 | callback(null, parsedData, response); 123 | } 124 | }); 125 | }; 126 | 127 | //Streaming 128 | Twitter.prototype.getStream = function(type, params, accessToken, accessTokenSecret, dataCallback, endCallback) { 129 | type = type.toLowerCase(); 130 | 131 | var url, method = "GET"; 132 | switch (type) { 133 | case "userstream": 134 | case "user": 135 | url = "https://userstream.twitter.com/1.1/user.json"; 136 | break; 137 | case "sitestream": 138 | case "site": 139 | url = "https://sitestream.twitter.com/1.1/site.json"; 140 | break; 141 | case "sample": 142 | url = "https://stream.twitter.com/1.1/statuses/sample.json"; 143 | break; 144 | case "firehose": 145 | url = "https://stream.twitter.com/1.1/statuses/firehose.json"; 146 | break; 147 | case "filter": 148 | method = "POST"; 149 | url = "https://stream.twitter.com/1.1/statuses/filter.json"; 150 | break; 151 | default: 152 | var errorMessage = "Please specify an existing type."; 153 | dataCallback({message: errorMessage, e: new Error(errorMessage)}, null, null, null); 154 | return false; 155 | } 156 | 157 | var req; 158 | if (method == "GET") { 159 | req = this.oa.get(url + "?" + querystring.stringify(params), accessToken, accessTokenSecret); 160 | } else { 161 | req = this.oa.post(url, accessToken, accessTokenSecret, params, null); 162 | } 163 | var msg = []; 164 | req.addListener("response", function(res) { 165 | res.setEncoding("utf-8"); 166 | res.addListener("data", function(chunk) { 167 | if (chunk == "\r\n") { 168 | dataCallback(null, {}, chunk, res); 169 | return; 170 | } else if (chunk.substr(chunk.length - 2) == "\r\n") { 171 | msg.push(chunk.substr(0, chunk.length - 2)); 172 | var ret = msg.join(""); 173 | msg = []; 174 | 175 | var parsedRet; 176 | try { 177 | parsedRet = JSON.parse(ret); 178 | } catch (e) { 179 | dataCallback({ 180 | message: "Error while parsing Twitter-Response.", 181 | error: e 182 | }, null, chunk, res); 183 | return; 184 | } 185 | dataCallback(null, parsedRet, ret, res); 186 | return; 187 | } else { 188 | msg.push(chunk); 189 | return; 190 | } 191 | }); 192 | res.addListener("end", function() { 193 | endCallback(res); 194 | }); 195 | }); 196 | req.end(); 197 | 198 | return req; 199 | }; 200 | 201 | // Tweets 202 | Twitter.prototype.statuses = function(type, params, accessToken, accessTokenSecret, callback) { 203 | var url = type.toLowerCase(); 204 | 205 | var method = "GET"; 206 | switch (type) { 207 | case "retweets": 208 | url = "retweets/" + params.id; 209 | delete params.id; 210 | break; 211 | case "show": 212 | url = "show/" + params.id; 213 | delete params.id; 214 | break; 215 | case "lookup": 216 | url = "lookup"; 217 | method = "POST"; 218 | break; 219 | case "destroy": 220 | url = "destroy/" + params.id; 221 | delete params.id; 222 | method = "POST"; 223 | break; 224 | case "update": 225 | method = "POST"; 226 | break; 227 | case "retweet": 228 | url = "retweet/" + params.id; 229 | delete params.id; 230 | method = "POST"; 231 | break; 232 | case "unretweet": 233 | url = "unretweet/" + params.id; 234 | delete params.id; 235 | method = "POST"; 236 | break; 237 | case "oembed": 238 | url ="oembed"; 239 | break; 240 | case "upload_media": 241 | this.uploadMedia(params, accessToken, accessTokenSecret, callback); 242 | return; 243 | case "update_with_media": 244 | callback("'update_with_media' type has been removed. Use 'upload_media' instead"); 245 | return false; 246 | default: 247 | callback("Please specify an existing type."); 248 | return false; 249 | } 250 | 251 | if (method == "GET") { 252 | this.oa.get(baseUrl + "statuses/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 253 | if (error) { 254 | callback(error, data, response, baseUrl + "statuses/" + url + ".json?" + querystring.stringify(params)); 255 | } else { 256 | try { 257 | var parsedData = JSON.parse(data); 258 | } catch (e) { 259 | callback(e, data, response); 260 | } 261 | callback(null, parsedData, response); 262 | } 263 | }); 264 | } else { 265 | this.oa.post(baseUrl + "statuses/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 266 | if (error) { 267 | callback(error, data, response); 268 | } else { 269 | try { 270 | var parsedData = JSON.parse(data); 271 | } catch (e) { 272 | callback(e, data, response); 273 | } 274 | callback(null, parsedData, response); 275 | } 276 | }); 277 | } 278 | }; 279 | 280 | Twitter.prototype.uploadMedia = function(params, accessToken, accessTokenSecret, callback) { 281 | var r = request.post({ 282 | url: uploadBaseUrl + "media/upload.json", 283 | oauth: { 284 | consumer_key: this.consumerKey, 285 | consumer_secret: this.consumerSecret, 286 | token: accessToken, 287 | token_secret: accessTokenSecret 288 | } 289 | }, function(error, response, body) { 290 | if (error) { 291 | callback(error, body, response, uploadBaseUrl + "media/upload.json?" + querystring.stringify(params)); 292 | } else { 293 | try { 294 | var parsedBody = JSON.parse(body); 295 | } catch (e) { 296 | callback(e, body, response); 297 | } 298 | callback(null, parsedBody, response); 299 | } 300 | }); 301 | 302 | var parameter = (params.isBase64) ? "media_data" : "media"; 303 | 304 | // multipart/form-data 305 | var form = r.form(); 306 | if (fs.existsSync(params.media)) { 307 | form.append(parameter, fs.createReadStream(params.media)); 308 | } else { 309 | form.append(parameter, params.media); 310 | } 311 | }; 312 | 313 | /** 314 | * upload video to twitter 315 | * @param params 316 | * @param accessToken 317 | * @param accessTokenSecret 318 | * @param callback 319 | */ 320 | Twitter.prototype.uploadVideo = function (params, accessToken, accessTokenSecret, callback) { 321 | this.uploadMediaChunked(params, "video/mp4", accessToken, accessTokenSecret, callback); 322 | }; 323 | 324 | Twitter.prototype.uploadMediaChunked = function (params, media_type, accessToken, accessTokenSecret, callback) { 325 | var bufferLength = 1000000; 326 | var theBuffer = new Buffer(bufferLength); 327 | var offset = 0; 328 | var segment_index = 0; 329 | var finished = 0; 330 | var oauthObj = { 331 | consumer_key: this.consumerKey, 332 | consumer_secret: this.consumerSecret, 333 | token: accessToken, 334 | token_secret: accessTokenSecret 335 | }; 336 | 337 | fs.stat(params.media, function (err, stats) { 338 | var formData, finalizeMedia, options; 339 | formData = { 340 | command: "INIT", 341 | media_type: media_type, 342 | total_bytes: stats.size 343 | }; 344 | options = { 345 | url: uploadBaseUrl + "media/upload.json", 346 | oauth: oauthObj, 347 | formData: formData 348 | }; 349 | 350 | finalizeMedia = function (media_id) { 351 | return function (err, response, body) { 352 | 353 | finished++; 354 | if (finished === segment_index) { 355 | 356 | options.formData = { 357 | command: 'FINALIZE', 358 | media_id: media_id 359 | }; 360 | request.post(options, function (err, response, body) { 361 | if (err) { 362 | return cb(err, body); 363 | } else { 364 | try { 365 | var parsedBody = JSON.parse(body); 366 | } catch (e) { 367 | return callback(e, body); 368 | } 369 | return callback(null, parsedBody); 370 | } 371 | }); 372 | } 373 | }; 374 | }; 375 | request.post(options, function (err, response, body) { 376 | var media_id; 377 | media_id = JSON.parse(body).media_id_string; 378 | fs.open(params.media, 'r', function (err, fd) { 379 | var bytesRead, data; 380 | 381 | while (offset < stats.size) { 382 | 383 | bytesRead = fs.readSync(fd, theBuffer, 0, bufferLength, null); 384 | data = bytesRead < bufferLength ? theBuffer.slice(0, bytesRead) : theBuffer; 385 | options.formData = { 386 | command: "APPEND", 387 | media_id: media_id, 388 | segment_index: segment_index, 389 | media_data: data.toString('base64') 390 | }; 391 | request.post(options, finalizeMedia(media_id)); 392 | offset += bufferLength; 393 | segment_index++ 394 | } 395 | }); 396 | }); 397 | }); 398 | }; 399 | 400 | 401 | 402 | // Search 403 | Twitter.prototype.search = function(params, accessToken, accessTokenSecret, callback) { 404 | this.oa.get(baseUrl + "search/tweets.json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 405 | if (error) { 406 | callback(error, data, response, baseUrl + "search/tweets.json?" + querystring.stringify(params)); 407 | } else { 408 | try { 409 | var parsedData = JSON.parse(data); 410 | } catch (e) { 411 | callback(e, data, response); 412 | } 413 | callback(null, parsedData, response); 414 | } 415 | }); 416 | }; 417 | 418 | // Users 419 | Twitter.prototype.users = function(type, params, accessToken, accessTokenSecret, callback) { 420 | var url = type.toLowerCase(); 421 | 422 | var method = "GET"; // show, search, contributees, contributors 423 | if (url == "lookup") method = "POST"; 424 | 425 | 426 | if (method == "GET") { 427 | this.oa.get(baseUrl + "users/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 428 | if (error) { 429 | callback(error, data, response, baseUrl + "users/" + url + ".json?" + querystring.stringify(params)); 430 | } else { 431 | try { 432 | var parsedData = JSON.parse(data); 433 | } catch (e) { 434 | callback(e, data, response); 435 | } 436 | callback(null, parsedData, response); 437 | } 438 | }); 439 | } else { 440 | this.oa.post(baseUrl + "users/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 441 | if (error) { 442 | callback(error, data, response); 443 | } else { 444 | try { 445 | var parsedData = JSON.parse(data); 446 | } catch (e) { 447 | callback(e, data, response); 448 | } 449 | callback(null, parsedData, response); 450 | } 451 | }); 452 | } 453 | 454 | }; 455 | 456 | 457 | // Friends (similiar to Followers) 458 | Twitter.prototype.friends = function(type, params, accessToken, accessTokenSecret, callback) { 459 | var url = type.toLowerCase(); // ids or list 460 | 461 | this.oa.get(baseUrl + "friends/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 462 | if (error) { 463 | callback(error, data, response, baseUrl + "friends/" + url + ".json?" + querystring.stringify(params)); 464 | } else { 465 | try { 466 | var parsedData = JSON.parse(data); 467 | } catch (e) { 468 | callback(e, data, response); 469 | } 470 | callback(null, parsedData, response); 471 | } 472 | }); 473 | }; 474 | 475 | // Followers (similiar to Friends) 476 | Twitter.prototype.followers = function(type, params, accessToken, accessTokenSecret, callback) { 477 | var url = type.toLowerCase(); // ids or list 478 | 479 | this.oa.get(baseUrl + "followers/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 480 | if (error) { 481 | callback(error, data, response, baseUrl + "folllowers/" + url + ".json?" + querystring.stringify(params)); 482 | } else { 483 | try { 484 | var parsedData = JSON.parse(data); 485 | } catch (e) { 486 | callback(e, data, response); 487 | } 488 | callback(null, parsedData, response); 489 | } 490 | }); 491 | }; 492 | 493 | // Friendships 494 | Twitter.prototype.friendships = function(type, params, accessToken, accessTokenSecret, callback) { 495 | var url = type.toLowerCase(); // ids or list 496 | var method = "GET"; 497 | 498 | // define endpoints that use POST 499 | switch (type) { 500 | case "create": 501 | case "destroy": 502 | case "update": 503 | method = "POST"; 504 | } 505 | 506 | 507 | if (method == "GET") { 508 | this.oa.get(baseUrl + "friendships/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 509 | if (error) { 510 | callback(error, data, response, baseUrl + "friendships/" + url + ".json?" + querystring.stringify(params)); 511 | } else { 512 | try { 513 | var parsedData = JSON.parse(data); 514 | } catch (e) { 515 | callback(e, data, response); 516 | } 517 | callback(null, parsedData, response); 518 | } 519 | }); 520 | } else { 521 | this.oa.post(baseUrl + "friendships/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 522 | if (error) { 523 | callback(error, data, response); 524 | } else { 525 | try { 526 | var parsedData = JSON.parse(data); 527 | } catch (e) { 528 | callback(e, data, response); 529 | } 530 | callback(null, parsedData, response); 531 | } 532 | }); 533 | } 534 | }; 535 | 536 | Twitter.prototype.updateProfileImage = function(params, accessToken, accessTokenSecret, callback) { 537 | 538 | if (!fs.existsSync(params["image"])) throw new Error("no image"); 539 | 540 | var r = request.post({ 541 | url: baseUrl + "account/update_profile_image.json", 542 | oauth: { 543 | consumer_key: this.consumerKey, 544 | consumer_secret: this.consumerSecret, 545 | token: accessToken, 546 | token_secret: accessTokenSecret 547 | } 548 | }, function(error, response, body) { 549 | if (error) { 550 | callback(error, body, response, baseUrl + "account/update_profile_image.json?" + querystring.stringify(params)); 551 | } else { 552 | try { 553 | var parsedBody = JSON.parse(body); 554 | } catch (e) { 555 | callback(e, body, response); 556 | } 557 | callback(null, parsedBody, response); 558 | } 559 | }); 560 | 561 | // multipart/form-data 562 | var form = r.form(); 563 | for (var key in params) { 564 | if (key != "image") { 565 | form.append(key, params[key]); 566 | } 567 | } 568 | 569 | form.append("image", fs.createReadStream(params["image"])); 570 | 571 | }; 572 | 573 | // Account 574 | Twitter.prototype.account = function(type, params, accessToken, accessTokenSecret, callback) { 575 | var url = type.toLowerCase(); 576 | 577 | var method = "POST"; 578 | switch (url) { 579 | case "settings": 580 | if (Object.keys(params).length === 0) { 581 | method = "GET"; 582 | } 583 | break; 584 | case "verify_credentials": 585 | method = "GET"; 586 | break; 587 | case "update_profile_image": 588 | this.updateProfileImage(params, accessToken, accessTokenSecret, callback); 589 | return; 590 | } 591 | 592 | if (method == "GET") { 593 | this.oa.get(baseUrl + "account/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 594 | if (error) { 595 | callback(error, data, response, baseUrl + "account/" + url + ".json?" + querystring.stringify(params)); 596 | } else { 597 | try { 598 | var parsedData = JSON.parse(data); 599 | } catch (e) { 600 | callback(e, data, response); 601 | } 602 | callback(null, parsedData, response); 603 | } 604 | }); 605 | } else { 606 | this.oa.post(baseUrl + "account/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 607 | if (error) { 608 | callback(error, data, response); 609 | } else { 610 | try { 611 | var parsedData = JSON.parse(data); 612 | } catch (e) { 613 | callback(e, data, response); 614 | } 615 | callback(null, parsedData, response); 616 | } 617 | }); 618 | } 619 | }; 620 | 621 | // Blocks 622 | Twitter.prototype.blocks = function(type, params, accessToken, accessTokenSecret, callback) { 623 | var url = type.toLowerCase(); 624 | 625 | var method = "GET"; 626 | switch (url) { 627 | case "create": 628 | case "destroy": 629 | method = "POST"; 630 | break; 631 | } 632 | 633 | if (method == "GET") { 634 | this.oa.get(baseUrl + "blocks/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 635 | if (error) { 636 | callback(error, data, response, baseUrl + "blocks/" + url + ".json?" + querystring.stringify(params)); 637 | } else { 638 | try { 639 | var parsedData = JSON.parse(data); 640 | } catch (e) { 641 | callback(e, data, response); 642 | } 643 | callback(null, parsedData, response); 644 | } 645 | }); 646 | } else { 647 | this.oa.post(baseUrl + "blocks/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 648 | if (error) { 649 | callback(error, data, response); 650 | } else { 651 | try { 652 | var parsedData = JSON.parse(data); 653 | } catch (e) { 654 | callback(e, data, response); 655 | } 656 | callback(null, parsedData, response); 657 | } 658 | }); 659 | } 660 | }; 661 | 662 | // Mutes 663 | Twitter.prototype.mutes = function(type, params, accessToken, accessTokenSecret, callback) { 664 | var url = type.toLowerCase(); 665 | 666 | var method = "GET"; 667 | switch (url) { 668 | case "users/create": 669 | case "users/destroy": 670 | method = "POST"; 671 | break; 672 | } 673 | 674 | if (method == "GET") { 675 | this.oa.get(baseUrl + "mutes/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 676 | if (error) { 677 | callback(error, data, response, baseUrl + "mutes/" + url + ".json?" + querystring.stringify(params)); 678 | } else { 679 | try { 680 | var parsedData = JSON.parse(data); 681 | } catch (e) { 682 | callback(e, data, response); 683 | } 684 | callback(null, parsedData, response); 685 | } 686 | }); 687 | } else { 688 | this.oa.post(baseUrl + "mutes/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 689 | if (error) { 690 | callback(error, data, response); 691 | } else { 692 | try { 693 | var parsedData = JSON.parse(data); 694 | } catch (e) { 695 | callback(e, data, response); 696 | } 697 | callback(null, parsedData, response); 698 | } 699 | }); 700 | } 701 | }; 702 | 703 | // Users 704 | Twitter.prototype.users = function(type, params, accessToken, accessTokenSecret, callback) { 705 | var url = type.toLowerCase(); 706 | 707 | this.oa.get(baseUrl + "users/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 708 | if (error) { 709 | callback(error, data, response, baseUrl + "users/" + url + ".json?" + querystring.stringify(params)); 710 | } else { 711 | try { 712 | var parsedData = JSON.parse(data); 713 | } catch (e) { 714 | callback(e, data, response); 715 | } 716 | callback(null, parsedData, response); 717 | } 718 | }); 719 | }; 720 | 721 | // Suggestions 722 | Twitter.prototype.suggestions = function(type, params, accessToken, accessTokenSecret, callback) { 723 | var url = type.toLowerCase(); 724 | var method = "GET"; 725 | 726 | switch (url) { 727 | case "suggestions": 728 | case "": 729 | url = ""; 730 | break; 731 | case "members": 732 | url = params.slug + "/members"; 733 | delete params.slug; 734 | break; 735 | case "slug": 736 | url = params.slug; 737 | delete params.slug; 738 | break; 739 | } 740 | 741 | this.oa.get(baseUrl + "users/suggestions" + ((url) ? "/" + url : "") + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 742 | if (error) { 743 | callback(error, data, response, baseUrl + "users/suggestions" + ((url) ? "/" + url : "") + ".json?" + querystring.stringify(params)); 744 | } else { 745 | try { 746 | var parsedData = JSON.parse(data); 747 | } catch (e) { 748 | callback(e, data, response); 749 | } 750 | callback(null, parsedData, response); 751 | } 752 | }); 753 | }; 754 | 755 | // Favorites 756 | Twitter.prototype.favorites = function(type, params, accessToken, accessTokenSecret, callback) { 757 | var url = type.toLowerCase(); 758 | var method = "GET"; 759 | 760 | switch (url) { 761 | case "destroy": 762 | case "create": 763 | method = "POST"; 764 | } 765 | 766 | if (method == "GET") { 767 | this.oa.get(baseUrl + "favorites/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 768 | if (error) { 769 | callback(error, data, response, baseUrl + "favorites/" + url + ".json?" + querystring.stringify(params)); 770 | } else { 771 | try { 772 | var parsedData = JSON.parse(data); 773 | } catch (e) { 774 | callback(e, data, response); 775 | } 776 | callback(null, parsedData, response); 777 | } 778 | }); 779 | } else { 780 | this.oa.post(baseUrl + "favorites/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 781 | if (error) { 782 | callback(error, data, response); 783 | } else { 784 | try { 785 | var parsedData = JSON.parse(data); 786 | } catch (e) { 787 | callback(e, data, response); 788 | } 789 | callback(null, parsedData, response); 790 | } 791 | }); 792 | } 793 | }; 794 | 795 | // Direct Messages 796 | Twitter.prototype.direct_messages = function(type, params, accessToken, accessTokenSecret, callback) { 797 | var url = type.toLowerCase(); 798 | var method = "GET"; 799 | 800 | 801 | switch (url) { 802 | case "direct_messages": 803 | case "": 804 | url = ""; 805 | break; 806 | case "destroy": 807 | case "new": 808 | method = "POST"; 809 | } 810 | 811 | if (method == "GET") { 812 | this.oa.get(baseUrl + "direct_messages" + ((url) ? "/" + url : "") + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 813 | if (error) { 814 | callback(error, data, response, baseUrl + "direct_messages" + ((url) ? "/" + url : "") + ".json?" + querystring.stringify(params)); 815 | } else { 816 | try { 817 | var parsedData = JSON.parse(data); 818 | } catch (e) { 819 | callback(e, data, response); 820 | } 821 | callback(null, parsedData, response); 822 | } 823 | }); 824 | } else { 825 | this.oa.post(baseUrl + "direct_messages/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 826 | if (error) { 827 | callback(error, data, response); 828 | } else { 829 | try { 830 | var parsedData = JSON.parse(data); 831 | } catch (e) { 832 | callback(e, data, response); 833 | } 834 | callback(null, parsedData, response); 835 | } 836 | }); 837 | } 838 | }; 839 | 840 | // Lists 841 | Twitter.prototype.lists = function(type, params, accessToken, accessTokenSecret, callback) { 842 | var url = type.toLowerCase(); 843 | var method = "GET"; 844 | 845 | switch (url) { 846 | case "members/destroy": 847 | case "members/destroy_all": 848 | case "members/create": 849 | case "members/create_all": 850 | case "subscribers/create": 851 | case "subscribers/destroy": 852 | case "destroy": 853 | case "update": 854 | case "create": 855 | method = "POST"; 856 | } 857 | 858 | if (method == "GET") { 859 | this.oa.get(baseUrl + "lists/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 860 | if (error) { 861 | callback(error, data, response, baseUrl + "lists/" + url + ".json?" + querystring.stringify(params)); 862 | } else { 863 | try { 864 | var parsedData = JSON.parse(data); 865 | } catch (e) { 866 | callback(e, data, response); 867 | } 868 | callback(null, parsedData, response); 869 | } 870 | }); 871 | } else { 872 | this.oa.post(baseUrl + "lists/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 873 | if (error) { 874 | callback(error, data, response); 875 | } else { 876 | try { 877 | var parsedData = JSON.parse(data); 878 | } catch (e) { 879 | callback(e, data, response); 880 | } 881 | callback(null, parsedData, response); 882 | } 883 | }); 884 | } 885 | }; 886 | 887 | 888 | // Saved Searches 889 | Twitter.prototype.savedSearches = function(type, params, accessToken, accessTokenSecret, callback) { 890 | var url = type.toLowerCase(); 891 | var method = "GET"; 892 | 893 | switch (url) { 894 | case "create": 895 | method = "POST"; 896 | break; 897 | case "show": 898 | url = "show/" + params.id; 899 | delete params.id; 900 | break; 901 | case "destroy": 902 | url = "destroy/" + params.id; 903 | delete params.id; 904 | method = "POST"; 905 | break; 906 | } 907 | 908 | if (method == "GET") { 909 | this.oa.get(baseUrl + "saved_searches/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 910 | if (error) { 911 | callback(error, data, response, baseUrl + "saved_searches/" + url + ".json?" + querystring.stringify(params)); 912 | } else { 913 | try { 914 | var parsedData = JSON.parse(data); 915 | } catch (e) { 916 | callback(e, data, response); 917 | } 918 | callback(null, parsedData, response); 919 | } 920 | }); 921 | } else { 922 | this.oa.post(baseUrl + "saved_searches/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 923 | if (error) { 924 | callback(error, data, response); 925 | } else { 926 | try { 927 | var parsedData = JSON.parse(data); 928 | } catch (e) { 929 | callback(e, data, response); 930 | } 931 | callback(null, parsedData, response); 932 | } 933 | }); 934 | } 935 | }; 936 | 937 | // Geo 938 | Twitter.prototype.geo = function(type, params, accessToken, accessTokenSecret, callback) { 939 | var url = type.toLowerCase(); 940 | var method = "GET"; 941 | 942 | switch (url) { 943 | case "place": 944 | method = "POST"; 945 | break; 946 | case "id": 947 | url = "id/" + params.place_id; 948 | delete params.place_id; 949 | break; 950 | } 951 | 952 | if (method == "GET") { 953 | this.oa.get(baseUrl + "geo/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 954 | if (error) { 955 | callback(error, data, response, baseUrl + "geo/" + url + ".json?" + querystring.stringify(params)); 956 | } else { 957 | try { 958 | var parsedData = JSON.parse(data); 959 | } catch (e) { 960 | callback(e, data, response); 961 | } 962 | callback(null, parsedData, response); 963 | } 964 | }); 965 | } else { 966 | this.oa.post(baseUrl + "geo/" + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 967 | if (error) { 968 | callback(error, data, response); 969 | } else { 970 | try { 971 | var parsedData = JSON.parse(data); 972 | } catch (e) { 973 | callback(e, data, response); 974 | } 975 | callback(null, parsedData, response); 976 | } 977 | }); 978 | } 979 | }; 980 | 981 | // Trends 982 | Twitter.prototype.trends = function(type, params, accessToken, accessTokenSecret, callback) { 983 | var url = type.toLowerCase(); 984 | 985 | this.oa.get(baseUrl + "trends/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 986 | if (error) { 987 | callback(error, data, response, baseUrl + "trends/" + url + ".json?" + querystring.stringify(params)); 988 | } else { 989 | try { 990 | var parsedData = JSON.parse(data); 991 | } catch (e) { 992 | callback(e, data, response); 993 | } 994 | callback(null, parsedData, response); 995 | } 996 | }); 997 | }; 998 | 999 | // Spam Reporting 1000 | Twitter.prototype.report_spam = function(type, params, accessToken, accessTokenSecret, callback) { 1001 | var url = type.toLowerCase(); 1002 | 1003 | this.oa.post(baseUrl + "users/report_spam.json", accessToken, accessTokenSecret, params, function(error, data, response) { 1004 | if (error) { 1005 | callback(error, data, response); 1006 | } else { 1007 | try { 1008 | var parsedData = JSON.parse(data); 1009 | } catch (e) { 1010 | callback(e, data, response); 1011 | } 1012 | callback(null, parsedData, response); 1013 | } 1014 | }); 1015 | }; 1016 | 1017 | // OAuth 1018 | Twitter.prototype.oauth = function(type, params, accessToken, accessTokenSecret, callback) { 1019 | var url = type.toLowerCase(); 1020 | var method = "GET"; 1021 | 1022 | switch (url) { 1023 | case "access_token": 1024 | case "request_token": 1025 | method = "POST"; 1026 | url = "oauth/" + url; 1027 | break; 1028 | case "token": 1029 | case "invalidate_token": 1030 | method = "POST"; 1031 | url = "oauth2/" + url; 1032 | break; 1033 | default: 1034 | url = "oauth/" + url; 1035 | break; 1036 | } 1037 | 1038 | if (method == "GET") { 1039 | this.oa.get(baseUrl + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 1040 | if (error) { 1041 | callback(error, data, response, baseUrl + "geo/" + url + ".json?" + querystring.stringify(params)); 1042 | } else { 1043 | try { 1044 | var parsedData = JSON.parse(data); 1045 | } catch (e) { 1046 | callback(e, data, response); 1047 | } 1048 | callback(null, parsedData, response); 1049 | } 1050 | }); 1051 | } else { 1052 | this.oa.post(baseUrl + url + ".json", accessToken, accessTokenSecret, params, function(error, data, response) { 1053 | if (error) { 1054 | callback(error, data, response); 1055 | } else { 1056 | try { 1057 | var parsedData = JSON.parse(data); 1058 | } catch (e) { 1059 | callback(e, data, response); 1060 | } 1061 | callback(null, parsedData, response); 1062 | } 1063 | }); 1064 | } 1065 | }; 1066 | 1067 | // Help 1068 | Twitter.prototype.help = function(type, params, accessToken, accessTokenSecret, callback) { 1069 | var url = type.toLowerCase(); 1070 | 1071 | this.oa.get(baseUrl + "help/" + url + ".json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 1072 | if (error) { 1073 | callback(error, data, response, baseUrl + "help/" + url + ".json?" + querystring.stringify(params)); 1074 | } else { 1075 | try { 1076 | var parsedData = JSON.parse(data); 1077 | } catch (e) { 1078 | callback(e, data, response); 1079 | } 1080 | callback(null, parsedData, response); 1081 | } 1082 | }); 1083 | }; 1084 | 1085 | // Rate Limit Status 1086 | Twitter.prototype.rateLimitStatus = function(params, accessToken, accessTokenSecret, callback) { 1087 | this.oa.get(baseUrl + "application/rate_limit_status.json?" + querystring.stringify(params), accessToken, accessTokenSecret, function(error, data, response) { 1088 | if (error) { 1089 | callback(error, data, response, baseUrl + "application/rate_limit_status.json?" + querystring.stringify(params)); 1090 | } else { 1091 | try { 1092 | var parsedData = JSON.parse(data); 1093 | } catch (e) { 1094 | callback(e, data, response); 1095 | } 1096 | callback(null, parsedData, response); 1097 | } 1098 | }); 1099 | }; 1100 | 1101 | module.exports = Twitter; 1102 | --------------------------------------------------------------------------------