em-websocket 0.3.8 → 0.4.0

data/spec/integration/draft03_spec.rb

@@ -36,6 +36,8 @@ describe "draft03" do
   end
 
   it_behaves_like "a websocket server" do
+    let(:version) { 3 }
+
     def start_server
       EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
         yield ws

data/spec/integration/draft13_spec.rb

@@ -32,6 +32,8 @@ describe "draft13" do
   end
 
   it_behaves_like "a websocket server" do
+    let(:version) { 13 }
+
     def start_server
       EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
         yield ws

data/spec/integration/draft75_spec.rb

@@ -10,6 +10,8 @@ describe "WebSocket server draft75" do
   default_timeout 1
 
   it_behaves_like "a websocket server" do
+    let(:version) { 75 }
+
     def start_server
       EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
         yield ws
@@ -108,7 +110,7 @@ describe "WebSocket server draft75" do
         ws.onclose { EventMachine.stop }
         ws.onerror {|e|
           e.should be_an_instance_of EventMachine::WebSocket::HandshakeError
-          e.message.should match('Connection and Upgrade headers required')
+          e.message.should match('Not an upgrade request')
           EventMachine.stop
         }
       end

data/spec/integration/draft76_spec.rb

@@ -35,6 +35,8 @@ describe "WebSocket server draft76" do
   end
   
   it_behaves_like "a websocket server" do
+    let(:version) { 76 }
+
     def start_server
       EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
         yield ws
@@ -185,7 +187,7 @@ describe "WebSocket server draft76" do
       EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |server|
         server.onerror { |error|
           error.should be_an_instance_of EM::WebSocket::HandshakeError
-          error.message.should == "Invalid HTTP header"
+          error.message.should == "Invalid HTTP header: Could not parse data entirely"
           done
         }
       }

data/spec/integration/shared_examples.rb

@@ -3,6 +3,32 @@
 # These tests are run against all draft versions
 #
 shared_examples_for "a websocket server" do
