websocket-rack 0.3.0 → 0.3.1

data/.travis.yml

@@ -0,0 +1,6 @@
+script: "bundle exec rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - rbx

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.3.1 / 2011-07-29
+
+- support for WebSocket drafts 07 and 08
+
 ## 0.3.0 / 2011-05-10
 
 - support for WebSocket drafts 05 and 06

data/Gemfile

@@ -1,3 +1,5 @@
 source "http://rubygems.org"
 
 gemspec
+
+gem 'rake'

data/README.md

@@ -1,4 +1,4 @@
-# WebSocket Rack
+# WebSocket Rack [![](http://travis-ci.org/imanel/websocket-rack.png)](http://travis-ci.org/imanel/websocket-rack)
 
 Rack-based WebSocket server
 
@@ -6,18 +6,22 @@ Rack-based WebSocket server
 
 Create sample rack config file, and inside build app basing on Rack::WebSocket::Application.
 
-    require 'rack/websocket'
+``` ruby
+require 'rack/websocket'
 
-    class MyApp < Rack::WebSocket::Application
-    end
+class MyApp < Rack::WebSocket::Application
+end
 
-    map '/' do
-      run MyApp.new
-    end
+map '/' do
+  run MyApp.new
+end
+```
 
 After that just run Rack config from Rack server:
 
-    thin -R config.ru start
+``` bash
+thin -R config.ru start
+```
 
 Done.
 
@@ -25,17 +29,48 @@ Done.
 
 Rack::WebSocket::Application make following methods available:
 
+### initialize
+
+Called once after server is started. This is place for application configuration so each instance variables from here will be available in whole application.
+
+Example:
+
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def initialize(options = {})
+    super
+    @myvar = 4
+  end
+end
+```
+
+It is important to include 'super' in initialize function, so application will be properly configured.
+
+Please notice that in some servers, when 'initialize' is called, EventMachine reactor is not running yet. If you would like to configure EventMachine-based software, then you need to put it inside 'EM.next_tick' block, so this function will be called in first cycle of reactor.
+
+Example:
+
+``` ruby
+class MyWebSocket < Rack::WebSocket::Application
+  def initialize
+    EM.next_tick { @redis = EM::Hiredis.connect }
+  end
+end
+```
+
 ### on_open(env)
 
 Called after client is connected. Rack env of client is passed as attribute.
 
 Example:
 
-    class MyApp < Rack::WebSocket::Application
-      def on_open(env)
-        puts "Clien connected"
-      end
-    end
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_open(env)
+    puts "Clien connected"
+  end
+end
+```
 
 ### on_close(env)
 
@@ -43,11 +78,13 @@ Called after client is disconnected. Rack env of client is passed as attribute.
 
 Example:
 
-    class MyApp < Rack::WebSocket::Application
-      def on_close(env)
-        puts "Clien disconnected"
-      end
-    end
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_close(env)
+    puts "Clien disconnected"
+  end
+end
+```
 
 ### on_message(env, msg)
 
@@ -55,11 +92,13 @@ Called after server receive message. Rack env of client is passed as attribute.
 
 Example:
 
-    class MyApp < Rack::WebSocket::Application
-      def on_message(env, msg)
-        puts "Received message: " + msg
-      end
-    end
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_message(env, msg)
+    puts "Received message: " + msg
+  end
+end
+```
 
 ### on_error(env, error)
 
@@ -67,11 +106,13 @@ Called after server catch error. Variable passed is instance of Ruby Exception c
 
 Example:
 
-    class MyApp < Rack::WebSocket::Application
-      def on_error(env, error)
-        puts "Error occured: " + error.message
-      end
-    end
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_error(env, error)
+    puts "Error occured: " + error.message
+  end
+end
+```
 
 ### send_data(data)
 
@@ -79,11 +120,13 @@ Sends data do client.
 
 Example:
 
-    class MyApp < Rack::WebSocket::Application
-      def on_open(env)
-        send_data "Hello to you!"
-      end
-    end
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_open(env)
+    send_data "Hello to you!"
+  end
+end
+```
 
 ### close_websocket
 
@@ -91,11 +134,13 @@ Closes connection.
 
 Example:
 
