websocket-rails 0.4.9 → 0.5.0

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # WebsocketRails Change Log
 
+## Version 0.5.0
+
+September 2 2013
+
+* Use window.location.protocol to choose between ws:// and wss://
+shcheme. - Thanks to @depili
+* Override ConnectionManager#inspect to clean up the output from `rake
+routes`
+* Add a basic Global UserManager for triggering events on specific users
+from anywhere inside your app without creating a dedicated user channel.
+* Deprecate the old controller observer system and implement full Rails
+AbstractController::Callbacks support. - Thanks to @pitr
+* Reload the events.rb event route file each time an event is fired. -
+Thanks to @moaa
+* Separate the event route file and WebsocketRails configuration files.
+The events.rb now lives in `config/events.rb`. The configuration should
+remain in an initializer located at `config/initializers/websocket_rails.rb`. - Thanks to @moaa
+
 ## Version 0.4.9
 
 July 9 2013

data/README.md

@@ -6,7 +6,7 @@ If you haven't done so yet, check out the [Project Page](http://danknox.github.c
 
 **Find us on IRC #websocket-rails**
 
-Stop by #websocket-rails if you would like to chat or have any
+Stop by #websocket-rails on freenode if you would like to chat or have any
 questions.
 
 ## Recent Updates

data/lib/assets/javascripts/websocket_rails/websocket_connection.js.coffee

@@ -4,7 +4,13 @@ WebSocket Interface for the WebSocketRails client.
 class WebSocketRails.WebSocketConnection
 
   constructor: (@url,@dispatcher) ->
-    @url             = "ws://#{@url}" unless @url.match(/^wss?:\/\//)
+    if @url.match(/^wss?:\/\//)
+        console.log "WARNING: Using connection urls with protocol specified is depricated"
+    else if window.location.protocol == 'http:'
+        @url             = "ws://#{@url}"
+    else
+        @url             = "wss://#{@url}"
+    
     @message_queue   = []
     @_conn           = new WebSocket(@url)
     @_conn.onmessage = @on_message

data/lib/generators/websocket_rails/install/install_generator.rb

@@ -11,7 +11,8 @@ module WebsocketRails
                    :desc => "Javascript manifest file to modify (or create)"
 
       def create_events_initializer_file
-        template 'events.rb', File.join('config', 'initializers', 'events.rb')
+        template 'events.rb', File.join('config', 'events.rb')
+        template 'websocket_rails.rb', File.join('config', 'initializers', 'websocket_rails.rb')
       end
 
       def inject_websocket_rails_client

data/lib/generators/websocket_rails/install/templates/events.rb

@@ -1,39 +1,3 @@
-WebsocketRails.setup do |config|
-
-  # Uncomment to override the default log level. The log level can be
-  # any of the standard Logger log levels. By default it will mirror the
-  # current Rails environment log level.
-  # config.log_level = :debug
-
-  # Uncomment to change the default log file path.
-  # config.log_path = "#{Rails.root}/log/websocket_rails.log"
-
-  # Set to true if you wish to log the internal websocket_rails events
-  # such as the keepalive `websocket_rails.ping` event.
-  # config.log_internal_events = false
-
-  # Change to true to enable standalone server mode
-  # Start the standalone server with rake websocket_rails:start_server
-  # * Requires Redis
-  config.standalone = false
-
-  # Change to true to enable channel synchronization between
-  # multiple server instances.
-  # * Requires Redis.
-  config.synchronize = false
-
-  # Uncomment and edit to point to a different redis instance.
-  # Will not be used unless standalone or synchronization mode
-  # is enabled.
-  # config.redis_options = {:host => 'localhost', :port => '6379'}
-
-  # By default, all subscribers in to a channel will be removed
-  # when that channel is made private. If you don't wish active
-  # subscribers to be removed from a previously public channel
-  # when making it private, set the following to true.
-  # config.keep_subscribers_when_private = false
-end
-
 WebsocketRails::EventMap.describe do
   # You can use this file to map incoming events to controller actions.
   # One event can be mapped to any number of controller actions. The

data/lib/generators/websocket_rails/install/templates/websocket_rails.rb

@@ -0,0 +1,41 @@
+WebsocketRails.setup do |config|
+
+  # Uncomment to override the default log level. The log level can be
+  # any of the standard Logger log levels. By default it will mirror the
+  # current Rails environment log level.
+  # config.log_level = :debug
+
+  # Uncomment to change the default log file path.
+  # config.log_path = "#{Rails.root}/log/websocket_rails.log"
+
+  # Set to true if you wish to log the internal websocket_rails events
+  # such as the keepalive `websocket_rails.ping` event.
+  # config.log_internal_events = false
+
+  # Change to true to enable standalone server mode
+  # Start the standalone server with rake websocket_rails:start_server
+  # * Requires Redis
+  config.standalone = false
+
+  # Change to true to enable channel synchronization between
+  # multiple server instances.
+  # * Requires Redis.
+  config.synchronize = false
+
+  # Uncomment and edit to point to a different redis instance.
+  # Will not be used unless standalone or synchronization mode
+  # is enabled.
+  # config.redis_options = {:host => 'localhost', :port => '6379'}
+
+  # By default, all subscribers in to a channel will be removed
+  # when that channel is made private. If you don't wish active
+  # subscribers to be removed from a previously public channel
+  # when making it private, set the following to true.
+  # config.keep_subscribers_when_private = false
+
+  # Used as the key for the WebsocketRails.users Hash. This method
+  # will be called on the `current_user` object in your controller
+  # if one exists. If `current_user` does not exist or does not
+  # respond to the identifier, the key will default to `connection.id`
+  # config.user_identifier = :id
+end

data/lib/rails/tasks/websocket_rails.tasks

@@ -2,7 +2,8 @@ namespace :websocket_rails do
   desc 'Start the WebsocketRails standalone server.'
   task :start_server do
     require "thin"
-    load "#{Rails.root}/config/initializers/events.rb"
+    load "#{Rails.root}/config/initializers/websocket_rails.rb"
+    load "#{Rails.root}/config/events.rb"
 
     options = WebsocketRails.config.thin_options
 
@@ -18,7 +19,8 @@ namespace :websocket_rails do
   desc 'Stop the WebsocketRails standalone server.'
   task :stop_server do
     require "thin"
-    load "#{Rails.root}/config/initializers/events.rb"
+    load "#{Rails.root}/config/initializers/websocket_rails.rb"
+    load "#{Rails.root}/config/events.rb"
 
     options = WebsocketRails.config.thin_options
 
@@ -31,6 +33,6 @@ end
 def warn_if_standalone_not_enabled!
   return if WebsocketRails.standalone?
   puts "Fail!"
-  puts "You must enable standalone mode in your events.rb initializer to use the standalone server."
+  puts "You must enable standalone mode in your websocket_rails.rb initializer to use the standalone server."
   exit 1
 end

data/lib/websocket-rails.rb

@@ -41,6 +41,7 @@ require 'websocket_rails/event_map'
 require 'websocket_rails/event_queue'
 require 'websocket_rails/channel'
 require 'websocket_rails/channel_manager'
+require 'websocket_rails/user_manager'
 require 'websocket_rails/base_controller'
 require 'websocket_rails/internal_events'
 
@@ -48,6 +49,7 @@ require 'websocket_rails/connection_adapters'
 require 'websocket_rails/connection_adapters/http'
 require 'websocket_rails/connection_adapters/web_socket'
 
+load "#{Rails.root}/config/events.rb" if File.exists?("#{Rails.root}/config/events.rb")
 
 # Exceptions
 class WebsocketRails::InvalidConnectionError < StandardError
@@ -83,6 +85,18 @@ class WebsocketRails::EventRoutingError < StandardError
 
 end
 
+class WebsocketRails::ConfigDeprecationError < StandardError
+  def to_s
+    out = "Deprecation Error:\n\n\t"
+    out << "config/initializers/events.rb has been moved to config/events.rb\n\t"
+    out << "Make sure events.rb is in the proper location and the old one has been removed.\n\t"
+    out << "More information can be found in the wiki.\n\n"
+  end
+end
+
+raise WebsocketRails::ConfigDeprecationError if File.exists?("config/initializers/events.rb")
+
+
 # Deprecation Notices
 class WebsocketRails::Dispatcher
   def self.describe_events(&block)

data/lib/websocket_rails/base_controller.rb

@@ -1,4 +1,5 @@
 require "websocket_rails/data_store"
+require 'abstract_controller/callbacks'
 
 module WebsocketRails
   # Provides controller helper methods for developing a WebsocketRails controller. Action methods
@@ -18,6 +19,24 @@ module WebsocketRails
   #
   class BaseController
 
+    # We need process_action to be in a module loaded before AbstractController::Callbacks
+    # to get inheritance properly
+    module Metal
+      def process_action(method, event)
+        if respond_to?(method)
+          self.send(method)
+        else
+          raise EventRoutingError.new(event, self, method)
+        end
+      end
+      def response_body
+        false
+      end
+    end
+
+    include Metal
+    include AbstractController::Callbacks
+
     # Tell Rails that BaseController and children can be reloaded when in
     # the Development environment.
     def self.inherited(controller)
@@ -26,33 +45,6 @@ module WebsocketRails
       end
     end
 
-    # Add observers to specific events or the controller in general. This functionality is similar
-    # to the Rails before_filter methods. Observers are stored as Proc objects and have access
-    # to the current controller environment.
-    #
-    # Observing all events sent to a controller:
-    #   class ChatController < WebsocketRails::BaseController
-    #     observe {
-    #       if data_store.each_user.count > 0
-    #         puts 'a user has joined'
-    #       end
-    #     }
-    #   end
-    # Observing a single event that occurrs:
-    #   observe(:new_message) {
-    #     puts 'new_message has fired!'
-    #   }
-    def self.observe(event = nil, &block)
-      # Stores the observer Procs for the current controller. See {observe} for details.
-      @observers ||= Hash.new {|h,k| h[k] = Array.new}
-
-      if event
-        @observers[event] << block
-      else
-        @observers[:general] << block
-      end
-    end
-
     # Provides direct access to the connection object for the client that
     # initiated the event that is currently being executed.
     def connection
@@ -136,7 +128,11 @@ module WebsocketRails
     end
 
     def request
-      @_request
+      connection.request
+    end
+
+    def action_name
+      @_action_name
     end
 
     # Provides access to the {DataStore} for the current controller. The {DataStore} provides convenience
@@ -150,24 +146,16 @@ module WebsocketRails
       connection.data_store
     end
 
-    private
-
-    # Executes the observers that have been defined for this controller. General observers are executed
-    # first and event specific observers are executed last. Each will be executed in the order that
-    # they have been defined. This method is executed by the {Dispatcher}.
-    def execute_observers(event)
-      observers = self.class.instance_variable_get(:@observers)
-
-      return unless observers
+    def self.controller_name
+      self.name.underscore.gsub(/_controller$/,'')
+    end
 
-      observers[:general].each do |observer|
-        instance_eval( &observer )
-      end
-      observers[event].each do |observer|
-        instance_eval( &observer )
-      end
+    def controller_name
+      self.class.controller_name
     end
 
+    private
+
     def delegate
       connection.controller_delegate
     end

data/lib/websocket_rails/channel_manager.rb

@@ -1,5 +1,3 @@
-require 'active_support/hash_with_indifferent_access'
-
 module WebsocketRails
 
   class << self
@@ -19,7 +17,7 @@ module WebsocketRails
     attr_reader :channels
 
     def initialize
-      @channels = HashWithIndifferentAccess.new
+      @channels = {}.with_indifferent_access
     end
 
     def [](channel)

data/lib/websocket_rails/configuration.rb

@@ -1,6 +1,14 @@
 module WebsocketRails
   class Configuration
 
+    def user_identifier
+      @user_identifier ||= :id
+    end
+
+    def user_identifier=(identifier)
+      @user_identifier = identifier
+    end
+
     def keep_subscribers_when_private?
       @keep_subscribers_when_private ||= false
     end

data/lib/websocket_rails/connection_adapters.rb

@@ -9,7 +9,7 @@ module WebsocketRails
       @adapters.unshift adapter
     end
 
-    def self.establish_connection(request,dispatcher)
+    def self.establish_connection(request, dispatcher)
       adapter = adapters.detect { |a| a.accepts?( request.env ) } || (raise InvalidConnectionError)
       adapter.new request, dispatcher
     end
@@ -36,8 +36,10 @@ module WebsocketRails
         @queue      = EventQueue.new
         @data_store = DataStore::Connection.new(self)
         @delegate   = WebsocketRails::DelegationController.new
-        @delegate.instance_variable_set(:@_env,request.env)
-        @delegate.instance_variable_set(:@_request,request)
+        @delegate.instance_variable_set(:@_env, request.env)
+        @delegate.instance_variable_set(:@_request, request)
+
+        WebsocketRails.users[user_identifier] = self
         start_ping_timer
       end
 
@@ -92,6 +94,14 @@ module WebsocketRails
         send message
       end
 
+      def send_message(event_name, data = {}, options = {})
+        options.merge! :user_id => user_identifier, :connection => self
+        options[:data] = data
+
+        event = Event.new(event_name, options)
+        event.trigger
+      end
+
       def send(message)
         raise NotImplementedError, "Override this method in the connection specific adapter class"
       end
@@ -118,14 +128,29 @@ module WebsocketRails
 
       private
 
+      def user_identifier
+        @user_identifier ||= begin
+          identifier = WebsocketRails.config.user_identifier
+
+          unless @delegate.respond_to?(:current_user) &&
+                 @delegate.current_user &&
+                 @delegate.current_user.respond_to?(identifier)
+            return id
+          end
+
+          controller_delegate.current_user.send(identifier)
+         end
+      end
+
       def dispatch(event)
-        dispatcher.dispatch( event )
+        dispatcher.dispatch event
       end
 
       def close_connection
         @data_store.destroy!
         @ping_timer.try(:cancel)
         dispatcher.connection_manager.close_connection self
+        WebsocketRails.users.delete(user_identifier)
       end
 
       attr_accessor :pong

data/lib/websocket_rails/connection_manager.rb

@@ -41,6 +41,10 @@ module WebsocketRails
       end
     end
 
+    def inspect
+      "websocket_rails"
+    end
+
     # Primary entry point for the Rack application
     def call(env)
       request = ActionDispatch::Request.new(env)

data/lib/websocket_rails/controller_factory.rb

@@ -11,11 +11,11 @@ module WebsocketRails
 
     # TODO: Add deprecation notice for user defined
     # instance variables.
-    def new_for_event(event, controller_class)
+    def new_for_event(event, controller_class, method)
       controller_class = reload!(controller_class)
       controller = controller_class.new
 
-      prepare(controller, event)
+      prepare(controller, event, method)
 
       controller
     end
@@ -26,10 +26,11 @@ module WebsocketRails
       @controller_stores[controller.class] ||= DataStore::Controller.new(controller)
     end
 
-    def prepare(controller, event)
+    def prepare(controller, event, method)
       set_event(controller, event)
       set_dispatcher(controller, dispatcher)
       set_controller_store(controller)
+      set_action_name(controller, method)
       initialize_controller(controller)
     end
 
@@ -45,6 +46,10 @@ module WebsocketRails
       set_ivar :@_controller_store, controller, store_for_controller(controller)
     end
 
+    def set_action_name(controller, method)
+      set_ivar :@_action_name, controller, method
+    end
+
     def set_ivar(ivar, object, value)
       object.instance_variable_set(ivar, value)
     end
@@ -67,7 +72,7 @@ module WebsocketRails
         load "#{filename}.rb"
         return class_name.constantize
       end
-      
+
       return controller
     end
 

data/lib/websocket_rails/data_store.rb

@@ -102,8 +102,8 @@ module WebsocketRails
     #
     #
     #     class AccountController < WebsocketRails::BaseController
-    #       # We will use an Event Observer to set the initial value
-    #       observe { controller_store[:event_count] ||= 0 }
+    #       # We will use a before filter to set the initial value
+    #       before_action { controller_store[:event_count] ||= 0 }
     #
     #       # Mapped as `accounts.important_event` in the Event Router
     #       def important_event
@@ -114,11 +114,11 @@ module WebsocketRails
     #     end
     #
     #     class ProductController < WebsocketRails::BaseController
-    #       # We will use an Event Observer to set the initial value
-    #       observe { controller_store[:event_count] ||= 0 }
+    #       # We will use a before filter to set the initial value
+    #       before_action { controller_store[:event_count] ||= 0 }
     #
     #       # Mapped as `products.boring_event` in the Event Router
-    #       def boring_event 
+    #       def boring_event
     #         # This will be private for each controller
     #         controller_store[:event_count] += 1
     #         trigger_success controller_store[:event_count]

data/lib/websocket_rails/dispatcher.rb

@@ -27,6 +27,7 @@ module WebsocketRails
       if event.is_channel?
         WebsocketRails[event.channel].trigger_event event
       else
+        reload_event_map! unless event.is_internal?
         route event
       end
     end
@@ -41,6 +42,16 @@ module WebsocketRails
       end
     end
 
+    def reload_event_map!
+      return unless defined?(Rails) and !Rails.configuration.cache_classes
+      begin
+        load "#{Rails.root}/config/events.rb"
+        @event_map = EventMap.new(self)
+      rescue Exception => ex
+        log(:warn, "EventMap reload failed: #{ex.message}")
+      end
+    end
+
     private
 
     def route(event)
@@ -49,15 +60,9 @@ module WebsocketRails
         actions << Fiber.new do
           begin
             log_event(event) do
-              controller = controller_factory.new_for_event(event, controller_class)
-
-              controller.send(:execute_observers, event.name)
+              controller = controller_factory.new_for_event(event, controller_class, method)
 
-              if controller.respond_to?(method)
-                controller.send(method)
-              else
-                raise EventRoutingError.new(event, controller, method)
-              end
+              controller.process_action(method, event)
             end
           rescue Exception => ex
             event.success = false

data/lib/websocket_rails/event.rb

@@ -93,11 +93,11 @@ module WebsocketRails
     include Logging
     extend StaticEvents
 
-    attr_reader :id, :name, :connection, :namespace, :channel
+    attr_reader :id, :name, :connection, :namespace, :channel, :user_id
 
     attr_accessor :data, :result, :success, :server_token
 
-    def initialize(event_name,options={})
+    def initialize(event_name, options={})
       case event_name
       when String
         namespace   = event_name.split('.')
@@ -111,6 +111,7 @@ module WebsocketRails
       @channel      = options[:channel].to_sym if options[:channel]
       @connection   = options[:connection]
       @server_token = options[:server_token]
+      @user_id      = options[:user_id]
       @namespace    = validate_namespace( options[:namespace] || namespace )
     end
 
@@ -120,6 +121,7 @@ module WebsocketRails
         {
           :id => id,
           :channel => channel,
+          :user_id => user_id,
           :data => data,
           :success => success,
           :result => result,
@@ -132,6 +134,10 @@ module WebsocketRails
       !@channel.nil?
     end
 
+    def is_user?
+      !@user_id.nil? && !is_channel?
+    end
+
     def is_invalid?
       name == :invalid_event
     end
@@ -163,7 +169,5 @@ module WebsocketRails
       namespace.map(&:to_sym) rescue [:global]
     end
 
-
-
   end
 end

data/lib/websocket_rails/synchronization.rb

@@ -55,12 +55,18 @@ module WebsocketRails
           fiber_redis = Redis.connect(WebsocketRails.config.redis_options)
           fiber_redis.subscribe "websocket_rails.events" do |on|
 
-            on.message do |channel, encoded_event|
+            on.message do |_, encoded_event|
               event = Event.new_from_json(encoded_event, nil)
+
+              # Do nothing if this is the server that sent this event.
               next if event.server_token == server_token
 
+              # Ensure an event never gets triggered twice. Events added to the
+              # redis queue from other processes may not have a server token
+              # attached.
               event.server_token = server_token if event.server_token.nil?
-              WebsocketRails[event.channel].trigger_event(event)
+
+              trigger_incoming event
             end
           end
 
@@ -72,17 +78,28 @@ module WebsocketRails
         EM.next_tick { synchro.resume }
 
         trap('TERM') do
-          shutdown!
+          Thread.new { shutdown! }
         end
         trap('INT') do
-          shutdown!
+          Thread.new { shutdown! }
         end
         trap('QUIT') do
-          shutdown!
+          Thread.new { shutdown! }
         end
       end
     end
 
+    def trigger_incoming(event)
+      case
+      when event.is_channel?
+        WebsocketRails[event.channel].trigger_event(event)
+      when event.is_user?
+        connection = WebsocketRails.users[event.user_id]
+        return if connection.nil?
+        connection.trigger event
+      end
+    end
+
     def shutdown!
       remove_server(server_token)
     end
@@ -103,11 +120,9 @@ module WebsocketRails
     end
 
     def remove_server(token)
-      Fiber.new do
-        redis.srem "websocket_rails.active_servers", token
-        info "Server Removed: #{token}"
-        EM.stop
-      end.resume
+      ruby_redis.srem "websocket_rails.active_servers", token
+      info "Server Removed: #{token}"
+      EM.stop
     end
 
   end

data/lib/websocket_rails/user_manager.rb

@@ -0,0 +1,85 @@
+module WebsocketRails
+
+  # Contains a Hash of all connected users. This
+  # can be used to trigger an event on a specific
+  # user from outside of a WebsocketRails controller.
+  #
+  # The key for a particular user is defined in the
+  # configuration as `config.user_identifier`.
+  #
+  # If there is a `current_user` method defined
+  # in ApplicationController and a user is signed
+  # in to your application when the connection is
+  # opened, WebsocketRails will call the method
+  # defined in `config.user_identifier` on the
+  # `current_user` object and use that value as
+  # the key.
+  #
+  #   # In your events.rb file
+  #   WebsocketRails.setup do |config|
+  #     # Defaults to :id
+  #     config.user_identifier = :name
+  #   end
+  #
+  #   # In a standard controller or background job
+  #   name = current_user.name
+  #   WebsocketRails.users[name].send_message :event_name, data
+  #
+  # If no `current_user` method is defined or the
+  # user is not signed in when the WebsocketRails
+  # connection is opened, the key will default to
+  # `connection.id`.
+  def self.users
+    @user_manager ||= UserManager.new
+  end
+
+  class UserManager
+
+    attr_reader :users
+
+    def initialize
+      @users = {}
+    end
+
+    def [](identifier)
+      unless user = @users[identifier]
+        user = MissingUser.new(identifier)
+      end
+      user
+    end
+
+    def []=(identifier, connection)
+      @users[identifier] = connection
+    end
+
+    def delete(identifier)
+      @users.delete(identifier)
+    end
+
+    class MissingUser
+
+      def initialize(identifier)
+        @identifier = identifier
+      end
+
+      def send_message(event_name, data = {}, options = {})
+        if WebsocketRails.synchronize?
+          options.merge! :user_id => @identifier
+          options[:data] = data
+
+          event = Event.new(event_name, options)
+          Synchronization.publish event
+          true
+        else
+          false
+        end
+      end
+
+      def nil?
+        true
+      end
+
+    end
+
+  end
+end

data/lib/websocket_rails/version.rb

@@ -1,3 +1,3 @@
 module WebsocketRails
-  VERSION = "0.4.9"
+  VERSION = "0.5.0"
 end

data/spec/dummy/app/controllers/chat_controller.rb

@@ -1,53 +1,53 @@
 class ChatController < WebsocketRails::BaseController
 
-  observe {
+  before_action do
     if message_counter > 10
       self.message_counter = 0
     end
-  }
-  
-  observe(:new_message) {
+  end
+
+  before_action :only => :new_message do
     true
-  }
-  
+  end
+
   attr_accessor :message_counter
 
   def initialize
     # perform application setup here
     @message_counter = 0
   end
-  
+
   def client_connected
     # do something when a client connects
   end
-  
+
   def error_occurred
     # do something when an error occurs
   end
-    
+
   def new_message
     @message_counter += 1
     broadcast_message :new_message, message
   end
-  
+
   def new_user
     controller_store[:user] = message
     broadcast_user_list
   end
-  
+
   def change_username
     controller_store[:user] = message
     broadcast_user_list
   end
-  
+
   def delete_user
     controller_store[:user] = nil
     broadcast_user_list
   end
-  
+
   def broadcast_user_list
     users = ['user']
     broadcast_message :user_list, users
   end
-  
+
 end

data/spec/javascripts/generated/assets/websocket_connection.js

@@ -15,8 +15,12 @@ WebSocket Interface for the WebSocketRails client.
       this.on_close = __bind(this.on_close, this);
       this.on_message = __bind(this.on_message, this);
       this.trigger = __bind(this.trigger, this);
-      if (!this.url.match(/^wss?:\/\//)) {
+      if (this.url.match(/^wss?:\/\//)) {
+        console.log("WARNING: Using connection urls with protocol specified is depricated");
+      } else if (window.location.protocol === 'http:') {
         this.url = "ws://" + this.url;
+      } else {
+        this.url = "wss://" + this.url;
       }
       this.message_queue = [];
       this._conn = new WebSocket(this.url);

data/spec/unit/connection_adapters_spec.rb

@@ -43,6 +43,18 @@ module WebsocketRails
         it "should create a new DataStore::Connection instance" do
           subject.data_store.should be_a DataStore::Connection
         end
+
+        before do
+          WebsocketRails.config.stub(:user_identifier).and_return(:name)
+          WebsocketRails::DelegationController.any_instance
+            .stub_chain(:current_user, :name)
+            .and_return('Frank')
+          subject
+        end
+
+        it "adds itself to the UserManager Hash" do
+          WebsocketRails.users['Frank'].should == subject
+        end
       end
 
       describe "#on_open" do
@@ -69,6 +81,11 @@ module WebsocketRails
           dispatcher.should_receive(:dispatch).with(on_close_event)
           subject.on_close("data")
         end
+
+        it "removes itself from the global UserMnaager" do
+          subject.on_close
+          WebsocketRails.users[subject.id].nil?.should == true
+        end
       end
 
       describe "#on_error" do
@@ -87,9 +104,36 @@ module WebsocketRails
         end
       end
 
+      describe "#send_message" do
+        before do
+          Event.any_instance.stub(:trigger)
+        end
+        after do
+          subject.send_message :message, "some_data"
+        end
+
+        it "creates and triggers a new event" do
+          Event.any_instance.should_receive(:trigger)
+        end
+
+        it "sets it's user identifier on the event" do
+          subject.stub(:user_identifier).and_return(:some_name_or_id)
+          Event.should_receive(:new) do |name, options|
+            options[:user_id].should == :some_name_or_id
+          end.and_call_original
+        end
+
+        it "sets the connection property of the event correctly" do
+          subject.stub(:user_identifier).and_return(:some_name_or_id)
+          Event.should_receive(:new) do |name, options|
+            options[:connection].should == subject
+          end.and_call_original
+        end
+      end
+
       describe "#send" do
         it "should raise a NotImplementedError exception" do
-          expect { subject.send :message }.to raise_exception( NotImplementedError )
+          expect { subject.send :message }.to raise_exception(NotImplementedError)
         end
       end
 

data/spec/unit/controller_factory_spec.rb

@@ -38,37 +38,37 @@ module WebsocketRails
           rails_env = double(:rails_env)
           Rails.stub(:env).and_return rails_env
           rails_env.stub(:development?).and_return true
-          controller = subject.new_for_event(event, InternalController)
+          controller = subject.new_for_event(event, InternalController, 'some_method')
           controller.class.should == InternalController
         end
 
       end
 
       it "creates and returns a new controller instance" do
-        controller = subject.new_for_event(event, TestController)
+        controller = subject.new_for_event(event, TestController, 'some_method')
         controller.class.should == TestController
       end
 
       it "initializes the controller with the correct data_store" do
         store = double('data_store')
         subject.controller_stores[TestController] = store
-        controller = subject.new_for_event(event, TestController)
+        controller = subject.new_for_event(event, TestController, 'some_method')
         controller.controller_store.should == store
       end
 
       it "initializes the controller with the correct event" do
-        controller = subject.new_for_event(event, TestController)
+        controller = subject.new_for_event(event, TestController, 'some_method')
         controller.event.should == event
       end
 
       it "initializes the controller with the correct dispatcher" do
-        controller = subject.new_for_event(event, TestController)
+        controller = subject.new_for_event(event, TestController, 'some_method')
         controller._dispatcher.should == dispatcher
       end
 
       it "calls #initialize_session on the controller only once" do
         TestController.any_instance.should_receive(:initialize_session).once
-        3.times { subject.new_for_event(event, TestController) }
+        3.times { subject.new_for_event(event, TestController, 'some_method') }
       end
     end
 

data/spec/unit/dispatcher_spec.rb

@@ -20,21 +20,12 @@ def set_temp_module_const(mod, name, value, &block)
   mod.send(:remove_const, name)
 end
 
-
 module WebsocketRails
 
-
-
   class EventTarget
     attr_reader :_event, :_dispatcher, :test_method
-
-    def execute_observers(event_name)
-      true
-    end
   end
 
-
-
   describe Dispatcher do
 
     let(:event) { double('Event').as_null_object }
@@ -59,6 +50,7 @@ module WebsocketRails
 
     describe "#receive" do
       before { Event.stub(:new).and_return( event ) }
+
       it "should dispatch a new event" do
         subject.stub(:dispatch) do |dispatch_event|
           dispatch_event.should == event
@@ -79,7 +71,7 @@ module WebsocketRails
       end
 
       it "should execute the correct method on the target class" do
-        EventTarget.any_instance.should_receive(:test_method)
+        EventTarget.any_instance.should_receive(:process_action).with(:test_method, event)
         subject.dispatch(event)
       end
 
@@ -167,7 +159,6 @@ module WebsocketRails
 
       end
 
-
       context 'when ActiveRecord::RecordInvalid is not defined' do
 
         it 'should check that exception can be converted to JSON' do
@@ -181,6 +172,5 @@ module WebsocketRails
       end
 
     end
-
   end
 end

data/spec/unit/event_spec.rb

@@ -6,7 +6,7 @@ module WebsocketRails
     let(:encoded_message_string) { '["new_message",{"id":"1234","data":"this is a message"}]' }
     let(:namespace_encoded_message_string) { '["product.new_message",{"id":"1234","data":"this is a message"}]' }
     let(:namespace_encoded_message) { '["product.new_message",{"id":"1234","data":{"message":"this is a message"}}]' }
-    let(:channel_encoded_message_string) { '["new_message",{"id":"1234","channel":"awesome_channel","data":"this is a message","success":null,"result":null,"server_token":"1234"}]' }
+    let(:channel_encoded_message_string) { '["new_message",{"id":"1234","channel":"awesome_channel","user_id":null,"data":"this is a message","success":null,"result":null,"server_token":"1234"}]' }
     let(:synchronizable_encoded_message) { '["new_message",{"id":"1234","data":{"message":"this is a message"},"server_token":"1234"}]' }
     let(:connection) { double('connection') }
 
@@ -96,6 +96,13 @@ module WebsocketRails
       end
     end
 
+    describe "#is_user?" do
+      it "returns true if the event is meant for a specific user" do
+        event = Event.new "event", :data => "data", :user_id => :username
+        event.is_user?
+      end
+    end
+
     describe "#is_invalid?" do
       it "returns true if the event name is :invalid_event" do
         event = Event.new(:invalid_event)

data/spec/unit/synchronization_spec.rb

@@ -2,12 +2,23 @@ require "spec_helper"
 require "eventmachine"
 
 module WebsocketRails
+    #class Synchronization
+    #  def test_block(channel, &block)
+    #    # do nothing beyatch
+    #    block.call
+    #  end
+
+    #  def synchronize!
+    #    test_block("something") { raise "FTW!" }
+    #  end
+    #end
+
   describe Synchronization do
 
     around(:each) do |example|
       EM.run do
         Fiber.new do
-          @redis = Redis.new
+          @redis = Redis.new(WebsocketRails.config.redis_options)
           @redis.del "websocket_rails.active_servers"
           example.run
         end.resume
@@ -15,6 +26,7 @@ module WebsocketRails
     end
 
     after(:each) do
+      @redis.del "websocket_rails.active_servers"
       EM.stop
     end
 
@@ -30,36 +42,43 @@ module WebsocketRails
     end
 
     describe "#synchronize!" do
-      #before do
-      #  #@synchro = Synchronization.new
-      #end
-
-      #it "should receive remote channel events" do
-      #  event = Event.new(:channel_event, :channel => :channel_one, :data => 'hello channel one')
+      # need to add an integration test to cover this.
+    end
 
-      #  @redis.should_receive(:subscribe)
-      #  Redis.should_receive(:connect).with(WebsocketRails.redis_options).and_return(@redis)
+    describe "#trigger_incoming" do
+      context "when dispatching channel events" do
+        before do
+          @event = Event.new(:channel_event, :channel => :channel_one, :data => 'hello channel one')
+        end
 
-      #  Synchronization.new.synchronize!
+        it "triggers the event on the correct channel" do
+          WebsocketRails[:channel_one].should_receive(:trigger_event).with @event
+          subject.trigger_incoming @event
+        end
+      end
 
-      #  EM::Synchrony.sleep(0.5)
+      context "when dispatching user events" do
+        before do
+          @event = Event.new(:channel_event, :user_id => :username, :data => 'hello channel one')
+        end
 
-      #  redis = @redis
-      #  EM.next_tick { redis.publish "websocket_rails.events", event.serialize }
-      #end
-      it "should set server_token to stop circular publishing" do
-        event = Event.new(:redis_event, :channel => 'synchrony', :data => 'hello from another process')
-        if event.server_token.nil?
-          event.server_token = subject.server_token
+        context "and the user is not connected to this server" do
+          it "does nothing" do
+            subject.trigger_incoming(@event).should == nil
+          end
         end
-        event.server_token.should == subject.server_token
-      end
-      it "should not set server_token if it is present" do
-        event = Event.new(:redis_event, :channel => 'synchrony', :data => 'hello from another process', :server_token => '1234')
-        if event.server_token.nil?
-          event.server_token = subject.server_token
+
+        context "and the user is connected to this server" do
+          before do
+            @connection = double('Connection')
+            WebsocketRails.users[:username] = @connection
+          end
+
+          it "triggers the event on the correct user" do
+            WebsocketRails.users[:username].should_receive(:trigger).with @event
+            subject.trigger_incoming @event
+          end
         end
-        event.server_token.should == '1234'
       end
     end
 

data/spec/unit/user_manager_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+module WebsocketRails
+
+  describe ".users" do
+    it "returns the global instance of UserManager" do
+      WebsocketRails.users.should be_a UserManager
+    end
+
+    context "when synchronization is enabled" do
+      before do
+        WebsocketRails.stub(:synchronize?).and_return(true)
+      end
+
+      context "and the user is not connected to this worker" do
+        it "publishes the event to redis" do
+          Synchronization.should_receive(:publish) do |event|
+            event.user_id.should == :missing
+          end
+
+          WebsocketRails.users[:missing].send_message :test, :data
+        end
+      end
+    end
+  end
+
+  describe UserManager do
+
+    let(:connection) { double('Connection') }
+
+    describe "#[]=" do
+      it "store's a reference to a connection in the user's hash" do
+        subject[:username] = connection
+        subject.users[:username].should == connection
+      end
+    end
+
+    describe "#[]" do
+      before do
+        subject[:username] = connection
+      end
+
+      context "when passed a known user identifier" do
+        it "returns that user's connection" do
+          subject[:username].should == connection
+        end
+      end
+    end
+
+    describe "#delete" do
+      before do
+        subject[:username] = connection
+      end
+
+      it "deletes the connection from the users hash" do
+        subject.delete(:username)
+        subject[:username].should be_a UserManager::MissingUser
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -190,6 +190,7 @@ files:
 - lib/config.ru
 - lib/generators/websocket_rails/install/install_generator.rb
 - lib/generators/websocket_rails/install/templates/events.rb
+- lib/generators/websocket_rails/install/templates/websocket_rails.rb
 - lib/rails/app/controllers/websocket_rails/delegation_controller.rb
 - lib/rails/config/routes.rb
 - lib/rails/tasks/websocket_rails.tasks
@@ -216,6 +217,7 @@ files:
 - lib/websocket_rails/logging.rb
 - lib/websocket_rails/spec_helpers.rb
 - lib/websocket_rails/synchronization.rb
+- lib/websocket_rails/user_manager.rb
 - lib/websocket_rails/version.rb
 - bin/thin-socketrails
 - spec/dummy/app/controllers/application_controller.rb
@@ -294,6 +296,7 @@ files:
 - spec/unit/logging_spec.rb
 - spec/unit/synchronization_spec.rb
 - spec/unit/target_validator_spec.rb
+- spec/unit/user_manager_spec.rb
 - MIT-LICENSE
 - Rakefile
 - Gemfile
@@ -301,7 +304,7 @@ files:
 - CHANGELOG.md
 homepage: http://danknox.github.com/websocket-rails/
 licenses: []
-post_install_message: Welcome to WebsocketRails v0.4.9!
+post_install_message: Welcome to WebsocketRails v0.5.0!
 rdoc_options: []
 require_paths:
 - lib
@@ -313,7 +316,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2441396343706207267
+      hash: -3442295277156714841
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -322,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2441396343706207267
+      hash: -3442295277156714841
 requirements: []
 rubyforge_project: websocket-rails
 rubygems_version: 1.8.25