faye-websocket 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e55b90e0392792e40296464c5bfb0419042dac2a
-  data.tar.gz: 6d7a46c812d1c98cf23b5fe4f5b7c82149ae2144
+  metadata.gz: be0df4257b3a1f898577eb787b6f1fc8f5c0fae4
+  data.tar.gz: 75def6662b64d516ee753ccd78003a445c9dca11
 SHA512:
-  metadata.gz: 807a1837ccc7d7817f611c21aeeb05d7d8e64795e10b83aaf6bb93145044e956626b27feeef228dca7ea21b7930c544caf11f6d37f95d5b6c463d3d300b6e2b4
-  data.tar.gz: eefb00619befa06948f8d2752b6c670d16ed2ae1da71809780b7c3b0400b799118fd241758afd9c6565b8916a8b17af3f222afd3480e2c185776b7de1779beca
+  metadata.gz: 9054661c65b66682fea05e779d785b142f7005f323228ffdbd3429570ba4df9055b2c7b6516a6c7f046c929387133574ffa39a142121b1871bdcfe99e52ff828
+  data.tar.gz: 7eb1cb4a544824ffa191270c665ed70c87d5a131e54f597f090d71a23802691bdce18e9cc46f62c39d3283e031af42c27bec6bae552519c2c7e4a4630fde64cf

data/CHANGELOG.md

@@ -1,76 +1,66 @@
+### 0.10.0 / 2015-07-08
+
+* Add the standard `code` and `reason` parameters to the `close` method
+
 ### 0.9.2 / 2014-12-21
 
 * Only emit `error` once, and don't emit it after `close`
 
-
 ### 0.9.1 / 2014-12-18
 
 * Check that all options to the WebSocket constructor are recognized
 
-
 ### 0.9.0 / 2014-12-13
 
 * Allow protocol extensions to be passed into websocket-extensions
 
-
 ### 0.8.0 / 2014-11-08
 
 * Support connections via HTTP proxies
 
-
 ### 0.7.5 / 2014-10-04
 
 * Allow sockets to be closed when they are in any state other than `CLOSED`
 
-
 ### 0.7.4 / 2014-07-06
 
 * Stop using `define_method` to implement `Event` properties, since it blows the method cache
 * Stop setup errors masking URI errors in `Client#initialize`
 * Make the Goliath adapter compatible with goliath-1.0.4.
 
-
 ### 0.7.3 / 2014-04-24
 
 * Remove an unneeded method override in the `WebSocket` class
 
-
 ### 0.7.2 / 2013-12-29
 
 * Fix WebSocket detection in cases where the web server does not produce an `env`
 
-
 ### 0.7.1 / 2013-12-03
 
 * Support the `max_length` websocket-driver option
 * Expose a `message` property on `error` events
 
-
 ### 0.7.0 / 2013-09-09
 
 * Allow the server to send custom headers with EventSource responses
 
-
 ### 0.6.3 / 2013-08-04
 
 * Stop implicitly depending on Rack 1.4
 
-
 ### 0.6.2 / 2013-07-05
 
 * Catch errors thrown by EventMachine and emit `error` and `close` events
 
-
 ### 0.6.1 / 2013-05-12
 
 * Release a gem without log and pid files in it
 
-
 ### 0.6.0 / 2013-05-12
 
 * Add support for custom headers
 
-
 ### 0.5.0 / 2013-05-05
 
 * Extract the protocol handlers into the `websocket-driver` library
@@ -78,58 +68,48 @@
 * Add support for Rainbows 4.5 and Puma
 * Officially support JRuby and Rubinius
 
-
 ### 0.4.7 / 2013-02-14
 
 * Emit the `close` event if TCP is closed before CLOSE frame is acked
 * Treat the `Upgrade: websocket` header case-insensitively because of IE10
 * Do not suppress headers in the Thin and Rainbows adapters unless the status is `101`
 
-
 ### 0.4.6 / 2012-07-09
 
 * Add `Connection: close` to EventSource response
 
-
 ### 0.4.5 / 2012-04-06
 
 * Add WebSocket error code `1011`.
 * Handle URLs with no path correctly by sending `GET /`
 
