websocket-rails 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,19 +1,60 @@
 # WebsocketRails Change Log
 
+February 27 2013
+
+## Version 0.4.0
+
+__There have been a few breaking changes in the public API since the
+last release. Please review the list below and consult the Wiki for more
+information regarding the usage of the new features.__
+
+* Controller instances no longer persist between events that are
+  triggered. Each event is processed by a new controller instance,
+similar to a standard Rails request. Since you can no longer use
+instance variables to temporarily persist data between events, there is
+a new Controller Data Store that can be used for this purpose. This
+change addresses issue #31.
+
+* The original DataStore class has been deprecated. In it's place are
+  the new Controller Data Store and Connection Data Store. As mentioned
+above, the Controller Data Store can be used to persist data between
+events in much the same way that you would use instance variables. The
+Connection Data Store acts like the Rails session store. Use it to store
+data private to a connection. Data in the Connection Data Store can be
+accessed from any controller. Check out the Wiki for more information on
+both.
+
+* The `websocket_rails.reload_controllers` event has been deprecated.
+  The new Controller instantiation model allows for automatic controller
+class reloading while in the development environment. You no longer
+need to trigger an event to pick up code changes in controllers while
+connections are active.
+
+* Real logging support has _finally_ been implemented. Check out the
+  configuration WIki for more information on the various logging options
+available.
+
 ## Version 0.3.0
 
+February 6 2013
+
 * Extend the event router DSL to accept routes similar to the routes.rb
   shorthand `controller#action`. - Thanks to @nessche.
+
 * Add a custom RSpec matcher suite for verifying event routes
   and easily asserting that WebsocketRails controller actions are
   triggering  events correctly. - Also thanks to @nessche.
+
 * Fix fiber yielded across threads bug when running in standalone mode
   by disabling Thin threaded mode as default option.
 
 ## Version 0.2.1
 
+January 29 2013
+
 * Fix default redis driver issue that was causing problems when using
   redis while event machine was not running.
+
 * Fix undefined data store value issue. Thanks to @burninggramma.
 
 ## Version 0.2.0

data/README.md

