Bump version to 0.4.1.

Conflicts:
	lib/faye/websocket.js
	lib/faye/websocket/protocol8_parser.js

.npmignore

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

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - 0.4
+  - 0.6
+  - 0.7

CHANGELOG.txt

@@ -0,0 +1,45 @@
+=== 0.4.1 / 2012-02-26
+
+* Treat anything other than a Buffer as a string when calling send()
+
+
+=== 0.4.0 / 2012-02-13
+
+* Add ping() method to server-side WebSocket and EventSource
+* Buffer send() calls until the draft-76 handshake is complete
+* Fix HTTPS problems on Node 0.7
+
+
+=== 0.3.1 / 2012-01-16
+
+* Call setNoDelay(true) on net.Socket objects to reduce latency
+
+
+=== 0.3.0 / 2012-01-13
+
+* Add support for EventSource connections
+
+
+=== 0.2.0 / 2011-12-21
+
+* Add support for Sec-WebSocket-Protocol negotiation
+* Support hixie-76 close frames and 75/76 ignored segments
+* Improve performance of HyBi parsing/framing functions
+* Decouple parsers from TCP and reduce write volume
+
+
+=== 0.1.2 / 2011-12-05
+
+* Detect closed sockets on the server side when TCP connection breaks
+* Make hixie-76 sockets work through HAProxy
+
+
+=== 0.1.1 / 2011-11-30
+
+* Fix addEventListener() interface methods
+
+
+=== 0.1.0 / 2011-11-27
+
+* Initial release, based on WebSocket components from Faye
+

README.markdown

@@ -1,5 +1,8 @@
 # faye-websocket
 
