em-websocket 0.4.0 → 0.5.0

data/lib/em-websocket/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   module Websocket
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/em-websocket/websocket.rb

@@ -17,6 +17,10 @@ module EventMachine
       def code; 1002; end
     end
 
+    class InvalidDataError < WSProtocolError
+      def code; 1007; end
+    end
+
     # 1009: Message too big to process
     class WSMessageTooBigError < WSProtocolError
       def code; 1009; end

data/spec/helper.rb

@@ -1,7 +1,8 @@
+# encoding: BINARY
+
 require 'rubygems'
 require 'rspec'
 require 'em-spec/rspec'
-require 'pp'
 require 'em-http'
 
 require 'em-websocket'
@@ -27,74 +28,79 @@ class FakeWebSocketClient < EM::Connection
     # puts "RECEIVE DATA #{data}"
     if @state == :new
       @handshake_response = data
-      @onopen.call if @onopen
+      @onopen.call if defined? @onopen
       @state = :open
     else
-      @onmessage.call(data) if @onmessage
+      @onmessage.call(data) if defined? @onmessage
       @packets << data
     end
   end
 
-  def send(data)
-    send_data("\x00#{data}\xff")
+  def send(application_data)
+    send_frame(:text, application_data)
+  end
+
+  def send_frame(type, application_data)
+    send_data construct_frame(type, application_data)
   end
 
   def unbind
-    @onclose.call if @onclose
+    @onclose.call if defined? @onclose
+  end
+
+  private
+
+  def construct_frame(type, data)
+    "\x00#{data}\xff"
   end
 end
 
 class Draft03FakeWebSocketClient < FakeWebSocketClient
-  def send(application_data)
-    frame = ''
-    opcode = 4 # fake only supports text frames
-    byte1 = opcode # since more, rsv1-3 are 0
-    frame << byte1
+  private
+
+  def construct_frame(type, data)
+    frame = ""
+    frame << EM::WebSocket::Framing03::FRAME_TYPES[type]
+    frame << encoded_length(data.size)
+    frame << data
+  end
 
-    length = application_data.size
+  def encoded_length(length)
     if length <= 125
-      byte2 = length # since rsv4 is 0
-      frame << byte2
+      [length].pack('C') # since rsv4 is 0
     elsif length < 65536 # write 2 byte length
-      frame << 126
-      frame << [length].pack('n')
+      "\126#{[length].pack('n')}"
     else # write 8 byte length
-      frame << 127
-      frame << [length >> 32, length & 0xFFFFFFFF].pack("NN")
+      "\127#{[length >> 32, length & 0xFFFFFFFF].pack("NN")}"
     end
-
-    frame << application_data
-
-    send_data(frame)
   end
 end
 
-class Draft07FakeWebSocketClient < FakeWebSocketClient
-  def send(application_data)
-    frame = ''
-    opcode = 1 # fake only supports text frames
-    byte1 = opcode | 0b10000000 # since more, rsv1-3 are 0
-    frame << byte1
+class Draft05FakeWebSocketClient < Draft03FakeWebSocketClient
+  private
 
-    length = application_data.size
-    if length <= 125
-      byte2 = length # since rsv4 is 0
-      frame << byte2
-    elsif length < 65536 # write 2 byte length
-      frame << 126
-      frame << [length].pack('n')
-    else # write 8 byte length
-      frame << 127
-      frame << [length >> 32, length & 0xFFFFFFFF].pack("NN")
-    end
+  def construct_frame(type, data)
+    frame = ""
+    frame << "\x00\x00\x00\x00" # Mask with nothing for simplicity
+    frame << (EM::WebSocket::Framing05::FRAME_TYPES[type] | 0b10000000)
+    frame << encoded_length(data.size)
+    frame << data
+  end
+end
 
-    frame << application_data
+class Draft07FakeWebSocketClient < Draft05FakeWebSocketClient
+  private
 
