hkroger-websocket-rails 0.7.1

data/lib/config.ru

@@ -0,0 +1,3 @@
+require "websocket-rails"
+
+run WebsocketRails::ConnectionManager.new

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

@@ -0,0 +1,33 @@
+require 'rails'
+
+module WebsocketRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Create the events.rb initializer and require the JS client in the application.js manifest."
+
+      class_option :manifest, :type => :string, :aliases => "-m", :default => 'application.js',
+                   :desc => "Javascript manifest file to modify (or create)"
+
+      def create_events_initializer_file
+        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
+        manifest = options[:manifest]
+        js_path  = "app/assets/javascripts"
+
+        create_file("#{js_path}/#{manifest}") unless File.exists?("#{js_path}/#{manifest}")
+
+        append_to_file "#{js_path}/#{manifest}" do
+          out = ""
+          out << "//= require websocket_rails/main"
+          out << "\n"
+          out << "\n"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+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
+  # actions will be executed in the order they were subscribed.
+  #
+  # Uncomment and edit the next line to handle the client connected event:
+  #   subscribe :client_connected, :to => Controller, :with_method => :method_name
+  #
+  # Here is an example of mapping namespaced events:
+  #   namespace :product do
+  #     subscribe :new, :to => ProductController, :with_method => :new_product
+  #   end
+  # The above will handle an event triggered on the client like `product.new`.
+end

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

@@ -0,0 +1,63 @@
+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
+
+  # Prevent Thin from daemonizing (default is true)
+  # config.daemonize = 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
+
+  # Set to true if you wish to broadcast channel subscriber_join and
+  # subscriber_part events. All subscribers of a channel will be 
+  # notified when other clients join and part the channel. If you are
+  # using the UserManager, the current_user object will be sent along
+  # with the event.
+  # config.broadcast_subscriber_events = true
+
+  # 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
+
+  # Uncomment and change this option to override the class associated
+  # with your `current_user` object. This class will be used when
+  # synchronization is enabled and you trigger events from background
+  # jobs using the WebsocketRails.users UserManager.
+  # config.user_class = User
+
+  # Supporting HTTP streaming on Internet Explorer versions 8 & 9
+  # requires CORS to be enabled for GET "/websocket" request.
+  # List here the origin domains allowed to perform the request.
+  # config.allowed_origins = ['http://localhost:3000']
+
+end

data/lib/hkroger-websocket-rails.rb

@@ -0,0 +1 @@
+require "websocket-rails"

data/lib/rails/app/controllers/websocket_rails/delegation_controller.rb

@@ -0,0 +1,13 @@
+module WebsocketRails
+  # This class provides a means for accessing the Rails
+  # controller helper methods defined in a user's application
+  # or in gems that the user has added to the project.
+  #
+  # Each active connection creates and stores it's own
+  # instance with the correct @_request and @_env objects
+  # set. WebsocketRails::BaseController sends missing
+  # methods to the active connection's delegation controller
+  # instance.
+  class DelegationController < ApplicationController
+  end
+end

data/lib/rails/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  if Rails.version >= '4.0.0'
+    match "/websocket", :to => WebsocketRails::ConnectionManager.new, via: [:get, :post]
+  else
+    match "/websocket", :to => WebsocketRails::ConnectionManager.new
+  end
+end

data/lib/rails/tasks/websocket_rails.tasks