+* Travis CI build: [<img src="https://secure.travis-ci.org/faye/faye-websocket-node.png" />](http://travis-ci.org/faye/faye-websocket-node)
+* Autobahn tests: [server](http://faye.jcoglan.com/autobahn/servers/), [client](http://faye.jcoglan.com/autobahn/clients/)
+
 This is a robust, general-purpose WebSocket implementation extracted from the
 [Faye](http://faye.jcoglan.com) project. It provides classes for easily building
 WebSocket servers and clients in Node. It does not provide a server itself, but
@@ -7,6 +10,11 @@ rather makes it easy to handle WebSocket connections within an existing
 [Node](http://nodejs.org/) application. It does not provide any abstraction
 other than the standard [WebSocket API](http://dev.w3.org/html5/websockets/).
 
+It also provides an abstraction for handling [EventSource](http://dev.w3.org/html5/eventsource/)
+connections, which are one-way connections that allow the server to push data to
+the client. They are based on streaming HTTP responses and can be easier to
+access via proxies than WebSockets.
+
 The server-side socket can process [draft-75](http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75),
 [draft-76](http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76),
 [hybi-07](http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07)
@@ -15,7 +23,7 @@ supports both `text` and `binary` messages, and transparently handles `ping`,
 `pong`, `close` and fragmented messages.
 
 
-## Accepting WebSocket connections in Node
+## Handling WebSocket connections in Node
 
 You can handle WebSockets on the server side by listening for HTTP Upgrade
 requests, and creating a new socket for the request. This socket object exposes
@@ -44,13 +52,34 @@ server.addListener('upgrade', function(request, socket, head) {
 server.listen(8000);
 ```
 
+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
+handshake from the client yet. In this case, calls to `ws.send()` will buffer
+the message in memory until the handshake is complete, at which point any
+buffered messages will be sent to the client.
+
+If you need to detect when the WebSocket handshake is complete, you can use the
+`onopen` event.
+
+If the connection's protocol version supports it, you can call `ws.ping()` to
+send a ping message and wait for the client's response. This method takes a
+message string, and an optional callback that fires when a matching pong message
+is received. It returns `true` iff a ping message was sent. If the client does
+not support ping/pong, this method sends no data and returns `false`.
+
+```js
+ws.ping('Mic check, one, two', function() {
+  // fires when pong is received
+});
+```
+
 
 ## Using the WebSocket client
 
 The client supports both the plain-text `ws` protocol and the encrypted `wss`
 protocol, and has exactly the same interface as a socket you would use in a web
-browser. On the wire it identifies itself as hybi-08, though it's compatible
-with servers speaking later versions of the protocol, at least up to version 17.
+browser. On the wire it identifies itself as hybi-13.
 
 ```js
 var WebSocket = require('faye-websocket'),
@@ -72,6 +101,29 @@ ws.onclose = function(event) {
 ```
 
 
+## Subprotocol negotiation
+
+The WebSocket protocol allows peers to select and identify the application
+protocol to use over the connection. On the client side, you can set which
+protocols the client accepts by passing a list of protocol names when you
+construct the socket:
+
+```js
+var ws = new WebSocket.Client('ws://www.example.com/', ['irc', 'amqp']);
+```
+
+On the server side, you can likewise pass in the list of protocols the server
+supports after the other constructor arguments:
+
+```js
+var ws = new WebSocket(request, socket, head, ['irc', 'amqp']);
+```
+
+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.
+If they cannot agree on a protocol to use, the client closes the connection.
+
+
 ## WebSocket API
 
 The WebSocket API consists of several event handlers and a method for sending
@@ -92,13 +144,90 @@ messages.
   sends a text or binary message over the connection to the other peer.
 * <b><tt>close(code, reason)</tt></b> closes the connection, sending the given
   status code and reason text, both of which are optional.
+* <b><tt>protocol</tt></b> is a string (which may be empty) identifying the
+  subprotocol the socket is using.
+
+
+## Handling EventSource connections in Node
+
+EventSource connections provide a very similar interface, although because they
+only allow the server to send data to the client, there is no `onmessage` API.
+EventSource allows the server to push text messages to the client, where each
+message has an optional event-type and ID.
+
+```js
+var WebSocket   = require('faye-websocket'),
+    EventSource = WebSocket.EventSource,
+    http        = require('http');
+
+var server = http.createServer();
+
+server.addListener('request', function(request, response) {
+  if (EventSource.isEventSource(request)) {
+    var es = new EventSource(request, response);
+    console.log('open', es.url, es.lastEventId);
+    
+    // Periodically send messages
+    var loop = setInterval(function() { es.send('Hello') }, 1000);
+    
+    es.onclose = function() {
+      clearInterval(loop);
+      es = null;
+    };
+  
+  } else {
+    // Normal HTTP request
+    response.writeHead(200, {'Content-Type': 'text/plain'});
+    response.write('Hello');
+    response.end();
+  }
+});
+
+server.listen(8000);
+```
+
+The `send` method takes two optional parameters, `event` and `id`. The default
+event-type is `'message'` with no ID. For example, to send a `notification`
+event with ID `99`:
+
+```js
+es.send('Breaking News!', {event: 'notification', id: '99'});
+```
+
+The `EventSource` object exposes the following properties:
+
+* <b><tt>url</tt></b> is a string containing the URL the client used to create
+  the EventSource.
+* <b><tt>lastEventId</tt></b> is a string containing the last event ID
+  received by the client. You can use this when the client reconnects after a
+  dropped connection to determine which messages need resending.
+
+When you initialize an EventSource with ` new EventSource()`, you can pass
+configuration options after the `response` parameter. Available options are:
+
+* <b><tt>retry</tt></b> is a number that tells the client how long (in seconds)
+  it should wait after a dropped connection before attempting to reconnect.
+* <b><tt>ping</tt></b> is a number that tells the server how often (in seconds)
+  to send 'ping' packets to the client to keep the connection open, to defeat
+  timeouts set by proxies. The client will ignore these messages.
+
+For example, this creates a connection that pings every 15 seconds and is
+retryable every 10 seconds if the connection is broken:
+
+```js
+var es = new EventSource(request, response, {ping: 15, retry: 10});
+```
+
+You can send a ping message at any time by calling `es.ping()`. Unlike WebSocket,
+the client does not send a response to this; it is merely to send some data over
+the wire to keep the connection alive.
 
 
 ## License
 
 (The MIT License)
 
-Copyright (c) 2009-2011 James Coglan
+Copyright (c) 2009-2012 James Coglan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the 'Software'), to deal in

examples/benchmark.html

@@ -1,41 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
-    <title>WebSocket benchmarks</title>
-  </head>
-  <body>
-    
-    <div id="out"></div>
-    
-    <script type="text/javascript">
-      var Socket = window.MozWebSocket || window.WebSocket,
-          socket = new Socket('ws://' + location.hostname + ':' + location.port + '/'),
-          out    = document.getElementById('out');
-      
-      var msg = '', n = 64000;
-      while (n--) msg += 'X';
-      
-      var start = new Date().getTime();
-      
-      function ping(event) {
-        var data = (event && event.data) || '0',
-            id   = parseInt(data.split(':')[0]) + 1;
-        
-        out.innerHTML = id;
-        
-        if (id === 1000) {
-          var time = new Date().getTime() - start;
-          out.innerHTML = 'Time: ' + time;
-        } else {
-          socket.send(id + ':' + msg);
-        }
-      };
-      
-      socket.onopen = ping;
-      socket.onmessage = ping;
-    </script>
-    
-  </body>
-</html>
-

examples/server.js

@@ -6,6 +6,46 @@ var WebSocket = require('../lib/faye/websocket'),
 var port   = process.argv[2] || 7000,
     secure = process.argv[3] === 'ssl';
 
+var upgradeHandler = function(request, socket, head) {
+  var ws = new WebSocket(request, socket, head, ['irc', 'xmpp'], {ping: 5});
+  console.log('open', ws.url, ws.version, ws.protocol);
+  
+  ws.onmessage = function(event) {
+    ws.send(event.data);
+  };
+  
+  ws.onclose = function(event) {
+    console.log('close', event.code, event.reason);
+    ws = null;
+  };
+};
+
+var requestHandler = function(request, response) {
+  if (!WebSocket.EventSource.isEventSource(request))
+    return staticHandler(request, response);
+  
+  var es   = new WebSocket.EventSource(request, response),
+      time = parseInt(es.lastEventId, 10) || 0;
+  
+  console.log('open', es.url, es.lastEventId);
+  
+  var loop = setInterval(function() {
+    time += 1;
+    es.send('Time: ' + time);
+    setTimeout(function() {
+      if (es) es.send('Update!!', {event: 'update', id: time});
+    }, 1000);
+  }, 2000);
+  
+  es.send('Welcome!\n\nThis is an EventSource server.');
+  
+  es.onclose = function() {
+    clearInterval(loop);
+    console.log('close', es.url);
+    es = null;
+  };
+};
+
 var staticHandler = function(request, response) {
   var path = request.url;
   
@@ -22,20 +62,9 @@ var server = secure
                key:  fs.readFileSync(__dirname + '/../spec/server.key'),
                cert: fs.readFileSync(__dirname + '/../spec/server.crt')
              })
-           : http.createServer(staticHandler);
-
-server.addListener('upgrade', function(request, socket, head) {
-  var ws = new WebSocket(request, socket, head);
-  console.log('open', ws.url, ws.version);
-  
-  ws.onmessage = function(event) {
-    ws.send(event.data);
-  };
-  
-  ws.onclose = function(event) {
-    console.log('close', event.code, event.reason);
-    ws = null;
-  };
-});
+           : http.createServer();
 
+server.addListener('request', requestHandler);
+server.addListener('upgrade', upgradeHandler);
 server.listen(port);
+

examples/sse.html

@@ -0,0 +1,39 @@
+<!doctype html>
+<html>
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+    <title>EventSource test</title>
+  </head>
+  <body>
+    
+    <h1>EventSource test</h1>
+    <ul></ul>
+    
+    <script type="text/javascript">
+      var logger = document.getElementsByTagName('ul')[0],
+          socket = new EventSource('/');
+      
+      var log = function(text) {
+        logger.innerHTML += '<li>' + text + '</li>';
+      };
+      
+      socket.onopen = function() {
+        log('OPEN');
+      };
+      
+      socket.onmessage = function(event) {
+        log('MESSAGE: ' + event.data);
+      };
+      
+      socket.addEventListener('update', function(event) {
+        log('UPDATE(' + event.lastEventId + '): ' + event.data);
+      });
+      
+      socket.onerror = function(event) {
+        log('ERROR: ' + event.message);
+      };
+    </script>
+    
+  </body>
+</html>
+

examples/ws.html

@@ -12,21 +12,30 @@
     <script type="text/javascript">
       var logger = document.getElementsByTagName('ul')[0],
           Socket = window.MozWebSocket || window.WebSocket,
-          socket = new Socket('ws://' + location.hostname + ':' + location.port + '/'),
+          protos = ['foo', 'bar', 'xmpp'],
+          socket = new Socket('ws://' + location.hostname + ':' + location.port + '/', protos),
           index  = 0;
       
-      socket.onopen = function() {
-        logger.innerHTML += '<li>OPEN</li>';
-        socket.send('Hello, world');
+      var log = function(text) {
+        logger.innerHTML += '<li>' + text + '</li>';
       };
       
-      socket.addEventListener('message', function(event) {
-        logger.innerHTML += '<li>MESSAGE: ' + event.data + '</li>';
-        setTimeout(function() { socket.send(++index + ' ' + event.data) }, 2000);
+      socket.addEventListener('open', function() {
+        log('OPEN: ' + socket.protocol);
+        socket.send('Hello, world');
       });
       
+      socket.onerror = function(event) {
+        log('ERROR: ' + event.message);
+      };
+      
+      socket.onmessage = function(event) {
+        log('MESSAGE: ' + event.data);
+        setTimeout(function() { socket.send(++index + ' ' + event.data) }, 2000);
+      };
+      
       socket.onclose = function(event) {
-        logger.innerHTML += '<li>CLOSE: ' + event.code + ', ' + event.reason + '</li>';
+        log('CLOSE: ' + event.code + ', ' + event.reason);
       };
     </script>
     

lib/faye/eventsource.js

@@ -0,0 +1,109 @@
+var API   = require('./websocket/api'),
+    Event = require('./websocket/api/event');
+
+var isSecureConnection = function(request) {
+  if (request.headers['x-forwarded-proto']) {
+    return request.headers['x-forwarded-proto'] === 'https';
+  } else {
+    return (request.connection && request.connection.authorized !== undefined) ||
+           (request.socket && request.socket.secure);
+  }
+};
+
+var EventSource = function(request, response, options) {
+  options = options || {};
+  
+  this._request  = request;
+  this._response = response;
+  this._stream   = response.socket;
+  this._ping     = options.ping  || this.DEFAULT_PING;
+  this._retry    = options.retry || this.DEFAULT_RETRY;
+  
+  this._stream.setTimeout(0);
+  this._stream.setNoDelay(true);
+  
+  var scheme = isSecureConnection(request) ? 'https:' : 'http:';
+  this.url = scheme + '//' + request.headers.host + request.url;
+  
+  this.lastEventId = request.headers['last-event-id'] || '';
+  
+  var self = this;
+  this.readyState = API.CONNECTING;
+  this._sendBuffer = [];
+  process.nextTick(function() { self._open() });
+  
+  var handshake = 'HTTP/1.1 200 OK\r\n' +
+                  'Content-Type: text/event-stream\r\n' +
+                  'Cache-Control: no-cache, no-store\r\n' +
+                  '\r\n\r\n' +
+                  'retry: ' + Math.floor(this._retry * 1000) + '\r\n\r\n';
+  
+  try {
+    this._stream.write(handshake, 'utf8');
+  } catch (e) {}
+  
+  this.readyState = API.OPEN;
+  
+  if (this._ping)
+    this._pingLoop = setInterval(function() { self.ping() }, this._ping * 1000);
+  
+  ['close', 'end', 'error'].forEach(function(event) {
+    self._stream.addListener(event, function() { self.close() });
+  });
+};
+
+EventSource.isEventSource = function(request) {
+  var accept = (request.headers.accept || '').split(/\s*,\s*/);
+  return accept.indexOf('text/event-stream') >= 0;
+};
+
+var instance = {
+  DEFAULT_PING:   10,
+  DEFAULT_RETRY:  5,
+  
+  send: function(message, options) {
+    if (this.readyState !== API.OPEN) return false;
+    
+    message = String(message).replace(/(\r\n|\r|\n)/g, '$1data: ');
+    options = options || {};
+    
+    var frame = '';
+    if (options.event) frame += 'event: ' + options.event + '\r\n';
+    if (options.id)    frame += 'id: '    + options.id    + '\r\n';
+    frame += 'data: ' + message + '\r\n\r\n';
+    
+    try {
+      this._stream.write(frame, 'utf8');
+      return true;
+    } catch (e) {
+      return false;
+    }
+  },
+  
+  ping: function() {
+    try {
+      this._stream.write(':\r\n\r\n', 'utf8');
+      return true;
+    } catch (e) {
+      return false;
+    }
+  },
+  
+  close: function() {
+    if (this.readyState === API.CLOSING || this.readyState === API.CLOSED)
+      return;
+    
+    this.readyState = API.CLOSED;
+    clearInterval(this._pingLoop);
+    this._response.end();
+    
+    var event = new Event('close');
+    event.initEvent('close', false, false);
+    this.dispatchEvent(event);
+  }
+};
+
+for (var key in API) EventSource.prototype[key] = API[key];
+for (var key in instance) EventSource.prototype[key] = instance[key];
+module.exports = EventSource;
+

lib/faye/websocket.js

@@ -7,15 +7,16 @@
 // * http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76
 // * http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-17
 
-var Draft75Parser   = require('./websocket/draft75_parser'),
-    Draft76Parser   = require('./websocket/draft76_parser'),
-    Protocol8Parser = require('./websocket/protocol8_parser'),
-    API             = require('./websocket/api');
+var Draft75Parser = require('./websocket/draft75_parser'),
+    Draft76Parser = require('./websocket/draft76_parser'),
+    HybiParser    = require('./websocket/hybi_parser'),
+    API           = require('./websocket/api'),
+    Event         = require('./websocket/api/event');
 
 var getParser = function(request) {
   var headers = request.headers;
   return headers['sec-websocket-version']
-       ? Protocol8Parser
+       ? HybiParser
        : (headers['sec-websocket-key1'] && headers['sec-websocket-key2'])
        ? Draft76Parser
        : Draft75Parser;
@@ -30,43 +31,61 @@ var isSecureConnection = function(request) {
   }
 };
 
-var WebSocket = function(request, socket, head) {
+var WebSocket = function(request, socket, head, supportedProtos, options) {
   this.request = request;
   this._stream = request.socket;
+  this._ping   = options && options.ping;
+  this._pingId = 0;
+  
+  this._stream.setTimeout(0);
+  this._stream.setNoDelay(true);
   
   var scheme = isSecureConnection(request) ? 'wss:' : 'ws:';
-  this.url = scheme + '//' + request.headers.host + request.url;    
+  this.url = scheme + '//' + request.headers.host + request.url;
   this.readyState = API.CONNECTING;
   this.bufferedAmount = 0;
   
   var Parser = getParser(request);
-  this._parser = new Parser(this);
+  this._parser = new Parser(this, {protocols: supportedProtos});
+  
+  var self = this;
+  this._sendBuffer = [];
+  process.nextTick(function() { self._open() });
   
   var handshake = this._parser.handshakeResponse(head);
   try { this._stream.write(handshake, 'binary') } catch (e) {}
   
-  this.readyState = API.OPEN;
+  if (this._parser.isOpen()) this.readyState = API.OPEN;
+  
+  if (this._ping)
+    this._pingLoop = setInterval(function() {
+      self._pingId += 1;
+      self.ping(self._pingId.toString());
+    }, this._ping * 1000);
+  
+  this.protocol = this._parser.protocol || '';
   this.version = this._parser.getVersion();
   
-  var event = new API.Event('open');
-  event.initEvent('open', false, false);
-  this.dispatchEvent(event);
-  
-  var self = this;
-  
   this._stream.addListener('data', function(data) {
     var response = self._parser.parse(data);
     if (!response) return;
     try { self._stream.write(response, 'binary') } catch (e) {}
+    self._open();
   });
   ['close', 'end', 'error'].forEach(function(event) {
     self._stream.addListener(event, function() { self.close(1006, '', false) });
   });
 };
 
-var API = require('./websocket/api');
+WebSocket.prototype.ping = function(message, callback, context) {
+  if (!this._parser.ping) return false;
+  return this._parser.ping(message, callback, context);
+};
+
 for (var key in API) WebSocket.prototype[key] = API[key];
 
-WebSocket.Client = require('./websocket/client');
-module.exports   = WebSocket;
+WebSocket.WebSocket   = WebSocket;
+WebSocket.Client      = require('./websocket/client');
+WebSocket.EventSource = require('./eventsource');
+module.exports        = WebSocket;
 

lib/faye/websocket/api.js

@@ -1,24 +1,50 @@
+var EventTarget = require('./api/event_target'),
+    Event       = require('./api/event');
+
 var API = {
   CONNECTING:   0,
   OPEN:         1,
   CLOSING:      2,
   CLOSED:       3,
   
-  onopen:     null,
-  onmessage:  null,
-  onerror:    null,
-  onclose:    null,
+  _open: function() {
+    if (this._parser && !this._parser.isOpen()) return;
+    this.readyState = API.OPEN;
+    
+    var buffer = this._sendBuffer || [],
+        message;
+    
+    while (message = buffer.shift())
+      this.send.apply(this, message);
+    
+    var event = new Event('open');
+    event.initEvent('open', false, false);
+    this.dispatchEvent(event);
+  },
   
   receive: function(data) {
     if (this.readyState !== API.OPEN) return false;
-    var event = new API.Event('message');
+    var event = new Event('message');
     event.initEvent('message', false, false);
     event.data = data;
     this.dispatchEvent(event);
   },
   
   send: function(data, type, errorType) {
-    if (this.readyState === API.CLOSED) return false;
+    if (this.readyState === API.CONNECTING) {
+      if (this._sendBuffer) {
+        this._sendBuffer.push(arguments);
+        return true;
+      } else {
+        throw new Error('Cannot call send(), socket is not open yet');
+      }
+    }
+    
+    if (this.readyState === API.CLOSED)
+      return false;
+    
+    if (!(data instanceof Buffer)) data = String(data);
+    
     var frame = this._parser.frame(data, type, errorType);
     try {
       this._stream.write(frame, 'binary');
@@ -36,8 +62,9 @@ var API = {
     
     var close = function() {
       this.readyState = API.CLOSED;
+      if (this._pingLoop) clearInterval(this._pingLoop);
       this._stream.end();
-      var event = new API.Event('close', {code: code || 1000, reason: reason || ''});
+      var event = new Event('close', {code: code || 1000, reason: reason || ''});
       event.initEvent('close', false, false);
       this.dispatchEvent(event);
     };
@@ -49,66 +76,10 @@ var API = {
       if (this._parser.close) this._parser.close(code, reason);
       close.call(this);
     }
-  },
-  
-  addEventListener: function(eventType, listener, useCapture) {
-    this._listeners = this._listeners || {};
-    var list = this._listeners[eventType] = this._listeners[eventType] || [];
-    list.push(listener);
-  },
-  
-  removeEventListener: function(eventType, listener, useCapture) {
-    if (!this._listeners || !this._listeners[eventType]) return;
-    
-    if (!listener) {
-      delete this._listeners[eventType];
-      return;
-    }
-    var list = this._listeners[eventType],
-        i    = list.length;
-    
-    while (i--) {
-      if (listener !== list[i]) continue;
-      list.splice(i,1);
-    }
-  },
-  
-  dispatchEvent: function(event) {
-    event.target = event.currentTarget = this;
-    event.eventPhase = API.Event.AT_TARGET;
-    
-    if (this['on' + event.type])
-      this['on' + event.type](event);
-    
-    if (!this._listeners || !this._listeners[event.type]) return;
-    
-    this._listeners[event.type].forEach(function(listener) {
-      listener(event);
-    }, this);
   }
 };
 
-
-var Event = function(eventType, options) {
-  this.type = eventType;
-  for (var key in options)
-    this[key] = options[key];
-};
-    
-Event.prototype.initEvent = function(eventType, canBubble, cancelable) {
-  this.type       = eventType;
-  this.bubbles    = canBubble;
-  this.cancelable = cancelable;
-};
-
-Event.prototype.stopPropagation = function() {};
-Event.prototype.preventDefault  = function() {};
-    
-Event.CAPTURING_PHASE = 1;
-Event.AT_TARGET       = 2;
-Event.BUBBLING_PHASE  = 3;
-
-API.Event = Event;
+for (var key in EventTarget) API[key] = EventTarget[key];
 
 module.exports = API;
 

lib/faye/websocket/api/event.js

@@ -0,0 +1,21 @@
+var Event = function(eventType, options) {
+  this.type = eventType;
+  for (var key in options)
+    this[key] = options[key];
+};
+    
+Event.prototype.initEvent = function(eventType, canBubble, cancelable) {
+  this.type       = eventType;
+  this.bubbles    = canBubble;
+  this.cancelable = cancelable;
+};
+
+Event.prototype.stopPropagation = function() {};
+Event.prototype.preventDefault  = function() {};
+    
+Event.CAPTURING_PHASE = 1;
+Event.AT_TARGET       = 2;
+Event.BUBBLING_PHASE  = 3;
+
+module.exports = Event;
+

lib/faye/websocket/api/event_target.js

@@ -0,0 +1,47 @@
+var Event = require('./event');
+
+var EventTarget = {
+  onopen:     null,
+  onmessage:  null,
+  onerror:    null,
+  onclose:    null,
+  
+  addEventListener: function(eventType, listener, useCapture) {
+    this._listeners = this._listeners || {};
+    var list = this._listeners[eventType] = this._listeners[eventType] || [];
+    list.push(listener);
+  },
+  
+  removeEventListener: function(eventType, listener, useCapture) {
+    if (!this._listeners || !this._listeners[eventType]) return;
+    
+    if (!listener) {
+      delete this._listeners[eventType];
+      return;
+    }
+    var list = this._listeners[eventType],
+        i    = list.length;
+    
+    while (i--) {
+      if (listener !== list[i]) continue;
+      list.splice(i,1);
+    }
+  },
+  
+  dispatchEvent: function(event) {
+    event.target = event.currentTarget = this;
+    event.eventPhase = Event.AT_TARGET;
+    
+    if (this['on' + event.type])
+      this['on' + event.type](event);
+    
+    if (!this._listeners || !this._listeners[event.type]) return;
+    
+    this._listeners[event.type].forEach(function(listener) {
+      listener(event);
+    }, this);
+  }
+};
+
+module.exports = EventTarget;
+

lib/faye/websocket/client.js

@@ -1,13 +1,15 @@
-var API = require('./api'),
-    net = require('net'),
+var net = require('net'),
     tls = require('tls');
 
-var Protocol8Parser = require('./protocol8_parser');
+var HybiParser = require('./hybi_parser'),
+    API        = require('./api'),
+    Event      = require('./api/event');
 
-var Client = function(url) {
+var Client = function(url, protocols) {
   this.url  = url;
   this._uri = require('url').parse(url);
   
+  this.protocol = '';
   this.readyState = API.CONNECTING;
   this.bufferedAmount = 0;
   
@@ -16,21 +18,23 @@ var Client = function(url) {
       onConnect  = function() { self._onConnect() },
       
       connection = secure
-                 ? tls.connect(this._uri.port || 443, this._uri.hostname, onConnect)
+                 ? tls.connect(this._uri.port || 443, this._uri.hostname, {}, onConnect)
                  : net.createConnection(this._uri.port || 80, this._uri.hostname);
   
-  this._parser = new Protocol8Parser(this, {masking: true});
+  this._parser = new HybiParser(this, {masking: true, protocols: protocols});
   this._stream = connection;
   
+  this._stream.setTimeout(0);
+  this._stream.setNoDelay(true);
+  
   if (!secure) connection.addListener('connect', onConnect);
   
   connection.addListener('data', function(data) {
     self._onData(data);
   });
-  connection.addListener('close', function() {
-    self.close(1006, '', false);
+  ['close', 'end', 'error'].forEach(function(event) {
+    connection.addListener(event, function() { self.close(1006, '', false) });
   });
-  connection.addListener('error', function() {});
 };
   
 Client.prototype._onConnect = function() {
@@ -51,8 +55,9 @@ Client.prototype._onData = function(data) {
       if (!this._handshake.isComplete()) return;
       
       if (this._handshake.isValid()) {
+        this.protocol = this._handshake.protocol || '';
         this.readyState = API.OPEN;
-        var event = new API.Event('open');
+        var event = new Event('open');
         event.initEvent('open', false, false);
         this.dispatchEvent(event);
         
@@ -60,7 +65,7 @@ Client.prototype._onData = function(data) {
         
       } else {
         this.readyState = API.CLOSED;
-        var event = new API.Event('close');
+        var event = new Event('close', {code: 1006, reason: ''});
         event.initEvent('close', false, false);
         this.dispatchEvent(event);
       }

lib/faye/websocket/draft75_parser.js

@@ -1,15 +1,11 @@
 var Draft75Parser = function(webSocket) {
-  this._socket    = webSocket;
-  this._buffer    = [];
-  this._buffering = false;
+  this._socket = webSocket;
+  this._stage  = 0;
 };
 
 var instance = {
-  FRAME_START : new Buffer([0x00]),
-  FRAME_END   : new Buffer([0xFF]),
-  
   getVersion: function() {
-    return 'draft-75';
+    return 'hixie-75';
   },
   
   handshakeResponse: function() {
@@ -21,38 +17,77 @@ var instance = {
                       'utf8');
   },
   
-  parse: function(data) {
-    for (var i = 0, n = data.length; i < n; i++)
-      this._handleChar(data[i]);
+  isOpen: function() {
+    return true;
+  },
+  
+  parse: function(buffer) {
+    var data, message, value;
+    for (var i = 0, n = buffer.length; i < n; i++) {
+      data = buffer[i];
+      
+      switch (this._stage) {
+        case 0:
+          this._parseLeadingByte(data);
+          break;
+          
+        case 1:
+          value = (data & 0x7F);
+          this._length = value + 128 * this._length;
+          
+          if (this._closing && this._length === 0) {
+            this._socket.close(null, null, false);
+          }
+          else if ((0x80 & data) !== 0x80) {
+            if (this._length === 0) {
+              this._socket.receive('');
+              this._stage = 0;
+            }
+            else {
+              this._buffer = [];
+              this._stage = 2;
+            }
+          }
+          break;
+          
+        case 2:
+          if (data === 0xFF) {
+            message = new Buffer(this._buffer);
+            this._socket.receive(message.toString('utf8', 0, this._buffer.length));
+            this._stage = 0;
+          }
+          else {
+            this._buffer.push(data);
+            if (this._length && this._buffer.length === this._length)
+              this._stage = 0;
+          }
+          break;
+      }
+    }
+  },
+  
+  _parseLeadingByte: function(data) {
+    if ((0x80 & data) === 0x80) {
+      this._length = 0;
+      this._stage = 1;
+    } else {
+      delete this._length;
+      this._buffer = [];
+      this._stage = 2;
+    }
   },
   
   frame: function(data) {
+    if (Buffer.isBuffer(data)) return data;
+    
     var buffer = new Buffer(data, 'utf8'),
         frame  = new Buffer(buffer.length + 2);
     
-    this.FRAME_START.copy(frame, 0);
+    frame[0] = 0x00;
+    frame[buffer.length + 1] = 0xFF;
     buffer.copy(frame, 1);
-    this.FRAME_END.copy(frame, buffer.length + 1);
     
     return frame;
-  },
-  
-  _handleChar: function(data) {
-    switch (data) {
-      case 0x00:
-        this._buffering = true;
-        break;
-      
-      case 0xFF:
-        this._buffer = new Buffer(this._buffer);
-        this._socket.receive(this._buffer.toString('utf8', 0, this._buffer.length));
-        this._buffer = [];
-        this._buffering = false;
-        break;
-      
-      default:
-        if (this._buffering) this._buffer.push(data);
-    }
   }
 };
 

lib/faye/websocket/draft76_parser.js

@@ -23,7 +23,7 @@ var bigEndian = function(number) {
 };
 
 Draft76Parser.prototype.getVersion = function() {
-  return 'draft-76';
+  return 'hixie-76';
 };
   
 Draft76Parser.prototype.handshakeResponse = function(head) {
@@ -47,9 +47,12 @@ Draft76Parser.prototype.handshakeResponse = function(head) {
   return response;
 };
 
+Draft76Parser.prototype.isOpen = function() {
+  return !!this._handshakeComplete;
+};
+
 Draft76Parser.prototype.handshakeSignature = function(head) {
   if (head.length === 0) return null;
-  this._handshakeComplete = true;
   
   var request = this._socket.request,
       
@@ -65,6 +68,7 @@ Draft76Parser.prototype.handshakeSignature = function(head) {
   MD5.update(bigEndian(value2));
   MD5.update(head.toString('binary'));
   
+  this._handshakeComplete = true;
   return new Buffer(MD5.digest('binary'), 'binary');
 };
 
@@ -75,5 +79,21 @@ Draft76Parser.prototype.parse = function(data) {
   return this.handshakeSignature(data);
 };
 
+Draft76Parser.prototype._parseLeadingByte = function(data) {
+  if (data !== 0xFF)
+    return Draft75Parser.prototype._parseLeadingByte.call(this, data);
+  
+  this._closing = true;
+  this._length = 0;
+  this._stage = 1;
+};
+
+Draft76Parser.prototype.close = function(code, reason, callback, context) {
+  if (this._closed) return;
+  if (this._closing) this._socket.send(new Buffer([0xFF, 0x00]));
+  this._closed = true;
+  if (callback) callback.call(context);
+};
+
 module.exports = Draft76Parser;
 

lib/faye/websocket/hybi_parser.js

@@ -1,16 +1,33 @@
 var crypto    = require('crypto'),
-    Handshake = require('./protocol8_parser/handshake'),
-    Reader    = require('./protocol8_parser/stream_reader');
+    Handshake = require('./hybi_parser/handshake'),
+    Reader    = require('./hybi_parser/stream_reader');
 
-var Protocol8Parser = function(webSocket, options) {
+var HybiParser = function(webSocket, options) {
   this._reset();
-  this._socket  = webSocket;
-  this._reader  = new Reader();
-  this._stage   = 0;
-  this._masking = options && options.masking;
+  this._socket    = webSocket;
+  this._reader    = new Reader();
+  this._stage     = 0;
+  this._masking   = options && options.masking;
+  this._protocols = options && options.protocols;
+  
+  this._pingCallbacks = {};
+  
+  if (typeof this._protocols === 'string')
+    this._protocols = this._protocols.split(/\s*,\s*/);
+};
+
+HybiParser.mask = function(payload, mask, offset) {
+  if (mask.length === 0) return payload;
+  offset = offset || 0;
+  
+  for (var i = 0, n = payload.length - offset; i < n; i++) {
+    payload[offset + i] = payload[offset + i] ^ mask[i % 4];
+  }
+  return payload;
 };
 
 var instance = {
+  BYTE:   255,
   FIN:    128,
   MASK:   128,
   RSV1:   64,
@@ -48,26 +65,46 @@ var instance = {
   
   getVersion: function() {
     var version = this._socket.request.headers['sec-websocket-version'];
-    return 'protocol-' + version;
+    return 'hybi-' + version;
   },
   
   handshakeResponse: function() {
     var secKey = this._socket.request.headers['sec-websocket-key'];
-    if (!secKey) return;
+    if (!secKey) return null;
     
     var SHA1 = crypto.createHash('sha1');
     SHA1.update(secKey + Handshake.GUID);
-    var accept = SHA1.digest('base64');
     
-    return new Buffer('HTTP/1.1 101 Switching Protocols\r\n' +
-                      'Upgrade: websocket\r\n' +
-                      'Connection: Upgrade\r\n' +
-                      'Sec-WebSocket-Accept: ' + accept + '\r\n\r\n',
-                      'utf8');
+    var accept    = SHA1.digest('base64'),
+        protos    = this._socket.request.headers['sec-websocket-protocol'],
+        supported = this._protocols,
+        proto,
+    
+        headers = [
+          'HTTP/1.1 101 Switching Protocols',
+          'Upgrade: websocket',
+          'Connection: Upgrade',
+          'Sec-WebSocket-Accept: ' + accept
+        ];
+    
+    if (protos !== undefined && supported !== undefined) {
+      if (typeof protos === 'string') protos = protos.split(/\s*,\s*/);
+      proto = protos.filter(function(p) { return supported.indexOf(p) >= 0 })[0];
+      if (proto) {
+        this.protocol = proto;
+        headers.push('Sec-WebSocket-Protocol: ' + proto);
+      }
+    }
+    
+    return new Buffer(headers.concat('','').join('\r\n'), 'utf8');
+  },
+  
+  isOpen: function() {
+    return true;
   },
   
   createHandshake: function(uri) {
-    return new Handshake(uri);
+    return new Handshake(uri, this._protocols);
   },
   
   parse: function(data) {
@@ -158,7 +195,7 @@ var instance = {
   },
   
   frame: function(data, type, code) {
-    if (this._closed) return;
+    if (this._closed) return null;
     
     var isText = (typeof data === 'string'),
         opcode = this.OPCODES[type || (isText ? 'text' : 'binary')],
@@ -169,6 +206,7 @@ var instance = {
         offset = header + (this._masking ? 4 : 0),
         masked = this._masking ? this.MASK : 0,
         frame  = new Buffer(length + offset),
+        BYTE   = this.BYTE,
         mask, i;
     
     frame[0] = this.FIN | opcode;
@@ -178,35 +216,41 @@ var instance = {
     } else if (length <= 65535) {
       frame[1] = masked | 126;
       frame[2] = Math.floor(length / 256);
-      frame[3] = length & 255;
+      frame[3] = length & BYTE;
     } else {
       frame[1] = masked | 127;
-      frame[2] = Math.floor(length / Math.pow(2,56)) & 255;
-      frame[3] = Math.floor(length / Math.pow(2,48)) & 255;
-      frame[4] = Math.floor(length / Math.pow(2,40)) & 255;
-      frame[5] = Math.floor(length / Math.pow(2,32)) & 255;
-      frame[6] = Math.floor(length / Math.pow(2,24)) & 255;
-      frame[7] = Math.floor(length / Math.pow(2,16)) & 255;
-      frame[8] = Math.floor(length / Math.pow(2,8))  & 255;
-      frame[9] = length & 255;
+      frame[2] = Math.floor(length / Math.pow(2,56)) & BYTE;
+      frame[3] = Math.floor(length / Math.pow(2,48)) & BYTE;
+      frame[4] = Math.floor(length / Math.pow(2,40)) & BYTE;
+      frame[5] = Math.floor(length / Math.pow(2,32)) & BYTE;
+      frame[6] = Math.floor(length / Math.pow(2,24)) & BYTE;
+      frame[7] = Math.floor(length / Math.pow(2,16)) & BYTE;
+      frame[8] = Math.floor(length / Math.pow(2,8))  & BYTE;
+      frame[9] = length & BYTE;
     }
     
     if (code) {
-      frame[offset]   = Math.floor(code / 256);
-      frame[offset+1] = code & 255;
+      frame[offset]   = Math.floor(code / 256) & BYTE;
+      frame[offset+1] = code & BYTE;
     }
     buffer.copy(frame, offset + insert);
     
     if (this._masking) {
-      mask = new Buffer([1,2,3,4].map(function() { return Math.floor(Math.random() * 256) }));
-      mask.copy(frame, header);
-      for (i = 0; i < length; i++)
-        frame[offset + i] = frame[offset + i] ^ mask[i % 4];
+      mask = [Math.floor(Math.random() * 256), Math.floor(Math.random() * 256),
+              Math.floor(Math.random() * 256), Math.floor(Math.random() * 256)];
+      new Buffer(mask).copy(frame, header);
+      HybiParser.mask(frame, mask, offset);
     }
     
     return frame;
   },
   
+  ping: function(message, callback, context) {
+    message = message || '';
+    if (callback) this._pingCallbacks[message] = [callback, context];
+    return this._socket.send(message, 'ping');
+  },
+  
   close: function(code, reason, callback, context) {
     if (this._closed) return;
     if (callback) this._closingCallback = [callback, context];
@@ -220,7 +264,7 @@ var instance = {
   },
   
   _emitFrame: function() {
-    var payload = this._unmask(this._payload, this._mask),
+    var payload = HybiParser.mask(this._payload, this._mask),
         opcode  = this._opcode;
     
     if (opcode === this.OPCODES.continuation) {
@@ -272,6 +316,14 @@ var instance = {
       if (payload.length > 125) return this._socket.close(this.ERRORS.protocol_error, null, false);
       this._socket.send(payload, 'pong');
     }
+    else if (opcode === this.OPCODES.pong) {
+      var callbacks = this._pingCallbacks,
+          message   = this._encode(payload),
+          callback  = callbacks[message];
+      
+      delete callbacks[message];
+      if (callback) callback[0].call(callback[1]);
+    }
   },
   
   _reset: function() {
@@ -292,21 +344,11 @@ var instance = {
     for (var i = 0, n = bytes.length; i < n; i++)
       number += bytes[i] << (8 * (n - 1 - i));
     return number;
-  },
-  
-  _unmask: function(payload, mask) {
-    var unmasked = new Buffer(payload.length), b;
-    for (var i = 0, n = payload.length; i < n; i++) {
-      b = payload[i];
-      if (mask.length > 0) b = b ^ mask[i % 4];
-      unmasked[i] = b;
-    }
-    return unmasked;
   }
 };
 
 for (var key in instance)
-  Protocol8Parser.prototype[key] = instance[key];
+  HybiParser.prototype[key] = instance[key];
 
-module.exports = Protocol8Parser;
+module.exports = HybiParser;
 

lib/faye/websocket/hybi_parser/handshake.js

@@ -1,7 +1,8 @@
 var crypto = require('crypto');
 
-var Handshake = function(uri) {
+var Handshake = function(uri, protocols) {
   this._uri = uri;
+  this._protocols = protocols;
   
   var buffer = new Buffer(16), i = 16;
   while (i--) buffer[i] = Math.floor(Math.random() * 256);
@@ -43,13 +44,20 @@ Handshake.GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
     
 Handshake.prototype.requestData = function() {
   var u = this._uri;
-  return new Buffer('GET ' + u.pathname + (u.search || '') + ' HTTP/1.1\r\n' +
-                    'Host: ' + u.hostname + (u.port ? ':' + u.port : '') + '\r\n' +
-                    'Upgrade: websocket\r\n' +
-                    'Connection: Upgrade\r\n' +
-                    'Sec-WebSocket-Key: ' + this._key + '\r\n' +
-                    'Sec-WebSocket-Version: 8\r\n\r\n',
-                    'utf8');
+  
+  var headers = [
+    'GET ' + u.pathname + (u.search || '') + ' HTTP/1.1',
+    'Host: ' + u.hostname + (u.port ? ':' + u.port : ''),
+    'Upgrade: websocket',
+    'Connection: Upgrade',
+    'Sec-WebSocket-Key: ' + this._key,
+    'Sec-WebSocket-Version: 13'
+  ];
+  
+  if (this._protocols)
+    headers.push('Sec-WebSocket-Protocol: ' + this._protocols.join(', '));
+  
+  return new Buffer(headers.concat('','').join('\r\n'), 'utf8');
 };
 
 Handshake.prototype.parse = function(data) {
@@ -67,10 +75,16 @@ Handshake.prototype.isValid = function() {
   if (this._status !== 101) return false;
   
   var upgrade    = this._headers.Upgrade,
-      connection = this._headers.Connection;
+      connection = this._headers.Connection,
+      protocol   = this._headers['Sec-WebSocket-Protocol'];
+  
+  this.protocol = this._protocols && this._protocols.indexOf(protocol) >= 0
+                ? protocol
+                : null;
   
   return upgrade && /^websocket$/i.test(upgrade) &&
          connection && connection.split(/\s*,\s*/).indexOf('Upgrade') >= 0 &&
+         ((!this._protocols && !protocol) || this.protocol) &&
          this._headers['Sec-WebSocket-Accept'] === this._accept;
 };
 

package.json

@@ -1,15 +1,17 @@
 { "name"            : "faye-websocket"
-, "description"     : "Robust general-purpose WebSocket server and client"
-, "homepage"        : "http://github.com/jcoglan/faye-websocket-node"
+, "description"     : "Standards-compliant WebSocket server and client"
+, "homepage"        : "http://github.com/faye/faye-websocket-node"
 , "author"          : "James Coglan <jcoglan@gmail.com> (http://jcoglan.com/)"
-, "keywords"        : ["websocket"]
+, "keywords"        : ["websocket", "eventsource"]
 
-, "version"         : "0.1.2"
+, "version"         : "0.4.1"
 , "engines"         : {"node": ">=0.4.0"}
 , "main"            : "./lib/faye/websocket"
-, "devDependencies" : {"jsclass": ">=3.0.4"}
+, "devDependencies" : {"jsclass": ""}
 
-, "bugs"            : "http://github.com/jcoglan/faye-websocket-node/issues"
+, "scripts"         : {"test": "node spec/runner.js"}
+
+, "bugs"            : "http://github.com/faye/faye-websocket-node/issues"
 
 , "licenses"        : [ { "type"    : "MIT"
                         , "url"     : "http://www.opensource.org/licenses/mit-license.php"
@@ -17,7 +19,7 @@
                       ]
 
 , "repositories"    : [ { "type"    : "git"
-                        , "url"     : "git://github.com/jcoglan/faye-websocket-node.git"
+                        , "url"     : "git://github.com/faye/faye-websocket-node.git"
                         }
                       ]
 }

spec/faye/websocket/client_spec.js

@@ -13,7 +13,7 @@ JS.ENV.WebSocketSteps = JS.Test.asyncSteps({
     setTimeout(callback, 100)
   },
   
-  open_socket: function(url, callback) {
+  open_socket: function(url, protocols, callback) {
     var done = false,
         self = this,
         
@@ -24,7 +24,7 @@ JS.ENV.WebSocketSteps = JS.Test.asyncSteps({
                    callback()
                  }
     
-    this._ws = new Client(url)
+    this._ws = new Client(url, protocols)
     
     this._ws.onopen  = function() { resume(true)  }
     this._ws.onclose = function() { resume(false) }
@@ -49,19 +49,24 @@ JS.ENV.WebSocketSteps = JS.Test.asyncSteps({
     callback()
   },
   
+  check_protocol: function(protocol, callback) {
+    this.assertEqual( protocol, this._ws.protocol )
+    callback()
+  },
+  
   listen_for_message: function(callback) {
     var self = this
     this._ws.addEventListener('message', function(message) { self._message = message.data })
     callback()
   },
   
-  send_message: function(callback) {
-    this._ws.send("I expect this to be echoed")
+  send_message: function(message, callback) {
+    this._ws.send(message)
     setTimeout(callback, 100)
   },
   
-  check_response: function(callback) {
-    this.assertEqual( "I expect this to be echoed", this._message )
+  check_response: function(message, callback) {
+    this.assertEqual( message, this._message )
     callback()
   },
   
@@ -76,48 +81,73 @@ JS.ENV.ClientSpec = JS.Test.describe("Client", function() { with(this) {
   include(WebSocketSteps)
   
   before(function() {
+    this.protocols       = ["foo", "echo"]
     this.plain_text_url  = "ws://localhost:8000/bayeux"
     this.secure_url      = "wss://localhost:8000/bayeux"
   })
   
   sharedBehavior("socket client", function() { with(this) {
     it("can open a connection", function() { with(this) {
-      open_socket(socket_url)
+      open_socket(socket_url, protocols)
       check_open()
+      check_protocol("echo")
     }})
     
     it("cannot open a connection to the wrong host", function() { with(this) {
-      open_socket(blocked_url)
+      open_socket(blocked_url, protocols)
+      check_closed()
+    }})
+    
+    it("cannot open a connection with unacceptable protocols", function() { with(this) {
+      open_socket(socket_url, ["foo"])
       check_closed()
     }})
     
     it("can close the connection", function() { with(this) {
-      open_socket(socket_url)
+      open_socket(socket_url, protocols)
       close_socket()
       check_closed()
     }})
     
     describe("in the OPEN state", function() { with(this) {
       before(function() { with(this) {
-        open_socket(socket_url)
+        open_socket(socket_url, protocols)
       }})
       
       it("can send and receive messages", function() { with(this) {
         listen_for_message()
-        send_message()
-        check_response()
+        send_message("I expect this to be echoed")
+        check_response("I expect this to be echoed")
+      }})
+      
+      it("sends numbers as strings", function() { with(this) {
+        listen_for_message()
+        send_message(13)
+        check_response("13")
+      }})
+      
+      it("sends booleans as strings", function() { with(this) {
+        listen_for_message()
+        send_message(false)
+        check_response("false")
+      }})
+      
+      it("sends arrays as strings", function() { with(this) {
+        listen_for_message()
+        send_message([13,14,15])
+        check_response("13,14,15")
       }})
     }})
     
     describe("in the CLOSED state", function() { with(this) {
       before(function() { with(this) {
-        open_socket(socket_url)
+        open_socket(socket_url, protocols)
         close_socket()
       }})
       
       it("cannot send and receive messages", function() { with(this) {
         listen_for_message()
-        send_message()
+        send_message("I expect this to be echoed")
         check_no_response()
       }})
     }})

spec/faye/websocket/draft75parser_spec.js

@@ -7,20 +7,56 @@ JS.ENV.Draft75ParserSpec = JS.Test.describe("Draft75Parser", function() { with(t
   }})
   
   describe("parse", function() { with(this) {
-    it("parses text frames", function() { with(this) {
-      expect(webSocket, "receive").given("Hello")
-      parser.parse([0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff])
+    sharedBehavior("draft-75 parser", function() { with(this) {
+      it("parses text frames", function() { with(this) {
+        expect(webSocket, "receive").given("Hello")
+        parser.parse([0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff])
+      }})
+      
+      it("parses multiple frames from the same packet", function() { with(this) {
+        expect(webSocket, "receive").given("Hello").exactly(2)
+        parser.parse([0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff, 0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff])
+      }})
+      
+      it("parses text frames beginning 0x00-0x7F", function() { with(this) {
+        expect(webSocket, "receive").given("Hello")
+        parser.parse([0x66, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff])
+      }})
+      
+      it("ignores frames with a length header", function() { with(this) {
+        expect(webSocket, "receive").exactly(0)
+        parser.parse([0x80, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f])
+      }})
+      
+      it("parses text following an ignored block", function() { with(this) {
+        expect(webSocket, "receive").given("Hello")
+        parser.parse([0x80, 0x02, 0x48, 0x65, 0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff])
+      }})
+      
+      it("parses multibyte text frames", function() { with(this) {
+        expect(webSocket, "receive").given("Apple = ")
+        parser.parse([0x00, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf, 0xff])
+      }})
+      
+      it("parses frames received in several packets", function() { with(this) {
+        expect(webSocket, "receive").given("Apple = ")
+        parser.parse([0x00, 0x41, 0x70, 0x70, 0x6c, 0x65])
+        parser.parse([0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf, 0xff])
+      }})
+      
+      it("parses fragmented frames", function() { with(this) {
+        expect(webSocket, "receive").given("Hello")
+        parser.parse([0x00, 0x48, 0x65, 0x6c])
+        parser.parse([0x6c, 0x6f, 0xff])
+      }})
     }})
     
-    it("parses multibyte text frames", function() { with(this) {
-      expect(webSocket, "receive").given("Apple = ")
-      parser.parse([0x00, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf, 0xff])
-    }})
+    behavesLike("draft-75 parser")
     
-    it("parses fragmented frames", function() { with(this) {
-      expect(webSocket, "receive").given("Hello")
-      parser.parse([0x00, 0x48, 0x65, 0x6c])
-      parser.parse([0x6c, 0x6f, 0xff])
+    it("does not close the socket if a 76 close frame is received", function() { with(this) {
+      expect(webSocket, "close").exactly(0)
+      expect(webSocket, "receive").given("")
+      parser.parse([0xFF, 0x00])
     }})
   }})
   

spec/faye/websocket/draft76parser_spec.js

@@ -0,0 +1,28 @@
+var Draft76Parser = require('../../../lib/faye/websocket/draft76_parser')
+
+JS.ENV.Draft76ParserSpec = JS.Test.describe("Draft76Parser", function() { with(this) {
+  before(function() { with(this) {
+    this.webSocket = {dispatchEvent: function() {}}
+    this.parser = new Draft76Parser(webSocket)
+    parser._handshakeComplete = true
+  }})
+  
+  describe("parse", function() { with(this) {
+    behavesLike("draft-75 parser")
+    
+    it("closes the socket if a close frame is received", function() { with(this) {
+      expect(webSocket, "close")
+      parser.parse([0xFF, 0x00])
+    }})
+  }})
+  
+  describe("frame", function() { with(this) {
+    it("returns the given string formatted as a WebSocket frame", function() { with(this) {
+      assertBufferEqual( [0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff], parser.frame("Hello") )
+    }})
+    
+    it("encodes multibyte characters correctly", function() { with(this) {
+      assertBufferEqual( [0x00, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf, 0xff], parser.frame("Apple = ") )
+    }})
+  }})
+}})

spec/faye/websocket/hybi_parser_spec.js

@@ -1,9 +1,9 @@
-var Protocol8Parser = require('../../../lib/faye/websocket/protocol8_parser')
+var HybiParser = require('../../../lib/faye/websocket/hybi_parser')
 
-JS.ENV.Protocol8ParserSpec = JS.Test.describe("Protocol8Parser", function() { with(this) {
+JS.ENV.HybiParserSpec = JS.Test.describe("HybiParser", function() { with(this) {
   before(function() { with(this) {
     this.webSocket = {dispatchEvent: function() {}}
-    this.parser = new Protocol8Parser(webSocket)
+    this.parser = new HybiParser(webSocket)
   }})
   
   define("parse", function() {
@@ -38,6 +38,11 @@ JS.ENV.Protocol8ParserSpec = JS.Test.describe("Protocol8Parser", function() { wi
       parse([0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f])
     }})
     
+    it("parses multiple frames from the same packet", function() { with(this) {
+      expect(webSocket, "receive").given("Hello").exactly(2)
+      parse([0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f])
+    }})
+    
     it("parses empty text frames", function() { with(this) {
       expect(webSocket, "receive").given("")
       parse([0x81, 0x00])
@@ -80,6 +85,12 @@ JS.ENV.Protocol8ParserSpec = JS.Test.describe("Protocol8Parser", function() { wi
       parse([0x81, 0x0b, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf])
     }})
     
+    it("parses frames received in several packets", function() { with(this) {
+      expect(webSocket, "receive").given("Apple = ")
+      parse([0x81, 0x0b, 0x41, 0x70, 0x70, 0x6c])
+      parse([0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf])
+    }})
+    
     it("parses fragmented multibyte text frames", function() { with(this) {
       expect(webSocket, "receive").given("Apple = ")
       parse([0x01, 0x0a, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3])

spec/runner.js

@@ -16,7 +16,7 @@ EchoServer.prototype.listen = function(port, ssl) {
              : http.createServer()
   
   server.addListener('upgrade', function(request, socket, head) {
-    var ws = new WebSocket(request, socket, head)
+    var ws = new WebSocket(request, socket, head, ["echo"])
     ws.onmessage = function(event) {
       ws.send(event.data)
     }
@@ -47,7 +47,8 @@ JS.require('JS.Test', function() {
   
   JS.require( 'ClientSpec',
               'Draft75ParserSpec',
-              'Protocol8ParserSpec',
+              'Draft76ParserSpec',
+              'HybiParserSpec',
               JS.Test.method('autorun'))
 })