em-websocket 0.4.0 → 0.5.3

data/spec/integration/draft76_spec.rb

@@ -1,5 +1,6 @@
+# encoding: BINARY
+
 require 'helper'
-require 'integration/shared_examples'
 
 describe "WebSocket server draft76" do
   include EM::SpecHelper
@@ -33,46 +34,37 @@ describe "WebSocket server draft76" do
       :body => "8jKS\'y:G*Co,Wxa-"
     }
   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
-      }
-    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 +83,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 +106,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 +128,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 +136,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 +150,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 +158,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,10 +168,10 @@ 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"
+          error.message.should == "Invalid HTTP header: Could not parse data entirely (1 != 29)"
           done
         }
       }
@@ -199,7 +183,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 +203,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

data/spec/integration/gte_03_examples.rb

@@ -0,0 +1,42 @@
+shared_examples_for "a WebSocket server drafts 3 and above" do
+  it "should force close connections after a timeout if close handshake is not sent by the client" do
+    em {
+      server_onerror_fired = false
+      server_onclose_fired = false
+      client_got_close_handshake = false
+      
+      start_server(:close_timeout => 0.1) { |ws|
+        ws.onopen {
+          # 1: Send close handshake to client
+          EM.next_tick { ws.close(4999, "Close message") }
+        }
+        
+        ws.onerror { |e|
+          # 3: Client should receive onerror
+          e.class.should == EM::WebSocket::WSProtocolError
+          e.message.should == "Close handshake un-acked after 0.1s, closing tcp connection"
+          server_onerror_fired = true
+        }
+        
+        ws.onclose {
+          server_onclose_fired = true
+        }
+      }
+      start_client { |client|
+        client.onmessage { |msg|
+          # 2: Client does not respond to close handshake (the fake client 
+          # doesn't understand them at all hence this is in onmessage)
+          msg.should =~ /Close message/ if version >= 6
+          client_got_close_handshake = true
+        }
+        
+        client.onclose {
+          server_onerror_fired.should == true
+          server_onclose_fired.should == true
+          client_got_close_handshake.should == true
+          done
+        }
+      }
+    }
+  end
+end

data/spec/integration/shared_examples.rb

@@ -29,6 +29,99 @@ shared_examples_for "a websocket server" do
     }
   end
 
