Complete rewrite of the ConnectionManager Rack application.

Completely rewrote ConnectionManager to remove the websocket-rack
dependency. ConnectionManager is now a standalone Rack application
using the faye-websocket gem.

Added close to complete test coverage.

Reworked the Dispatcher class to focus it's responsibilities.

Author: DanKnox

.DS_Store

@@ -1,6 +1,7 @@
 .bundle/
 log/*.log
 pkg/
+doc/
 test/dummy/db/*.sqlite3
 test/dummy/log/*.log
 test/dummy/tmp/

.gitignore

@@ -0,0 +1,2 @@
+--color
+--format documentation

.rspec

@@ -0,0 +1,9 @@
+lib/websocket-rails.rb 6eee31896faf6bad2aa70a6e56963c3451e0e95a
+lib/websocket_rails/engine.rb 26d86b36fb5044066fe5fdb752ba2688c6af0e96
+lib/websocket_rails/version.rb 18f7775ac039b0fd3d0db90733e892b10405e1cf
+lib/websocket_rails/data_store.rb 3900177a989eb5d600a357596de6d13aec49dad2
+lib/websocket_rails/dispatcher.rb d075bf5431a7a61275b2190006d42eee6267fce7
+lib/websocket_rails/base_controller.rb bf11e6dfd5a2f1d5782f5da45840fedbf573fde1
+lib/websocket_rails/extensions/common.rb fd633e01c22e718a4955eabca9c204027b0c348f
+lib/websocket_rails/connection_manager.rb 9f9a8f743b357616a92881da60e0bbfac8c3bc13
+lib/websocket_rails/extensions/websocket_rack.rb c5ba8d6243b4ca201a2e56920ef142279d943227

.yardoc/checksums

@@ -1,3 +1,8 @@
 source "http://rubygems.org"
 
-gemspec
+gemspec
+
+gem "rspec-rails"
+gem "eventmachine", ">= 1.0.0.beta.3"
+gem "faye-websocket"
+gem "em-websocket-request"

.yardoc/object_types

@@ -2,10 +2,9 @@ PATH
   remote: .
   specs:
     websocket-rails (0.0.1)
-      em-websocket (~> 0.3.6)
+      faye-websocket
       rack
       thin
-      websocket-rack
 
 GEM
   remote: http://rubygems.org/
@@ -40,13 +39,25 @@ GEM
     addressable (2.2.7)
     arel (2.0.10)
     builder (2.1.2)
+    cookiejar (0.3.0)
     daemons (1.1.8)
-    em-websocket (0.3.6)
-      addressable (>= 2.1.1)
-      eventmachine (>= 0.12.9)
+    diff-lcs (1.1.3)
+    em-http-request (1.0.2)
+      addressable (>= 2.2.3)
+      cookiejar
+      em-socksify
+      eventmachine (>= 1.0.0.beta.4)
+      http_parser.rb (>= 0.5.3)
+    em-socksify (0.2.0)
+      eventmachine (>= 1.0.0.beta.4)
+    em-websocket-request (0.0.7)
+      em-http-request (~> 1.0.0)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    eventmachine (0.12.10)
+    eventmachine (1.0.0.beta.4)
+    faye-websocket (0.4.5)
+      eventmachine (>= 0.12.0)
+    http_parser.rb (0.5.3)
     i18n (0.5.0)
     json (1.6.5)
     mail (2.2.19)
@@ -78,6 +89,19 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rspec-rails (2.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.9.0)
     sqlite3 (1.3.5)
     thin (1.3.1)
       daemons (>= 1.0.9)
@@ -88,16 +112,16 @@ GEM
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.32)
-    websocket-rack (0.3.3)
-      em-websocket (~> 0.3.6)
-      rack
-      thin
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  em-websocket-request
+  eventmachine (>= 1.0.0.beta.3)
+  faye-websocket
   rails
   rake
+  rspec-rails
   sqlite3
   websocket-rails!

.yardoc/objects/root.dat

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012 Dan Knox and Kyle Whalen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

.yardoc/proxy_types

@@ -1,10 +1,14 @@
 # Websocket-Rails
 
-Plug and play WebSocket support for ruby on rails. Includes event router for mapping javascript events to controller actions. There is no need for a separate WebSocket server process. Requests to `/websocket` will be passed through to the embedded WebSocket server provided by the em-websocket gem.
+Plug and play WebSocket support for ruby on rails. Includes event router for mapping javascript events to controller actions. There is no need for a separate WebSocket server process. Requests to `/websocket` will be passed through to the `ConnectionManager` class which is a simple Rack based WebSocket server developed using the `Faye::WebSocket` library.
 
 *Important Note*
 
-This gem is not even close to production ready. This is mostly a proof of concept as of right now. Please try it out and let me know what you like or dislike. We will be adding much more soon including a development road map and full test coverage.
+This is mostly a proof of concept as of right now. Please try it out and let me know what you like or dislike. We will be adding much more soon including a development road map.
+
+*Update*
+
+We are finally very close to the first production release. Any comments or suggestions would be appreciated. The test coverage is now solid and the `ConnectionManager` class has been completely rewritten. There were a few bugs in the connection management on the first release that have been eliminated. Please upgrade to the latest version if you have not yet done so.
 
 ## Installation
 
@@ -31,7 +35,7 @@ You can subscribe multiple controllers and actions to the same event to provide
 ````ruby
 # app/config/initializers
 
-WebsocketRails::Dispatcher.describe_events do
+WebsocketRails::Events.describe_events do
   # The :client_connected method is fired automatically when a new client connects
   subscribe :client_connected, to: ChatController, with_method: :client_connected
 

Gemfile

@@ -1,4 +1,5 @@
 require "active_support/dependencies"
+require 'thin'
 
 module WebsocketRails
   mattr_accessor :app_root
@@ -7,12 +8,17 @@ def self.setup
     yield self
   end
 
+  def self.route_block=(routes)
+    @event_routes = routes
+  end
+  
+  def self.route_block
+    @event_routes
+  end
 end
 
 require "websocket_rails/engine"
 require 'websocket_rails/connection_manager'
 require 'websocket_rails/dispatcher'
-require 'websocket_rails/base_controller'
-require 'websocket_rails/extensions/common'
-
-WebsocketRails::Extensions::Common.apply!
+require 'websocket_rails/events'
+require 'websocket_rails/base_controller'

Gemfile.lock

@@ -8,17 +8,20 @@ def initialize
       @objects
     end
 
+    def connection
+      @_connection
+    end
+    
     def client_id
-      @_message.first
+      connection.object_id
     end
-
+    
     def message
-      @_message.last
+      @_message
     end
 
     def send_message(event, message)
-      @message_counter += 1
-      @_dispatcher.send_message event.to_s, [client_id,message] if @_dispatcher.respond_to?(:send_message)
+      @_dispatcher.send_message event.to_s, message, connection if @_dispatcher.respond_to?(:send_message)
     end
 
     def broadcast_message(event, message)

MIT-LICENSE

@@ -1,38 +1,58 @@
+require 'faye/websocket'
 require 'rack'
-require 'rack/websocket'
-require 'json'
+require 'thin'
+
 module WebsocketRails
-  class ConnectionManager < Rack::WebSocket::Application
-    def initialize(*args)
-      @dispatcher = Dispatcher.new(self)
-      super
-    end
-  
-    def on_open(env)
-      puts "Client connected\n"
-      @dispatcher.dispatch('client_connected',{},env)
-    end
+  class ConnectionManager
 
-    def on_message(env, msg)
-      @dispatcher.receive( msg, env )
-    end
+    attr_accessor :connections
 
-    def on_error(env, error)
-      puts "Error occured: " + error.message
+    def initialize
+      @connections = []
+      @dispatcher = Dispatcher.new( self )
     end
 
-    def on_close(env)
-      close_connection(env['websocket.client_id'])
-      @dispatcher.dispatch('client_disconnected',{},env)
-      puts "Client disconnected\n"
+    def call(env)
+      return invalid_connection_attempt unless Faye::WebSocket.websocket?( env )
+      connection = Faye::WebSocket.new( env )
+      
+      puts "Client #{connection} connected\n"
+      @dispatcher.dispatch( 'client_connected', {}, connection )
+      
+      
+      connection.onmessage = lambda do |event|
+        @dispatcher.receive( event.data, connection )
+      end
+      
+      connection.onerror = lambda do |event|
+        @dispatcher.dispatch( 'client_error', {}, connection )
+        connection.onclose
+      end
+      
+      connection.onclose = lambda do |event|
+        @dispatcher.dispatch( 'client_disconnected', {}, connection )
+        connections.delete( connection )
+        
+        puts "Client #{connection} disconnected\n"
+        connection = nil
+      end
+      
+      connections << connection
+      connection.rack_response
     end
 
-    def send_message(msg,uid)
-      send_data msg, uid
-    end
 
-    def broadcast_message(msg)
-      send_data_all msg
+    def broadcast_message(message)
+      @connections.map do |connection|
+        connection.send message
+      end
     end
+    
+    private
+    
+    def invalid_connection_attempt
+      [400,{'Content-Type' => 'text/plain'}, ['Connection was not a valid WebSocket connection']]
+    end
+    
   end
 end

README.md

@@ -1,73 +1,50 @@
 require 'json'
 
 module WebsocketRails
-  class Dispatcher  
-    def initialize(connection)
-      puts "Initializing dispatcher\n"
-      @connection = connection
-      @events  = Hash.new {|h,k| h[k] = Array.new}
-      @classes = Hash.new
-      evaluate(@@event_routes) if @@event_routes
+  class Dispatcher
+    
+    def self.describe_events(&block)
+      raise "This method has been deprecated. Please use WebsocketRails::Events.describe_events instead."
+    end
+    
+    attr_reader :events
+    
+    def initialize(connection_manager)
+      @connection_manager = connection_manager
+      @events = Events.new( self )
     end
 
-    def receive(enc_message,env)
+    def receive(enc_message,connection)
       message = JSON.parse( enc_message )
       event_name = message.first
       data = message.last
       data['received'] = Time.now.strftime("%I:%M:%p")
-      dispatch( event_name, data, env )
+      dispatch( event_name, data, connection )
     end
 
-    def send_message(event_name,data)
-      @connection.send_message encoded_message( event_name, data.last ), data.first
+    def send_message(event_name,data,connection)
+      connection.send encoded_message( event_name, data )
     end
 
     def broadcast_message(event_name,data)
-      @connection.broadcast_message encoded_message( event_name, data )
+      @connection_manager.broadcast_message encoded_message( event_name, data )
     end
 
-    def dispatch(event_name,data,env)
-      puts "#{event_name} is handled by #{@events[event_name.to_sym].inspect}\n\n"
+    def dispatch(event_name,message,connection)
       Fiber.new {
         event_symbol = event_name.to_sym
-        message = [env['websocket.client_id'],data]
-        @events[event_symbol].each do |event|
-          method  = event.last
-          handler = event.first
-          klass = @classes[handler]
-          klass.instance_variable_set(:@_message,message)
-          klass.send :execute_observers, event_symbol
-          klass.send method if klass.respond_to?(method)
+        events.routes_for(event_symbol) do |controller,method|
+          controller.instance_variable_set(:@_message,message)
+          controller.instance_variable_set(:@_connection,connection)
+          controller.send :execute_observers, event_symbol
+          controller.send method if controller.respond_to?(method)
         end
       }.resume
     end
-  
-    def close_connection
-      @connection.close_connection
-    end
-  
+    
     def encoded_message(event_name,data)
       [event_name, data].to_json
     end
-  
-    def subscribe(event_name,options)
-      klass = options[:to] || raise("Must specify a class for to: option in event route")
-      method = options[:with_method] || raise("Must specify a method for with_method: option in event route")
-      controller = klass.new
-      if @classes[klass].nil?
-        @classes[klass] = controller
-        controller.instance_variable_set(:@_dispatcher,self)
-        controller.send :initialize_session if controller.respond_to?(:initialize_session)
-      end
-      @events[event_name] << [klass,method]
-    end
-  
-    def self.describe_events(&block)
-      @@event_routes = block
-    end
-  
-    def evaluate(block)
-      instance_eval &block
-    end
+    
   end
 end