websocket-rack 0.1.4 → 0.2.1

data/lib/rack/websocket/handler/thin.rb

@@ -0,0 +1,61 @@
+require 'thin'
+
+module Rack
+  module WebSocket
+    module Handler
+      class Thin < Base
+
+        autoload :Connection,     "#{ROOT_PATH}/websocket/handler/thin/connection"
+        autoload :HandlerFactory, "#{ROOT_PATH}/websocket/handler/thin/handler_factory"
+
+        def call(env)
+          @env = env
+          socket = env['async.connection']
+          request = request_from_env(env)
+          @conn = Connection.new(self, socket, :debug => @options[:debug])
+          @conn.dispatch(request) ? async_response : failure_response
+        end
+
+        def send_data(data)
+          if @conn
+            @conn.send data
+          else
+            raise WebSocketError, "WebSocket not opened"
+          end
+        end
+
+        def close_websocket
+          if @conn
+            @conn.close_websocket
+          else
+            raise WebSocketError, "WebSocket not opened"
+          end
+        end
+        
+        private
+        
+        def request_from_env(env)
+          request = {}
+          request['Path']   = env['REQUEST_PATH'].to_s
+          request['Method'] = env['REQUEST_METHOD']
+          request['Query']  = env['QUERY_STRING'].to_s
+          request['body']   = env['rack.input'].read
+          
+          request['Sec-WebSocket-Draft']    = env['HTTP_SEC_WEBSOCKET_DRAFT']
+          request['Sec-WebSocket-Key1']     = env['HTTP_SEC_WEBSOCKET_KEY1']
+          request['Sec-WebSocket-Key2']     = env['HTTP_SEC_WEBSOCKET_KEY2']
+          request['Sec-WebSocket-Protocol'] = env['HTTP_SEC_WEBSOCKET_PROTOCOL']
+          
+          env.each do |key, value|
+            if key.match(/HTTP_(.+)/)
+              request[$1.capitalize.gsub('_','-')] ||= value
+            end
+          end
+          
+          request
+        end
+
+      end
+    end
+  end
+end

data/lib/rack/websocket/handler.rb

@@ -1,43 +1,20 @@
 module Rack
   module WebSocket
-    class Handler
-      include Debugger
-
-      attr_reader :request, :state
-
-      def initialize(connection, request, debug = false)
-        @connection, @request = connection, request
-        @debug = debug
-        @state = :handshake
-        initialize_framing
-      end
-
-      def run
-        @connection.send_data handshake
-        @state = :connected
-        @connection.trigger_on_open
-      end
-
-      # Handshake response
-      def handshake
-        # Implemented in subclass
-      end
-
-      def receive_data(data)
-        @data << data
-        process_data(data)
-      end
-
-      def close_websocket
-        # Unless redefined in a subclass, just close the connection
-        @state = :closed
-        @connection.close_connection_after_writing
-      end
-
-      def unbind
-        @state = :closed
-        @connection.trigger_on_close
+    module Handler
+      
+      autoload :Base, "#{ROOT_PATH}/websocket/handler/base"
+      autoload :Stub, "#{ROOT_PATH}/websocket/handler/stub"
+      autoload :Thin, "#{ROOT_PATH}/websocket/handler/thin"
+      
+      def self.detect(env)
+        server_software = env['SERVER_SOFTWARE']
+        if server_software.match(/\Athin /i)
+          Thin
+        else
+          Stub
+        end
       end
+      
     end
   end
-end
+end

data/lib/rack/websocket/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module WebSocket
+    VERSION = "0.2.1"
+  end
+end

data/lib/rack/websocket.rb

@@ -1,40 +1,14 @@
 require 'rack'
+require 'em-websocket'
 
 module Rack
   module WebSocket
-    VERSION = "0.1.4"
     ROOT_PATH = ::File.expand_path(::File.dirname(__FILE__))
 
