#3 - #9 - Added support for setting pool configuration and gzip

Author: trygve-lie

README.md

@@ -47,7 +47,7 @@ Twitter.pipe(fs.createWriteStream('tweets.json'));
 Create a new Twitter Stream API instance.
 
 ```js
-var Twitter = new TwitterStream(keys, objectMode);
+var Twitter = new TwitterStream(keys, [objectMode, options]);
 ```
 
 
@@ -75,6 +75,17 @@ value is `true` which set the stream to emit Objects. If a non-object stream is
 wanted, set the value to `false`.
 
 
+### options (optional)
+
+An Object containing misc configuration. The following values can be provided:
+
+ * gzip - Boolean value for enabling / disabling gzip on the connection against Twitter.
+ * pool - Sets pool configuration on the underlaying request.js object.
+
+Please refere to [request.js](https://github.com/request/request) for further
+documentation on these cunfiguration options.
+
+
 
 ## API
 

examples/site.basic.js

@@ -43,8 +43,8 @@ Twitter.on('connection error stall', function () {
     console.log('connection error stall');
 });
 
-Twitter.on('connection error http', function () {
-    console.log('connection error http');
+Twitter.on('connection error http', function (err) {
+    console.log('connection error http', err);
 });
 
 Twitter.on('connection rate limit', function () {

lib/main.js

@@ -27,14 +27,28 @@ var util        = require('util'),
   * @param {String} keys.consumer_secret Twitter consumer secret (API Secret)
   * @param {String} keys.token Twitter access token
   * @param {String} keys.token_secret Twitter access token secret
-  * @param {Boolean} objectMode If the stream should run in object mode or not. Default true.
+  * @param {(Boolean[]|Object[])} param1 If the stream should run in object mode or not. Default true.
+  * @param {Object[]} param2 A configurations Object
   */
 
-var Twitter = module.exports = function (keys, objectMode)  { 
+var Twitter = module.exports = function (keys, param1, param2)  { 
     var self = this;
-    objectMode = utils.isNullOrUndefined(objectMode) ? true : objectMode;
+    var objectMode = true;
+    var options = {};
 
-    this.connection = new Connection(keys);
+    if (utils.isBoolean(param1)) {
+        objectMode = param1;
+    }
+
+    if (utils.isObject(param1)) {
+        options = param1;
+    }
+
+    if (utils.isObject(param2)) {
+        options = param2;
+    }
+
+    this.connection = new Connection(keys, options);
     this.streamEndpoint = 'statuses/filter';
     this.streamParams = null;
 

test/main.js

@@ -0,0 +1,63 @@
+/* jshint node: true, strict: true */
+
+"use strict";
+
+var tap             = require('tap'),
+    TwitterStream   = require('../lib/main.js');
+
+
+var keys    = {
+    consumer_key: "a",
+    consumer_secret: "b",
+    token: "c",
+    token_secret: "d"
+};
+
+
+
+tap.test('Main() - no rest attributes set - "objectMode" should be "true" - "options" should be empty Object', function (t) {
+    var Twitter = new TwitterStream(keys);
+    t.equal(Twitter._readableState.objectMode, true);
+    t.same(Twitter.connection.options, {});
+    t.end();
+});
+
+
+tap.test('Main() - 1st rest attribute is "true" - "objectMode" should be "true" - "options" should be empty Object', function (t) {
+    var Twitter = new TwitterStream(keys, true);
+    t.equal(Twitter._readableState.objectMode, true);
+    t.same(Twitter.connection.options, {});
+    t.end();
+});
+
+
+tap.test('Main() - 1st rest attribute is "false" - "objectMode" should be "false" - "options" should be empty Object', function (t) {
+    var Twitter = new TwitterStream(keys, false);
+    t.equal(Twitter._readableState.objectMode, false);
+    t.same(Twitter.connection.options, {});
+    t.end();
+});
+
+
+tap.test('Main() - 1st rest attribute is a Object - "objectMode" should be "true" - "options" should be same Object', function (t) {
+    var Twitter = new TwitterStream(keys, {gzip : true});
+    t.equal(Twitter._readableState.objectMode, true);
+    t.same(Twitter.connection.options, {gzip : true});
+    t.end();
+});
+
+
+tap.test('Main() - 1st rest attribute is "true" - 2nd rest attribute is an Object - "objectMode" should be "true" - "options" should be same Object', function (t) {
+    var Twitter = new TwitterStream(keys, true, {gzip : true});
+    t.equal(Twitter._readableState.objectMode, true);
+    t.same(Twitter.connection.options, {gzip : true});
+    t.end();
+});
+
+
+tap.test('Main() - 1st rest attribute is "false"  - 2nd rest attribute is an Object - "objectMode" should be "true" - "options" should be same Object', function (t) {
+    var Twitter = new TwitterStream(keys, false, {gzip : true});
+    t.equal(Twitter._readableState.objectMode, false);
+    t.same(Twitter.connection.options, {gzip : true});
+    t.end();
+});