added streaming client

Author: Tim Whitlock

examples/stream-filter.js

@@ -0,0 +1,31 @@
+/**
+ * Example filters tweets via Streaming API.
+ * Raw JSON packets are returned to avoid unwanted parsing overhead
+ */
+
+
+var client = require('../lib/twitter').createClient();
+
+client.setAuth ( 
+    'your consumer key',
+    'your consumer secret', 
+    'some access key',
+    'some access secret' 
+);
+
+
+var num = 0,
+    max = 10;
+
+client.stream( 'statuses/filter', { track: '#sxsw' }, function( json ){
+    var tweet = JSON.parse( json );
+    if( tweet.text && tweet.user ){
+        console.log( tweet.user.screen_name+': "'+tweet.text+'"');
+        if( ++num === max ){
+            console.log('----');
+            client.abort();
+        }
+    }
+} );
+
+

lib/twitter.js

@@ -9,6 +9,7 @@
 var TWITTER_API_TIMEOUT             = 5,
     TWITTER_API_USERAGENT           = 'Node/'+process.version.substr(1),
     TWITTER_API_BASE                = 'https://api.twitter.com/1.1';
+    TWITTER_STREAM_BASE             = 'https://stream.twitter.com/1.1';
     TWITTER_OAUTH_REQUEST_TOKEN_URL = 'https://twitter.com/oauth/request_token';
     TWITTER_OAUTH_AUTHORIZE_URL     = 'https://twitter.com/oauth/authorize';
     TWITTER_OAUTH_AUTHENTICATE_URL  = 'https://twitter.com/oauth/authenticate';
@@ -141,42 +142,16 @@ TwitterClient.prototype.deAuth = function(){
 }
 
 TwitterClient.prototype.get = function( requestPath, requestArgs, callback ){
-    return this.call( 'GET', requestPath, requestArgs, callback );
+    return this._rest( 'GET', requestPath, requestArgs, callback );
 }
 
 TwitterClient.prototype.post = function( requestPath, requestArgs, callback ){
-    return this.call( 'POST', requestPath, requestArgs, callback );
+    return this._rest( 'POST', requestPath, requestArgs, callback );
 }
 
-TwitterClient.prototype.call = function( requestMethod, requestPath, requestArgs, callback ){
-    if( ! this.hasAuth() ){
-        throw new Error('Twitter client not authenticated');
-    }
-    requestMethod = String( requestMethod||'GET' ).toUpperCase();
+TwitterClient.prototype._rest = function( requestMethod, requestPath, requestArgs, callback ){
     var requestUri = TWITTER_API_BASE + '/' + requestPath + '.json';
-    // build and sign request parameters
-    var params = new OAuthParams( requestArgs )
-         .setConsumer( this.consumerToken )
-         .setAccess( this.accessToken )
-         .sign( requestMethod, requestUri );
-    // grab authorization header and any remaining params
-    var oauth = params.getHeader(),
-        query = params.serialize();
-    // build http request starting with parsed endpoint
-    var http = require('url').parse( requestUri );
-    http.headers = { 
-        Authorization: oauth,
-        'User-Agent': TWITTER_API_USERAGENT 
-    };
-    if( 'POST' === requestMethod ){
-        http.method = 'POST';
-        http.headers['Content-Type'] = 'application/x-www-form-urlencoded; charset=UTF-8';
-        http.headers['Content-Length'] = query.length;
-    }
-    else if( query ){
-        http.path += '?' + query;
-    }
-    var req = require('https').get( http, function( res ){
+    return this.call( requestMethod, requestUri, requestArgs, function( res ) {
         // started to receive response from twitter
         res.setEncoding('utf8');
         var body = '';
@@ -205,6 +180,73 @@ TwitterClient.prototype.call = function( requestMethod, requestPath, requestArgs
             }
         } );
     } );
+}
+
+TwitterClient.prototype.stream = function( requestPath, requestArgs, callback ){
+    var requestMethod = 'GET',
+        requestUri = TWITTER_STREAM_BASE+'/'+requestPath+'.json';
+    if( 'user' === requestPath ){
+        requestUri = requestUri.replace('stream','userstream');
+    }
+    else if( 'site' === requestPath ){
+        requestUri = requestUri.replace('stream','sitestream');
+    }
+    else if( 0 === requestPath.indexOf('statuses/filter') ){
+        requestMethod = 'POST';
+    }
+    if( 'function' !== typeof callback ){
+        callback = function( json ){
+            console.log( json );
+        };
+    }
+    var client = this;
+    return this.call( requestMethod, requestUri, requestArgs, function(res){
+        client.response = res;
+        res.setEncoding('utf8');
+        if( 200 !== res.statusCode ){
+            console.error( 'Error '+res.statusCode );
+            client.abort();
+        }
+        res.on('data', function( chunk ) {
+            // simple sniff for valid json and call back
+            if( '{' == chunk.charAt(0) && '}\r\n' === chunk.substr(-3) ){
+                callback( chunk );
+            }
+        } );
+        res.on('end', function(){
+            client.response = null;
+        } );
+    } );
+}
+
+TwitterClient.prototype.call = function( requestMethod, requestUri, requestArgs, callback ){
+    if( ! this.hasAuth() ){
+        throw new Error('Twitter client not authenticated');
+    }
+    requestMethod = String( requestMethod||'GET' ).toUpperCase();
+    // build and sign request parameters
+    var params = new OAuthParams( requestArgs )
+         .setConsumer( this.consumerToken )
+         .setAccess( this.accessToken )
+         .sign( requestMethod, requestUri );
+    // grab authorization header and any remaining params
+    var oauth = params.getHeader(),
+        query = params.serialize();
+    // build http request starting with parsed endpoint
+    var http = require('url').parse( requestUri );
+    http.headers = { 
+        Authorization: oauth,
+        'User-Agent': TWITTER_API_USERAGENT 
+    };
+    if( 'POST' === requestMethod ){
+        http.method = 'POST';
+        http.headers['Content-Type'] = 'application/x-www-form-urlencoded; charset=UTF-8';
+        http.headers['Content-Length'] = query.length;
+    }
+    else if( query ){
+        http.path += '?' + query;
+    }
+    var req = require('https').get( http, callback );
     if( 'POST' === requestMethod && query ){
         req.write( query );
         req.write( '\n' );
@@ -213,6 +255,19 @@ TwitterClient.prototype.call = function( requestMethod, requestPath, requestArgs
     return this;
 }
 
+TwitterClient.prototype.abort = function(){
+    try {
+        if( this.response ){
+            this.response.destroy();
+            this.response = null;
+        }
+    }
+    catch( e ){
+        console.error( e.message || String(e) || 'Unknown error on abort' );
+    }
+}
+
+