@@ -203,7 +203,7 @@ Read the [Private Channel Wiki](https://github.com/DanKnox/websocket-rails/wiki/
 private channels from the JavaScript client and handling the
 authorization in your controller.
 
-## Credit where credit is due.
+## Credit where credit is due
 
 Big thanks to our
 [contributors](https://github.com/DanKnox/websocket-rails/graphs/contributors)

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

@@ -1,21 +1,31 @@
 WebsocketRails.setup do |config|
 
-  # Change to :debug for debugging output
-  config.log_level = :default
+  # 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
+  # * Requires Redis
   config.standalone = false
 
   # Change to true to enable channel synchronization between
-  # multiple server instances. Requires Redis.
+  # 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'}
+  # config.redis_options = {:host => 'localhost', :port => '6379'}
 end
 
 WebsocketRails::EventMap.describe do

data/lib/rails/tasks/websocket_rails.tasks

@@ -1,14 +1,12 @@
 namespace :websocket_rails do
-  desc 'Test rails task'
+  desc 'Start the WebsocketRails standalone server.'
   task :start_server do
     require "thin"
     load "#{Rails.root}/config/initializers/events.rb"
 
-    options = WebsocketRails.thin_options
+    options = WebsocketRails.config.thin_options
 
-    unless WebsocketRails.standalone?
-      warn_standalone_not_enabled!
-    end
+    warn_if_standalone_not_enabled!
 
     fork do
       Thin::Controllers::Controller.new(options).start
@@ -17,21 +15,21 @@ namespace :websocket_rails do
     puts "Websocket Rails Standalone Server listening on port #{options[:port]}"
   end
 
+  desc 'Stop the WebsocketRails standalone server.'
   task :stop_server do
     require "thin"
     load "#{Rails.root}/config/initializers/events.rb"
 
-    options = WebsocketRails.thin_options
+    options = WebsocketRails.config.thin_options
 
-    unless WebsocketRails.standalone?
-      warn_standalone_not_enabled!
-    end
+    warn_if_standalone_not_enabled!
 
     Thin::Controllers::Controller.new(options).stop
   end
 end
 
-def warn_standalone_not_enabled!
+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."
   exit 1

data/lib/spec_helpers/matchers/route_matchers.rb

@@ -9,8 +9,9 @@ module WebsocketRails
 
         result = false
         no_of_routes = 0
-        event.dispatcher.event_map.routes_for event do |controller, method|
+        event.dispatcher.event_map.routes_for event do |controller_class, method|
           no_of_routes += 1
+          controller = controller_class.new
           if controller.class == target_class and method == target_method
             result = true
           end

data/lib/spec_helpers/spec_helper_event.rb

@@ -21,6 +21,10 @@ module WebsocketRails
       self
     end
 
+    def connection
+      OpenStruct.new(:id => 1)
+    end
+
   end
 
 end

data/lib/websocket-rails.rb

@@ -1,92 +1,41 @@
 require "active_support/dependencies"
-require 'thin'
+require "logger"
+require "thin"
 
 module WebsocketRails
-  mattr_accessor :app_root
 
-  def self.setup
-    yield self
-  end
-
-  def self.route_block=(routes)
-    @event_routes = routes
-  end
-
-  def self.route_block
-    @event_routes
-  end
+  class << self
+    def setup
+      yield config
+    end
 
-  def self.log_level
-    @log_level ||= :warn
-  end
+    def config
+      @config ||= Configuration.new
+    end
 
-  def self.log_level=(level)
-    @log_level = level
-  end
+    def synchronize?
+      config.synchronize == true || config.standalone == true
+    end
 
-  attr_accessor :synchronize
-  module_function :synchronize, :synchronize=
+    def standalone?
+      config.standalone == true
+    end
 
-  def self.synchronize?
-    (@synchronize == true) || (@standalone == true)
+    def logger
+      config.logger
+    end
   end
 
-  def self.redis_options
-    @redis_options ||= redis_defaults
-  end
-
-  def self.redis_options=(options = {})
-    @redis_options = redis_defaults.merge(options)
-  end
-
-  def self.redis_defaults
-    {:host => '127.0.0.1', :port => 6379, :driver => :synchrony}
-  end
-
-  attr_accessor :standalone
-  module_function :standalone, :standalone=
-
-  def self.standalone?
-    @standalone == true
-  end
-
-  def self.standalone_port
-    @standalone_port ||= '3001'
-  end
-
-  def self.standalone_port=(port)
-    @standalone_port = port
-  end
-
-  def self.thin_options
-    @thin_options ||= thin_defaults
-  end
-
-  def self.thin_options=(options = {})
-    @thin_options = thin_defaults.merge(options)
-  end
-
-  def self.thin_defaults
-    {
-      :port => standalone_port,
-      :pid => "#{Rails.root}/tmp/pids/websocket_rails.pid",
-      :log => "#{Rails.root}/log/websocket_rails.log",
-      :tag => 'websocket_rails',
-      :rackup => "#{Rails.root}/config.ru",
-      :threaded => false,
-      :daemonize => true,
-      :dirname => Rails.root,
-      :max_persistent_conns => 1024,
-      :max_conns => 1024
-    }
-  end
 end
 
 require 'websocket_rails/engine'
+
+require 'websocket_rails/configuration'
 require 'websocket_rails/logging'
 require 'websocket_rails/synchronization'
 require 'websocket_rails/connection_manager'
 require 'websocket_rails/dispatcher'
+require 'websocket_rails/controller_factory'
 require 'websocket_rails/event'
 require 'websocket_rails/event_map'
 require 'websocket_rails/event_queue'
@@ -99,13 +48,41 @@ require 'websocket_rails/connection_adapters'
 require 'websocket_rails/connection_adapters/http'
 require 'websocket_rails/connection_adapters/web_socket'
 
+
 # Exceptions
-class InvalidConnectionError < StandardError
+class WebsocketRails::InvalidConnectionError < StandardError
   def rack_response
     [400,{'Content-Type' => 'text/plain'},['invalid connection']]
   end
 end
 
+class WebsocketRails::EventRoutingError < StandardError
+
+  attr_reader :event, :controller, :method
+
+  def initialize(event, controller, method)
+    @event = event
+    @controller = controller
+  end
+
+  def to_s
+    out =  "Routing Error:\n"
+    out << "Event: #{event.name}\n"
+    out << "Controller #{controller.class} does not respond to #{method}"
+    out
+  end
+
+  def to_json
+    super({
+      error: "EventRoutingError",
+      event: event.name,
+      method: method,
+      reason: "Controller #{controller.class} does not respond to #{method}"
+    })
+  end
+
+end
+
 # Deprecation Notices
 class WebsocketRails::Dispatcher
   def self.describe_events(&block)

data/lib/websocket_rails/base_controller.rb

@@ -1,4 +1,4 @@
-require 'websocket_rails/data_store'
+require "websocket_rails/data_store"
 
 module WebsocketRails
   # Provides controller helper methods for developing a WebsocketRails controller. Action methods
@@ -18,6 +18,8 @@ module WebsocketRails
   #
   class BaseController
 
+    # Tell Rails that BaseController and children can be reloaded when in
+    # the Development environment.
     def self.inherited(controller)
       unloadable controller
     end
@@ -49,10 +51,6 @@ module WebsocketRails
     # Stores the observer Procs for the current controller. See {observe} for details.
     @@observers = Hash.new {|h,k| h[k] = Array.new}
 
-    def initialize
-      @data_store = DataStore.new(self)
-    end
-
     # Provides direct access to the connection object for the client that
     # initiated the event that is currently being executed.
     def connection
@@ -142,8 +140,12 @@ module WebsocketRails
     # Provides access to the {DataStore} for the current controller. The {DataStore} provides convenience
     # methods for keeping track of data associated with active connections. See it's documentation for
     # more information.
-    def data_store
-      @data_store
+    def controller_store
+      @_controller_store
+    end
+
+    def connection_store
+      connection.data_store
     end
 
     private

data/lib/websocket_rails/channel.rb

@@ -12,10 +12,16 @@ module WebsocketRails
     end
 
     def subscribe(connection)
-      log "#{connection} subscribed to channel #{name}"
+      info "#{connection} subscribed to channel #{name}"
       @subscribers << connection
     end
 
+    def unsubscribe(connection)
+      return unless @subscribers.include? connection
+      info "#{connection} unsubscribed from channel #{name}"
+      @subscribers.delete connection
+    end
+
     def trigger(event_name,data={},options={})
       options.merge! :channel => name
       options[:data] = data
@@ -26,6 +32,7 @@ module WebsocketRails
     end
 
     def trigger_event(event)
+      info "(processing_channel_event) name: #{event.name} namespace: #{event.namespace} connection: #{event.connection.id}"
       send_data event
     end
 

data/lib/websocket_rails/channel_manager.rb

@@ -26,5 +26,11 @@ module WebsocketRails
       @channels[channel] ||= Channel.new channel
     end
 
+    def unsubscribe(connection)
+      @channels.each do |channel_name, channel|
+        channel.unsubscribe(connection)
+      end
+    end
+
   end
 end

data/lib/websocket_rails/configuration.rb

@@ -0,0 +1,112 @@
+module WebsocketRails
+  class Configuration
+
+    def route_block=(routes)
+      @event_routes = routes
+    end
+
+    def route_block
+      @event_routes
+    end
+
+    def log_level
+      @log_level ||= begin
+        case Rails.env.to_sym
+        when :production then :info
+        when :development then :debug
+        end
+      end
+    end
+
+    def log_level=(level)
+      @log_level = level
+    end
+
+    def logger
+      @logger ||= begin
+        logger = Logger.new(log_path)
+        Logging.configure(logger)
+      end
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+
+    def log_path
+      @log_path ||= "#{Rails.root}/log/websocket_rails.log"
+    end
+
+    def log_path=(path)
+      @log_path = path
+    end
+
+    def log_internal_events?
+      @log_internal_events ||= false
+    end
+
+    def log_internal_events=(value)
+      @log_internal_events = value
+    end
+
+    def synchronize
+      @synchronize ||= false
+    end
+
+    def synchronize=(synchronize)
+      @synchronize = synchronize
+    end
+
+    def redis_options
+      @redis_options ||= redis_defaults
+    end
+
+    def redis_options=(options = {})
+      @redis_options = redis_defaults.merge(options)
+    end
+
+    def redis_defaults
+      {:host => '127.0.0.1', :port => 6379, :driver => :synchrony}
+    end
+
+    def standalone
+      @standalone ||= false
+    end
+
+    def standalone=(standalone)
+      @standalone = standalone
+    end
+
+    def standalone_port
+      @standalone_port ||= '3001'
+    end
+
+    def standalone_port=(port)
+      @standalone_port = port
+    end
+
+    def thin_options
+      @thin_options ||= thin_defaults
+    end
+
+    def thin_options=(options = {})
+      @thin_options = thin_defaults.merge(options)
+    end
+
+    def thin_defaults
+      {
+        :port => standalone_port,
+        :pid => "#{Rails.root}/tmp/pids/websocket_rails.pid",
+        :log => "#{Rails.root}/log/websocket_rails_server.log",
+        :tag => 'websocket_rails',
+        :rackup => "#{Rails.root}/config.ru",
+        :threaded => false,
+        :daemonize => true,
+        :dirname => Rails.root,
+        :max_persistent_conns => 1024,
+        :max_conns => 1024
+      }
+    end
+
+  end
+end