-    class WebSocketError < RuntimeError; end
-    class HandshakeError < WebSocketError; end
-    class DataError < WebSocketError; end
-
-    autoload :Application,    "#{ROOT_PATH}/websocket/application"
-    autoload :Connection,     "#{ROOT_PATH}/websocket/connection"
-    autoload :Debugger,       "#{ROOT_PATH}/websocket/debugger"
-    autoload :Framing03,      "#{ROOT_PATH}/websocket/framing03"
-    autoload :Framing76,      "#{ROOT_PATH}/websocket/framing76"
-    autoload :Handler,        "#{ROOT_PATH}/websocket/handler"
-    autoload :Handler03,      "#{ROOT_PATH}/websocket/handler03"
-    autoload :Handler75,      "#{ROOT_PATH}/websocket/handler75"
-    autoload :Handler76,      "#{ROOT_PATH}/websocket/handler76"
-    autoload :HandlerFactory, "#{ROOT_PATH}/websocket/handler_factory"
-    autoload :Handshake75,    "#{ROOT_PATH}/websocket/handshake75"
-    autoload :Handshake76,    "#{ROOT_PATH}/websocket/handshake76"
-
-    module Extensions
-      autoload :Thin,         "#{ROOT_PATH}/websocket/extensions/thin"
-    end
-
+    autoload :Application, "#{ROOT_PATH}/websocket/application"
+    autoload :Extensions,  "#{ROOT_PATH}/websocket/extensions"
+    autoload :Handler,    "#{ROOT_PATH}/websocket/handler"
   end
 end
 
-::Thin.send(:include, ::Rack::WebSocket::Extensions::Thin) if defined?(Thin)
-
-unless ''.respond_to?(:getbyte)
-  class String
-    def getbyte(i)
-      self[i]
-    end
-  end
-end
+Rack::WebSocket::Extensions.apply!

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rspec'
+
+require 'rack/websocket'
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+class TestApp < Rack::WebSocket::Application
+end
+
+TEST_PORT = 8081
+
+def new_server_connection
+  TCPSocket.new('localhost', TEST_PORT)
+end

data/spec/support/all_drafts.rb

@@ -0,0 +1,43 @@
+shared_examples_for 'all drafts' do
+  it "should accept incoming connection" do
+    conn = new_server_connection
+    conn.write(handshake_request)
+    conn.read(handshake_response.length).should eql(handshake_response)
+  end
+  it "should call 'on_open' on new connection" do
+    TestApp.any_instance.expects(:on_open)
+    conn = new_server_connection
+    conn.write(handshake_request)
+  end
+  it "should call 'on_open' on new connection with proper env" do
+    TestApp.any_instance.expects(:on_open).once.with { |env| env.class == Hash && !env.keys.empty? }
+    conn = new_server_connection
+    conn.write(handshake_request)
+  end
+  it "should call 'on_close' on connection close" do
+    TestApp.any_instance.expects(:on_close)
+    conn = new_server_connection
+    conn.write(handshake_request)
+    conn.close
+  end
+  it "should call 'on_close' on connection close with proper env" do
+    TestApp.any_instance.expects(:on_close).once.with { |env| env.class == Hash && !env.keys.empty? }
+    conn = new_server_connection
+    conn.write(handshake_request)
+    conn.close
+  end
+  it "should call 'on_message' on connection sending data" do
+    TestApp.any_instance.expects(:on_message)
+    conn = new_server_connection
+    conn.write(handshake_request)
+    conn.read(handshake_response.length)
+    conn.write(message)
+  end
+  it "should call 'on_message' on connection sending data with proper env and message" do
+    TestApp.any_instance.expects(:on_message).once.with { |env, message| env.class == Hash && !env.keys.empty? && message == 'some message' }
+    conn = new_server_connection
+    conn.write(handshake_request)
+    conn.read(handshake_response.length)
+    conn.write(message)
+  end
+end

data/spec/support/all_handlers.rb

@@ -0,0 +1,31 @@
+shared_examples_for 'all handlers' do
+  it "should return flash policy file" do
+    conn = new_server_connection
+    conn.write(flash_policy_request)
+    conn.read(flash_policy_response.length).should eql(flash_policy_response)
+  end
+  
+  context 'for draft75' do
+    let(:handshake_request)  { spec75_handshake_request }
+    let(:handshake_response) { spec75_handshake_response }
+    let(:message)            { spec75_message }
+    
+    it_should_behave_like 'all drafts'
+  end
+  
+  context 'for draft76' do
+    let(:handshake_request)  { spec76_handshake_request }
+    let(:handshake_response) { spec76_handshake_response }
+    let(:message)            { spec76_message }
+    
+    it_should_behave_like 'all drafts'
+  end
+  
+  context 'for draft03' do
+    let(:handshake_request)  { spec03_handshake_request }
+    let(:handshake_response) { spec03_handshake_response }
+    let(:message)            { spec03_message }
+    
+    it_should_behave_like 'all drafts'
+  end
+end