-
 ### 0.4.4 / 2012-03-16
 
 * Fix installation on JRuby with a platform-specific gem
 
-
 ### 0.4.3 / 2012-03-12
 
 * Make `extconf.rb` a no-op on JRuby
 
-
 ### 0.4.2 / 2012-03-09
 
 * Port masking-function C extension to Java for JRuby
 
-
 ### 0.4.1 / 2012-02-26
 
 * Treat anything other than an `Array` as a string when calling `send()`
 * Fix error loading UTF-8 validation code on Ruby 1.9 with `-Ku` flag
 
-
 ### 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
 
-
 ### 0.3.0 / 2012-01-13
 
 * Add support for `EventSource` connections
 * Support the Thin, Rainbows and Goliath web servers
 
-
 ### 0.2.0 / 2011-12-21
 
 * Add support for `Sec-WebSocket-Protocol` negotiation
@@ -137,17 +117,14 @@
 * Improve performance of HyBi parsing/framing functions
 * Write masking function in C
 
-
 ### 0.1.2 / 2011-12-05
 
 * Make `hixie-76` sockets work through HAProxy
 
-
 ### 0.1.1 / 2011-11-30
 
 * Fix `add_event_listener()` interface methods
 
-
 ### 0.1.0 / 2011-11-27
 
 * Initial release, based on WebSocket components from Faye

data/README.md

