wwl-websocket-rails 0.7.1

data/lib/websocket_rails/user_manager.rb

@@ -0,0 +1,276 @@
+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 connection will not be
+  # stored in the UserManager.
+  def self.users
+    @user_manager ||= UserManager.new
+  end
+
+  class UserManager
+
+    attr_reader :users
+
+    def initialize
+      @users = {}
+    end
+
+    def [](identifier)
+      unless user = (@users[identifier.to_s] || find_remote_user(identifier.to_s))
+        user = MissingConnection.new(identifier.to_s)
+      end
+      user
+    end
+
+    def []=(identifier, connection)
+      @users[identifier.to_s] ||= LocalConnection.new
+      @users[identifier.to_s] << connection
+      Synchronization.register_user(connection) if WebsocketRails.synchronize?
+    end
+
+    def delete(connection)
+      identifier = connection.user_identifier.to_s
+
+      if (@users.has_key?(identifier) && @users[identifier].connections.count > 1)
+        @users[identifier].delete(connection)
+      else
+        @users.delete(identifier)
+        Synchronization.destroy_user(identifier) if WebsocketRails.synchronize?
+      end
+    end
+
+    # Behaves similarly to Ruby's Array#each, yielding each connection
+    # object stored in the {UserManager}. If synchronization is enabled,
+    # each connection from every active worker will be yielded.
+    #
+    # You can access the `current_user` object through the #user method.
+    #
+    # You can trigger an event on this user using the #send_message method
+    # which behaves identically to BaseController#send_message.
+    #
+    # If Synchronization is enabled, the state of the `current_user` object
+    # will be equivalent to it's state at the time the connection was opened.
+    # It will not reflect changes made after the connection has been opened.
+    def each(&block)
+      if WebsocketRails.synchronize?
+        users_hash = Synchronization.all_users || return
+        users_hash.each do |identifier, user_json|
+          connection = remote_connection_from_json(identifier, user_json)
+          block.call(connection) if block
+        end
+      else
+        users.each do |_, connection|
+          block.call(connection) if block
+        end
+      end
+    end
+
+    # Behaves similarly to Ruby's Array#map, invoking the given block with
+    # each active connection object and returning a new array with the results.
+    #
+    # See UserManager#each for details on the current usage and limitations.
+    def map(&block)
+      collection = []
+
+      each do |connection|
+        collection << block.call(connection) if block
+      end
+
+      collection
+    end
+
+    private
+
+    def find_remote_user(identifier)
+      return unless WebsocketRails.synchronize?
+      user_hash = Synchronization.find_user(identifier) || return
+
+      remote_connection identifier, user_hash
+    end
+
+    def remote_connection_from_json(identifier, user_json)
+      user_hash = JSON.parse(user_json)
+      remote_connection identifier, user_hash
+    end
+
+    def remote_connection(identifier, user_hash)
+      RemoteConnection.new identifier, user_hash
+    end
+
+    # The UserManager::LocalConnection Class serves as a proxy object
+    # for storing multiple connections that belong to the same
+    # user. It implements the same basic interface as a Connection.
+    # This allows you to work with the object as though it is a
+    # single connection, but still trigger the events on all
+    # active connections belonging to the user.
+    class LocalConnection
+
+      attr_reader :connections
+
+      def initialize
+        @connections = []
+      end
+
+      def <<(connection)
+        @connections << connection
+      end
+
+      def delete(connection)
+        @connections.delete(connection)
+      end
+
+      def connected?
+        true
+      end
+
+      def user_identifier
+        latest_connection.user_identifier
+      end
+
+      def user
+        latest_connection.user
+      end
+
+      def trigger(event)
+        connections.each do |connection|
+          connection.trigger event
+        end
+      end
+
+      def send_message(event_name, data = {}, options = {})
+        options.merge! :user_id => user_identifier
+        options[:data] = data
+
+        event = Event.new(event_name, options)
+
+        # Trigger the event on all active connections for this user.
+        connections.each do |connection|
+          connection.trigger event
+        end
+
+        # Still publish the event in case the user is connected to
+        # other workers as well.
+        Synchronization.publish event if WebsocketRails.synchronize?
+        true
+      end
+
+      private
+
+      def latest_connection
+        @connections.last
+      end
+
+    end
+
+    class RemoteConnection
+
+      attr_reader :user_identifier, :user
+
+      def initialize(identifier, user_hash)
+        @user_identifier = identifier.to_s
+        @user_hash = user_hash
+      end
+
+      def connected?
+        true
+      end
+
+      def user
+        @user ||= load_user
+      end
+
+      def send_message(event_name, data = {}, options = {})
+        options.merge! :user_id => @user_identifier
+        options[:data] = data
+
+        event = Event.new(event_name, options)
+
+        # If the user is connected to this worker, trigger the event
+        # immediately as the event will be ignored by the Synchronization
+        ## dispatcher since the server_token will match.
+        if connection = WebsocketRails.users.users[@user_identifier]
+          connection.trigger event
+        end
+
+        # Still publish the event in case the user is connected to
+        # other workers as well.
+        #
+        # No need to check for Synchronization being enabled here.
+        # If a RemoteConnection has been fetched, Synchronization
+        # must be enabled.
+        Synchronization.publish event
+        true
+      end
+
+      private
+
+      def load_user
+        user = WebsocketRails.config.user_class.new
+        set_user_attributes user, @user_hash
+        user
+      end
+
+      def set_user_attributes(user, attr)
+        attr.each do |k, v|
+          user.send "#{k}=", v
+        end
+        user.instance_variable_set(:@new_record, false)
+        user.instance_variable_set(:@destroyed, false)
+      end
+
+    end
+
+    class MissingConnection
+
+      attr_reader :identifier
+
+      def initialize(identifier)
+        @user_identifier = identifier.to_s
+      end
+
+      def connected?
+        false
+      end
+
+      def user
+        nil
+      end
+
+      def send_message(*args)
+        false
+      end
+
+      def nil?
+        true
+      end
+
+    end
+
+  end
+end

data/lib/websocket_rails/version.rb

@@ -0,0 +1,3 @@
+module WebsocketRails
+  VERSION = "0.7.1"
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

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

@@ -0,0 +1,53 @@
+class ChatController < WebsocketRails::BaseController
+
+  before_action do
+    if message_counter > 10
+      self.message_counter = 0
+    end
+  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/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "websocket-rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,34 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  config.eager_load = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/events.rb

@@ -0,0 +1,7 @@
+WebsocketRails::EventMap.describe do
+  subscribe :client_connected, :to => ChatController, :with_method => :client_connected
+  subscribe :new_message, :to => ChatController, :with_method => :new_message
+  subscribe :new_user, :to => ChatController, :with_method => :new_user
+  subscribe :change_username, :to => ChatController, :with_method => :change_username
+  subscribe :client_disconnected, :to => ChatController, :with_method => :delete_user
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = 'b30db6f11a8e3681be5f5ceed18fe20a5d42ffccb172feac3788c178a2bbf681576a9a277abc1170fbf8d7b67b14bd4e8325eea93ded57eb3d9c3265fb2a3670'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"