Update the 0.4.0 release date.

This results in a more simple design, in the sense of fewer concerns
being mixed together. It makes the API more verbose, but it's not
difficult to use correctly.

It also means that we make the I/O implementation deal with TLS, so it
can use tls.connect({socket: io}) or the upcoming TLSSocket class,
rather than this module needing a huge amount of boilerplate and
internal indirection to use tls.createSecurePair() and make Proxy wrap
pair.encrypted.

Using tls.connect({socket: io}) would be awkward on this end, because it
expects a stream that emits *incoming* data from the TCP connection. All
the streams in this module emit *outgoing* data that should be written
to TCP, so their polarity is flipped compared to what tls.connect()
wants, and resolving that involves even more stream boilerplate.

.travis.yml

@@ -6,3 +6,5 @@ node_js:
   - "0.10"
   - "0.11"
 
+before_install:
+  - '[ "${TRAVIS_NODE_VERSION}" = "0.6" ] && npm conf set strict-ssl false || true'

CHANGELOG.md

@@ -1,3 +1,40 @@
+### 0.4.0 / 2014-11-08
+
+* Support connection via HTTP proxies using `CONNECT`
+
+### 0.3.6 / 2014-10-04
+
+* It is now possible to call `close()` before `start()` and close the driver
+
+### 0.3.5 / 2014-07-06
+
+* Don't hold references to frame buffers after a message has been emitted
+* Make sure that `protocol` and `version` are exposed properly by the TCP driver
+
+### 0.3.4 / 2014-05-08
+
+* Don't hold memory-leaking references to I/O buffers after they have been parsed
+
+### 0.3.3 / 2014-04-24
+
+* Correct the draft-76 status line reason phrase
+
+### 0.3.2 / 2013-12-29
+
+* Expand `maxLength` to cover sequences of continuation frames and `draft-{75,76}`
+* Decrease default maximum frame buffer size to 64MB
+* Stop parsing when the protocol enters a failure mode, to save CPU cycles
+
+### 0.3.1 / 2013-12-03
+
+* Add a `maxLength` option to limit allowed frame size
+* Don't pre-allocate a message buffer until the whole frame has arrived
+* Fix compatibility with Node v0.11 `HTTPParser`
+
+### 0.3.0 / 2013-09-09
+
+* Support client URLs with Basic Auth credentials
+
 ### 0.2.2 / 2013-07-05
 
 * No functional changes, just updates to package.json
@@ -15,4 +52,3 @@
 ### 0.1.0 / 2013-05-04
 
 * First stable release
-

README.md

@@ -1,4 +1,4 @@
-# websocket-driver [![Build Status](https://travis-ci.org/faye/websocket-driver-node.png)](https://travis-ci.org/faye/websocket-driver-node)
+# websocket-driver [![Build Status](https://travis-ci.org/faye/websocket-driver-node.svg)](https://travis-ci.org/faye/websocket-driver-node)
 
 This module provides a complete implementation of the WebSocket protocols that
 can be hooked up to any I/O stream. It aims to simplify things by decoupling
@@ -134,17 +134,17 @@ var net = require('net'),
     websocket = require('websocket-driver');
 
 var driver = websocket.client('ws://www.example.com/socket'),
-    tcp = net.createConnection(80, 'www.example.com');
+    tcp = net.connect(80, 'www.example.com');
 
 tcp.pipe(driver.io).pipe(tcp);
 
-driver.messages.on('data', function(message) {
-  console.log('Got a message', message);
-});
-
 tcp.on('connect', function() {
   driver.start();
 });
