em-websocket 0.1.4 → 0.2.0

data/spec/integration/draft03_spec.rb

@@ -0,0 +1,252 @@
+require 'spec/helper'
+
+describe "draft03" do
+  before :each do
+    @request = {
+      :port => 80,
+      :method => "GET",
+      :path => "/demo",
+      :headers => {
+        'Host' => 'example.com',
+        'Connection' => 'Upgrade',
+        'Sec-WebSocket-Key2' => '12998 5 Y3 1  .P00',
+        'Sec-WebSocket-Protocol' => 'sample',
+        'Upgrade' => 'WebSocket',
+        'Sec-WebSocket-Key1' => '4 @1  46546xW%0l 1 5',
+        'Origin' => 'http://example.com',
+        'Sec-WebSocket-Draft' => '3'
+      },
+      :body => '^n:ds[4U'
+    }
+
+    @response = {
+      :headers => {
+        "Upgrade" => "WebSocket",
+        "Connection" => "Upgrade",
+        "Sec-WebSocket-Location" => "ws://example.com/demo",
+        "Sec-WebSocket-Origin" => "http://example.com",
+        "Sec-WebSocket-Protocol" => "sample"
+      },
+      :body => "8jKS\'y:G*Co,Wxa-"
+    }
+  end
+
+  # These examples are straight from the spec
+  # http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-03#section-4.6
+  describe "examples from the spec" do
+    it "should accept a single-frame text message" do
+      EM.run do
+        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+          ws.onmessage { |msg|
+            msg.should == 'Hello'
+            EM.stop
+          }
+        }
+
+        # Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        connection.send_data(format_request(@request))
+
+        # Send frame
+        connection.onopen = lambda {
+          connection.send_data("\x04\x05Hello")
+        }
+      end
+    end
+    
+    it "should accept a fragmented text message" do
+      EM.run do
+        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+          ws.onmessage { |msg|
+            msg.should == 'Hello'
+            EM.stop
+          }
+        }
+
+        # Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        connection.send_data(format_request(@request))
+
+        # Send frame
+        connection.onopen = lambda {
+          connection.send_data("\x84\x03Hel")
+          connection.send_data("\x00\x02lo")
+        }
+      end
+    end
+    
+    it "should accept a ping request and respond with the same body" do
+      EM.run do
+        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws| }
+
+        # Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        connection.send_data(format_request(@request))
+
+        # Send frame
+        connection.onopen = lambda {
+          connection.send_data("\x02\x05Hello")
+        }
+        
+        connection.onmessage = lambda { |frame|
+          next if frame.nil?
+          frame.should == "\x03\x05Hello"
+          EM.stop
+        }
+      end
+    end
+    
+    it "should accept a 256 bytes binary message in a single frame" do
+      EM.run do
+        data = "a" * 256
+        
+        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+          ws.onmessage { |msg|
+            msg.should == data
+            EM.stop
+          }
+        }
+
+        # Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        connection.send_data(format_request(@request))
+
+        # Send frame
+        connection.onopen = lambda {
+          connection.send_data("\x05\x7E\x01\x00" + data)
+        }
+      end
+    end
+    
+    it "should accept a 64KiB binary message in a single frame" do
+      EM.run do
+        data = "a" * 65536
+        
+        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+          ws.onmessage { |msg|
+            msg.should == data
+            EM.stop
+          }
+        }
+
+        # Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        connection.send_data(format_request(@request))
+
+        # Send frame
+        connection.onopen = lambda {
+          connection.send_data("\x05\x7F\x00\x00\x00\x00\x00\x01\x00\x00" + data)
+        }
+      end
+    end
+  end
+
+  describe "close handling" do
+    it "should respond to a new close frame with a close frame" do
+      EM.run do
+        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws| }
+
+        # Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        connection.send_data(format_request(@request))
+
+        # Send close frame
+        connection.onopen = lambda {
+          connection.send_data("\x01\x00")
+        }
+
+        # Check that close ack received
+        connection.onmessage = lambda { |frame|
+          frame.should == "\x01\x00"
+          EM.stop
+        }
+      end
+    end
+
+    it "should close the connection on receiving a close acknowlegement" do
+      EM.run do
+        ack_received = false
+
+        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+          ws.onopen {
+            # 2. Send a close frame
+            EM.next_tick {
+              ws.close_websocket
+            }
+          }
+        }
+
+        # 1. Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        connection.send_data(format_request(@request))
+
+        # 3. Check that close frame recieved and acknowlege it
+        connection.onmessage = lambda { |frame|
+          frame.should == "\x01\x00"
+          ack_received = true
+          connection.send_data("\x01\x00")
+        }
+
+        # 4. Check that connection is closed _after_ the ack
+        connection.onclose = lambda {
+          ack_received.should == true
+          EM.stop
+        }
+      end
+    end
+
+    it "should not allow data fraome to be sent after close frame sent" do
+      EM.run {
+        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+          ws.onopen {
+            # 2. Send a close frame
+            EM.next_tick {
+              ws.close_websocket
+            }
+
+            # 3. Check that exception raised if I attempt to send more data
+            EM.add_timer(0.1) {
+              lambda {
+                ws.send('hello world')
+              }.should raise_error(EM::WebSocket::WebSocketError, 'Cannot send data frame since connection is closing')
+              EM.stop
+            }
+          }
+        }
+
+        # 1. Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        connection.send_data(format_request(@request))
+      }
+    end
+
+    it "should still respond to control frames after close frame sent" do
+      EM.run {
+        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+          ws.onopen {
+            # 2. Send a close frame
+            EM.next_tick {
+              ws.close_websocket
+            }
+          }
+        }
+
+        # 1. Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        connection.send_data(format_request(@request))
+
+        connection.onmessage = lambda { |frame|
+          if frame == "\x01\x00"
+            # 3. After the close frame is received send a ping frame, but
+            # don't respond with a close ack
+            connection.send_data("\x02\x05Hello")
+          else
+            # 4. Check that the pong is received
+            frame.should == "\x03\x05Hello"
+            EM.stop
+          end
+        }
+      }
+    end
+  end
+end