@@ -0,0 +1,42 @@
+namespace :websocket_rails do
+  desc 'Start the WebsocketRails standalone server.'
+  task :start_server do
+    require "thin"
+    load "#{Rails.root}/config/initializers/websocket_rails.rb"
+    load "#{Rails.root}/config/events.rb"
+
+    options = WebsocketRails.config.thin_options
+
+    warn_if_standalone_not_enabled!
+
+    if options[:daemonize]
+      fork do
+        Thin::Controllers::Controller.new(options).start
+      end
+    else
+        Thin::Controllers::Controller.new(options).start
+    end
+
+    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/websocket_rails.rb"
+    load "#{Rails.root}/config/events.rb"
+
+    options = WebsocketRails.config.thin_options
+
+    warn_if_standalone_not_enabled!
+
+    Thin::Controllers::Controller.new(options).stop
+  end
+end
+
+def warn_if_standalone_not_enabled!
+  return if WebsocketRails.standalone?
+  puts "Fail!"
+  puts "You must enable standalone mode in your websocket_rails.rb initializer to use the standalone server."
+  exit 1
+end

data/lib/spec_helpers/matchers/route_matchers.rb

@@ -0,0 +1,65 @@
+module WebsocketRails
+
+  module SpecHelpers
+
+      def self.verify_route(event, target, non_exclusive)
+
+        raise ArgumentError, 'event must be of type SpecHelperEvent' unless event.is_a? WebsocketRails::SpecHelperEvent
+        target_class, target_method = WebsocketRails::TargetValidator.validate_target target
+
+        result = false
+        no_of_routes = 0
+        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
+        end
+        result and (non_exclusive or no_of_routes == 1)
+      end
+
+  end
+
+end
+
+
+RSpec::Matchers.define :be_routed_to do |target|
+
+  match do |event|
+    WebsocketRails::SpecHelpers.verify_route event, target, true
+  end
+
+  failure_message_for_should do |event|
+    "expected event #{event.name} to be routed to target #{target}"
+  end
+
+  failure_message_for_should_not do |event|
+    "expected event #{event.name} not to be routed to target #{target}"
+  end
+
+  description do
+    "be routed to target #{target}"
+  end
+
+end
+
+RSpec::Matchers.define :be_routed_only_to do |target|
+
+  match do |event|
+    WebsocketRails::SpecHelpers.verify_route event, target, false
+  end
+
+  failure_message_for_should do |event|
+    "expected event #{event.name} to be routed only to target #{target}"
+  end
+
+  failure_message_for_should_not do |event|
+    "expected event #{event.name} not to be routed only to target #{target}"
+  end
+
+  description do
+    "be routed only to target #{target}"
+  end
+
+end

data/lib/spec_helpers/matchers/trigger_matchers.rb

