em-websocket 0.3.5 → 0.3.6

data/CHANGELOG.rdoc

@@ -1,5 +1,11 @@
 = Changelog
 
+== 0.3.6 / 2011-12-23
+
+- new features:
+  - Supports sending ping & pong messages
+  - Supports binding to received ping & pong messages
+
 == 0.3.5 / 2011-10-24
 
 - new features:

data/examples/echo.rb

@@ -1,8 +1,8 @@
-require 'lib/em-websocket'
+require File.expand_path('../../lib/em-websocket', __FILE__)
 
 EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 8080, :debug => true) do |ws|
   ws.onopen    { ws.send "Hello Client!"}
   ws.onmessage { |msg| ws.send "Pong: #{msg}" }
   ws.onclose   { puts "WebSocket closed" }
   ws.onerror   { |e| puts "Error: #{e.message}" }
-end
+end

data/examples/ping.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../../lib/em-websocket', __FILE__)
+
+EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 8080, :debug => false) do |ws|
+  timer = nil
+  ws.onopen {
+    puts "Ping supported: #{ws.pingable?}"
+    timer = EM.add_periodic_timer(1) {
+      p ["Sent ping", ws.ping('hello')]
+    }
+  }
+  ws.onpong { |value|
+    puts "Received pong: #{value}"
+  }
+  ws.onping { |value|
+    puts "Received ping: #{value}"
+  }
+  ws.onclose {
+    EM.cancel_timer(timer)
+    puts "WebSocket closed"
+  }
+  ws.onerror { |e|
+    puts "Error: #{e.message}"
+  }
+end

data/lib/em-websocket/connection.rb

@@ -10,6 +10,8 @@ module EventMachine
       def onclose(&blk);    @onclose = blk;   end
       def onerror(&blk);    @onerror = blk;   end
       def onmessage(&blk);  @onmessage = blk; end
+      def onping(&blk);     @onping = blk;    end
+      def onpong(&blk);     @onpong = blk;    end
 
       def trigger_on_message(msg)
         @onmessage.call(msg) if @onmessage
@@ -20,6 +22,12 @@ module EventMachine
       def trigger_on_close
         @onclose.call if @onclose
       end
+      def trigger_on_ping(data)
+        @onping.call(data) if @onping
+      end
+      def trigger_on_pong(data)
+        @onpong.call(data) if @onpong
+      end
       def trigger_on_error(reason)
         return false unless @onerror
         @onerror.call(reason)
@@ -140,6 +148,43 @@ module EventMachine
         end
       end
 
+      # Send a ping to the client. The client must respond with a pong.
+      #
+      # In the case that the client is running a WebSocket draft < 01, false
+      # is returned since ping & pong are not supported
+      #
+      def ping(body = '')
+        if @handler
+          @handler.pingable? ? @handler.send_frame(:ping, body) && true : false
+        else
+          raise WebSocketError, "Cannot ping before onopen callback"
+        end
+      end
+
+      # Send an unsolicited pong message, as allowed by the protocol. The
+      # client is not expected to respond to this message.
+      #
+      # em-websocket automatically takes care of sending pong replies to
+      # incoming ping messages, as the protocol demands.
+      #
+      def pong(body = '')
+        if @handler
+          @handler.pingable? ? @handler.send_frame(:pong, body) && true : false
+        else
+          raise WebSocketError, "Cannot ping before onopen callback"
+        end
+      end
+
+      # Test whether the connection is pingable (i.e. the WebSocket draft in
+      # use is >= 01)
+      def pingable?
+        if @handler
+          @handler.pingable?
+        else
+          raise WebSocketError, "Cannot test whether pingable before onopen callback"
+        end
+      end
+
       def request
         @handler ? @handler.request : {}
       end

data/lib/em-websocket/handler.rb

@@ -36,6 +36,16 @@ module EventMachine
         @state = :closed
         @connection.trigger_on_close
       end
+
+      def ping
+        # Overridden in subclass
+        false
+      end
+
+      def pingable?
+        # Also Overridden
+        false
+      end
     end
   end
 end

data/lib/em-websocket/message_processor_03.rb

@@ -22,8 +22,9 @@ module EventMachine
         when :ping
           # Pong back the same data
           send_frame(:pong, application_data)
+          @connection.trigger_on_ping(application_data)
         when :pong
-          # TODO: Do something. Complete a deferrable established by a ping?
+          @connection.trigger_on_pong(application_data)
         when :text
           if application_data.respond_to?(:force_encoding)
             application_data.force_encoding("UTF-8")