+  it "should expose the protocol version" do
+    em {
+      start_server { |ws|
+        ws.onopen { |handshake|
+          handshake.protocol_version.should == version
+          done
+        }
+      }
+
+      start_client
+    }
+  end
+
+  it "should expose the origin header" do
+    em {
+      start_server { |ws|
+        ws.onopen { |handshake|
+          handshake.origin.should == 'http://example.com'
+          done
+        }
+      }
+
+      start_client
+    }
+  end
+
   it "should call onerror if an application error raised in onopen" do
     em {
       start_server { |ws|

data/spec/unit/{handler_spec.rb → handshake_spec.rb}

@@ -1,11 +1,12 @@
 require 'helper'
 
-describe "EventMachine::WebSocket::Handler" do
-  def handler(request, secure = false)
-    connection = Object.new
-    EM::WebSocket::HandlerFactory.build(connection, format_request(request), secure)
+describe EM::WebSocket::Handshake do
+  def handshake(request, secure = false)
+    handshake = EM::WebSocket::Handshake.new(secure)
+    handshake.receive_data(format_request(request))
+    handshake
   end
-
+  
   before :each do
     @request = {
       :port => 80,
@@ -36,47 +37,51 @@ describe "EventMachine::WebSocket::Handler" do
     }
     @secure_response = @response.merge(:headers => @response[:headers].merge('Sec-WebSocket-Location' => "wss://example.com/demo"))
   end
-
+  
   it "should handle good request" do
-    handler(@request).should send_handshake(@response)
+    handshake(@request).should succeed_with_upgrade(@response)
   end
-
+  
   it "should handle good request to secure default port if secure mode is enabled" do
-    handler(@secure_request, true).should send_handshake(@secure_response)
+    handshake(@secure_request, true).
+      should succeed_with_upgrade(@secure_response)
   end
-
+  
   it "should not handle good request to secure default port if secure mode is disabled" do
-    handler(@secure_request, false).should_not send_handshake(@secure_response)
+    handshake(@secure_request, false).
+      should_not succeed_with_upgrade(@secure_response)
   end
-
+  
   it "should handle good request on nondefault port" do
     @request[:port] = 8081
     @request[:headers]['Host'] = 'example.com:8081'
     @response[:headers]['Sec-WebSocket-Location'] =
       'ws://example.com:8081/demo'
 
-    handler(@request).should send_handshake(@response)
+    handshake(@request).should succeed_with_upgrade(@response)
   end
-
+  
   it "should handle good request to secure nondefault port" do
     @secure_request[:port] = 8081
     @secure_request[:headers]['Host'] = 'example.com:8081'
     @secure_response[:headers]['Sec-WebSocket-Location'] = 'wss://example.com:8081/demo'
-    handler(@secure_request, true).should send_handshake(@secure_response)
+    
+    handshake(@secure_request, true).
+      should succeed_with_upgrade(@secure_response)
   end
-
+  
   it "should handle good request with no protocol" do
     @request[:headers].delete('Sec-WebSocket-Protocol')
     @response[:headers].delete("Sec-WebSocket-Protocol")
 
-    handler(@request).should send_handshake(@response)
+    handshake(@request).should succeed_with_upgrade(@response)
   end
-
+  
   it "should handle extra headers by simply ignoring them" do
     @request[:headers]['EmptyValue'] = ""
     @request[:headers]['AKey'] = "AValue"
 
-    handler(@request).should send_handshake(@response)
+    handshake(@request).should succeed_with_upgrade(@response)
   end
   
   it "should raise error on HTTP request" do
@@ -91,69 +96,98 @@ describe "EventMachine::WebSocket::Handler" do
       'Connection' => 'keep-alive',
     }
     
-    lambda {
-      handler(@request).handshake
-    }.should raise_error(EM::WebSocket::HandshakeError)
+    handshake(@request).should fail_with_error(EM::WebSocket::HandshakeError)
   end
-
+  
   it "should raise error on wrong method" do
     @request[:method] = 'POST'
 
-    lambda {
-      handler(@request).handshake
-    }.should raise_error(EM::WebSocket::HandshakeError)
+    handshake(@request).should fail_with_error(EM::WebSocket::HandshakeError)
   end
-
+  
   it "should raise error if upgrade header incorrect" do
     @request[:headers]['Upgrade'] = 'NonWebSocket'
 
-    lambda {
-      handler(@request).handshake
-    }.should raise_error(EM::WebSocket::HandshakeError)
+    handshake(@request).should fail_with_error(EM::WebSocket::HandshakeError)
   end
-
+  
   it "should raise error if Sec-WebSocket-Protocol is empty" do
     @request[:headers]['Sec-WebSocket-Protocol'] = ''
 
-    lambda {
-      handler(@request).handshake
-    }.should raise_error(EM::WebSocket::HandshakeError)
+    handshake(@request).should fail_with_error(EM::WebSocket::HandshakeError)
   end
-
+  
   %w[Sec-WebSocket-Key1 Sec-WebSocket-Key2].each do |header|
     it "should raise error if #{header} has zero spaces" do
       @request[:headers][header] = 'nospaces'
 
-      lambda {
-        handler(@request).handshake
-      }.should raise_error(EM::WebSocket::HandshakeError, 'Websocket Key1 or Key2 does not contain spaces - this is a symptom of a cross-protocol attack')
+      handshake(@request).
+        should fail_with_error(EM::WebSocket::HandshakeError, 'Websocket Key1 or Key2 does not contain spaces - this is a symptom of a cross-protocol attack')
     end
   end
-
+  
   it "should raise error if spaces do not divide numbers in Sec-WebSocket-Key* " do
     @request[:headers]['Sec-WebSocket-Key2'] = '12998 5 Y3 1.P00'
 
-    lambda {
-      handler(@request).handshake
-    }.should raise_error(EM::WebSocket::HandshakeError, 'Invalid Key "12998 5 Y3 1.P00"')
+    handshake(@request).
+      should fail_with_error(EM::WebSocket::HandshakeError, 'Invalid Key "12998 5 Y3 1.P00"')
   end
-
+  
   it "should raise error if the HTTP header is empty" do
-    connection = Object.new
-    lambda {
-      EM::WebSocket::HandlerFactory.build(connection, "\r\n\r\nfoobar", false)
-    }.should raise_error(EM::WebSocket::HandshakeError, "Empty HTTP header")
+    handshake = EM::WebSocket::Handshake.new(false)
+    handshake.receive_data("\r\n\r\nfoobar")
+    
+    handshake.
+      should fail_with_error(EM::WebSocket::HandshakeError, 'Invalid HTTP header: Could not parse data entirely')
   end
 
-  it "should leave request with incomplete header" do
-    data = format_request(@request)
-    # Sends only half of the request
-    EM::WebSocket::HandlerFactory.build(mock(EM::WebSocket::Connection), data[0...(data.length / 2)]).should == nil
-  end
+  # This might seems crazy, but very occasionally we saw multiple "Upgrade:
+  # WebSocket" headers in the wild. RFC 4.2.1 isn't particularly clear on this
+  # point, so for now I have decided not to accept --@mloughran
+  it "should raise error on multiple upgrade headers" do
+    handshake = EM::WebSocket::Handshake.new(false)
+
+    # Add a duplicate upgrade header
+    headers = format_request(@request)
+    upgrade_header = "Upgrade: WebSocket\r\n"
+    headers.gsub!(upgrade_header, "#{upgrade_header}#{upgrade_header}")
+
+    handshake.receive_data(headers)
 
-  it "should leave request with incomplete third key" do
-    data = format_request(@request)
+    handshake.errback { |e|
+      e.class.should == EM::WebSocket::HandshakeError
+      e.message.should == 'Invalid upgrade header: ["WebSocket", "WebSocket"]'
+    }
+  end
+  
+  it "should cope with requests where the header is split" do
+    request = format_request(@request)
+    incomplete_request = request[0...(request.length / 2)]
+    rest = request[(request.length / 2)..-1]
+    handshake = EM::WebSocket::Handshake.new(false)
+    handshake.receive_data(incomplete_request)
+    
+    handshake.instance_variable_get(:@deferred_status).should == nil
+    
+    # Send the remaining header
+    handshake.receive_data(rest)
+    
+    handshake(@request).should succeed_with_upgrade(@response)
+  end
+  
+  it "should cope with requests where the third key is split" do
+    request = format_request(@request)
     # Removes last two bytes of the third key
-    EM::WebSocket::HandlerFactory.build(mock(EM::WebSocket::Connection), data[0...(data.length - 2)]).should == nil
+    incomplete_request = request[0..-3]
+    rest = request[-2..-1]
+    handshake = EM::WebSocket::Handshake.new(false)
+    handshake.receive_data(incomplete_request)
+    
+    handshake.instance_variable_get(:@deferred_status).should == nil
+    
+    # Send the remaining third key
+    handshake.receive_data(rest)
+    
+    handshake(@request).should succeed_with_upgrade(@response)
   end
 end

metadata

@@ -1,144 +1,137 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: em-websocket
-version: !ruby/object:Gem::Version 
-  hash: 3
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 8
-  version: 0.3.8
 platform: ruby
-authors: 
+authors:
 - Ilya Grigorik
 - Martyn Loughran
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: eventmachine
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 61
-        segments: 
-        - 0
-        - 12
-        - 9
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.12.9
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: addressable
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.9
+- !ruby/object:Gem::Dependency
+  name: http_parser.rb
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 1
-        - 1
-        version: 2.1.1
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: em-spec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 2
-        - 6
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: em-spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 0.2.6
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: eventmachine
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 12
-        - 10
-        version: 0.12.10
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: em-http-request
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 2
-        - 6
+      - !ruby/object:Gem::Version
         version: 0.2.6
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 2
-        - 8
-        - 0
-        version: 2.8.0
+      - !ruby/object:Gem::Version
+        version: 2.12.0
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: EventMachine based WebSocket server
-email: 
+email:
 - ilya@igvita.com
 - me@mloughran.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG.rdoc
 - Gemfile
@@ -146,11 +139,6 @@ files:
 - Rakefile
 - em-websocket.gemspec
 - examples/echo.rb
-- examples/flash_policy_file_server.rb
-- examples/js/FABridge.js
-- examples/js/WebSocketMain.swf
-- examples/js/swfobject.js
-- examples/js/web_socket.js
 - examples/multicast.rb
 - examples/ping.rb
 - examples/test.html
@@ -175,7 +163,7 @@ files:
 - lib/em-websocket/handler13.rb
 - lib/em-websocket/handler75.rb
 - lib/em-websocket/handler76.rb
-- lib/em-websocket/handler_factory.rb
+- lib/em-websocket/handshake.rb
 - lib/em-websocket/handshake04.rb
 - lib/em-websocket/handshake75.rb
 - lib/em-websocket/handshake76.rb
@@ -194,42 +182,39 @@ files:
 - spec/integration/draft76_spec.rb
 - spec/integration/shared_examples.rb
 - spec/unit/framing_spec.rb
-- spec/unit/handler_spec.rb
+- spec/unit/handshake_spec.rb
 - spec/unit/masking_spec.rb
 homepage: http://github.com/igrigorik/em-websocket
 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 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 3969961455966824026
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 3969961455966824026
 requirements: []
-
 rubyforge_project: em-websocket
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: EventMachine based WebSocket server
-test_files: 
+test_files:
 - spec/helper.rb
 - spec/integration/common_spec.rb
 - spec/integration/draft03_spec.rb
@@ -240,5 +225,5 @@ test_files:
 - spec/integration/draft76_spec.rb
 - spec/integration/shared_examples.rb
 - spec/unit/framing_spec.rb
-- spec/unit/handler_spec.rb
+- spec/unit/handshake_spec.rb
 - spec/unit/masking_spec.rb