data/spec/integration/{integration_spec.rb → draft76_spec.rb}

@@ -161,7 +161,32 @@ describe "WebSocket server draft76" do
       }
       
       client = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
-      client.send_data("This is not a HTTP header")
+      client.send_data("This is not a HTTP header\r\n\r\n")
     }
   end
+
+  it "should handle handshake request split into two TCP packets" do
+    EM.run do
+      EM.add_timer(0.1) do
+        EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { }
+
+        # Create a fake client which sends draft 76 handshake
+        connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
+        data = format_request(@request)
+        # Sends first half of the request
+        connection.send_data(data[0...(data.length / 2)])
+
+        connection.onopen = lambda {
+          connection.handshake_response.lines.sort.
+            should == format_response(@response).lines.sort
+          EM.stop
+        }
+
+        EM.add_timer(0.1) do
+          # Sends second half of the request
+          connection.send_data(data[(data.length / 2)..-1])
+        end
+      end
+    end
+  end
 end

data/spec/unit/framing_spec.rb

@@ -0,0 +1,108 @@
+require 'spec/helper'
+
+describe EM::WebSocket::Framing03 do
+  class FramingContainer
+    include EM::WebSocket::Framing03
+    
+    def <<(data)
+      @data << data
+      process_data
+    end
+    
+    def debug(*args); end
+  end
+  
+  before :each do
+    @f = FramingContainer.new
+    @f.initialize_framing
+  end
+  
+  describe "basic examples" do
+    it "connection close" do
+      @f.should_receive(:message).with(:close, '', '')
+      @f << 0b00000001
+      @f << 0b00000000
+    end
+    
+    it "ping" do
+      @f.should_receive(:message).with(:ping, '', '')
+      @f << 0b00000010
+      @f << 0b00000000
+    end
+    
+    it "pong" do
+      @f.should_receive(:message).with(:pong, '', '')
+      @f << 0b00000011
+      @f << 0b00000000
+    end
+    
+    it "text" do
+      @f.should_receive(:message).with(:text, '', 'foo')
+      @f << 0b00000100
+      @f << 0b00000011
+      @f << 'foo'
+    end
+    
+    it "Text in two frames" do
+      @f.should_receive(:message).with(:text, '', 'hello world')
+      @f << 0b10000100
+      @f << 0b00000110
+      @f << "hello "
+      @f << 0b00000000
+      @f << 0b00000101
+      @f << "world"
+    end
+    
+    it "2 byte extended payload length text frame" do
+      data = 'a' * 256
+      @f.should_receive(:message).with(:text, '', data)
+      @f << 0b00000100 # Single frame, text
+      @f << 0b01111110 # Length 126 (so read 2 bytes)
+      @f << 0b00000001 # Two bytes in network byte order (256)
+      @f << 0b00000000
+      @f << data
+    end
+  end
+  
+  # These examples are straight from the spec
+  # http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-03#section-4.6
+  describe "examples from the spec" do
+    it "a single-frame text message" do
+      @f.should_receive(:message).with(:text, '', 'Hello')
+      @f << "\x04\x05Hello"
+    end
+    
+    it "a fragmented text message" do
+      @f.should_receive(:message).with(:text, '', 'Hello')
+      @f << "\x84\x03Hel"
+      @f << "\x00\x02lo"
+    end
+    
+    it "Ping request and response" do
+      @f.should_receive(:message).with(:ping, '', 'Hello')
+      @f << "\x02\x05Hello"
+    end
+    
+    it "256 bytes binary message in a single frame" do
+      data = "a"*256
+      @f.should_receive(:message).with(:binary, '', data)
+      @f << "\x05\x7E\x01\x00" + data
+    end
+    
+    it "64KiB binary message in a single frame" do
+      data = "a"*65536
+      @f.should_receive(:message).with(:binary, '', data)
+      @f << "\x05\x7F\x00\x00\x00\x00\x00\x01\x00\x00" + data
+    end
+  end
+
+  describe "error cases" do
+    it "should raise an exception on continuation frame without preceeding more frame" do
+      lambda {
+        @f << 0b00000000 # Single frame, continuation
+        @f << 0b00000001 # Length 1
+        @f << 'f'
+      }.should raise_error(EM::WebSocket::WebSocketError, 'Continuation frame not expected')
+    end
+  end
+end