-    class MyApp < Rack::WebSocket::Application
-      def on_open(env)
-        close_websocket if env['REQUEST_PATH'] != '/websocket'
-      end
-    end
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_open(env)
+    close_websocket if env['REQUEST_PATH'] != '/websocket'
+  end
+end
+```
 
 ## Available variables:
 
@@ -105,16 +150,22 @@ Options passed to app on initialize.
 
 Example:
 
-    # In config.ru
-    map '/' do
-      run MyApp.new :some => :variable
-    end
-    
-    # In application instance
-    @options # => { :some => :variable }
+``` ruby
+# In config.ru
+map '/' do
+  run MyApp.new :some => :variable
+end
+
+# In application instance
+@options # => { :some => :variable }
+```
 
 ## FAQ
 
+### Which WebSocket drafts are supported:
+
+Currently we support drafts -75 and -76 form old(hixie) numeration and all drafts from -00 to -08 from current(ietf-hybi) numeration.
+
 ### Which Rack servers are supported?
 
 Currently we are supporting following servers:

data/lib/rack/websocket/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module WebSocket
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

data/spec/support/all_drafts.rb

@@ -34,7 +34,7 @@ shared_examples_for 'all drafts' do
     conn.write(message)
   end
   it "should call 'on_message' on connection sending data with proper env and message" do
-    TestApp.any_instance.expects(:on_message).once.with { |env, message| env.class == Hash && !env.keys.empty? && message == 'some message' }
+    TestApp.any_instance.expects(:on_message).once.with { |env, message| env.class == Hash && !env.keys.empty? && message == 'Hello' }
     conn = new_server_connection
     conn.write(handshake_request)
     conn.read(handshake_response.length)

data/spec/support/all_handlers.rb

@@ -13,6 +13,7 @@ shared_examples_for 'all handlers' do
     it_should_behave_like 'all drafts'
   end
   
+  # Also draft00
   context 'for draft76' do
     let(:handshake_request)  { spec76_handshake_request }
     let(:handshake_response) { spec76_handshake_response }
@@ -21,6 +22,7 @@ shared_examples_for 'all handlers' do
     it_should_behave_like 'all drafts'
   end
   
+  # Drafts 01, 02 and 03 are pretty the same so one test for all
   context 'for draft03' do
     let(:handshake_request)  { spec03_handshake_request }
     let(:handshake_response) { spec03_handshake_response }
@@ -28,4 +30,40 @@ shared_examples_for 'all handlers' do
     
     it_should_behave_like 'all drafts'
   end
+  
+  context 'for draft05' do
+    let(:handshake_request)  { spec05_handshake_request }
+    let(:handshake_response) { spec05_handshake_response }
+    let(:message)            { spec05_message }
+    
+    it_should_behave_like 'all drafts'
+  end
+  
+  context 'for draft06' do
+    let(:handshake_request)  { spec06_handshake_request }
+    let(:handshake_response) { spec06_handshake_response }
+    let(:message)            { spec06_message }
+    
+    it_should_behave_like 'all drafts'
+  end
+  
+  context 'for draft07' do
+    let(:handshake_request)  { spec07_handshake_request }
+    let(:handshake_response) { spec07_handshake_response }
+    let(:message)            { spec07_unmasked_message }
+    let(:masked_message)     { spec07_masked_message }
+    
+    it_should_behave_like 'all drafts'
+    it_should_behave_like 'draft with masked messages'
+  end
+  
+  context 'for draft08' do
+    let(:handshake_request)  { spec08_handshake_request }
+    let(:handshake_response) { spec08_handshake_response }
+    let(:message)            { spec08_unmasked_message }
+    let(:masked_message)     { spec08_masked_message }
+    
+    it_should_behave_like 'all drafts'
+    it_should_behave_like 'draft with masked messages'
+  end
 end

data/spec/support/masked_messages.rb

@@ -0,0 +1,9 @@
+shared_examples_for 'draft with masked messages' do
+  it "should call 'on_message' on connection sending masked data with proper env and message" do
+    TestApp.any_instance.expects(:on_message).once.with { |env, message| env.class == Hash && !env.keys.empty? && message == 'Hello' }
+    conn = new_server_connection
+    conn.write(handshake_request)
+    conn.read(handshake_response.length)
+    conn.write(masked_message)
+  end
+end

data/spec/support/requests.rb

@@ -8,7 +8,7 @@ end
 
 def spec75_handshake_request
   <<-EOF
-GET / HTTP/1.1\r
+GET /demo HTTP/1.1\r
 Upgrade: WebSocket\r
 Connection: Upgrade\r
 Host: localhost:#{TEST_PORT}\r
@@ -23,26 +23,27 @@ HTTP/1.1 101 Web Socket Protocol Handshake\r
 Upgrade: WebSocket\r
 Connection: Upgrade\r
 WebSocket-Origin: http://localhost:#{TEST_PORT}\r
-WebSocket-Location: ws://localhost:#{TEST_PORT}/\r
+WebSocket-Location: ws://localhost:#{TEST_PORT}/demo\r
 \r
 EOF
 end
 
 def spec75_message
-  "\x00some message\xff"
+  "\x00Hello\xff"
 end
 
 def spec76_handshake_request
   request = <<-EOF
-GET / HTTP/1.1\r
-Upgrade: WebSocket\r
-Connection: Upgrade\r
+GET /demo HTTP/1.1\r
 Host: localhost:#{TEST_PORT}\r
+Connection: Upgrade\r
+Sec-WebSocket-Key2: 12998 5 Y3 1  .P00\r
+Sec-WebSocket-Protocol: sample\r
+Upgrade: WebSocket\r
+Sec-WebSocket-Key1: 4 @1  46546xW%0l 1 5\r
 Origin: http://localhost:#{TEST_PORT}\r
-Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8\r
-Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0\r
 \r
-Tm[K T2u
+^n:ds[4U
 EOF
   request.rstrip
 end
@@ -52,31 +53,32 @@ def spec76_handshake_response
 HTTP/1.1 101 WebSocket Protocol Handshake\r
 Upgrade: WebSocket\r
 Connection: Upgrade\r
-Sec-WebSocket-Location: ws://localhost:#{TEST_PORT}/\r
+Sec-WebSocket-Location: ws://localhost:#{TEST_PORT}/demo\r
 Sec-WebSocket-Origin: http://localhost:#{TEST_PORT}\r
+Sec-WebSocket-Protocol: sample\r
 \r
-fQJ,fN/4F4!~K~MH
+8jKS'y:G*Co,Wxa-
 EOF
   response.rstrip
 end
 
 def spec76_message
-  "\x00some message\xff"
+  "\x00Hello\xff"
 end
 
 def spec03_handshake_request
   request = <<-EOF
-GET / HTTP/1.1\r
-Upgrade: WebSocket\r
-Connection: Upgrade\r
+GET /demo HTTP/1.1\r
 Host: localhost:#{TEST_PORT}\r
-Origin: http://localhost:#{TEST_PORT}\r
-Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8\r
-Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0\r
+Connection: Upgrade\r
+Sec-WebSocket-Key2: 12998 5 Y3 1  .P00\r
 Sec-WebSocket-Protocol: sample\r
+Upgrade: WebSocket\r
+Sec-WebSocket-Key1: 4 @1  46546xW%0l 1 5\r
+Origin: http://localhost:#{TEST_PORT}\r
 Sec-WebSocket-Draft: 3\r
 \r
-Tm[K T2u
+^n:ds[4U
 EOF
   request.rstrip
 end
@@ -86,15 +88,131 @@ def spec03_handshake_response
 HTTP/1.1 101 WebSocket Protocol Handshake\r
 Upgrade: WebSocket\r
 Connection: Upgrade\r
-Sec-WebSocket-Location: ws://localhost:#{TEST_PORT}/\r
+Sec-WebSocket-Location: ws://localhost:#{TEST_PORT}/demo\r
 Sec-WebSocket-Origin: http://localhost:#{TEST_PORT}\r
 Sec-WebSocket-Protocol: sample\r
 \r
-fQJ,fN/4F4!~K~MH
+8jKS'y:G*Co,Wxa-
 EOF
   response.rstrip
 end
 
 def spec03_message
-  "\x04\x0Csome message"
+  "\x04\x05Hello"
+end
+
+def spec05_handshake_request
+  <<-EOF
+GET /chat HTTP/1.1\r
+Host: localhost:#{TEST_PORT}\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r
+Sec-WebSocket-Origin: http://localhost:#{TEST_PORT}\r
+Sec-WebSocket-Protocol: chat, superchat\r
+Sec-WebSocket-Version: 5\r
+\r
+EOF
+end
+
+def spec05_handshake_response
+  <<-EOF
+HTTP/1.1 101 Switching Protocols\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r
+EOF
+end
+
+def spec05_message
+  "\x00\x00\x01\x00\x84\x05Ielln"
+end
+
+def spec06_handshake_request
+  <<-EOF
+GET /chat HTTP/1.1\r
+Host: localhost:#{TEST_PORT}\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r
+Sec-WebSocket-Origin: http://localhost:#{TEST_PORT}\r
+Sec-WebSocket-Protocol: chat, superchat\r
+Sec-WebSocket-Version: 6\r
+\r
+EOF
+end
+
+def spec06_handshake_response
+  <<-EOF
+HTTP/1.1 101 Switching Protocols\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r
+EOF
+end
+
+def spec06_message
+  "\x00\x00\x01\x00\x84\x05Ielln"
+end
+
+def spec07_handshake_request
+  <<-EOF
+GET /chat HTTP/1.1\r
+Host: localhost:#{TEST_PORT}\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r
+Sec-WebSocket-Origin: http://localhost:#{TEST_PORT}\r
+Sec-WebSocket-Protocol: chat, superchat\r
+Sec-WebSocket-Version: 7\r
+\r
+EOF
+end
+
+def spec07_handshake_response
+  <<-EOF
+HTTP/1.1 101 Switching Protocols\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r
+EOF
+end
+
+def spec07_unmasked_message
+  "\x81\x05\x48\x65\x6c\x6c\x6f"
+end
+
+def spec07_masked_message
+  "\x81\x85\x37\xfa\x21\x3d\x7f\x9f\x4d\x51\x58"
+end
+
+def spec08_handshake_request
+  <<-EOF
+GET /chat HTTP/1.1\r
+Host: localhost:#{TEST_PORT}\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r
+Sec-WebSocket-Origin: http://localhost:#{TEST_PORT}\r
+Sec-WebSocket-Protocol: chat, superchat\r
+Sec-WebSocket-Version: 8\r
+\r
+EOF
+end
+
+def spec08_handshake_response
+  <<-EOF
+HTTP/1.1 101 Switching Protocols\r
+Upgrade: websocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r
+EOF
+end
+
+def spec08_unmasked_message
+  "\x81\x05\x48\x65\x6c\x6c\x6f"
+end
+
+def spec08_masked_message
+  "\x81\x85\x37\xfa\x21\x3d\x7f\x9f\x4d\x51\x58"
 end

data/spec/thin_spec.rb

@@ -29,6 +29,7 @@ end
 def stop_thin_server
   sleep 0.1
   @server.stop!
+  sleep 0.1
   @thread.kill
   sleep 0.1
   raise "Reactor still running, wtf?" if EventMachine.reactor_running?

data/websocket-rack.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.description = %q{Rack-based WebSocket server}
 
   s.add_dependency 'rack'
-  s.add_dependency 'em-websocket', '~> 0.3.0'
+  s.add_dependency 'em-websocket', '~> 0.3.1'
   s.add_dependency 'thin' # Temporary until we support more servers
   s.add_development_dependency 'rspec', '~> 2.4.0'
   s.add_development_dependency 'mocha'

metadata

@@ -1,84 +1,82 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: websocket-rack
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.1
   prerelease: 
-  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Bernard Potocki
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-10 00:00:00 +02:00
+date: 2011-07-29 00:00:00.000000000 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70160187655260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: em-websocket
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70160187655260
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: &70160187654640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.3.0
+      - !ruby/object:Gem::Version
+        version: 0.3.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: thin
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70160187654640
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &70160187653460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70160187653460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70160187650680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70160187650680
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70160187649040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *70160187649040
 description: Rack-based WebSocket server
-email: 
+email:
 - bernard.potocki@imanel.org
-executables: 
+executables:
 - thin-websocket
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -105,40 +103,39 @@ files:
 - spec/spec_helper.rb
 - spec/support/all_drafts.rb
 - spec/support/all_handlers.rb
+- spec/support/masked_messages.rb
 - spec/support/requests.rb
 - spec/thin_spec.rb
 - websocket-rack.gemspec
 has_rdoc: true
 homepage: http://github.com/imanel/websocket-rack
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Rack-based WebSocket server
-test_files: 
+test_files:
 - spec/spec_helper.rb
 - spec/support/all_drafts.rb
 - spec/support/all_handlers.rb
+- spec/support/masked_messages.rb
 - spec/support/requests.rb
 - spec/thin_spec.rb