hkroger-websocket-rails 0.7.1

data/spec/unit/target_validator_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+
+class ComplexProductController < WebsocketRails::BaseController
+
+  def simplify
+  end
+
+end
+
+module MyModule
+
+  class AnotherController < WebsocketRails::BaseController
+
+    def complicate
+    end
+
+  end
+
+  module MySubModule
+
+    class AThirdController < WebsocketRails::BaseController
+
+      def confuse
+      end
+
+    end
+
+  end
+
+end
+
+
+module WebsocketRails
+
+  describe TargetValidator do
+
+    describe 'validate_target' do
+
+      it 'should raise an error when target class is not supported' do
+        expect{TargetValidator.validate_target(50)}.to raise_error
+      end
+
+      it 'should raise if passed hash does not contain the to: key' do
+        expect{TargetValidator.validate_target(from: ComplexProductController, with_method: :simplify)}.to raise_error
+      end
+
+      it 'should raise if passed hash does not contain the with_method: key' do
+        expect{TargetValidator.validate_target(to: ComplexProductController, without_method: :simplify)}.to raise_error
+      end
+
+      it 'should raise if the string is not in the correct format' do
+        expect{TargetValidator.validate_target('malformed_string')}.to raise_error
+        expect{TargetValidator.validate_target('very#malformed#string')}.to raise_error
+      end
+
+      it 'should raise if the class specified in the String does not exist' do
+        expect{TargetValidator.validate_target('my_non_existent#my_method')}.to raise_error
+      end
+
+      it 'should parse correctly a well-formed Hash' do
+        TargetValidator::validate_target(to: ComplexProductController, with_method: :simplify).should == [ComplexProductController, :simplify]
+      end
+
+      context 'when the string is well-formed' do
+
+        it 'should parse correctly when the controller is a top-level' do
+          TargetValidator::validate_target('complex_product#simplify').should == [ComplexProductController, :simplify]
+        end
+
+        it 'should parse correctly when the controller belongs to a module' do
+          TargetValidator::validate_target('my_module/another#complicate').should == [MyModule::AnotherController, :complicate]
+        end
+
+        it 'should parse correctly with many levels of module nesting' do
+          TargetValidator::validate_target('my_module/my_sub_module/a_third#confuse').should == [MyModule::MySubModule::AThirdController, :confuse]
+        end
+
+      end
+
+    end
+
+
+  end
+
+
+
+end

data/spec/unit/user_manager_spec.rb