@@ -33,6 +34,11 @@ module EventMachine
           @connection.trigger_on_message(application_data)
         end
       end
+
+      # Ping & Pong supported
+      def pingable?
+        true
+      end
     end
   end
 end

data/lib/em-websocket/message_processor_06.rb

@@ -35,8 +35,9 @@ module EventMachine
         when :ping
           # Pong back the same data
           send_frame(:pong, application_data)
+          @connection.trigger_on_ping(application_data)
         when :pong
-          # TODO: Do something. Complete a deferrable established by a ping?
+          @connection.trigger_on_pong(application_data)
         when :text
           if application_data.respond_to?(:force_encoding)
             application_data.force_encoding("UTF-8")
@@ -46,6 +47,11 @@ module EventMachine
           @connection.trigger_on_message(application_data)
         end
       end
+
+      # Ping & Pong supported
+      def pingable?
+        true
+      end
     end
   end
 end

data/lib/em-websocket/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   module Websocket
-    VERSION = "0.3.5"
+    VERSION = "0.3.6"
   end
 end

data/spec/helper.rb

@@ -132,11 +132,6 @@ def format_response(r)
   data
 end
 
-def handler(request, secure = false)
-  connection = Object.new
-  EM::WebSocket::HandlerFactory.build(connection, format_request(request), secure)
-end
-
 RSpec::Matchers.define :send_handshake do |response|
   match do |actual|
     actual.handshake.lines.sort == format_response(response).lines.sort

data/spec/integration/draft13_spec.rb

@@ -47,19 +47,48 @@ describe "draft13" do
 
   it "should send back the correct handshake response" do
     em {
-      EM.add_timer(0.1) do
-        EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { }
-        
-        # Create a fake client which sends draft 07 handshake
-        connection = EM.connect('0.0.0.0', 12345, Draft07FakeWebSocketClient)
-        connection.send_data(format_request(@request))
-        
-        connection.onopen {
-          connection.handshake_response.lines.sort.
-            should == format_response(@response).lines.sort
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { }
+
+      # 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.onopen {
+        connection.handshake_response.lines.sort.
+          should == format_response(@response).lines.sort
+        done
+      }
+    }
+  end
+
+  # 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|
+        ws.onopen {
+          ws.should be_pingable
+          EM.next_tick {
+            ws.ping('hello').should == true
+          }
+
+        }
+        ws.onpong { |data|
+          data.should == 'hello'
           done
         }
-      end
+      }
+
+      # Create a fake client which sends draft 13 handshake
+      connection = EM.connect('0.0.0.0', 12345, Draft07FakeWebSocketClient)
+      connection.send_data(format_request(@request))
+
+      # Confusing, fake onmessage means any data after the handshake
+      connection.onmessage { |data|
+        # This is what a ping looks like
+        data.should == "\x89\x05hello"
+        # This is what a pong looks like
+        connection.send_data("\x8a\x05hello")
+      }
     }
   end
 end

data/spec/integration/draft76_spec.rb

