em-websocket 0.4.0 → 0.5.0

data/spec/integration/draft05_spec.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'integration/shared_examples'
 
 describe "draft05" do
   include EM::SpecHelper
@@ -22,26 +23,30 @@ describe "draft05" do
   end
   
   def start_server
-    EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
-      yield ws
+    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
+      yield ws if block_given?
     }
   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 "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

@@ -1,4 +1,5 @@
 require 'helper'
+require 'integration/shared_examples'
 
 describe "draft06" do
   include EM::SpecHelper
@@ -31,17 +32,22 @@ describe "draft06" do
   end
   
   def start_server
-    EM::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
-      yield ws
+    EM::WebSocket.run(:host => "0.0.0.0", :port => 12345) { |ws|
+      yield ws if block_given?
     }
   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 "should open connection" do
     em {
       start_server { |server|
@@ -82,4 +88,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,3 +1,5 @@
+# encoding: BINARY
+
 require 'helper'
 require 'integration/shared_examples'
 
@@ -31,29 +33,28 @@ describe "draft13" do
     }
   end
 
-  it_behaves_like "a websocket server" do
-    let(:version) { 13 }
+  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, Draft07FakeWebSocketClient)
+    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, Draft07FakeWebSocketClient)
-      client.send_data(format_request(@request))
-      yield client if block_given?
-    end
+  it_behaves_like "a websocket server" 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 +67,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 +81,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 +92,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

@@ -9,19 +9,20 @@ describe "WebSocket server draft75" do
   include EM::SpecHelper
   default_timeout 1
 
-  it_behaves_like "a websocket server" do
-    let(:version) { 75 }
+  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 = Draft75WebSocketClient.new
+    yield client if block_given?
+    return client
+  end
 
-    def start_client
-      client = Draft75WebSocketClient.new
-      yield client if block_given?
-    end
+  it_behaves_like "a websocket server" do
+    let(:version) { 75 }
   end
 
   it "should automatically complete WebSocket handshake" do
@@ -38,11 +39,11 @@ describe "WebSocket server draft75" do
         }
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+      start_server { |ws|
         ws.onopen {
           ws.send MSG
         }
-      end
+      }
     }
   end
 
@@ -62,7 +63,7 @@ describe "WebSocket server draft75" do
         }
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+      start_server { |ws|
         ws.onopen {}
         ws.onclose {}
         ws.onmessage {|msg|
@@ -71,7 +72,7 @@ describe "WebSocket server draft75" do
 
           EventMachine.stop if received.size == messages.size
         }
-      end
+      }
     }
   end
 
@@ -87,13 +88,13 @@ describe "WebSocket server draft75" do
         http.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
 
@@ -105,7 +106,7 @@ describe "WebSocket server draft75" do
         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 +114,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

data/spec/integration/draft76_spec.rb

@@ -1,3 +1,5 @@
+# encoding: BINARY
+
 require 'helper'
 require 'integration/shared_examples'
 
@@ -34,45 +36,42 @@ describe "WebSocket server draft76" do
     }
   end
   
-  it_behaves_like "a websocket server" do
-    let(:version) { 76 }
+  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, FakeWebSocketClient)
+    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, FakeWebSocketClient)
-      client.send_data(format_request(@request))
-      yield client if block_given?
-    end
+  it_behaves_like "a websocket server" do
+    let(:version) { 76 }
   end
 
   it "should send back the correct handshake response" do
     em {
-      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)
-      connection.send_data(format_request(@request))
+      start_server
 
-      connection.onopen {
-        connection.handshake_response.lines.sort.
-          should == format_response(@response).lines.sort
-        done
+      start_client { |connection|
+        connection.onopen {
+          connection.handshake_response.lines.sort.
+            should == format_response(@response).lines.sort
+          done
+        }
       }
     }
   end
   
   it "should send closing frame back and close the connection after recieving closing frame" do
     em {
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { }
+      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 closing frame after handshake complete
       connection.onopen {
@@ -91,16 +90,14 @@ describe "WebSocket server draft76" do
   
   it "should ignore any data received after the closing frame" do
     em {
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+      start_server { |ws|
         # Fail if foobar message is received
         ws.onmessage { |msg|
           fail
         }
       }
 
-      # 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 closing frame after handshake complete, followed by another msg
       connection.onopen {
@@ -116,15 +113,13 @@ describe "WebSocket server draft76" do
 
   it "should accept null bytes within the frame after a line return" do
     em {
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+      start_server { |ws|
         ws.onmessage { |msg|
           msg.should == "\n\000"
         }
       }
 
-      # 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 closing frame after handshake complete
       connection.onopen {
@@ -140,7 +135,7 @@ describe "WebSocket server draft76" do
 
   it "should handle unreasonable frame lengths by calling onerror callback" do
     em {
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |server|
+      start_server { |server|
         server.onerror { |error|
           error.should be_an_instance_of EM::WebSocket::WSMessageTooBigError
           error.message.should == "Frame length too long (1180591620717411303296 bytes)"
@@ -148,9 +143,7 @@ describe "WebSocket server draft76" do
         }
       }
 
-      # Create a fake client which sends draft 76 handshake
-      client = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
-      client.send_data(format_request(@request))
+      client = start_client
 
       # This particular frame indicates a message length of
       # 1180591620717411303296 bytes. Such a message would previously cause
@@ -164,7 +157,7 @@ describe "WebSocket server draft76" do
   
   it "should handle impossible frames by calling onerror callback" do
     em {
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |server|
+      start_server { |server|
         server.onerror { |error|
           error.should be_an_instance_of EM::WebSocket::WSProtocolError
           error.message.should == "Invalid frame received"
@@ -172,9 +165,7 @@ describe "WebSocket server draft76" do
         }
       }
 
-      # Create a fake client which sends draft 76 handshake
-      client = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
-      client.send_data(format_request(@request))
+      client = start_client
 
       client.onopen {
         client.send_data("foobar") # Does not start with \x00 or \xff
@@ -184,7 +175,7 @@ describe "WebSocket server draft76" do
 
   it "should handle invalid http requests by raising HandshakeError passed to onerror callback" do
     em {
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |server|
+      start_server { |server|
         server.onerror { |error|
           error.should be_an_instance_of EM::WebSocket::HandshakeError
           error.message.should == "Invalid HTTP header: Could not parse data entirely"
@@ -199,7 +190,7 @@ describe "WebSocket server draft76" do
 
   it "should handle handshake request split into two TCP packets" do
     em {
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { }
+      start_server
 
       # Create a fake client which sends draft 76 handshake
       connection = EM.connect('0.0.0.0', 12345, FakeWebSocketClient)
@@ -219,4 +210,32 @@ describe "WebSocket server draft76" do
       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
+
+  it "should call onclose when the server closes the connection [antiregression]" do
+    em {
+      start_server { |ws|
+        ws.onopen {
+          EM.add_timer(0.1) {
+            ws.close()
+          }
+        }
+        ws.onclose {
+          done
+        }
+      }
+      start_client
+    }
+  end
 end