em-websocket 0.0.4 → 0.0.5

data/.gitignore

@@ -0,0 +1,3 @@
+*.gemspec
+pkg
+

data/README.rdoc

@@ -1,6 +1,7 @@
 = EM-WebSocket
 
-EventMachine based WebSocket server -- highly experimental, at this point, at least.
+EventMachine based, async WebSocket server. Take a look at examples directory, or
+check out the blog post below:
 - http://www.igvita.com/2009/12/22/ruby-websockets-tcp-for-the-browser/
 
 == Simple server example
@@ -23,4 +24,32 @@ EventMachine based WebSocket server -- highly experimental, at this point, at le
     end
   }
 
+== Examples
+- examples/multicast.rb - broadcast all ruby tweets to all subscribers
+- examples/echo.rb - server <> client exchange via a websocket
+- http://github.com/rubenfonseca/twitter-amqp-websocket-example
 
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Ilya Grigorik
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake'
+require 'spec/rake/spectask'
 
 begin
   require 'jeweler'
@@ -10,11 +11,21 @@ begin
     gemspec.homepage = "http://github.com/igrigorik/em-websocket"
     gemspec.authors = ["Ilya Grigorik"]
     gemspec.add_dependency("eventmachine", ">= 0.12.9")
-    gemspec.add_dependency("addressable")
+    gemspec.add_dependency("addressable", '>= 2.1.1')
+    gemspec.add_development_dependency('em-http-request', '>= 0.2.6')
     gemspec.rubyforge_project = "em-websocket"
   end
 
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
 end
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |t|
+  t.ruby_opts = ['-rtest/unit']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/examples/multicast.rb

@@ -0,0 +1,43 @@
+require 'lib/em-websocket'
+require 'twitter/json_stream'
+require 'json'
+
+#
+# broadcast all ruby related tweets to all connected users!
+#
+
+username = ARGV.shift
+password = ARGV.shift
+raise "need username and password" if !username or !password
+
+EventMachine.run {
+  @channel = EM::Channel.new
+
+  @twitter = Twitter::JSONStream.connect(
+    :path => '/1/statuses/filter.json?track=ruby',
+    :auth => "#{username}:#{password}"
+  )
+
+  @twitter.each_item do |status|
+    status = JSON.parse(status)
+    @channel.push "#{status['user']['screen_name']}: #{status['text']}"
+  end
+
+
+  EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 8080, :debug => true) do |ws|
+    ws.onopen {
+      @sid = @channel.subscribe { |msg| ws.send msg }
+      @channel.push "#{@sid} connected!"
+    }
+
+    ws.onmessage { |msg|
+      @channel.push "<#{@sid}>: #{msg}"
+    }
+
+    ws.onclose {
+      @channel.unsubscribe(@sid)
+    }
+  end
+
+  puts "Server started"
+}

data/lib/em-websocket.rb

@@ -1,6 +1,6 @@
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 
-require "rubygems"
+#require "rubygems"
 require "eventmachine"
 
 %w[ websocket connection ].each do |file|

data/lib/em-websocket/connection.rb

@@ -7,7 +7,7 @@ module EventMachine
       PATH   = /^GET (\/[^\s]*) HTTP\/1\.1$/
       HEADER = /^([^:]+):\s*([^$]+)/
 
-      attr_reader :state
+      attr_reader :state, :request
 
       # define WebSocket callbacks
       def onopen(&blk);     @onopen = blk;    end
@@ -33,7 +33,7 @@ module EventMachine
 
       def unbind
         debug [:unbind, :connection]
-        
+
         @state = :closed
         @onclose.call if @onclose
       end
@@ -59,6 +59,9 @@ module EventMachine
           # extract request path
           @request['Path'] = lines.shift.match(PATH)[1].strip
 
+          # extract query string values
+          @request['Query'] = Addressable::URI.parse(@request['Path']).query_values ||= {}
+
           # extract remaining headers
           lines.each do |line|
             h = HEADER.match(line)
@@ -67,7 +70,7 @@ module EventMachine
 
           # transform headers
           @request['Host'] = Addressable::URI.parse("ws://"+@request['Host'])
-          
+
           if not websocket_connection?
             send_data "HTTP/1.1 400 Bad request\r\n\r\n"
             close_connection_after_writing
@@ -90,7 +93,7 @@ module EventMachine
       def send_upgrade
         location  = "ws://#{@request['Host'].host}"
         location << ":#{@request['Host'].port}" if @request['Host'].port
-        location << @request['Path']
+        location << @request['Path'].split("?").first
 
         upgrade =  "HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
         upgrade << "Upgrade: WebSocket\r\n"
@@ -120,7 +123,7 @@ module EventMachine
           msg.gsub!(/^\x00|\xff$/, '')
           @onmessage.call(msg)
         end
-       
+
         false
       end
 

data/spec/websocket_spec.rb

@@ -11,7 +11,7 @@ describe EventMachine::WebSocket do
     EM.run do
       MSG = "Hello World!"
       EventMachine.add_timer(0.1) do
-        http = EventMachine::HttpRequest.new('ws://127.0.0.1:8080/').get :timeout => 0
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:12345/').get :timeout => 0
         http.errback { failed }
         http.callback { http.response_header.status.should == 101 }
 