-    send_data(frame)
+  def construct_frame(type, data)
+    frame = ""
+    frame << (EM::WebSocket::Framing07::FRAME_TYPES[type] | 0b10000000)
+    # Should probably mask the data, but I get away without bothering since
+    # the server doesn't enforce that incoming frames are masked
+    frame << encoded_length(data.size)
+    frame << data
   end
 end
 
-
 # Wrap EM:HttpRequest in a websocket like interface so that it can be used in the specs with the same interface as FakeWebSocketClient
 class Draft75WebSocketClient
   def onopen(&blk);     @onopen = blk;    end
@@ -107,10 +113,10 @@ class Draft75WebSocketClient
       :timeout => 0,
       :origin => 'http://example.com',
     })
-    @ws.errback { @onerror.call if @onerror }
-    @ws.callback { @onopen.call if @onopen }
-    @ws.stream { |msg| @onmessage.call(msg) if @onmessage }
-    @ws.disconnect { @onclose.call if @onclose }
+    @ws.errback { @onerror.call if defined? @onerror }
+    @ws.callback { @onopen.call if defined? @onopen }
+    @ws.stream { |msg| @onmessage.call(msg) if defined? @onmessage }
+    @ws.disconnect { @onclose.call if defined? @onclose }
   end
 
   def send(message)

data/spec/integration/common_spec.rb

@@ -6,6 +6,12 @@ describe "WebSocket server" do
   include EM::SpecHelper
   default_timeout 1
 
+  def start_server
+    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
+      yield ws if block_given?
+    }
+  end
+
   it "should fail on non WebSocket requests" do
     em {
       EM.add_timer(0.1) do
@@ -14,7 +20,7 @@ describe "WebSocket server" do
         http.callback { fail }
       end
 
-      EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) {}
+      start_server
     }
   end
 
@@ -30,7 +36,7 @@ describe "WebSocket server" do
         http.stream { |msg| }
       end
 