@@ -0,0 +1,165 @@
+require "spec_helper"
+
+module WebsocketRails
+
+  describe ".users" do
+    before do
+      Synchronization.stub(:find_user)
+      Synchronization.stub(:register_user)
+      Synchronization.stub(:destroy_user)
+    end
+
+    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 connected to a different worker" do
+        before do
+          user_attr = {name: 'test', email: 'test@test.com'}
+          Synchronization.stub(:find_user).and_return(user_attr)
+        end
+
+        it "publishes the event to redis" do
+          Synchronization.should_receive(:publish) do |event|
+            event.user_id.should == "remote"
+          end
+
+          WebsocketRails.users["remote"].send_message :test, :data
+        end
+
+        it "instantiates a user object pulled from redis" do
+          remote = WebsocketRails.users["remote"]
+
+          remote.class.should == UserManager::RemoteConnection
+          remote.user.class.should == User
+          remote.user.name.should == 'test'
+          remote.user.persisted?.should == true
+        end
+      end
+    end
+  end
+
+  describe UserManager do
+
+    before do
+      Synchronization.stub(:find_user)
+      Synchronization.stub(:register_user)
+      Synchronization.stub(:destroy_user)
+    end
+
+    let(:connection) do
+      connection = double('Connection')
+      connection.stub(:id).and_return(1)
+      connection.stub(:user_identifier).and_return('Juanita')
+      connection
+    end
+
+    describe "#[]=" do
+      it "store's a reference to a connection in the user's hash" do
+        subject["username"] = connection
+        subject.users["username"].connections.first.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"].connections.first.should == connection
+        end
+      end
+    end
+
+    describe "#delete" do
+      before do
+        subject["Juanita"] = connection
+      end
+
+      it "deletes the connection from the users hash" do
+        subject.delete(connection)
+        subject["Juanita"].should be_a UserManager::MissingConnection
+      end
+    end
+
+    describe "#each" do
+      before do
+        subject['Juanita'] = connection
+      end
+
+      context "when synchronization is disabled" do
+        before do
+          WebsocketRails.stub(:synchronize?).and_return false
+        end
+
+        it "passes each local connection to the given block" do
+          subject.each do |conn|
+            connection.should == conn.connections.first
+          end
+        end
+      end
+
+      context "when synchronization is enabled" do
+        before do
+          WebsocketRails.stub(:synchronize?).and_return true
+
+          user_attr = {name: 'test', email: 'test@test.com'}.to_json
+          Synchronization.stub(:all_users).and_return 'test' => user_attr
+        end
+
+        it "passes each remote connection to the given block" do
+          subject.each do |conn|
+            conn.class.should == UserManager::RemoteConnection
+            conn.user.class.should == User
+            conn.user.name.should == 'test'
+            conn.user.email.should == 'test@test.com'
+          end
+        end
+      end
+    end
+
+    describe "#map" do
+      before do
+        subject['Juanita'] = connection
+      end
+
+      context "when synchronization is disabled" do
+        before do
+          WebsocketRails.stub(:synchronize?).and_return false
+        end
+
+        it "passes each local connection to the given block and collects the results" do
+          results = subject.map do |conn|
+            [conn, true]
+          end
+          results.count.should == 1
+          results[0][0].connections.count.should == 1
+        end
+      end
+
+      context "when synchronization is enabled" do
+        before do
+          WebsocketRails.stub(:synchronize?).and_return true
+
+          user_attr = {name: 'test', email: 'test@test.com'}.to_json
+          Synchronization.stub(:all_users).and_return 'test' => user_attr
+        end
+
+        it "passes each remote connection to the given block and collects the results" do
+          results = subject.map do |conn|
+            [conn, true]
+          end
+          results.count.should == 1
+          results[0].first.class.should == UserManager::RemoteConnection
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,320 @@
+--- !ruby/object:Gem::Specification
+name: hkroger-websocket-rails
+version: !ruby/object:Gem::Version
+  version: 0.7.1
+platform: ruby
+authors:
+- Hannu Kröger
+- Dan Knox
+- Kyle Whalen
+- Three Dot Loft LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-synchrony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-matchers-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Seamless Ruby on Rails websocket integration.
+email:
+- hkroger@gmail.com
+executables:
+- thin-socketrails
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/thin-socketrails
+- lib/assets/javascripts/websocket_rails/abstract_connection.js.coffee
+- lib/assets/javascripts/websocket_rails/channel.js.coffee
+- lib/assets/javascripts/websocket_rails/event.js.coffee
+- lib/assets/javascripts/websocket_rails/http_connection.js.coffee
+- lib/assets/javascripts/websocket_rails/main.js
+- lib/assets/javascripts/websocket_rails/websocket_connection.js.coffee
+- lib/assets/javascripts/websocket_rails/websocket_rails.js.coffee
+- 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/hkroger-websocket-rails.rb
+- lib/rails/app/controllers/websocket_rails/delegation_controller.rb
+- lib/rails/config/routes.rb
+- lib/rails/tasks/websocket_rails.tasks
+- lib/spec_helpers/matchers/route_matchers.rb
+- lib/spec_helpers/matchers/trigger_matchers.rb
+- lib/spec_helpers/spec_helper_event.rb
+- lib/websocket-rails.rb
+- lib/websocket_rails/base_controller.rb
+- lib/websocket_rails/channel.rb
+- lib/websocket_rails/channel_manager.rb
+- lib/websocket_rails/configuration.rb
+- lib/websocket_rails/connection_adapters.rb
+- lib/websocket_rails/connection_adapters/http.rb
+- lib/websocket_rails/connection_adapters/web_socket.rb
+- lib/websocket_rails/connection_manager.rb
+- lib/websocket_rails/controller_factory.rb
+- lib/websocket_rails/data_store.rb
+- lib/websocket_rails/dispatcher.rb
+- lib/websocket_rails/engine.rb
+- lib/websocket_rails/event.rb
+- lib/websocket_rails/event_map.rb
+- lib/websocket_rails/event_queue.rb
+- lib/websocket_rails/internal_events.rb
+- 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
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/chat_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/events.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20130902222552_create_users.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/production.log
+- spec/dummy/log/server.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/javascripts/application.js
+- spec/dummy/public/javascripts/controls.js
+- spec/dummy/public/javascripts/dragdrop.js
+- spec/dummy/public/javascripts/effects.js
+- spec/dummy/public/javascripts/prototype.js
+- spec/dummy/public/javascripts/rails.js
+- spec/dummy/script/rails
+- spec/integration/connection_manager_spec.rb
+- spec/javascripts/support/jasmine.yml
+- spec/javascripts/support/jasmine_helper.rb
+- spec/javascripts/support/vendor/sinon-1.7.1.js
+- spec/javascripts/websocket_rails/channel_spec.coffee
+- spec/javascripts/websocket_rails/event_spec.coffee
+- spec/javascripts/websocket_rails/helpers.coffee
+- spec/javascripts/websocket_rails/websocket_connection_spec.coffee
+- spec/javascripts/websocket_rails/websocket_rails_spec.coffee
+- spec/spec_helper.rb
+- spec/spec_helpers/matchers/route_matchers_spec.rb
+- spec/spec_helpers/matchers/trigger_matchers_spec.rb
+- spec/spec_helpers/spec_helper_event_spec.rb
+- spec/support/helper_methods.rb
+- spec/support/mock_web_socket.rb
+- spec/unit/base_controller_spec.rb
+- spec/unit/channel_manager_spec.rb
+- spec/unit/channel_spec.rb
+- spec/unit/connection_adapters/http_spec.rb
+- spec/unit/connection_adapters/web_socket_spec.rb
+- spec/unit/connection_adapters_spec.rb
+- spec/unit/connection_manager_spec.rb
+- spec/unit/controller_factory_spec.rb
+- spec/unit/data_store_spec.rb
+- spec/unit/dispatcher_spec.rb
+- spec/unit/event_map_spec.rb
+- spec/unit/event_queue_spec.rb
+- spec/unit/event_spec.rb
+- spec/unit/logging_spec.rb
+- spec/unit/synchronization_spec.rb
+- spec/unit/target_validator_spec.rb
+- spec/unit/user_manager_spec.rb
+homepage: http://websocket-rails.github.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: Welcome to WebsocketRails v0.7.1!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Plug and play websocket support for ruby on rails. Includes event router
+  for mapping javascript events to controller actions.
+test_files: []