Bump version to 0.6.1.

Use singular repository to avoid warning

.npmignore

@@ -1,6 +1,6 @@
 .git
 .gitignore
 .npmignore
-.redcar
 .travis.yml
 node_modules
+spec

CHANGELOG.md

@@ -1,3 +1,20 @@
+### 0.6.1 / 2013-07-05
+
+* Add `ca` option to the client for specifying certificate authorities
+* Start the server driver asynchronously so that `onopen` handlers can be added
+
+
+### 0.6.0 / 2013-05-12
+
+* Add support for custom headers
+
+
+### 0.5.0 / 2013-05-05
+
+* Extract the protocol handlers into the `websocket-driver` library
+* Support the Node streaming API
+
+
 ### 0.4.4 / 2013-02-14
 
 * Emit the `close` event if TCP is closed before CLOSE frame is acked

README.md

@@ -52,13 +52,19 @@ server.on('upgrade', function(request, socket, body) {
       console.log('close', event.code, event.reason);
       ws = null;
     });
-
   }
 });
 
 server.listen(8000);
 ```
 
+`WebSocket` objects are also duplex streams, so you could replace the
+`ws.on('message', ...)` line with:
+
+```js
+    ws.pipe(ws);
+```
+
 Note that under certain circumstances (notably a draft-76 client connecting
 through an HTTP proxy), the WebSocket handshake will not be complete after you
 call `new WebSocket()` because the server will not have received the entire
@@ -108,6 +114,9 @@ ws.on('close', function(event) {
 });
 ```
 
+The WebSocket client also lets you inspect the status and headers of the
+handshake response via its `statusCode` and `headers` properties.
+
 
 ## Subprotocol negotiation
 
@@ -131,9 +140,28 @@ If the client and server agree on a protocol, both the client- and server-side
 socket objects expose the selected protocol through the `ws.protocol` property.
 
 
+## Initialization options
+
+Both the server- and client-side classes allow an options object to be passed
+in at initialization time, for example:
+
+```js
+var ws = new WebSocket(request, socket, body, protocols, options);
+var ws = new WebSocket.Client(url, protocols, options);
+```
+
+`protocols` is an array of subprotocols as described above, or `null`.
+`options` is an optional object containing any of these fields:
+
+* `headers` - an object containing key-value pairs representing HTTP headers to
+  be sent during the handshake process
+* `ping` - an integer that sets how often the WebSocket should send ping
+  frames, measured in seconds
+
+
 ## WebSocket API
 
-Both server- and client-side `WebSocket` objects support the following API:
+Both server- and client-side `WebSocket` objects support the following API.
 
 * <b>`on('open', function(event) {})`</b> fires when the socket connection is
   established. Event has no attributes.

examples/autobahn_client.js

@@ -28,14 +28,8 @@ socket.onclose = function() {
 
     } else {
       socket = new WebSocket.Client(host + '/runCase?case=' + n + '&agent=' + encodeURIComponent(agent));
-
-      socket.onmessage = function(event) {
-        socket.send(event.data);
-      };
-
-      socket.onclose = function() {
-        runCase(n + 1);
-      };
+      socket.pipe(socket);
+      socket.on('close', function() { runCase(n + 1) });
     }
   };
 

examples/client.js

@@ -2,7 +2,9 @@ var WebSocket = require('../lib/faye/websocket'),
     port      = process.argv[2] || 7000,
     secure    = process.argv[3] === 'ssl',
     scheme    = secure ? 'wss' : 'ws',
-    ws        = new WebSocket.Client(scheme + '://localhost:' + port + '/');
+    url       = scheme + '://localhost:' + port + '/',
+    headers   = {Origin: 'http://faye.jcoglan.com'},
+    ws        = new WebSocket.Client(url, null, {headers: headers});
 
 console.log('Connecting to ' + ws.url);
 

examples/server.js

@@ -35,7 +35,7 @@ var requestHandler = function(request, response) {
     }, 1000);
   }, 2000);
 