@@ -0,0 +1,113 @@
+module WebsocketRails
+
+  module SpecHelpers
+
+    def self.compare_trigger_data(event, data)
+      return true if data.nil?
+      return true if data == :any and event.data
+      return true if data == :nil and event.data.nil?
+      data.eql? event.data
+    end
+
+    def self.expected_data_for_spec_message(data)
+      case data
+        when nil
+          ''
+        when :nil
+          ' with no data'
+        when :any
+          ' with some data'
+        else
+          " with data #{data}"
+      end
+    end
+
+    def self.actual_data_for_spec_message(data)
+      data ? "with data #{data}": 'with no data'
+    end
+
+    def self.actual_for_spec_message(event, success)
+      if event.triggered?
+        if success.nil?
+          "triggered message #{actual_data_for_spec_message(event.data)}"
+        else
+          "triggered #{event.success ? 'a success' : 'a failure' } message #{actual_data_for_spec_message(event.data)}"
+        end
+      else
+        'did not trigger any message'
+      end
+    end
+
+    def self.verify_trigger(event, data, success)
+      return false unless event.triggered?
+      return false unless compare_trigger_data(event, data)
+      success.nil? || success == event.success
+    end
+
+  end
+
+end
+
+
+RSpec::Matchers.define :trigger_message do |data|
+
+  match do |event|
+    WebsocketRails::SpecHelpers.verify_trigger event, data, nil
+  end
+
+  failure_message_for_should do |event|
+    "expected #{event.encoded_name} to trigger message#{WebsocketRails::SpecHelpers.expected_data_for_spec_message data}, " +
+        "instead it #{WebsocketRails::SpecHelpers.actual_for_spec_message event, nil}"
+  end
+
+  failure_message_for_should_not do |event|
+    "expected #{event.encoded_name} not to trigger message#{WebsocketRails::SpecHelpers.expected_data_for_spec_message data}"
+  end
+
+  description do
+    "trigger message#{WebsocketRails::SpecHelpers.expected_data_for_spec_message data}"
+  end
+
+end
+
+RSpec::Matchers.define :trigger_success_message do |data|
+
+  match do |event|
+    WebsocketRails::SpecHelpers.verify_trigger event, data, true
+  end
+
+  failure_message_for_should do |event|
+    "expected #{event.encoded_name} to trigger success message#{WebsocketRails::SpecHelpers.expected_data_for_spec_message data}, "+
+        "instead it #{WebsocketRails::SpecHelpers.actual_for_spec_message event, true}"
+  end
+
+  failure_message_for_should_not do |event|
+    "expected #{event.encoded_name} not to trigger success message#{WebsocketRails::SpecHelpers.expected_data_for_spec_message data}"
+  end
+
+  description do
+    "trigger success message#{WebsocketRails::SpecHelpers.expected_data_for_spec_message data}"
+  end
+
+end
+
+RSpec::Matchers.define :trigger_failure_message do |data|
+
+  match do |event|
+    WebsocketRails::SpecHelpers.verify_trigger event, data, false
+  end
+
+  failure_message_for_should do |event|
+    "expected #{event.encoded_name} to trigger failure message#{WebsocketRails::SpecHelpers.expected_data_for_spec_message data}, " +
+        "instead it #{WebsocketRails::SpecHelpers.actual_for_spec_message event, true}"
+  end
+
+  failure_message_for_should_not do |event|
+    "expected #{event.encoded_name} not to trigger failure message#{WebsocketRails::SpecHelpers.expected_data_for_spec_message data}"
+  end
+
+  description do
+    "trigger failure message#{WebsocketRails::SpecHelpers.expected_data_for_spec_message data}"
+  end
+
+end

data/lib/spec_helpers/spec_helper_event.rb

@@ -0,0 +1,34 @@
+module WebsocketRails
+
+  class SpecHelperEvent < Event
+
+    attr_reader :dispatcher, :triggered
+
+    alias :triggered? :triggered
+
+    def initialize(event_name,options={})
+      super(event_name, options)
+      @triggered = false
+      @dispatcher =  Dispatcher.new(nil)
+    end
+
+    def trigger
+      @triggered = true
+    end
+
+    def dispatch
+      @dispatcher.dispatch(self)
+      self
+    end
+
+    def connection
+      OpenStruct.new(:id => 1)
+    end
+
+  end
+
+end
+
+def create_event(name, data)
+  WebsocketRails::SpecHelperEvent.new(name, {data: data})
+end

data/lib/websocket-rails.rb

@@ -0,0 +1,108 @@
+require "active_support/dependencies"
+require "logger"
+require "thin"
+
+module WebsocketRails
+
+  class << self
+    def setup
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def synchronize?
+      config.synchronize == true || config.standalone == true
+    end
+
+    def standalone?
+      config.standalone == true
+    end
+
+    def logger
+      config.logger
+    end
+  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'
+require 'websocket_rails/channel'
+require 'websocket_rails/channel_manager'
+require 'websocket_rails/user_manager'
+require 'websocket_rails/base_controller'
+require 'websocket_rails/internal_events'
+
+require 'websocket_rails/connection_adapters'
+require 'websocket_rails/connection_adapters/http'
+require 'websocket_rails/connection_adapters/web_socket'
+
+# Exceptions
+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
+
+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)
+    raise "This method has been deprecated. Please use WebsocketRails::EventMap.describe instead."
+  end
+end
+class WebsocketRails::Events
+  def self.describe_events(&block)
+    raise "This method has been deprecated. Please use WebsocketRails::EventMap.describe instead."
+  end
+end