@@ -6,12 +6,11 @@
   [client](http://faye.jcoglan.com/autobahn/clients/)
 
 This is a general-purpose WebSocket implementation extracted from the
-[Faye](http://faye.jcoglan.com) project. It provides classes for easily
-building WebSocket servers and clients in Ruby. It does not provide a server
-itself, but rather makes it easy to handle WebSocket connections within an
-existing [Rack](http://rack.github.io/) application. It does not provide
-any abstraction other than the standard [WebSocket
-API](http://dev.w3.org/html5/websockets/).
+[Faye](http://faye.jcoglan.com) project. It provides classes for easily building
+WebSocket servers and clients in Ruby. It does not provide a server itself, but
+rather makes it easy to handle WebSocket connections within an existing
+[Rack](http://rack.github.io/) 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
@@ -38,10 +37,10 @@ $ gem install faye-websocket
 
 ## Handling WebSocket connections in Rack
 
-You can handle WebSockets on the server side by listening for requests using
-the `Faye::WebSocket.websocket?` method, and creating a new socket for the
-request. This socket object exposes the usual WebSocket methods for receiving
-and sending messages. For example this is how you'd implement an echo server:
+You can handle WebSockets on the server side by listening for requests using the
+`Faye::WebSocket.websocket?` method, and creating a new socket for the request.
+This socket object exposes the usual WebSocket methods for receiving and sending
+messages. For example this is how you'd implement an echo server:
 
 ```ruby
 # app.rb
@@ -82,8 +81,8 @@ If you need to detect when the WebSocket handshake is complete, you can use the
 
 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
+message string, and an optional callback that fires when a matching pong message
+is received. It returns `true` if and only if a ping message was sent. If the
 client does not support ping/pong, this method sends no data and returns
 `false`.
 
@@ -130,7 +129,7 @@ To connect via a proxy, set the `proxy` option to the HTTP origin of the proxy,
 including any authorization information and custom headers you require:
 
 ```rb
-ws = Faye::WebSocket::Client.new('ws://www.example.com/', nil, {
+ws = Faye::WebSocket::Client.new('ws://www.example.com/', [], {
   :proxy => {
     :origin  => 'http://username:password@proxy.example.com',
     :headers => {'User-Agent' => 'ruby'}
@@ -173,7 +172,7 @@ array of extensions to the `:extensions` option. For example, to add
 ```rb
 require 'permessage_deflate'
 
-ws = Faye::WebSocket.new(env, nil, :extensions => [PermessageDeflate])
+ws = Faye::WebSocket.new(env, [], :extensions => [PermessageDeflate])
 ```
 
 
@@ -193,8 +192,8 @@ is an optional hash containing any of these keys:
 * `:extensions` - an array of
   [websocket-extensions](https://github.com/faye/websocket-extensions-ruby)
   compatible extensions, as described above
-* `:headers` - a hash containing key-value pairs representing HTTP headers to
-  be sent during the handshake process
+* `:headers` - a hash containing key-value pairs representing HTTP headers to be
+  sent during the handshake process
 * `:max_length` - the maximum allowed size of incoming message frames, in bytes.
   The default value is `2^26 - 1`, or 1 byte short of 64 MiB.
 * `:ping` - an integer that sets how often the WebSocket should send ping
@@ -215,18 +214,19 @@ Both the server- and client-side `WebSocket` objects support the following API:
   not need to implement error recovery.
 * <b>`on(:close) { |event| }`</b> fires when either the client or the server
   closes the connection. Event has two optional attributes, <b>`code`</b> and
-  <b>`reason`</b>, that expose the status code and message sent by the peer
-  that closed the connection.
+  <b>`reason`</b>, that expose the status code and message sent by the peer that
+  closed the connection.
 * <b>`send(message)`</b> accepts either a `String` or an `Array` of byte-sized
   integers and sends a text or binary message over the connection to the other
   peer; binary data must be encoded as an `Array`.
-* <b>`ping(message = '', &callback)`</b> sends a ping frame with an optional
-  message and fires the callback when a matching pong is received.
-* <b>`close`</b> closes the connection.
+* <b>`ping(message, &callback)`</b> sends a ping frame with an optional message
+  and fires the callback when a matching pong is received.
+* <b>`close(code, reason)`</b> closes the connection, sending the given status
+  code and reason text, both of which are optional.
 * <b>`version`</b> is a string containing the version of the `WebSocket`
   protocol the connection is using.
-* <b>`protocol`</b> is a string (which may be empty) identifying the
-  subprotocol the socket is using.
+* <b>`protocol`</b> is a string (which may be empty) identifying the subprotocol
+  the socket is using.
 
 
 ## Handling EventSource connections in Rack
@@ -263,9 +263,9 @@ App = lambda do |env|
 end
 ```
 
-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`:
+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`:
 
 ```ruby
 es.send('Breaking News!', :event => 'notification', :id => '99')
@@ -302,8 +302,8 @@ es = Faye::EventSource.new(es,
 ```
 
 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.
+the client does not send a response to this; it is merely to send some data over
+the wire to keep the connection alive.
 
 
 ## Running your socket application
@@ -321,8 +321,8 @@ loading `faye/websocket`:
 Faye::WebSocket.load_adapter('thin')
 ```
 
-Thin can be started via the command line if you've set up a `config.ru` file
-for your application:
+Thin can be started via the command line if you've set up a `config.ru` file for
+your application:
 
 ```
 $ thin start -R config.ru -p 9292
@@ -362,9 +362,20 @@ end
 ### Running the app with Passenger
 
 faye-websocket requires either Passenger for Nginx or Passenger Standalone.
-Apache doesn't work well with WebSockets at this time. You do not need any
-special configuration to make faye-websocket work, it should work out of the
-box on Passenger provided you use at least Passenger 4.0.
+[Apache doesn't work well with WebSockets at this time](https://github.com/phusion/passenger/issues/1202).
+You do not need any special configuration to make faye-websocket work, it
+should work out of the box on Passenger provided you use at least Passenger
+4.0.
+
+However, you do need to insert the following code in `config.ru` for optimal
+WebSocket performance in Passenger. This is
+[documented in the Passenger manual](https://www.phusionpassenger.com/documentation/Users%20guide%20Nginx.html#tuning_sse_websockets).
+
+```ruby
+if defined?(PhusionPasseneger)
+  PhusionPassenger.advertised_concurrency_level = 0
+end
+```
 
 Run your app on Passenger for Nginx by creating a virtual host entry which
 points to your app's "public" directory:
@@ -479,22 +490,21 @@ end
 
 (The MIT License)
 
-Copyright (c) 2010-2014 James Coglan
+Copyright (c) 2010-2015 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
 the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-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.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 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.

data/examples/autobahn_client.rb

@@ -30,7 +30,7 @@ EM.run {
     end
 
     url = "#{host}/runCase?case=#{n}&agent=#{agent}"
-    socket = Faye::WebSocket::Client.new(url, nil, options)
+    socket = Faye::WebSocket::Client.new(url, [], options)
 
     socket.onmessage = lambda do |event|
       socket.send(event.data)

data/examples/client.rb

@@ -2,12 +2,17 @@ require 'rubygems'
 require 'bundler/setup'
 require 'faye/websocket'
 require 'eventmachine'
+require 'permessage_deflate'
 
 EM.run {
-  url     = ARGV[0]
-  headers = {'Origin' => 'http://faye.jcoglan.com'}
-  proxy   = {:origin => ARGV[1], :headers => {'User-Agent' => 'Echo'}}
-  ws      = Faye::WebSocket::Client.new(url, nil, :headers => headers, :proxy => proxy)
+  url   = ARGV[0]
+  proxy = ARGV[1]
+
+  ws = Faye::WebSocket::Client.new(url, [],
+    :proxy      => {:origin => proxy, :headers => {'User-Agent' => 'Echo'}},
+    :headers    => {'Origin' => 'http://faye.jcoglan.com'},
+    :extensions => [PermessageDeflate]
+  )
 
   ws.onopen = lambda do |event|
     p [:open, ws.headers]

data/lib/faye/websocket/api.rb

@@ -69,9 +69,18 @@ module Faye
         @driver.ping(message, &callback)
       end
 
-      def close
+      def close(code = nil, reason = nil)
+        code   ||= 1000
+        reason ||= ''
+
+        unless code == 1000 or (code >= 3000 and code <= 4999)
+          raise ArgumentError, "Failed to execute 'close' on WebSocket: " +
+                               "The code must be either 1000, or between 3000 and 4999. " +
+                               "#{code} is neither."
+        end
+
         @ready_state = CLOSING unless @ready_state == CLOSED
-        @driver.close
+        @driver.close(reason, code)
       end
 
       def protocol
@@ -106,13 +115,13 @@ module Faye
       def begin_close(reason, code)
         return if @ready_state == CLOSED
         @ready_state = CLOSING
+        @close_params = [reason, code]
 
         if @stream
           @stream.close_connection_after_writing
         else
           finalize_close
         end
-        @close_params = [reason, code]
       end
 
       def finalize_close

data/lib/faye/websocket/api/event_target.rb

@@ -7,7 +7,7 @@ module Faye::WebSocket::API
     events.each do |event_type|
       define_method "on#{event_type}=" do |handler|
         EventMachine.next_tick do
-          flush(event_type, &handler)
+          flush(event_type, handler)
           instance_variable_set("@on#{event_type}", handler)
         end
       end
@@ -17,9 +17,10 @@ module Faye::WebSocket::API
       add_listener(event_type, &listener)
     end
 
-    def add_listener(event_type, &listener)
+    def add_listener(event_type, callable = nil, &block)
+      listener = callable || block
       EventMachine.next_tick do
-        flush(event_type, &listener)
+        flush(event_type, listener)
         super(event_type, &listener)
       end
     end
@@ -32,23 +33,23 @@ module Faye::WebSocket::API
       event.target = event.current_target = self
       event.event_phase = Event::AT_TARGET
 
-      callback = instance_variable_get("@on#{ event.type }")
+      listener = instance_variable_get("@on#{ event.type }")
       count    = listener_count(event.type)
 
-      unless callback or count > 0
+      unless listener or count > 0
         @buffers ||= Hash.new { |k,v| k[v] = [] }
         @buffers[event.type].push(event)
       end
 
-      callback.call(event) if callback
+      listener.call(event) if listener
       emit(event.type, event)
     end
 
   private
 
-    def flush(event_type, &callback)
+    def flush(event_type, listener)
       if buffer = @buffers && @buffers.delete(event_type.to_s)
-        buffer.each { |event| callback.call(event) }
+        buffer.each { |event| listener.call(event) }
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faye-websocket
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - James Coglan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Standards-compliant WebSocket server and client