-  fs.createReadStream(__dirname + '/haproxy.conf').pipe(es);
+  fs.createReadStream(__dirname + '/haproxy.conf').pipe(es, {end: false});
 
   es.onclose = function() {
     clearInterval(loop);

lib/faye/websocket.js

@@ -10,8 +10,6 @@ var util   = require('util'),
 
 var WebSocket = function(request, socket, body, protocols, options) {
   this._stream  = socket;
-  this._ping    = options && options.ping;
-  this._pingId  = 0;
   this._driver  = driver.http(request, {protocols: protocols});
 
   var self = this;
@@ -24,13 +22,15 @@ var WebSocket = function(request, socket, body, protocols, options) {
   this._stream.setNoDelay(true);
 
   this._driver.io.write(body);
-  API.call(this);
+  API.call(this, options);
 
   ['error', 'end'].forEach(function(event) {
     this._stream.on(event, function() { self._finalize('', 1006) });
   }, this);
 
-  this._driver.start();
+  process.nextTick(function() {
+    self._driver.start();
+  });
 };
 util.inherits(WebSocket, API);
 

lib/faye/websocket/api.js

@@ -3,9 +3,18 @@ var Stream      = require('stream').Stream,
     EventTarget = require('./api/event_target'),
     Event       = require('./api/event');
 
-var API = function() {
+var API = function(options) {
+  options = options || {};
+
   this.readable = this.writable = true;
 
+  var headers = options.headers;
+  if (headers) {
+    for (var name in headers) this._driver.setHeader(name, headers[name]);
+  }
+
+  this._ping          = options.ping;
+  this._pingId        = 0;
   this.readyState     = API.CONNECTING;
   this.bufferedAmount = 0;
   this.protocol       = '';

lib/faye/websocket/client.js

@@ -7,16 +7,21 @@ var util   = require('util'),
 var Client = function(url, protocols, options) {
   this.url     = url;
   this._uri    = require('url').parse(url);
-  this._ping   = options && options.ping;
-  this._pingId = 0;
   this._driver = driver.client(url, {protocols: protocols});
 
+  ['open', 'error'].forEach(function(event) {
+    this._driver.on(event, function() {
+      self.headers    = self._driver.headers;
+      self.statusCode = self._driver.statusCode;
+    });
+  }, this);
+
   var secure     = (this._uri.protocol === 'wss:'),
       onConnect  = function() { self._driver.start() },
       tlsOptions = {},
       self       = this;
 
-  if (options && options.verify === false) tlsOptions.rejectUnauthorized = false;
+  if (options && options.ca) tlsOptions.ca = options.ca;
 
   var connection = secure
                  ? tls.connect(this._uri.port || 443, this._uri.hostname, tlsOptions, onConnect)
@@ -28,7 +33,7 @@ var Client = function(url, protocols, options) {
 
   if (!secure) this._stream.on('connect', onConnect);
 
-  API.call(this);
+  API.call(this, options);
 
   ['error', 'end'].forEach(function(event) {
     this._stream.on(event, function() { self._finalize('', 1006) });

package.json

@@ -3,25 +3,20 @@
 , "homepage"        : "http://github.com/faye/faye-websocket-node"
 , "author"          : "James Coglan <jcoglan@gmail.com> (http://jcoglan.com/)"
 , "keywords"        : ["websocket", "eventsource"]
+, "license"         : "MIT"
 
-, "version"         : "0.4.4"
+, "version"         : "0.6.1"
 , "engines"         : {"node": ">=0.4.0"}
 , "main"            : "./lib/faye/websocket"
-, "dependencies"    : {"websocket-driver": ""}
-, "devDependencies" : {"jsclass": "", "pace": ""}
+, "dependencies"    : {"websocket-driver": ">=0.2.0"}
+, "devDependencies" : {"jstest": "", "pace": ""}
 
-, "scripts"         : {"test": "node spec/runner.js"}
+, "scripts"         : {"test": "jstest spec/runner.js"}
+
+, "repository"      : { "type"  : "git"
+                      , "url"   : "git://github.com/faye/faye-websocket-node.git"
+                      }
 
 , "bugs"            : "http://github.com/faye/faye-websocket-node/issues"
-
-, "licenses"        : [ { "type"  : "MIT"
-                        , "url"   : "http://www.opensource.org/licenses/mit-license.php"
-                        }
-                      ]
-
-, "repositories"    : [ { "type"  : "git"
-                        , "url"   : "git://github.com/faye/faye-websocket-node.git"
-                        }
-                      ]
 }
 

spec/faye/websocket/client_spec.js

@@ -1,6 +1,8 @@
-var Client = require('../../../lib/faye/websocket/client')
+var Client = require('../../../lib/faye/websocket/client'),
+    test   = require('jstest').Test,
+    fs     = require('fs')
 
-JS.ENV.WebSocketSteps = JS.Test.asyncSteps({
+var WebSocketSteps = test.asyncSteps({
   server: function(port, secure, callback) {
     this._adapter = new EchoServer()
     this._adapter.listen(port, secure)
@@ -24,7 +26,9 @@ JS.ENV.WebSocketSteps = JS.Test.asyncSteps({
                    callback()
                  }
 
-    this._ws = new Client(url, protocols, {verify: false})
+    this._ws = new Client(url, protocols, {
+      ca: fs.readFileSync(__dirname + '/../../server.crt')
+    })
 
     this._ws.onopen  = function() { resume(true)  }
     this._ws.onclose = function() { resume(false) }
@@ -77,7 +81,7 @@ JS.ENV.WebSocketSteps = JS.Test.asyncSteps({
 })
 
 
-JS.ENV.ClientSpec = JS.Test.describe("Client", function() { with(this) {
+test.describe("Client", function() { with(this) {
   include(WebSocketSteps)
 
   before(function() {

spec/runner.js

@@ -1,12 +1,11 @@
-require('jsclass')
-
 var WebSocket = require('../lib/faye/websocket'),
     fs        = require('fs'),
     http      = require('http'),
-    https     = require('https')
+    https     = require('https'),
+    test      = require('jstest').Test
 
 
-JS.ENV.EchoServer = function() {}
+EchoServer = function() {}
 EchoServer.prototype.listen = function(port, ssl) {
   var server = ssl
              ? https.createServer({
@@ -30,8 +29,5 @@ EchoServer.prototype.stop = function(callback, scope) {
 }
 
 
-JS.require('JS.Test', function() {
-  require('./faye/websocket/client_spec')
-  JS.Test.autorun()
-})
+require('./faye/websocket/client_spec')
 

spec/server.crt

@@ -1,15 +1,14 @@
 -----BEGIN CERTIFICATE-----
-MIICZTCCAc4CCQDxyrJZrFA0vjANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJV
-SzEPMA0GA1UECBMGTG9uZG9uMQ8wDQYDVQQHEwZMb25kb24xDTALBgNVBAoTBEZh
-eWUxFTATBgNVBAMTDEphbWVzIENvZ2xhbjEgMB4GCSqGSIb3DQEJARYRamNvZ2xh
-bkBnbWFpbC5jb20wHhcNMTEwODMwMTIzOTM2WhcNMTIwODI5MTIzOTM2WjB3MQsw
-CQYDVQQGEwJVSzEPMA0GA1UECBMGTG9uZG9uMQ8wDQYDVQQHEwZMb25kb24xDTAL
-BgNVBAoTBEZheWUxFTATBgNVBAMTDEphbWVzIENvZ2xhbjEgMB4GCSqGSIb3DQEJ
-ARYRamNvZ2xhbkBnbWFpbC5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGB
-AMDjU5fAK7fvUCZIYHcGXDZD/m9bY+B/UcwGcowk0hMQGYNlLKrpiK7xXBmZpDb6
-r8n+7L/epBeSumbRIm4TDzeNHhuQGYLIeGQy7JNLoPBr6GxubjuJhKOOBnCqcupR
-CLGG7Zw5oL4UvtZVH6kL9XnjyokQQbxxeoV9DqtqOaHHAgMBAAEwDQYJKoZIhvcN
-AQEFBQADgYEAvQjSpzE1ahaeH1CmbLwckTxvWMZfxcZOrxTruK1po3cNnDOjGqFQ
-KEkNj3K5WfwTBD4QgUdYDykhDX2m6HaMz4JEbgrwQv8M8FiswIA3dyGsbOifOk8H
-r3GPNKMzm4o6vrn6RGOpt9q6bsWUBUHfNpP93uU2C9QEwDua3cFjDA0=
+MIICKTCCAZICCQDtAJo/efrTvjANBgkqhkiG9w0BAQUFADBZMQswCQYDVQQGEwJV
+SzETMBEGA1UECBMKU29tZS1TdGF0ZTEPMA0GA1UEBxMGTG9uZG9uMRAwDgYDVQQK
+EwdqY29nbGFuMRIwEAYDVQQDEwlsb2NhbGhvc3QwHhcNMTMwNjE5MDcwNzQ1WhcN
+MTQwNjE5MDcwNzQ1WjBZMQswCQYDVQQGEwJVSzETMBEGA1UECBMKU29tZS1TdGF0
+ZTEPMA0GA1UEBxMGTG9uZG9uMRAwDgYDVQQKEwdqY29nbGFuMRIwEAYDVQQDEwls
+b2NhbGhvc3QwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBALhPVRbctfcjCJEC
+DsZfgtTMVYMsvV/miLxc7veumuuApe5y3DFuG8Tlz3/0wrvRm3dCSUOfIBK8ktor
+VoY6QGHwrhYK2MhnJQOUTYC+FCyUp4zAYjRgJWd4uTii+uqRbLCPOF8jEx7VunTT
+Lj9hu82IdRgT3OtqzPUoTmYXCXSZAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAcARo
+TO7LTbII0HIsB7PePspFkwiuYQtvFqYm10I+4yuIdfPBdH0/OBhKvNC1O7tc7dmy
+NPd8e5FXrt6qHDgCVh0kpg37sMJp42jUCn4lguWKN5dZPkzGrRFUfXvcx1qwdF2T
+0CgyULvKWl9wt3Wp5feG8dNn1UZOGlZBZ+0GNyk=
 -----END CERTIFICATE-----

spec/server.key

@@ -1,15 +1,15 @@
 -----BEGIN RSA PRIVATE KEY-----
-MIICXAIBAAKBgQDA41OXwCu371AmSGB3Blw2Q/5vW2Pgf1HMBnKMJNITEBmDZSyq
-6Yiu8VwZmaQ2+q/J/uy/3qQXkrpm0SJuEw83jR4bkBmCyHhkMuyTS6Dwa+hsbm47
-iYSjjgZwqnLqUQixhu2cOaC+FL7WVR+pC/V548qJEEG8cXqFfQ6rajmhxwIDAQAB
-AoGABlk1DiCQD8y7mZb2PdSiwlJ4lFewsNnf6lQn/v7TPzdfb5ir4LAxBHkDLACH
-jBuyH3bZefMs+W2l3u5xMKhF7uJqYcUlJdH2UwRfNG54Hn4SGAjQOK3ONer99sUf
-USlsWSX1HjAAFMCBwUfKxMZA3VNQfYKTPdm0jSVf85kHO1ECQQD3s6ksm3QpfD0L
-eG9EoDrqmwnEfpKoWPpz1O0i5tY9VcmhmLwS5Zpd7lB1qjTqzZk4RygU73T/BseJ
-azehIHK5AkEAx1mSXt+ec8RfzVi/io6oqi2vOcACXRbOG4NQmqUWPnumdwsJjsjR
-RzEoDFC2lu6448p9sgEq+CkbmgVeiyp4fwJAQnmgySve/NMuvslPcyddKGD7OhSN
-30ghzrwx98/jZwqC1i9bKeccimDOjwVitjD/Ea9m/ldVGqwDGMoBX+iJYQJAEIOO
-CYfyw1pQKV2huGOq+zX/nwQV7go2lrbhFX55gkGR/6iNaSOfmosq6yJAje5GqLAc
-i4NnQNl+7NpnA5ZIFwJBAI1+OsZyjbRI99pYkTdOpa5IPlIb3j3JbSfjAWHLxlRY
-0HLvN3Q1mE9kbB+uKH6syF/S7nALgsLgq7eHYvIaE/A=
+MIICXAIBAAKBgQC4T1UW3LX3IwiRAg7GX4LUzFWDLL1f5oi8XO73rprrgKXuctwx
+bhvE5c9/9MK70Zt3QklDnyASvJLaK1aGOkBh8K4WCtjIZyUDlE2AvhQslKeMwGI0
+YCVneLk4ovrqkWywjzhfIxMe1bp00y4/YbvNiHUYE9zrasz1KE5mFwl0mQIDAQAB
+AoGAfcTc6oHnxeHpKZJ+5I0uaOmafK2d+IAG1IqSIv/KBWQ/VoyYhz58woqTYtxx
+udqZvPLFrdg6+a4mg6vJGkVLwp/PFi7r57/vqUR/P8SnuV0iTJZ7BczZHSffdzgT
+9v2XUDFZ3ZSjIi+XkCMirHc7G8BVYImqjCGy80NX3YB5RRECQQDuX+udSSZi2I0C
+gT/LnoVsb8JkanNALZH/U/XQog50I9aNf2GAAboUVsGuETL3I9f12Ku0A+xK5biv
+s4P4g01FAkEAxfALp1Yzud+ooNmbbtSTE6hrUwjFeG1skEW4GvocB5ZiQqXwv59v
+AmWedup7St2kamb5vNtcpewHGd2kUpatRQJARDwg7f0qh9EFTFpDML5H4yp6stPl
++dERoc0e6IH7MTOxDwAPoNzdr0TGXFWACU6xWyaSwAz/btEjdOgmNtUfIQJAFrWO
+sLksIBQwBZxRv+p1oVi+T31/Imzzeq31DGtLkfdH+LuPHn0NQGomPyBx2soJFggQ
+eQF15LdqrSYHt04APQJBAO2SPMC7MxDKdhryf6PDcaL/lTKSxRttQ72jZmDU9ujp
+dcvFPgrQTa3iNLm4SWvARFXXZrrGEeDgKX7jVJygfI4=
 -----END RSA PRIVATE KEY-----