data/spec/unit/handler_spec.rb

@@ -124,4 +124,16 @@ describe "EventMachine::WebSocket::Handler" do
       }.should raise_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 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
+
+  it "should leave request with incomplete third key" do
+    data = 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
+  end
 end

data/spec/websocket_spec.rb

@@ -190,4 +190,19 @@ describe EventMachine::WebSocket do
     end
   end
 
-end
+  it "should raise an exception if frame sent before handshake complete" do
+    EM.run {
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |c|
+        # We're not using a real client so the handshake will not be sent
+        EM.add_timer(0.1) {
+          lambda {
+            c.send('early message')
+          }.should raise_error('Cannot send data before onopen callback')
+          EM.stop
+        }
+      }
+
+      client = EM.connect('0.0.0.0', 12345, EM::Connection)
+    }
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ilya Grigorik
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-23 00:00:00 -04:00
+date: 2010-11-23 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,7 @@ dependencies:
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
@@ -59,20 +59,47 @@ dependencies:
         version: 0.2.6
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: EventMachine based WebSocket server
-email: ilya@igvita.com
+email: 
+- ilya@igvita.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .gitignore
 - CHANGELOG.rdoc
-- README.rdoc
+- Gemfile
+- README.md
 - Rakefile
-- VERSION
 - em-websocket.gemspec
 - examples/echo.rb
 - examples/js/FABridge.js
@@ -84,13 +111,21 @@ files:
 - lib/em-websocket.rb
 - lib/em-websocket/connection.rb
 - lib/em-websocket/debugger.rb
+- lib/em-websocket/framing03.rb
+- lib/em-websocket/framing76.rb
 - lib/em-websocket/handler.rb
+- lib/em-websocket/handler03.rb
 - lib/em-websocket/handler75.rb
 - lib/em-websocket/handler76.rb
 - lib/em-websocket/handler_factory.rb
+- lib/em-websocket/handshake75.rb
+- lib/em-websocket/handshake76.rb
+- lib/em-websocket/version.rb
 - lib/em-websocket/websocket.rb
 - spec/helper.rb
-- spec/integration/integration_spec.rb
+- spec/integration/draft03_spec.rb
+- spec/integration/draft76_spec.rb
+- spec/unit/framing_spec.rb
 - spec/unit/handler_spec.rb
 - spec/websocket_spec.rb
 has_rdoc: true
@@ -98,8 +133,8 @@ homepage: http://github.com/igrigorik/em-websocket
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -125,9 +160,8 @@ specification_version: 3
 summary: EventMachine based WebSocket server
 test_files: 
 - spec/helper.rb
-- spec/integration/integration_spec.rb
+- spec/integration/draft03_spec.rb
+- spec/integration/draft76_spec.rb
+- spec/unit/framing_spec.rb
 - spec/unit/handler_spec.rb
 - spec/websocket_spec.rb
-- examples/echo.rb
-- examples/multicast.rb
-- examples/srv.rb