+
+driver.messages.on('data', function(message) {
+  console.log('Got a message', message);
+});
 ```
 
 Client drivers have two additional properties for reading the HTTP data that
@@ -154,6 +154,65 @@ was sent back by the server:
 * `driver.headers` - an object containing the response headers
 
 
+### HTTP Proxies
+
+The client driver supports connections via HTTP proxies using the `CONNECT`
+method. Instead of sending the WebSocket handshake immediately, it will send a
+`CONNECT` request, wait for a `200` response, and then proceed as normal.
+
+To use this feature, call `driver.proxy(url)` where `url` is the origin of the
+proxy, including a username and password if required. This produces a duplex
+stream that you should pipe in and out of your TCP connection to the proxy
+server. When the proxy emits `connect`, you can then pipe `driver.io` to your
+TCP stream and call `driver.start()`.
+
+```js
+var net = require('net'),
+    websocket = require('websocket-driver');
+
+var driver = websocket.client('ws://www.example.com/socket'),
+    proxy  = driver.proxy('http://username:password@proxy.example.com'),
+    tcp    = net.connect(80, 'proxy.example.com');
+
+tcp.pipe(proxy).pipe(tcp, {end: false});
+
+tcp.on('connect', function() {
+  proxy.start();
+});
+
+proxy.on('connect', function() {
+  driver.io.pipe(tcp).pipe(driver.io);
+  driver.start();
+});
+
+driver.messages.on('data', function(message) {
+  console.log('Got a message', message);
+});
+```
+
+The proxy's `connect` event is also where you should perform a TLS handshake on
+your TCP stream, if you are connecting to a `wss:` endpoint.
+
+In the event that proxy connection fails, `proxy` will emit an `error`. You can
+inspect the proxy's response via `proxy.statusCode` and `proxy.headers`.
+
+```js
+proxy.on('error', function(error) {
+  console.error(error.message);
+  console.log(proxy.statusCode);
+  console.log(proxy.headers);
+});
+```
+
+Before calling `proxy.start()` you can set custom headers using
+`proxy.setHeader()`:
+
+```js
+proxy.setHeader('User-Agent', 'node');
+proxy.start();
+```
+
+
 ### Driver API
 
 Drivers are created using one of the following methods:
@@ -173,6 +232,8 @@ with masking enabled on outgoing frames.
 The `options` argument is optional, and is an object. It may contain the
 following fields:
 
+* `maxLength` - the maximum allowed size of incoming message frames, in bytes.
+  The default value is `2^26 - 1`, or 1 byte short of 64 MiB.
 * `protocols` - an array of strings representing acceptable subprotocols for
   use over the socket. The driver will negotiate one of these to use via the
   `Sec-WebSocket-Protocol` header if supported by the other peer.
@@ -283,7 +344,7 @@ after `emit('open')` has fired.
 
 (The MIT License)
 
-Copyright (c) 2010-2013 James Coglan
+Copyright (c) 2010-2014 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
@@ -302,4 +363,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

examples/tcp_server.js

@@ -18,4 +18,3 @@ var server = net.createServer(function(connection) {
 });
 
 server.listen(process.argv[2]);
-

lib/websocket/driver.js

@@ -41,4 +41,3 @@ var Driver = {
 };
 
 module.exports = Driver;
-

lib/websocket/driver/base.js

@@ -8,7 +8,8 @@ var Base = function(request, url, options) {
 
   this._request   = request;
   this._options   = options || {};
-  this.__headers  = new Headers();
+  this._maxLength = this._options.maxLength || this.MAX_LENGTH;
+  this._headers   = new Headers();
   this.__queue    = [];
   this.readyState = 0;
   this.url        = url;
@@ -20,6 +21,10 @@ var Base = function(request, url, options) {
 util.inherits(Base, Emitter);
 
 var instance = {
+  // This is 64MB, small enough for an average VPS to handle without
+  // crashing from process out of memory
+  MAX_LENGTH: 0x3ffffff,
+
   STATES: ['connecting', 'open', 'closing', 'closed'],
 
   _bindEventListeners: function() {
@@ -52,7 +57,7 @@ var instance = {
 
   setHeader: function(name, value) {
     if (this.readyState > 0) return false;
-    this.__headers.set(name, value);
+    this._headers.set(name, value);
     return true;
   },
 
@@ -118,4 +123,3 @@ Base.MessageEvent = function(data) {
 };
 
 module.exports = Base;
-

lib/websocket/driver/client.js

@@ -1,17 +1,35 @@
 var url        = require('url'),
     util       = require('util'),
-    HttpParser = require('./http_parser'),
+    HttpParser = require('../http_parser'),
     Base       = require('./base'),
-    Hybi       = require('./hybi');
+    Hybi       = require('./hybi'),
+    Proxy      = require('./proxy');
 
-var Client = function(url, options) {
+var Client = function(_url, options) {
   this.version = 'hybi-13';
-  Hybi.call(this, null, url, options);
+  Hybi.call(this, null, _url, options);
 
   this.readyState = -1;
   this._key       = Client.generateKey();
   this._accept    = Hybi.generateAccept(this._key);
   this._http      = new HttpParser('response');
+
+  var uri  = url.parse(this.url),
+      auth = uri.auth && new Buffer(uri.auth, 'utf8').toString('base64');
+
+  this._pathname = (uri.pathname || '/') + (uri.search || '');
+
+  this._headers.set('Host', uri.host);
+  this._headers.set('Upgrade', 'websocket');
+  this._headers.set('Connection', 'Upgrade');
+  this._headers.set('Sec-WebSocket-Key', this._key);
+  this._headers.set('Sec-WebSocket-Version', '13');
+
+  if (this._protocols.length > 0)
+    this._headers.set('Sec-WebSocket-Protocol', this._protocols.join(', '));
+
+  if (auth)
+    this._headers.set('Authorization', 'Basic ' + auth);
 };
 util.inherits(Client, Hybi);
 
@@ -22,6 +40,10 @@ Client.generateKey = function() {
 };
 
 var instance = {
+  proxy: function(origin, options) {
+    return new Proxy(this, origin, options);
+  },
+
   start: function() {
     if (this.readyState !== -1) return false;
     this._write(this._handshakeRequest());
@@ -34,26 +56,16 @@ var instance = {
 
     this._http.parse(data);
     if (!this._http.isComplete()) return;
-    
+
     this._validateHandshake();
     this.parse(this._http.body);
   },
 
   _handshakeRequest: function() {
-    var uri = url.parse(this.url);
+    var start   = 'GET ' + this._pathname + ' HTTP/1.1',
+        headers = [start, this._headers.toString(), ''];
 
-    var headers = [ 'GET ' + (uri.pathname || '/') + (uri.search || '') + ' HTTP/1.1',
-                    'Host: ' + uri.hostname + (uri.port ? ':' + uri.port : ''),
-                    'Upgrade: websocket',
-                    'Connection: Upgrade',
-                    'Sec-WebSocket-Key: ' + this._key,
-                    'Sec-WebSocket-Version: 13'
-                  ];
-
-    if (this._protocols.length > 0)
-      headers.push('Sec-WebSocket-Protocol: ' + this._protocols.join(', '));
-
-    return new Buffer(headers.concat(this.__headers.toString(), '').join('\r\n'), 'utf8');
+    return new Buffer(headers.join('\r\n'), 'utf8');
   },
 
   _failHandshake: function(message) {
@@ -106,4 +118,3 @@ for (var key in instance)
   Client.prototype[key] = instance[key];
 
 module.exports = Client;
-

lib/websocket/driver/draft75.js

@@ -5,11 +5,25 @@ var Draft75 = function(request, url, options) {
   Base.apply(this, arguments);
   this._stage = 0;
   this.version = 'hixie-75';
+
+  this._headers.set('Upgrade', 'WebSocket');
+  this._headers.set('Connection', 'Upgrade');
+  this._headers.set('WebSocket-Origin', this._request.headers.origin);
+  this._headers.set('WebSocket-Location', this.url);
 };
 util.inherits(Draft75, Base);
 
 var instance = {
+  close: function() {
+    if (this.readyState === 3) return false;
+    this.readyState = 3;
+    this.emit('close', new Base.CloseEvent(null, null));
+    return true;
+  },
+
   parse: function(buffer) {
+    if (this.readyState > 1) return;
+
     var data, message, value;
     for (var i = 0, n = buffer.length; i < n; i++) {
       data = buffer[i];
@@ -29,8 +43,7 @@ var instance = {
           this._length = value + 128 * this._length;
 
           if (this._closing && this._length === 0) {
-            this.readyState = 3;
-            this.emit('close', new Base.CloseEvent(null, null));
+            return this.close();
           }
           else if ((0x80 & data) !== 0x80) {
             if (this._length === 0) {
@@ -56,6 +69,7 @@ var instance = {
                 this._stage = 0;
             } else {
               this._buffer.push(data);
+              if (this._buffer.length > this._maxLength) return this.close();
             }
           }
           break;
@@ -79,14 +93,10 @@ var instance = {
   },
 
   _handshakeResponse: function() {
-    return new Buffer('HTTP/1.1 101 Web Socket Protocol Handshake\r\n' +
-                      'Upgrade: WebSocket\r\n' +
-                      'Connection: Upgrade\r\n' +
-                      'WebSocket-Origin: ' + this._request.headers.origin + '\r\n' +
-                      'WebSocket-Location: ' + this.url + '\r\n' +
-                      this.__headers.toString() +
-                      '\r\n',
-                      'utf8');
+    var start   = 'HTTP/1.1 101 Web Socket Protocol Handshake',
+        headers = [start, this._headers.toString(), ''];
+
+    return new Buffer(headers.join('\r\n'), 'utf8');
   },
 
   _parseLeadingByte: function(data) {
@@ -106,4 +116,3 @@ for (var key in instance)
   Draft75.prototype[key] = instance[key];
 
 module.exports = Draft75;
-

lib/websocket/driver/draft76.js

@@ -26,6 +26,13 @@ var Draft76 = function(request, url, options) {
   this._stage  = -1;
   this._body   = [];
   this.version = 'hixie-76';
+
+  this._headers.clear();
+
+  this._headers.set('Upgrade', 'WebSocket');
+  this._headers.set('Connection', 'Upgrade');
+  this._headers.set('Sec-WebSocket-Origin', this._request.headers.origin);
+  this._headers.set('Sec-WebSocket-Location', this.url);
 };
 util.inherits(Draft76, Draft75);
 
@@ -48,14 +55,10 @@ var instance = {
   },
 
   _handshakeResponse: function() {
-    return new Buffer('HTTP/1.1 101 Web Socket Protocol Handshake\r\n' +
-                      'Upgrade: WebSocket\r\n' +
-                      'Connection: Upgrade\r\n' +
-                      'Sec-WebSocket-Origin: ' + this._request.headers.origin + '\r\n' +
-                      'Sec-WebSocket-Location: ' + this.url + '\r\n' +
-                      this.__headers.toString() +
-                      '\r\n',
-                      'binary');
+    var start   = 'HTTP/1.1 101 WebSocket Protocol Handshake',
+        headers = [start, this._headers.toString(), ''];
+
+    return new Buffer(headers.join('\r\n'), 'binary');
   },
 
   _handshakeSignature: function() {
@@ -106,4 +109,3 @@ for (var key in instance)
   Draft76.prototype[key] = instance[key];
 
 module.exports = Draft76;
-

lib/websocket/driver/headers.js

@@ -1,10 +1,14 @@
 var Headers = function() {
+  this.clear();
+};
+
+Headers.prototype.ALLOWED_DUPLICATES = ['set-cookie', 'set-cookie2', 'warning', 'www-authenticate'];
+
+Headers.prototype.clear = function() {
   this._sent  = {};
   this._lines = [];
 };
 
-Headers.prototype.ALLOWED_DUPLICATES = ['set-cookie', 'set-cookie2', 'warning', 'www-authenticate']
-
 Headers.prototype.set = function(name, value) {
   if (value === undefined) return;
 
@@ -12,7 +16,7 @@ Headers.prototype.set = function(name, value) {
   value = this._strip(value);
 
   var key = name.toLowerCase();
-  if (!this._sent.hasOwnProperty(key) || this.ALLOWED_DUPLICATES.indexOf(key) < 0) {
+  if (!this._sent.hasOwnProperty(key) || this.ALLOWED_DUPLICATES.indexOf(key) >= 0) {
     this._sent[key] = true;
     this._lines.push(name + ': ' + value + '\r\n');
   }
@@ -27,4 +31,3 @@ Headers.prototype._strip = function(string) {
 };
 
 module.exports = Headers;
-

lib/websocket/driver/hybi.js

@@ -7,26 +7,39 @@ var Hybi = function(request, url, options) {
   Base.apply(this, arguments);
   this._reset();
 
-  this._reader    = new Reader();
-  this._stage     = 0;
-  this._masking   = this._options.masking;
-  this._protocols = this._options.protocols || [];
+  this._reader         = new Reader();
+  this._stage          = 0;
+  this._masking        = this._options.masking;
+  this._protocols      = this._options.protocols || [];
+  this._requireMasking = this._options.requireMasking;
+  this._pingCallbacks  = {};
 
   if (typeof this._protocols === 'string')
     this._protocols = this._protocols.split(/\s*,\s*/);
 
-  this._requireMasking = this._options.requireMasking;
-  this._pingCallbacks  = {};
+  if (!this._request) return;
 
-  if (!this.version) {
-    var version = this._request.headers['sec-websocket-version'];
-    this.version = 'hybi-' + version;
+  var secKey    = this._request.headers['sec-websocket-key'],
+      protos    = this._request.headers['sec-websocket-protocol'],
+      version   = this._request.headers['sec-websocket-version'],
+      supported = this._protocols;
+
+  this._headers.set('Upgrade', 'websocket');
+  this._headers.set('Connection', 'Upgrade');
+  this._headers.set('Sec-WebSocket-Accept', Hybi.generateAccept(secKey));
+
+  if (protos !== undefined) {
+    if (typeof protos === 'string') protos = protos.split(/\s*,\s*/);
+    this.protocol = protos.filter(function(p) { return supported.indexOf(p) >= 0 })[0];
+    if (this.protocol) this._headers.set('Sec-WebSocket-Protocol', this.protocol);
   }
+
+  this.version = 'hybi-' + version;
 };
 util.inherits(Hybi, Base);
 
 Hybi.mask = function(payload, mask, offset) {
-  if (mask.length === 0) return payload;
+  if (!mask || mask.length === 0) return payload;
   offset = offset || 0;
 
   for (var i = 0, n = payload.length - offset; i < n; i++) {
@@ -66,7 +79,6 @@ var instance = {
   FRAGMENTED_OPCODES: [0, 1, 2],
   OPENING_OPCODES:    [1, 2],
 
-  MAX_LENGTH: Math.pow(2, 53) - 1,
   TWO_POWERS: [0, 1, 2, 3, 4, 5, 6, 7].map(function(n) { return Math.pow(2, 8 * n) }),
 
   ERRORS: {
@@ -119,11 +131,13 @@ var instance = {
         case 4:
           buffer = this._reader.read(this._length);
           if (buffer) {
-            this._payload = buffer;
-            this._emitFrame();
+            this._emitFrame(buffer);
             this._stage = 0;
           }
           break;
+
+        default:
+          buffer = null;
       }
     }
   },
@@ -201,7 +215,7 @@ var instance = {
     reason = reason || '';
     code   = code   || this.ERRORS.normal_closure;
 
-    if (this.readyState === 0) {
+    if (this.readyState <= 0) {
       this.readyState = 3;
       this.emit('close', new Base.CloseEvent(code, reason));
       return true;
@@ -215,36 +229,16 @@ var instance = {
   },
 
   _handshakeResponse: function() {
-    var secKey = this._request.headers['sec-websocket-key'];
-    if (!secKey) return '';
+    var start   = 'HTTP/1.1 101 Switching Protocols',
+        headers = [start, this._headers.toString(), ''];
 
-    var accept    = Hybi.generateAccept(secKey),
-        protos    = this._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) {
-      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(this.__headers.toString(), '').join('\r\n'), 'utf8');
+    return new Buffer(headers.join('\r\n'), 'utf8');
   },
 
   _shutdown: function(code, reason) {
     this.frame(reason, 'close', code);
     this.readyState = 3;
+    this._stage = 5;
     this.emit('close', new Base.CloseEvent(code, reason));
   },
 
@@ -266,8 +260,6 @@ var instance = {
 
     this._final   = (data & this.FIN) === this.FIN;
     this._opcode  = (data & this.OPCODE);
-    this._mask    = [];
-    this._payload = [];
 
     if (this.OPCODE_CODES.indexOf(this._opcode) < 0)
       return this._fail('protocol_error', 'Unrecognized frame opcode: ' + this._opcode);
@@ -289,11 +281,11 @@ var instance = {
     this._length = (data & this.LENGTH);
 
     if (this._length >= 0 && this._length <= 125) {
+      if (!this._checkFrameLength()) return;
       this._stage = this._masked ? 3 : 4;
     } else {
-      this._lengthBuffer = [];
-      this._lengthSize   = (this._length === 126 ? 2 : 8);
-      this._stage        = 2;
+      this._lengthSize = (this._length === 126 ? 2 : 8);
+      this._stage      = 2;
     }
   },
 
@@ -303,21 +295,32 @@ var instance = {
     if (this.FRAGMENTED_OPCODES.indexOf(this._opcode) < 0 && this._length > 125)
       return this._fail('protocol_error', 'Received control frame having too long payload: ' + this._length);
 
-    if (this._length > this.MAX_LENGTH)
-      return this._fail('too_large', 'WebSocket frame length too large');
+    if (!this._checkFrameLength()) return;
 
     this._stage  = this._masked ? 3 : 4;
   },
 
-  _emitFrame: function() {
-    var payload = Hybi.mask(this._payload, this._mask),
+  _checkFrameLength: function() {
+    if (this.__blength + this._length > this._maxLength) {
+      this._fail('too_large', 'WebSocket frame length too large');
+      return false;
+    } else {
+      return true;
+    }
+  },
+
+  _emitFrame: function(buffer) {
+    var payload = Hybi.mask(buffer, this._mask),
+        isFinal = this._final,
         opcode  = this._opcode;
 
+    this._final = this._opcode = this._length = this._lengthSize = this._masked = this._mask = null;
+
     if (opcode === this.OPCODES.continuation) {
       if (!this._mode) return this._fail('protocol_error', 'Received unexpected continuation frame');
       this._buffer(payload);
-      if (this._final) {
-        var message = new Buffer(this.__buffer);
+      if (isFinal) {
+        var message = this._concatBuffer();
         if (this._mode === 'text') message = this._encode(message);
         this._reset();
         if (message === null)
@@ -327,7 +330,7 @@ var instance = {
       }
     }
     else if (opcode === this.OPCODES.text) {
-      if (this._final) {
+      if (isFinal) {
         var message = this._encode(payload);
         if (message === null)
           this._fail('encoding_error', 'Could not decode a text frame as UTF-8');
@@ -339,7 +342,7 @@ var instance = {
       }
     }
     else if (opcode === this.OPCODES.binary) {
-      if (this._final) {
+      if (isFinal) {
         this.emit('message', new Base.MessageEvent(payload));
       } else {
         this._mode = 'binary';
@@ -374,13 +377,25 @@ var instance = {
   },
 
   _buffer: function(fragment) {
-    for (var i = 0, n = fragment.length; i < n; i++)
-      this.__buffer.push(fragment[i]);
+    this.__buffer.push(fragment);
+    this.__blength += fragment.length;
+  },
+
+  _concatBuffer: function() {
+    var buffer = new Buffer(this.__blength),
+        offset = 0;
+
+    for (var i = 0, n = this.__buffer.length; i < n; i++) {
+      this.__buffer[i].copy(buffer, offset);
+      offset += this.__buffer[i].length;
+    }
+    return buffer;
   },
 
   _reset: function() {
-    this._mode    = null;
-    this.__buffer = [];
+    this._mode     = null;
+    this.__buffer  = [];
+    this.__blength = 0;
   },
 
   _encode: function(buffer) {
@@ -403,4 +418,3 @@ for (var key in instance)
   Hybi.prototype[key] = instance[key];
 
 module.exports = Hybi;
-

lib/websocket/driver/hybi/stream_reader.js

@@ -1,41 +1,40 @@
 var StreamReader = function() {
-  this._queue  = [];
-  this._cursor = 0;
-};
-
-StreamReader.prototype.read = function(bytes) {
-  return this._readBuffer(bytes);
+  this._queue     = [];
+  this._queueSize = 0;
+  this._cursor    = 0;
 };
 
 StreamReader.prototype.put = function(buffer) {
   if (!buffer || buffer.length === 0) return;
   if (!buffer.copy) buffer = new Buffer(buffer);
   this._queue.push(buffer);
+  this._queueSize += buffer.length;
 };
 
-StreamReader.prototype._readBuffer = function(length) {
+StreamReader.prototype.read = function(length) {
+  if (length > this._queueSize) return null;
+
   var buffer = new Buffer(length),
       queue  = this._queue,
       remain = length,
       n      = queue.length,
       i      = 0,
-      chunk, offset, size;
-
-  if (remain === 0) return buffer;
+      chunk, size;
 
   while (remain > 0 && i < n) {
     chunk = queue[i];
-    offset = (i === 0) ? this._cursor : 0;
-    size = Math.min(remain, chunk.length - offset);
-    chunk.copy(buffer, length - remain, offset, offset + size);
-    remain -= size;
+    size  = Math.min(remain, chunk.length - this._cursor);
+
+    chunk.copy(buffer, length - remain, this._cursor, this._cursor + size);
+
+    remain          -= size;
+    this._queueSize -= size;
+    this._cursor     = (this._cursor + size) % chunk.length;
+
     i += 1;
   }
 
-  if (remain > 0) return null;
-
-  queue.splice(0, i-1);
-  this._cursor = (i === 1 ? this._cursor : 0) + size;
+  queue.splice(0, this._cursor === 0 ? i : i - 1);
 
   return buffer;
 };

lib/websocket/driver/proxy.js

@@ -0,0 +1,95 @@
+var Stream     = require('stream').Stream,
+    url        = require('url'),
+    util       = require('util'),
+    Headers    = require('./headers'),
+    HttpParser = require('../http_parser');
+
+var PORTS = {'ws:': 80, 'wss:': 443};
+
+var Proxy = function(client, origin, options) {
+  this._client  = client;
+  this._http    = new HttpParser('response');
+  this._origin  = (typeof client.url === 'object') ? client.url : url.parse(client.url);
+  this._url     = (typeof origin === 'object') ? origin : url.parse(origin);
+  this._options = options || {};
+  this._state   = 0;
+
+  this.readable = this.writable = true;
+  this._paused  = false;
+
+  this._headers = new Headers();
+  this._headers.set('Host', this._origin.host);
+  this._headers.set('Connection', 'keep-alive');
+  this._headers.set('Proxy-Connection', 'keep-alive');
+
+  var auth = this._url.auth && new Buffer(this._url.auth, 'utf8').toString('base64');
+  if (auth) this._headers.set('Proxy-Authorization', 'Basic ' + auth);
+};
+util.inherits(Proxy, Stream);
+
+var instance = {
+  setHeader: function(name, value) {
+    if (this._state !== 0) return false;
+    this._headers.set(name, value);
+    return true;
+  },
+
+  start: function() {
+    if (this._state !== 0) return false;
+    this._state = 1;
+
+    var origin = this._origin,
+        port   = origin.port || PORTS[origin.protocol],
+        start  = 'CONNECT ' + origin.hostname + ':' + port + ' HTTP/1.1';
+
+    var headers = [start, this._headers.toString(), ''];
+
+    this.emit('data', new Buffer(headers.join('\r\n'), 'utf8'));
+    return true;
+  },
+
+  pause: function() {
+    this._paused = true;
+  },
+
+  resume: function() {
+    this._paused = false;
+    this.emit('drain');
+  },
+
+  write: function(chunk) {
+    if (!this.writable) return false;
+
+    this._http.parse(chunk);
+    if (!this._http.isComplete()) return !this._paused;
+
+    this.statusCode = this._http.statusCode;
+    this.headers    = this._http.headers;
+
+    if (this.statusCode === 200) {
+      this.emit('connect');
+    } else {
+      var message = "Can't establish a connection to the server at " + this._origin.href;
+      this.emit('error', new Error(message));
+    }
+    this.end();
+    return !this._paused;
+  },
+
+  end: function(chunk) {
+    if (!this.writable) return;
+    if (chunk !== undefined) this.write(chunk);
+    this.readable = this.writable = false;
+    this.emit('close');
+    this.emit('end');
+  },
+
+  destroy: function() {
+    this.end();
+  }
+};
+
+for (var key in instance)
+  Proxy.prototype[key] = instance[key];
+
+module.exports = Proxy;

lib/websocket/driver/server.js

@@ -1,5 +1,5 @@
 var util       = require('util'),
-    HttpParser = require('./http_parser'),
+    HttpParser = require('../http_parser'),
     Base       = require('./base'),
     Draft75    = require('./draft75'),
     Draft76    = require('./draft76'),
@@ -40,6 +40,9 @@ var instance = {
       this._delegate.on(event, function(e) { self.emit(event, e) });
     }, this);
 
+    this.protocol = this._delegate.protocol;
+    this.version  = this._delegate.version;
+
     this.parse(this._http.body);
     this.emit('connect', new Base.ConnectEvent());
   },
@@ -101,4 +104,3 @@ Server.http = function(request, options) {
 };
 
 module.exports = Server;
-

lib/websocket/http_parser.js

@@ -22,23 +22,45 @@ var HttpParser = function(type) {
     self.headers[current] = b.toString('utf8', start, start + length);
   };
 
-  this._parser.onHeadersComplete = function(info) {
-    self.method     = info.method;
+  this._parser.onHeadersComplete = this._parser[HTTPParser.kOnHeadersComplete] = function(info) {
+    self.method     = (typeof info.method === 'number') ? HttpParser.METHODS[info.method] : info.method;
     self.statusCode = info.statusCode;
     self.url        = info.url;
-    
+
     var headers = info.headers;
     if (!headers) return;
 
     for (var i = 0, n = headers.length; i < n; i += 2)
       self.headers[headers[i].toLowerCase()] = headers[i+1];
-  };
 
-  this._parser.onMessageComplete = function() {
     self._complete = true;
   };
 };
 
+HttpParser.METHODS = {
+  0:  'DELETE',
+  1:  'GET',
+  2:  'HEAD',
+  3:  'POST',
+  4:  'PUT',
+  5:  'CONNECT',
+  6:  'OPTIONS',
+  7:  'TRACE',
+  8:  'COPY',
+  9:  'LOCK',
+  10: 'MKCOL',
+  11: 'MOVE',
+  12: 'PROPFIND',
+  13: 'PROPPATCH',
+  14: 'SEARCH',
+  15: 'UNLOCK',
+  16: 'REPORT',
+  17: 'MKACTIVITY',
+  18: 'CHECKOUT',
+  19: 'MERGE',
+  24: 'PATCH'
+};
+
 HttpParser.prototype.isComplete = function() {
   return this._complete;
 };
@@ -54,4 +76,3 @@ HttpParser.prototype.parse = function(data) {
 };
 
 module.exports = HttpParser;
-

lib/websocket/streams.js

@@ -141,4 +141,3 @@ Messages.prototype.destroy = function() {};
 
 exports.IO = IO;
 exports.Messages = Messages;
-

package.json

@@ -5,7 +5,7 @@
 , "keywords"        : ["websocket"]
 , "license"         : "MIT"
 
-, "version"         : "0.2.2"
+, "version"         : "0.4.0"
 , "engines"         : {"node": ">=0.4.0"}
 , "main"            : "./lib/websocket/driver"
 , "devDependencies" : {"jstest": ""}
@@ -18,4 +18,3 @@
 
 , "bugs"            : "http://github.com/faye/websocket-driver-node/issues"
 }
-

spec/runner.js

@@ -42,4 +42,3 @@ require('./websocket/driver/draft75_spec')
 require('./websocket/driver/draft76_spec')
 require('./websocket/driver/hybi_spec')
 require('./websocket/driver/client_spec')
-

spec/websocket/driver/client_spec.js

@@ -10,9 +10,13 @@ test.describe("Client", function() { with(this) {
     null
   })
 
+  define("url", function() {
+    return "ws://www.example.com/socket"
+  })
+
   define("driver", function() {
     if (this._driver) return this._driver
-    this._driver = new Client("ws://www.example.com/socket", this.options())
+    this._driver = new Client(this.url(), this.options())
     var self = this
     this._driver.on('open',    function(e) { self.open = true })
     this._driver.on('message', function(e) { self.message += e.data })
@@ -46,6 +50,14 @@ test.describe("Client", function() { with(this) {
       assertEqual( null, driver().getState() )
     }})
 
+    describe("close", function() { with(this) {
+      it("changes the state to closed", function() { with(this) {
+        driver().close()
+        assertEqual( "closed", driver().getState() )
+        assertEqual( [1000, ''], close )
+      }})
+    }})
+
     describe("start", function() { with(this) {
       it("writes the handshake request to the socket", function() { with(this) {
         expect(driver().io, "emit").given("data", buffer(
@@ -80,6 +92,23 @@ test.describe("Client", function() { with(this) {
         }})
       }})
 
+      describe("with basic auth", function() { with(this) {
+        define("url", function() { return "ws://user:pass@www.example.com/socket" })
+
+        it("writes the handshake with Authorization", function() { with(this) {
+          expect(driver().io, "emit").given("data", buffer(
+              "GET /socket HTTP/1.1\r\n" +
+              "Host: www.example.com\r\n" +
+              "Upgrade: websocket\r\n" +
+              "Connection: Upgrade\r\n" +
+              "Sec-WebSocket-Key: 2vBVWg4Qyk3ZoM/5d3QD9Q==\r\n" +
+              "Sec-WebSocket-Version: 13\r\n" +
+              "Authorization: Basic dXNlcjpwYXNz\r\n" +
+              "\r\n"))
+          driver().start()
+        }})
+      }})
+
       describe("with custom headers", function() { with(this) {
         before(function() { with(this) {
           driver().setHeader("User-Agent", "Chrome")
@@ -106,6 +135,70 @@ test.describe("Client", function() { with(this) {
     }})
   }})
 
+  describe("using a proxy", function() { with(this) {
+    it("sends a CONNECT request", function() { with(this) {
+      var proxy = driver().proxy("http://proxy.example.com")
+      expect(proxy, "emit").given("data", buffer(
+          "CONNECT www.example.com:80 HTTP/1.1\r\n" +
+          "Host: www.example.com\r\n" +
+          "Connection: keep-alive\r\n" +
+          "Proxy-Connection: keep-alive\r\n" +
+          "\r\n"))
+      proxy.start()
+    }})
+
+    it("sends an authenticated CONNECT request", function() { with(this) {
+      var proxy = driver().proxy("http://user:pass@proxy.example.com")
+      expect(proxy, "emit").given("data", buffer(
+          "CONNECT www.example.com:80 HTTP/1.1\r\n" +
+          "Host: www.example.com\r\n" +
+          "Connection: keep-alive\r\n" +
+          "Proxy-Connection: keep-alive\r\n" +
+          "Proxy-Authorization: Basic dXNlcjpwYXNz\r\n" +
+          "\r\n"))
+      proxy.start()
+    }})
+
+    it("sends a CONNECT request with custom headers", function() { with(this) {
+      var proxy = driver().proxy("http://user:pass@proxy.example.com")
+      proxy.setHeader("User-Agent", "Chrome")
+      expect(proxy, "emit").given("data", buffer(
+          "CONNECT www.example.com:80 HTTP/1.1\r\n" +
+          "Host: www.example.com\r\n" +
+          "Connection: keep-alive\r\n" +
+          "Proxy-Connection: keep-alive\r\n" +
+          "Proxy-Authorization: Basic dXNlcjpwYXNz\r\n" +
+          "User-Agent: Chrome\r\n" +
+          "\r\n"))
+      proxy.start()
+    }})
+
+    describe("receiving a response", function() { with(this) {
+      before(function() { with(this) {
+        this.proxy = driver().proxy("http://proxy.example.com")
+      }})
+
+      it("returns true when the response is written", function() { with(this) {
+        // this prevents downstream connections suddenly closing for no reason
+        assertEqual( true, proxy.write(new Buffer("HTTP/1.1 200 OK\r\n\r\n")) )
+      }})
+
+      it("emits a 'connect' event when the proxy connects", function() { with(this) {
+        expect(proxy, "emit").given("connect")
+        expect(proxy, "emit").given("close")
+        expect(proxy, "emit").given("end")
+        proxy.write(new Buffer("HTTP/1.1 200 OK\r\n\r\n"))
+      }})
+
+      it("emits an 'error' event if the proxy does not connect", function() { with(this) {
+        expect(proxy, "emit").given("error", objectIncluding({message: "Can't establish a connection to the server at ws://www.example.com/socket"}))
+        expect(proxy, "emit").given("close")
+        expect(proxy, "emit").given("end")
+        proxy.write(new Buffer("HTTP/1.1 403 Forbidden\r\n\r\n"))
+      }})
+    }})
+  }})
+
   describe("in the connecting state", function() { with(this) {
     before(function() { this.driver().start() })
 
@@ -228,4 +321,3 @@ test.describe("Client", function() { with(this) {
     }})
   }})
 }})
-

spec/websocket/driver/draft75_examples.js

@@ -112,4 +112,3 @@ test.describe("draft-75", function() { with(this) {
     }})
   }})
 }})
-

spec/websocket/driver/draft75_spec.js

@@ -97,4 +97,3 @@ test.describe("Draft75", function() { with(this) {
 
   itShouldBehaveLike("draft-75 protocol")
 }})
-

spec/websocket/driver/draft76_spec.js

@@ -53,7 +53,7 @@ test.describe("Draft76", function() { with(this) {
     describe("start", function() { with(this) {
       it("writes the handshake response to the socket", function() { with(this) {
         expect(driver().io, "emit").given("data", buffer(
-            "HTTP/1.1 101 Web Socket Protocol Handshake\r\n" +
+            "HTTP/1.1 101 WebSocket Protocol Handshake\r\n" +
             "Upgrade: WebSocket\r\n" +
             "Connection: Upgrade\r\n" +
             "Sec-WebSocket-Origin: http://www.example.com\r\n" +
@@ -95,7 +95,7 @@ test.describe("Draft76", function() { with(this) {
 
       it("queues the frames until the handshake has been sent", function() { with(this) {
         expect(driver().io, "emit").given("data", buffer(
-            "HTTP/1.1 101 Web Socket Protocol Handshake\r\n" +
+            "HTTP/1.1 101 WebSocket Protocol Handshake\r\n" +
             "Upgrade: WebSocket\r\n" +
             "Connection: Upgrade\r\n" +
             "Sec-WebSocket-Origin: http://www.example.com\r\n" +
@@ -116,7 +116,7 @@ test.describe("Draft76", function() { with(this) {
 
       it("writes the handshake response with no body", function() { with(this) {
         expect(driver().io, "emit").given("data", buffer(
-            "HTTP/1.1 101 Web Socket Protocol Handshake\r\n" +
+            "HTTP/1.1 101 WebSocket Protocol Handshake\r\n" +
             "Upgrade: WebSocket\r\n" +
             "Connection: Upgrade\r\n" +
             "Sec-WebSocket-Origin: http://www.example.com\r\n" +
@@ -184,4 +184,3 @@ test.describe("Draft76", function() { with(this) {
     }})
   }})
 }})
-

spec/websocket/driver/hybi_spec.js

@@ -308,7 +308,7 @@ test.describe("Hybi", function() { with(this) {
       }})
 
       it("returns an error for too-large frames", function() { with(this) {
-        driver().parse([0x81, 0x7f, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00])
+        driver().parse([0x81, 0x7f, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00])
         assertEqual( "WebSocket frame length too large", error.message )
         assertEqual( [1009, "WebSocket frame length too large"], close )
         assertEqual( "closed", driver().getState() )
@@ -539,4 +539,3 @@ test.describe("Hybi", function() { with(this) {
     }})
   }})
 }})
-