+  it "should expose the remote IP address" do
+    em {
+      start_server { |ws|
+        ws.onopen {
+          ws.remote_ip.should == "127.0.0.1"
+          done
+        }
+      }
+
+      start_client
+    }
+  end
+
+  it "should send messages successfully" do
+    em {
+      start_server { |ws|
+        ws.onmessage { |message|
+          message.should == "hello server"
+          done
+        }
+      }
+
+      start_client { |client|
+        client.onopen {
+          client.send("hello server")
+        }
+      }
+    }
+  end
+
+  it "should allow connection to be closed with valid close code" do
+    em {
+      start_server { |ws|
+        ws.onopen {
+          ws.close(4004, "Bye bye")
+          done
+        }
+      }
+
+      start_client
+      # TODO: Use a real client which understands how to respond to closing
+      # handshakes, sending the handshake currently untested
+    }
+  end
+
+  it "should raise error if if invalid close code is used" do
+    em {
+      start_server { |ws|
+        ws.onopen {
+          lambda {
+            ws.close(2000)
+          }.should raise_error("Application code may only use codes from 1000, 3000-4999")
+          done
+        }
+      }
+
+      start_client
+    }
+  end
+
+  it "should call onclose with was_clean set to false if connection closed without closing handshake by server" do
+    em {
+      start_server { |ws|
+        ws.onopen {
+          # Close tcp connection (no close handshake)
+          ws.close_connection
+        }
+        ws.onclose { |event|
+          event.should == {:code => 1006, :was_clean => false}
+          done
+        }
+      }
+      start_client
+    }
+  end
+
+  it "should call onclose with was_clean set to false if connection closed without closing handshake by client" do
+    em {
+      start_server { |ws|
+        ws.onclose { |event|
+          event.should == {:code => 1006, :was_clean => false}
+          done
+        }
+      }
+      start_client { |client|
+        client.onopen {
+          # Close tcp connection (no close handshake)
+          client.close_connection
+        }
+      }
+    }
+  end
+
   it "should call onerror if an application error raised in onopen" do
     em {
       start_server { |ws|

data/spec/unit/framing_spec.rb

@@ -1,3 +1,5 @@
+# encoding: BINARY
+
 require 'helper'
 
 describe EM::WebSocket::Framing03 do
@@ -13,7 +15,7 @@ describe EM::WebSocket::Framing03 do
 
     def <<(data)
       @data << data
-      process_data(data)
+      process_data
     end
     
     def debug(*args); end
@@ -138,7 +140,7 @@ describe EM::WebSocket::Framing04 do
 
     def <<(data)
       @data << data
-      process_data(data)
+      process_data
     end
 
     def debug(*args); end
@@ -207,7 +209,7 @@ describe EM::WebSocket::Framing07 do
 
     def <<(data)
       @data << data
-      process_data(data)
+      process_data
     end
 
     def debug(*args); end
@@ -265,7 +267,7 @@ describe EM::WebSocket::Framing07 do
       lambda {
         # Opcode 3 is not supported by this draft
         @f << "\x83\x05Hello"
-      }.should raise_error(EventMachine::WebSocket::WSProtocolError, "Unknown opcode")
+      }.should raise_error(EventMachine::WebSocket::WSProtocolError, "Unknown opcode 3")
     end
 
     it "should accept a fragmented unmasked text message in 3 frames" do
@@ -274,5 +276,23 @@ describe EM::WebSocket::Framing07 do
       @f << "\x00\x02lo"
       @f << "\x80\x06 world"
     end
+
+    it "should raise if non-fin frame is followed by a non-continuation data frame (continuation frame would be expected)" do
+      lambda {
+        @f << 0b00000001 # Not fin, text
+        @f << 0b00000001 # Length 1
+        @f << 'f'
+        @f << 0b10000001 # fin, text (continutation expected)
+        @f << 0b00000001 # Length 1
+        @f << 'b'
+      }.should raise_error(EM::WebSocket::WebSocketError, 'Continuation frame expected')
+    end
+
+    it "should raise on non-fin control frames (control frames must not be fragmented)" do
+      lambda {
+        @f << 0b00001010 # Not fin, pong (opcode 10)
+        @f << 0b00000000 # Length 1
+      }.should raise_error(EM::WebSocket::WebSocketError, 'Control frames must not be fragmented')
+    end
   end
 end

data/spec/unit/handshake_spec.rb

@@ -126,6 +126,23 @@ describe EM::WebSocket::Handshake do
     end
   end
   
+  it "should raise error if Sec-WebSocket-Key1 is missing" do
+    @request[:headers].delete("Sec-WebSocket-Key1")
+
+    # The error message isn't correct since key1 is used to heuristically
+    # determine the protocol version in use, however this test at least checks
+    # that the handshake does correctly fail
+    handshake(@request).
+      should fail_with_error(EM::WebSocket::HandshakeError, 'Extra bytes after header')
+  end
+
+  it "should raise error if Sec-WebSocket-Key2 is missing" do
+    @request[:headers].delete("Sec-WebSocket-Key2")
+
+    handshake(@request).
+      should fail_with_error(EM::WebSocket::HandshakeError, 'WebSocket key1 or key2 is missing')
+  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'
 
@@ -138,7 +155,7 @@ describe EM::WebSocket::Handshake do
     handshake.receive_data("\r\n\r\nfoobar")
     
     handshake.
-      should fail_with_error(EM::WebSocket::HandshakeError, 'Invalid HTTP header: Could not parse data entirely')
+      should fail_with_error(EM::WebSocket::HandshakeError, 'Invalid HTTP header: Could not parse data entirely (4 != 10)')
   end
 
   # This might seems crazy, but very occasionally we saw multiple "Upgrade:
@@ -190,4 +207,10 @@ describe EM::WebSocket::Handshake do
     
     handshake(@request).should succeed_with_upgrade(@response)
   end
+
+  it "should fail if the request URI is invalid" do
+    @request[:path] = "/%"
+    handshake(@request).should \
+      fail_with_error(EM::WebSocket::HandshakeError, 'Invalid request URI: /%')
+  end
 end

data/spec/unit/masking_spec.rb

@@ -23,5 +23,7 @@ describe EM::WebSocket::MaskedString do
     t.getbyte(4).should == 0x03
     t.read_mask
     t.getbyte(4).should == 0x01
+    t.unset_mask
+    t.getbyte(4).should == 0x03
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-websocket
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.5.3
 platform: ruby
 authors:
 - Ilya Grigorik
@@ -10,118 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.9
   type: :runtime
   prerelease: false
   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
-        version: 0.5.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !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
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !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
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    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
-        version: 0.2.6
-  type: :development
-  prerelease: false
-  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:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-  type: :development
-  prerelease: false
-  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
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: EventMachine based WebSocket server
@@ -132,9 +47,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.rdoc
 - Gemfile
+- LICENCE
 - README.md
 - Rakefile
 - em-websocket.gemspec
@@ -180,39 +96,33 @@ files:
 - spec/integration/draft13_spec.rb
 - spec/integration/draft75_spec.rb
 - spec/integration/draft76_spec.rb
+- spec/integration/gte_03_examples.rb
 - spec/integration/shared_examples.rb
 - spec/unit/framing_spec.rb
 - spec/unit/handshake_spec.rb
 - spec/unit/masking_spec.rb
 homepage: http://github.com/igrigorik/em-websocket
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3969961455966824026
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3969961455966824026
 requirements: []
-rubyforge_project: em-websocket
-rubygems_version: 1.8.24
+rubygems_version: 3.0.3.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: EventMachine based WebSocket server
 test_files:
 - spec/helper.rb
@@ -223,6 +133,7 @@ test_files:
 - spec/integration/draft13_spec.rb
 - spec/integration/draft75_spec.rb
 - spec/integration/draft76_spec.rb
+- spec/integration/gte_03_examples.rb
 - spec/integration/shared_examples.rb
 - spec/unit/framing_spec.rb
 - spec/unit/handshake_spec.rb