-      EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+      start_server do |ws|
         ws.onopen { |handshake|
           headers = handshake.headers
           headers["User-Agent"].should == "EventMachine HttpClient"
@@ -64,7 +70,7 @@ describe "WebSocket server" do
         http.stream { |msg| }
       end
 
-      EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+      start_server do |ws|
         ws.onopen { |handshake|
           handshake.path.should == '/hello'
           handshake.query_string.split('&').sort.
@@ -82,7 +88,7 @@ describe "WebSocket server" do
   it "should raise an exception if frame sent before handshake complete" do
     em {
       # 1. Start WebSocket server
-      EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+      start_server { |ws|
         # 3. Try to send a message to the socket
         lambda {
           ws.send('early message')
@@ -107,7 +113,7 @@ describe "WebSocket server" do
         http.stream { |msg| }
       end
 
-      EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) do |ws|
+      start_server do |ws|
         ws.onopen { |handshake|
           handshake.headers["User-Agent"].should == "EventMachine HttpClient"
         }

data/spec/integration/draft03_spec.rb

@@ -35,20 +35,21 @@ describe "draft03" do
     }
   end
 
-  it_behaves_like "a websocket server" do
-    let(:version) { 3 }
+  def start_server
+    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
+      yield ws if block_given?
+    }
+  end
 
-    def start_server
-      EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
-        yield ws
-      }
-    end
+  def start_client
+    client = EM.connect('0.0.0.0', 12345, Draft03FakeWebSocketClient)
+    client.send_data(format_request(@request))
+    yield client if block_given?
+    return client
+  end
 
-    def start_client
-      client = EM.connect('0.0.0.0', 12345, Draft03FakeWebSocketClient)
-      client.send_data(format_request(@request))
-      yield client if block_given?
-    end
+  it_behaves_like "a websocket server" do
+    let(:version) { 3 }
   end
 
   # These examples are straight from the spec
@@ -56,36 +57,30 @@ describe "draft03" do
   describe "examples from the spec" do
     it "should accept a single-frame text message" do
       em {
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+        start_server { |ws|
           ws.onmessage { |msg|
             msg.should == 'Hello'
             done
           }
         }
-
-        # 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 {
-          connection.send_data("\x04\x05Hello")
+        start_client { |client|
+          client.onopen {
+            client.send_data("\x04\x05Hello")
+          }
         }
       }
     end
     
     it "should accept a fragmented text message" do
       em {
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+        start_server { |ws|
           ws.onmessage { |msg|
             msg.should == 'Hello'
             done
           }
         }
 
-        # 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 = start_client
 
         # Send frame
         connection.onopen {
@@ -97,11 +92,9 @@ describe "draft03" do
     
     it "should accept a ping request and respond with the same body" do
       em {
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws| }
+        start_server
 
-        # 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 = start_client
 
         # Send frame
         connection.onopen {
@@ -120,16 +113,14 @@ describe "draft03" do
       em {
         data = "a" * 256
         
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+        start_server { |ws|
           ws.onmessage { |msg|
             msg.should == data
             done
           }
         }
 
-        # 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 = start_client
 
         # Send frame
         connection.onopen {
@@ -142,16 +133,14 @@ describe "draft03" do
       em {
         data = "a" * 65536
         
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+        start_server { |ws|
           ws.onmessage { |msg|
             msg.should == data
             done
           }
         }
 
-        # 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 = start_client
 
         # Send frame
         connection.onopen {
@@ -164,11 +153,9 @@ describe "draft03" do
   describe "close handling" do
     it "should respond to a new close frame with a close frame" do
       em {
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws| }
+        start_server
 
-        # 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 = start_client
 
         # Send close frame
         connection.onopen {
@@ -183,22 +170,31 @@ describe "draft03" do
       }
     end
 
-    it "should close the connection on receiving a close acknowlegement" do
+    it "should close the connection on receiving a close acknowlegement and call onclose with close code 1005 and was_clean=true (initiated by server)" do
       em {
         ack_received = false
 
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+        start_server { |ws|
           ws.onopen {
             # 2. Send a close frame
             EM.next_tick {
-              ws.close_websocket
+              ws.close
             }
           }
+
+          # 5. Onclose event on server
+          ws.onclose { |event|
+            event.should == {
+              :code => 1005,
+              :reason => "",
+              :was_clean => true,
+            }
+            done
+          }
         }
 
         # 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 = start_client
 
         # 3. Check that close frame recieved and acknowlege it
         connection.onmessage { |frame|
@@ -210,18 +206,39 @@ describe "draft03" do
         # 4. Check that connection is closed _after_ the ack
         connection.onclose {
           ack_received.should == true
-          done
+        }
+      }
+    end
+
+    # it "should repur"
+    #
+    it "should return close code 1005 and was_clean=true after closing handshake (initiated by client)" do
+      em {
+        start_server { |ws|
+          ws.onclose { |event|
+            event.should == {
+              :code => 1005,
+              :reason => "",
+              :was_clean => true,
+            }
+            done
+          }
+        }
+        start_client { |client|
+          client.onopen {
+            client.send_data("\x01\x00")
+          }
         }
       }
     end
 
     it "should not allow data frame to be sent after close frame sent" do
       em {
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+        start_server { |ws|
           ws.onopen {
             # 2. Send a close frame
             EM.next_tick {
-              ws.close_websocket
+              ws.close
             }
 
             # 3. Check that exception raised if I attempt to send more data
@@ -235,25 +252,23 @@ describe "draft03" do
         }
 
         # 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))
+        start_client
       }
     end
 
     it "should still respond to control frames after close frame sent" do
       em {
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+        start_server { |ws|
           ws.onopen {
             # 2. Send a close frame
             EM.next_tick {
-              ws.close_websocket
+              ws.close
             }
           }
         }
 
         # 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 = start_client
 
         connection.onmessage { |frame|
           if frame == "\x01\x00"
@@ -268,5 +283,17 @@ describe "draft03" do
         }
       }
     end
+
+    it "should report that close codes are not supported" do
+      em {
+        start_server { |ws|
+          ws.onopen {
+            ws.supports_close_codes?.should == false
+            done
+          }
+        }
+        start_client
+      }
+    end
   end
 end