em-websocket 0.4.0 → 0.5.3

data/spec/integration/draft03_spec.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'integration/shared_examples'
 
 describe "draft03" do
   include EM::SpecHelper
@@ -35,20 +34,19 @@ describe "draft03" do
     }
   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
+
   it_behaves_like "a websocket server" do
     let(:version) { 3 }
+  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?
-    end
+  it_behaves_like "a WebSocket server drafts 3 and above" do
+    let(:version) { 3 }
   end
 
   # These examples are straight from the spec
@@ -56,36 +54,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 +89,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 +110,15 @@ describe "draft03" do
       em {
         data = "a" * 256
         
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
-          ws.onmessage { |msg|
+        start_server { |ws|
+          ws.onbinary { |msg|
+            msg.encoding.should == Encoding.find("BINARY") if defined?(Encoding)
             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 +131,15 @@ describe "draft03" do
       em {
         data = "a" * 65536
         
-        EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
-          ws.onmessage { |msg|
+        start_server { |ws|
+          ws.onbinary { |msg|
+            msg.encoding.should == Encoding.find("BINARY") if defined?(Encoding)
             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 +152,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 +169,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 +205,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 +251,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 +282,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

data/spec/integration/draft05_spec.rb

@@ -20,28 +20,30 @@ describe "draft05" do
       }
     }
   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 = EM.connect('0.0.0.0', 12345, Draft05FakeWebSocketClient)
     client.send_data(format_request(@request))
     yield client if block_given?
+    return client
   end
   
-  it "should open connection" do
+  it_behaves_like "a websocket server" do
+    let(:version) { 5 }
+  end
+
+  it_behaves_like "a WebSocket server drafts 3 and above" do
+    let(:version) { 5 }
+  end
+
+  it "should report that close codes are not supported" do
     em {
-      start_server { |server|
-        server.onopen {
-          server.instance_variable_get(:@handler).class.should == EventMachine::WebSocket::Handler05
+      start_server { |ws|
+        ws.onopen {
+          ws.supports_close_codes?.should == false
           done
         }
       }
-      
       start_client
     }
   end

data/spec/integration/draft06_spec.rb

@@ -26,22 +26,26 @@ describe "draft06" do
         "Upgrade" => "websocket",
         "Connection" => "Upgrade",
         "Sec-WebSocket-Accept" => "s3pPLMBiTxaQ9kYGzzhZRbK+xOo=",
+        "Sec-WebSocket-Protocol" => "sample",
       }
     }
   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 = EM.connect('0.0.0.0', 12345, Draft05FakeWebSocketClient)
     client.send_data(format_request(@request))
     yield client if block_given?
+    return client
   end
   
+  it_behaves_like "a websocket server" do
+    let(:version) { 6 }
+  end
+
+  it_behaves_like "a WebSocket server drafts 3 and above" do
+    let(:version) { 6 }
+  end
+
   it "should open connection" do
     em {
       start_server { |server|
@@ -82,4 +86,60 @@ describe "draft06" do
       }
     }
   end
+
+  it "should return close code and reason if closed via handshake" do
+    em {
+      start_server { |ws|
+        ws.onclose { |event|
+          # 2. Receive close event in server
+          event.should == {
+            :code => 4004,
+            :reason => "close reason",
+            :was_clean => true,
+          }
+          done
+        }
+      }
+      start_client { |client|
+        client.onopen {
+          # 1: Send close handshake
+          close_data = [4004].pack('n')
+          close_data << "close reason"
+          client.send_frame(:close, close_data)
+        }
+      }
+    }
+  end
+
+  it "should return close code 1005 if no code was specified" do
+    em {
+      start_server { |ws|
+        ws.onclose { |event|
+          event.should == {
+            :code => 1005,
+            :reason => "",
+            :was_clean => true,
+          }
+          done
+        }
+      }
+      start_client { |client|
+        client.onopen {
+          client.send_frame(:close, '')
+        }
+      }
+    }
+  end
+
+  it "should report that close codes are supported" do
+    em {
+      start_server { |ws|
+        ws.onopen {
+          ws.supports_close_codes?.should == true
+          done
+        }
+      }
+      start_client
+    }
+  end
 end

data/spec/integration/draft13_spec.rb

@@ -1,5 +1,6 @@
+# encoding: BINARY
+
 require 'helper'
-require 'integration/shared_examples'
 
 describe "draft13" do
   include EM::SpecHelper
@@ -27,33 +28,31 @@ describe "draft13" do
         "Upgrade" => "websocket",
         "Connection" => "Upgrade",
         "Sec-WebSocket-Accept" => "s3pPLMBiTxaQ9kYGzzhZRbK+xOo=",
+        "Sec-WebSocket-Protocol" => "sample",
       }
     }
   end
 
+  def start_client
+    client = EM.connect('0.0.0.0', 12345, Draft07FakeWebSocketClient)
+    client.send_data(format_request(@request))
+    yield client if block_given?
+    return client
+  end
+
   it_behaves_like "a websocket server" do
     let(:version) { 13 }
+  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, Draft07FakeWebSocketClient)
-      client.send_data(format_request(@request))
-      yield client if block_given?
-    end
+  it_behaves_like "a WebSocket server drafts 3 and above" do
+    let(:version) { 13 }
   end
 
   it "should send back the correct handshake response" do
     em {
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { }
+      start_server
 
-      # Create a fake client which sends draft 13 handshake
-      connection = EM.connect('0.0.0.0', 12345, Draft07FakeWebSocketClient)
-      connection.send_data(format_request(@request))
+      connection = start_client
 
       connection.onopen {
         connection.handshake_response.lines.sort.
@@ -66,7 +65,7 @@ describe "draft13" do
   # TODO: This test would be much nicer with a real websocket client...
   it "should support sending pings and binding to onpong" do
     em {
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+      start_server { |ws|
         ws.onopen {
           ws.should be_pingable
           EM.next_tick {
@@ -80,9 +79,7 @@ describe "draft13" do
         }
       }
 
-      # Create a fake client which sends draft 13 handshake
-      connection = EM.connect('0.0.0.0', 12345, Draft07FakeWebSocketClient)
-      connection.send_data(format_request(@request))
+      connection = start_client
 
       # Confusing, fake onmessage means any data after the handshake
       connection.onmessage { |data|
@@ -93,4 +90,16 @@ describe "draft13" do
       }
     }
   end
+
+  it "should report that close codes are supported" do
+    em {
+      start_server { |ws|
+        ws.onopen {
+          ws.supports_close_codes?.should == true
+          done
+        }
+      }
+      start_client
+    }
+  end
 end

data/spec/integration/draft75_spec.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'integration/shared_examples'
 
 # These integration tests are older and use a different testing style to the 
 # integration tests for newer drafts. They use EM::HttpRequest which happens 
@@ -9,40 +8,35 @@ describe "WebSocket server draft75" do
   include EM::SpecHelper
   default_timeout 1
 
+  def start_client
+    client = Draft75WebSocketClient.new
+    yield client if block_given?
+    return client
+  end
+
   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
-      }
-    end
-
-    def start_client
-      client = Draft75WebSocketClient.new
-      yield client if block_given?
-    end
   end
 
   it "should automatically complete WebSocket handshake" do
     em {
       MSG = "Hello World!"
       EventMachine.add_timer(0.1) do
-        http = EventMachine::HttpRequest.new('ws://127.0.0.1:12345/').get :timeout => 0
-        http.errback { fail }
-        http.callback { http.response_header.status.should == 101 }
+        ws = EventMachine::WebSocketClient.connect('ws://127.0.0.1:12345/')
+        ws.errback { fail }
+        ws.callback { }
 
-        http.stream { |msg|
-          msg.should == MSG
+        ws.stream { |msg|
+          msg.data.should == MSG
           EventMachine.stop
         }
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+      start_server { |ws|
         ws.onopen {
           ws.send MSG
         }
-      end
+      }
     }
   end
 
@@ -52,17 +46,16 @@ describe "WebSocket server draft75" do
       received = []
 
       EventMachine.add_timer(0.1) do
-        http = EventMachine::HttpRequest.new('ws://127.0.0.1:12345/').get :timeout => 0
-        http.errback { fail }
-        http.stream {|msg|}
-        http.callback {
-          http.response_header.status.should == 101
-          http.send messages[0]
-          http.send messages[1]
+        ws = EventMachine::WebSocketClient.connect('ws://127.0.0.1:12345/')
+        ws.errback { fail }
+        ws.stream {|msg|}
+        ws.callback {
+          ws.send_msg messages[0]
+          ws.send_msg messages[1]
         }
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+      start_server { |ws|
         ws.onopen {}
         ws.onclose {}
         ws.onmessage {|msg|
@@ -71,41 +64,40 @@ describe "WebSocket server draft75" do
 
           EventMachine.stop if received.size == messages.size
         }
-      end
+      }
     }
   end
 
   it "should call onclose callback when client closes connection" do
     em {
       EventMachine.add_timer(0.1) do
-        http = EventMachine::HttpRequest.new('ws://127.0.0.1:12345/').get :timeout => 0
-        http.errback { fail }
-        http.callback {
-          http.response_header.status.should == 101
-          http.close_connection
+        ws = EventMachine::WebSocketClient.connect('ws://127.0.0.1:12345/')
+        ws.errback { fail }
+        ws.callback {
+          ws.close_connection
         }
-        http.stream{|msg|}
+        ws.stream{|msg|}
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+      start_server { |ws|
         ws.onopen {}
         ws.onclose {
           ws.state.should == :closed
           EventMachine.stop
         }
-      end
+      }
     }
   end
 
   it "should call onerror callback with raised exception and close connection on bad handshake" do
     em {
       EventMachine.add_timer(0.1) do
-        http = EventMachine::HttpRequest.new('http://127.0.0.1:12345/').get :timeout => 0
-        http.errback { http.response_header.status.should == 0 }
+        http = EM::HttpRequest.new('http://127.0.0.1:12345/').get
+        http.errback { }
         http.callback { fail }
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+      start_server { |ws|
         ws.onopen { fail }
         ws.onclose { EventMachine.stop }
         ws.onerror {|e|
@@ -113,7 +105,19 @@ describe "WebSocket server draft75" do
           e.message.should match('Not an upgrade request')
           EventMachine.stop
         }
-      end
+      }
+    }
+  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