data/spec/support/requests.rb

@@ -0,0 +1,100 @@
+def flash_policy_request
+  "<policy-file-request/>\000"
+end
+
+def flash_policy_response
+  '<?xml version="1.0"?><cross-domain-policy><allow-access-from domain="*" to-ports="*"/></cross-domain-policy>'
+end
+
+def spec75_handshake_request
+  <<-EOF
+GET / HTTP/1.1\r
+Upgrade: WebSocket\r
+Connection: Upgrade\r
+Host: localhost:#{TEST_PORT}\r
+Origin: http://localhost:#{TEST_PORT}\r
+\r
+EOF
+end
+
+def spec75_handshake_response
+  <<-EOF
+HTTP/1.1 101 Web Socket Protocol Handshake\r
+Upgrade: WebSocket\r
+Connection: Upgrade\r
+WebSocket-Origin: http://localhost:#{TEST_PORT}\r
+WebSocket-Location: ws://localhost:#{TEST_PORT}/\r
+\r
+EOF
+end
+
+def spec75_message
+  "\x00some message\xff"
+end
+
+def spec76_handshake_request
+  request = <<-EOF
+GET / HTTP/1.1\r
+Upgrade: WebSocket\r
+Connection: Upgrade\r
+Host: localhost:#{TEST_PORT}\r
+Origin: http://localhost:#{TEST_PORT}\r
+Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8\r
+Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0\r
+\r
+Tm[K T2u
+EOF
+  request.rstrip
+end
+
+def spec76_handshake_response
+  response = <<-EOF
+HTTP/1.1 101 WebSocket Protocol Handshake\r
+Upgrade: WebSocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Location: ws://localhost:#{TEST_PORT}/\r
+Sec-WebSocket-Origin: http://localhost:#{TEST_PORT}\r
+\r
+fQJ,fN/4F4!~K~MH
+EOF
+  response.rstrip
+end
+
+def spec76_message
+  "\x00some message\xff"
+end
+
+def spec03_handshake_request
+  request = <<-EOF
+GET / HTTP/1.1\r
+Upgrade: WebSocket\r
+Connection: Upgrade\r
+Host: localhost:#{TEST_PORT}\r
+Origin: http://localhost:#{TEST_PORT}\r
+Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8\r
+Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0\r
+Sec-WebSocket-Protocol: sample\r
+Sec-WebSocket-Draft: 3\r
+\r
+Tm[K T2u
+EOF
+  request.rstrip
+end
+
+def spec03_handshake_response
+  response = <<-EOF
+HTTP/1.1 101 WebSocket Protocol Handshake\r
+Upgrade: WebSocket\r
+Connection: Upgrade\r
+Sec-WebSocket-Location: ws://localhost:#{TEST_PORT}/\r
+Sec-WebSocket-Origin: http://localhost:#{TEST_PORT}\r
+Sec-WebSocket-Protocol: sample\r
+\r
+fQJ,fN/4F4!~K~MH
+EOF
+  response.rstrip
+end
+
+def spec03_message
+  "\x04\x0Csome message"
+end

data/spec/thin_spec.rb

@@ -0,0 +1,46 @@
+require 'thin'
+require 'spec_helper'
+
+describe 'Thin handler' do
+  let(:app) { TestApp.new }
+  
+  before(:all) { silent_thin }
+  before { start_thin_server(app) }
+  after  { stop_thin_server }
+  
+  it "should include extensions" do
+    ::Thin::Connection.include?(::Rack::WebSocket::Extensions::Common).should be_true
+    ::Thin::Connection.include?(::Rack::WebSocket::Extensions::Thin::Connection).should be_true
+  end
+  
+  it_should_behave_like 'all handlers'
+end
+
+def start_thin_server(app, options = {})
+  @server = Thin::Server.new('0.0.0.0', TEST_PORT, options, app)
+  @server.ssl = options[:ssl]
+  # @server.threaded = options[:threaded]
+  # @server.timeout = 3
+
+  @thread = Thread.new { @server.start }
+  sleep 1 until @server.running?
+end
+
+def stop_thin_server
+  sleep 0.1
+  @server.stop!
+  @thread.kill
+  raise "Reactor still running, wtf?" if EventMachine.reactor_running?
+end
+
+def silent_thin
+  ::Thin::Logging.silent = true
+  if EM::VERSION < "1.0.0"
+    begin
+      old_verbose, $VERBOSE = $VERBOSE, nil
+      ::Thin::Server.const_set 'DEFAULT_TIMEOUT', 0
+    ensure
+      $VERBOSE = old_verbose
+    end
+  end
+end

data/websocket-rack.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "rack/websocket"
+require "rack/websocket/version"
 
 Gem::Specification.new do |s|
   s.name        = "websocket-rack"
@@ -13,10 +13,10 @@ Gem::Specification.new do |s|
   s.description = %q{Rack-based WebSocket server}
 
   s.add_dependency 'rack'
-  s.add_dependency 'addressable', '>= 2.1.1'
-  s.add_dependency 'eventmachine', '>= 0.12.9'
-  s.add_dependency 'thin'
+  s.add_dependency 'em-websocket', '~> 0.2.1'
+  s.add_dependency 'thin' # Temporary until we support more servers
   s.add_development_dependency 'rspec', '~> 2.4.0'
+  s.add_development_dependency 'mocha'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: websocket-rack
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 21
   prerelease: 
   segments: 
   - 0
+  - 2
   - 1
-  - 4
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors: 
 - Bernard Potocki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-13 00:00:00 +01:00
+date: 2011-04-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,65 +33,63 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: addressable
+  name: em-websocket
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 21
         segments: 
+        - 0
         - 2
         - 1
-        - 1
-        version: 2.1.1
+        version: 0.2.1
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: eventmachine
+  name: thin
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 61
+        hash: 3
         segments: 
         - 0
-        - 12
-        - 9
-        version: 0.12.9
+        version: "0"
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: thin
+  name: rspec
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 31
         segments: 
+        - 2
+        - 4
         - 0
-        version: "0"
-  type: :runtime
+        version: 2.4.0
+  type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: mocha
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 3
         segments: 
-        - 2
-        - 4
         - 0
-        version: 2.4.0
+        version: "0"
   type: :development
   version_requirements: *id005
 description: Rack-based WebSocket server
@@ -118,25 +116,22 @@ files:
 - example/html/web_socket.js
 - lib/rack/websocket.rb
 - lib/rack/websocket/application.rb
-- lib/rack/websocket/connection.rb
-- lib/rack/websocket/debugger.rb
+- lib/rack/websocket/extensions.rb
+- lib/rack/websocket/extensions/common.rb
 - lib/rack/websocket/extensions/thin.rb
 - lib/rack/websocket/extensions/thin/connection.rb
-- lib/rack/websocket/framing03.rb
-- lib/rack/websocket/framing76.rb
 - lib/rack/websocket/handler.rb
-- lib/rack/websocket/handler03.rb
-- lib/rack/websocket/handler75.rb
-- lib/rack/websocket/handler76.rb
-- lib/rack/websocket/handler_factory.rb
-- lib/rack/websocket/handshake75.rb
-- lib/rack/websocket/handshake76.rb
-- spec/helper.rb
-- spec/integration/draft03_spec.rb
-- spec/integration/draft76_spec.rb
-- spec/unit/framing_spec.rb
-- spec/unit/handler_spec.rb
-- spec/websocket_spec.rb
+- lib/rack/websocket/handler/base.rb
+- lib/rack/websocket/handler/stub.rb
+- lib/rack/websocket/handler/thin.rb
+- lib/rack/websocket/handler/thin/connection.rb
+- lib/rack/websocket/handler/thin/handler_factory.rb
+- lib/rack/websocket/version.rb
+- spec/spec_helper.rb
+- spec/support/all_drafts.rb
+- spec/support/all_handlers.rb
+- spec/support/requests.rb
+- spec/thin_spec.rb
 - websocket-rack.gemspec
 has_rdoc: true
 homepage: http://github.com/imanel/websocket-rack
@@ -173,9 +168,8 @@ signing_key:
 specification_version: 3
 summary: Rack-based WebSocket server
 test_files: 
-- spec/helper.rb
-- spec/integration/draft03_spec.rb
-- spec/integration/draft76_spec.rb
-- spec/unit/framing_spec.rb
-- spec/unit/handler_spec.rb
-- spec/websocket_spec.rb
+- spec/spec_helper.rb
+- spec/support/all_drafts.rb
+- spec/support/all_handlers.rb
+- spec/support/requests.rb
+- spec/thin_spec.rb