@@ -21,7 +21,7 @@ describe EventMachine::WebSocket do
         }
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 8080) do |ws|
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
         ws.onopen {
           puts "WebSocket connection open"
           ws.send MSG
@@ -33,7 +33,7 @@ describe EventMachine::WebSocket do
   it "should fail on non WebSocket requests" do
     EM.run do
       EventMachine.add_timer(0.1) do
-        http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/').get :timeout => 0
+        http = EventMachine::HttpRequest.new('http://127.0.0.1:12345/').get :timeout => 0
         http.errback { failed }
         http.callback {
           http.response_header.status.should == 400
@@ -41,17 +41,17 @@ describe EventMachine::WebSocket do
         }
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 8080) {}
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) {}
     end
   end
 
   it "should split multiple messages into separate callbacks" do
     EM.run do
       messages = %w[1 2]
-      recieved = []
+      received = []
 
       EventMachine.add_timer(0.1) do
-        http = EventMachine::HttpRequest.new('ws://127.0.0.1:8080/').get :timeout => 0
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:12345/').get :timeout => 0
         http.errback { failed }
         http.stream {|msg|}
         http.callback {
@@ -61,14 +61,14 @@ describe EventMachine::WebSocket do
         }
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 8080) do |ws|
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
         ws.onopen {}
         ws.onclose {}
         ws.onmessage {|msg|
-          msg.should == messages[recieved.size]
-          recieved.push msg
+          msg.should == messages[received.size]
+          received.push msg
 
-          EventMachine.stop if recieved.size == messages.size
+          EventMachine.stop if received.size == messages.size
         }
       end
     end
@@ -77,7 +77,7 @@ describe EventMachine::WebSocket do
   it "should call onclose callback when client closes connection" do
     EM.run do
       EventMachine.add_timer(0.1) do
-        http = EventMachine::HttpRequest.new('ws://127.0.0.1:8080/').get :timeout => 0
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:12345/').get :timeout => 0
         http.errback { failed }
         http.callback {
           http.response_header.status.should == 101
@@ -86,7 +86,7 @@ describe EventMachine::WebSocket do
         http.stream{|msg|}
       end
 
-      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 8080) do |ws|
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
         ws.onopen {}
         ws.onclose {
           ws.state.should == :closed
@@ -96,4 +96,84 @@ describe EventMachine::WebSocket do
     end
   end
 
+  it "should populate ws.request with appropriate headers" do
+    EM.run do
+      EventMachine.add_timer(0.1) do
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:12345/').get :timeout => 0
+        http.errback { failed }
+        http.callback {
+          http.response_header.status.should == 101
+          http.close_connection
+        }
+        http.stream { |msg| }
+      end
+
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+        ws.onopen {
+          ws.request["User-Agent"].should == "EventMachine HttpClient"
+          ws.request["Connection"].should == "Upgrade"
+          ws.request["Upgrade"].should == "WebSocket"
+          ws.request["Path"].should == "/"
+          ws.request["Origin"].should == "127.0.0.1"
+          ws.request["Host"].to_s.should == "ws://127.0.0.1:12345"
+        }
+        ws.onclose {
+          ws.state.should == :closed
+          EventMachine.stop
+        }
+      end
+    end
+  end
+
+  it "should allow sending and retrieving query string args passed in on the connection request." do
+    EM.run do
+      EventMachine.add_timer(0.1) do
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:12345/').get(:query => {'foo' => 'bar', 'baz' => 'qux'}, :timeout => 0)
+        http.errback { failed }
+        http.callback {
+          http.response_header.status.should == 101
+          http.close_connection
+        }
+        http.stream { |msg| }
+      end
+
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+        ws.onopen {
+          ws.request["Path"].should == "/?baz=qux&foo=bar"
+          ws.request["Query"]["foo"].should == "bar"
+          ws.request["Query"]["baz"].should == "qux"
+        }
+        ws.onclose {
+          ws.state.should == :closed
+          EventMachine.stop
+        }
+      end
+    end
+  end
+
+  it "should ws.response['Query'] to empty hash when no query string params passed in connection URI" do
+    EM.run do
+      EventMachine.add_timer(0.1) do
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:12345/').get(:timeout => 0)
+        http.errback { failed }
+        http.callback {
+          http.response_header.status.should == 101
+          http.close_connection
+        }
+        http.stream { |msg| }
+      end
+
+      EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 12345) do |ws|
+        ws.onopen {
+          ws.request["Path"].should == "/"
+          ws.request["Query"].should == {}
+        }
+        ws.onclose {
+          ws.state.should == :closed
+          EventMachine.stop
+        }
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: em-websocket
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Ilya Grigorik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-24 00:00:00 -05:00
+date: 2010-01-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,17 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.6
     version: 
 description: EventMachine based WebSocket server
 email: ilya@igvita.com
@@ -41,10 +51,12 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .gitignore
 - README.rdoc
 - Rakefile
 - VERSION
 - examples/echo.rb
+- examples/multicast.rb
 - examples/test.html
 - lib/em-websocket.rb
 - lib/em-websocket/connection.rb
@@ -83,3 +95,4 @@ test_files:
 - spec/helper.rb
 - spec/websocket_spec.rb
 - examples/echo.rb
+- examples/multicast.rb