@@ -50,97 +50,89 @@ describe "WebSocket server draft76" do
 
   it "should send back the correct handshake response" do
     em {
-      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)
-        connection.send_data(format_request(@request))
-        
-        connection.onopen {
-          connection.handshake_response.lines.sort.
-            should == format_response(@response).lines.sort
-          done
-        }
-      end
+      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))
+
+      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 {
-      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)
-        connection.send_data(format_request(@request))
-  
-        # Send closing frame after handshake complete
-        connection.onopen {
-          connection.send_data(EM::WebSocket::Handler76::TERMINATE_STRING)
-        }
-  
-        # Check that this causes a termination string to be returned and the 
-        # connection close
-        connection.onclose {
-          connection.packets[0].should == 
-            EM::WebSocket::Handler76::TERMINATE_STRING
-          done
-        }
-      end
+      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))
+
+      # Send closing frame after handshake complete
+      connection.onopen {
+        connection.send_data(EM::WebSocket::Handler76::TERMINATE_STRING)
+      }
+
+      # Check that this causes a termination string to be returned and the
+      # connection close
+      connection.onclose {
+        connection.packets[0].should ==
+          EM::WebSocket::Handler76::TERMINATE_STRING
+        done
+      }
     }
   end
   
   it "should ignore any data received after the closing frame" do
     em {
-      EM.add_timer(0.1) do
-        EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |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))
-  
-        # Send closing frame after handshake complete, followed by another msg
-        connection.onopen {
-          connection.send_data(EM::WebSocket::Handler76::TERMINATE_STRING)
-          connection.send('foobar')
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
+        # Fail if foobar message is received
+        ws.onmessage { |msg|
+          fail
         }
-  
-        connection.onclose {
-          done
-        }
-      end
+      }
+
+      # 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 closing frame after handshake complete, followed by another msg
+      connection.onopen {
+        connection.send_data(EM::WebSocket::Handler76::TERMINATE_STRING)
+        connection.send('foobar')
+      }
+
+      connection.onclose {
+        done
+      }
     }
   end
 
   it "should accept null bytes within the frame after a line return" do
     em {
-      EM.add_timer(0.1) do
-        EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |ws|
-          ws.onmessage { |msg|
-            msg.should == "\n\000" 
-          }
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { |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))
-  
-        # Send closing frame after handshake complete
-        connection.onopen {
-          connection.send_data("\000\n\000\377")
-          connection.send_data(EM::WebSocket::Handler76::TERMINATE_STRING)
-        }
-  
-        connection.onclose {
-          done
-        }
-      end
+      }
+
+      # 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 closing frame after handshake complete
+      connection.onopen {
+        connection.send_data("\000\n\000\377")
+        connection.send_data(EM::WebSocket::Handler76::TERMINATE_STRING)
+      }
+
+      connection.onclose {
+        done
+      }
     }
   end
 
@@ -205,25 +197,23 @@ describe "WebSocket server draft76" do
 
   it "should handle handshake request split into two TCP packets" do
     em {
-      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)])
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) { }
 
-        connection.onopen {
-          connection.handshake_response.lines.sort.
-            should == format_response(@response).lines.sort
-          done
-        }
+      # 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 {
+        connection.handshake_response.lines.sort.
+          should == format_response(@response).lines.sort
+        done
+      }
 
-        EM.add_timer(0.1) do
-          # Sends second half of the request
-          connection.send_data(data[(data.length / 2)..-1])
-        end
+      EM.add_timer(0.1) do
+        # Sends second half of the request
+        connection.send_data(data[(data.length / 2)..-1])
       end
     }
   end

data/spec/unit/handler_spec.rb

@@ -1,6 +1,11 @@
 require 'helper'
 
 describe "EventMachine::WebSocket::Handler" do
+  def handler(request, secure = false)
+    connection = Object.new
+    EM::WebSocket::HandlerFactory.build(connection, format_request(request), secure)
+  end
+
   before :each do
     @request = {
       :port => 80,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-websocket
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-24 00:00:00.000000000Z
+date: 2011-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70358050200200 !ruby/object:Gem::Requirement
+  requirement: &70364656209880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.12.9
   type: :runtime
   prerelease: false
-  version_requirements: *70358050200200
+  version_requirements: *70364656209880
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70358050199560 !ruby/object:Gem::Requirement
+  requirement: &70364656231520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 2.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70358050199560
+  version_requirements: *70364656231520
 - !ruby/object:Gem::Dependency
   name: em-spec
-  requirement: &70358050199080 !ruby/object:Gem::Requirement
+  requirement: &70364656231060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 0.2.5
   type: :development
   prerelease: false
-  version_requirements: *70358050199080
+  version_requirements: *70364656231060
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70358050198540 !ruby/object:Gem::Requirement
+  requirement: &70364656230580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 0.12.10
   type: :development
   prerelease: false
-  version_requirements: *70358050198540
+  version_requirements: *70364656230580
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70358050197960 !ruby/object:Gem::Requirement
+  requirement: &70364656230100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 0.2.6
   type: :development
   prerelease: false
-  version_requirements: *70358050197960
+  version_requirements: *70364656230100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70358050197280 !ruby/object:Gem::Requirement
+  requirement: &70364656229640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70358050197280
+  version_requirements: *70364656229640
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70358050176420 !ruby/object:Gem::Requirement
+  requirement: &70364656229260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70358050176420
+  version_requirements: *70364656229260
 description: EventMachine based WebSocket server
 email:
 - ilya@igvita.com
@@ -110,6 +110,7 @@ files:
 - examples/js/swfobject.js
 - examples/js/web_socket.js
 - examples/multicast.rb
+- examples/ping.rb
 - examples/test.html
 - lib/em-websocket.rb
 - lib/em-websocket/close03.rb
@@ -173,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: em-websocket
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: EventMachine based WebSocket server