websocket-rails 0.0.1 → 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'simplecov'
+SimpleCov.start
+
+require File.expand_path("../../spec/dummy/config/environment", __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+require 'thin'
+#require 'vendor/em-rspec/lib/em-rspec'
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'websocket-rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["../../spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  
+  #config.include FactoryGirl::Syntax::Methods
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+  
+  config.before(:all) do
+    silence_output
+  end
+  
+  config.after(:all) do
+    enable_output
+  end
+end
+
+def silence_output
+  @orig_stderr = $stderr
+  @orig_stdout = $stdout
+
+  # redirect stderr and stdout to /dev/null
+  $stderr = File.new('/dev/null', 'w')
+  $stdout = File.new('/dev/null', 'w')
+end
+
+# Replace stdout and stderr so anything else is output correctly.
+def enable_output
+  $stderr = @orig_stderr
+  $stdout = @orig_stdout
+  @orig_stderr = nil
+  @orig_stdout = nil
+end

data/spec/support/mock_web_socket.rb

@@ -0,0 +1,27 @@
+module WebsocketRails
+  
+  class MockWebSocket
+    attr_writer :onmessage, :onerror, :onclose
+    
+    def onmessage(event=nil)
+      @onmessage.call(event)
+    end
+    
+    def onerror(event=nil)
+      @onerror.call(event)
+    end
+    
+    def onclose(event=nil)
+      @onclose.call(event)
+    end
+    
+    def rack_response
+      [ -1, {}, [] ]
+    end
+    
+    def send(*args)
+      true
+    end    
+  end
+  
+end

data/spec/unit/connection_manager_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'support/mock_web_socket'
+
+module WebsocketRails
+  describe ConnectionManager do
+    
+    def open_connection
+      subject.call(@env)
+    end
+    
+    let(:connections) { subject.connections }
+    
+    before(:each) do
+      Faye::WebSocket.stub(:websocket?).and_return(true)
+      @mock_socket = MockWebSocket.new
+      Faye::WebSocket.stub(:new).and_return(@mock_socket)
+      @dispatcher = double('dispatcher').as_null_object
+      Dispatcher.stub(:new).and_return(@dispatcher)
+      @env = {}    
+    end
+    
+    context "new connections" do
+      it "should add one to the total connection count" do
+        expect { open_connection }.to change { connections.count }.by(1)
+      end
+      
+      it "should execute the :client_connected event" do
+        @dispatcher.should_receive(:dispatch) do |event,data,connection|
+          event.should == 'client_connected'
+          connection.should == @mock_socket
+        end
+        open_connection
+      end
+      
+      it "should store the new connection in the @connections array" do
+        open_connection
+        connections.include?(@mock_socket).should be_true
+      end
+      
+      it "should return an Async Rack response" do
+        open_connection.should == [ -1, {}, [] ]
+      end
+    end
+    
+    context "new event on an open connection" do
+      before(:all) { MockEvent = Struct.new(:data) }
+      before(:each) { open_connection }      
+      
+      it "should dispatch the appropriate event through the Dispatcher" do
+        mock_event = MockEvent.new(:new_message)
+        @dispatcher.should_receive(:receive) do |event,connection|
+          event.should == :new_message
+          connection.should == @mock_socket
+        end
+        @mock_socket.onmessage(mock_event)
+      end
+    end
+    
+    context "open connections" do
+      before(:each) do
+        Faye::WebSocket.stub(:new).and_return(MockWebSocket.new,MockWebSocket.new,@mock_socket,MockWebSocket.new)
+        4.times { open_connection }
+      end
+      
+      context "when closing" do      
+        it "should remove the connection object from the @connections array" do
+          @mock_socket.onclose
+          connections.include?(@mock_socket).should be_false
+        end
+      
+        it "should decrement the connection count by one" do
+          expect { @mock_socket.onclose }.to change { connections.count }.by(-1)
+        end
+      
+        it "should dispatch the :client_disconnected event" do
+          @dispatcher.should_receive(:dispatch) do |event,data,connection|
+            event.should == 'client_disconnected'
+            connection.should == @mock_socket
+          end
+          @mock_socket.onclose
+        end
+      end
+    
+      context "when experiencing errors" do        
+        it "should dispatch the :client_error event" do
+          @mock_socket.stub(:onclose)
+          @dispatcher.should_receive(:dispatch) do |event,data,connection|
+            event.should == 'client_error'
+            connection.should == @mock_socket
+          end
+          @mock_socket.onerror
+        end
+        
+        it "should execute the #onclose procedure on connection" do
+          @mock_socket.should_receive(:onclose)
+          @mock_socket.onerror
+        end
+      end
+    end
+    
+    context "invalid connections" do
+      before(:each) do
+        Faye::WebSocket.stub(:websocket?).and_return(false)
+      end
+      
+      it "should return a 400 bad request error code" do
+        open_connection.first.should == 400
+      end
+    end
+  end
+end

data/spec/unit/data_store_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module WebsocketRails
+  describe DataStore do
+    before(:each) do
+      @base = double('base_controller')
+      @base.stub(:client_id).and_return(1)
+    end
+    
+    it "loads up" do
+      data_store = DataStore.new(@base)
+      data_store.present?.should be_true
+    end
+  end
+end

data/spec/unit/dispatcher_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'json'
+
+module WebsocketRails
+  
+  class EventTarget
+    attr_reader :_connection, :_message, :test_method
+    
+    def execute_observers(event_name)
+      true
+    end    
+  end
+  
+  describe Dispatcher do
+    
+    let(:connection) { MockWebSocket.new }
+    let(:connection_manager) { double('connection_manager').as_null_object }
+    subject { Dispatcher.new(connection_manager) }
+    
+    let(:test_message) { ['new_message',{message: 'this is a message'}] }
+    let(:encoded_message) { test_message.to_json }
+    
+    context "receiving a new message" do
+      it "should be decoded from JSON and dispatched" do
+        subject.stub(:dispatch) do |event,data,con|
+          event.should == 'new_message'
+          data['message'].should == 'this is a message'
+          con.should == connection
+        end
+        subject.receive(encoded_message,connection)
+      end
+    end
+    
+    context "dispatching a message for an event" do
+      before(:each) do
+        @target = EventTarget.new
+        Events.any_instance.stub(:routes_for).with(any_args).and_yield( @target, :test_method )
+      end
+      
+      it "should execute the correct method on the target class" do
+        @target.should_receive(:test_method)
+        subject.dispatch('test_method',{},connection)
+      end
+      
+      it "should set the _message instance variable on the target object" do
+        subject.dispatch('test_method',:some_message,connection)
+        @target._message.should == :some_message
+      end
+      
+      it "should set the _connection instance variable on the target object" do
+        subject.dispatch('test_method',:some_message,connection)
+        @target._connection.should == connection
+      end
+    end
+    
+  end
+end

data/spec/unit/events_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+module WebsocketRails
+  describe Events do
+    
+    def define_test_events
+      WebsocketRails.route_block = nil
+      WebsocketRails::Events.describe_events do
+        subscribe :client_connected, to: Object, with_method: :object_id
+      end
+    end
+    
+    let(:dispatcher) { double('dispatcher').as_null_object }
+    subject { Events.new(dispatcher) }
+    
+    context "Events.describe_events" do      
+      it "should store the event route block in the global configuration" do
+        define_test_events
+        WebsocketRails.route_block.should be_present
+      end
+    end
+    
+    context "#evaluate" do
+      it "should evaluate the route DSL" do
+        evaluated = double()
+        evaluated.should_receive(:done)
+        block = Proc.new { evaluated.done }
+        subject.evaluate( block )
+      end
+      
+      it "should initialize empty hashes for classes and events" do
+        subject.evaluate Proc.new {}
+        subject.classes.should == {}
+        subject.events.should == {}
+      end
+    end
+    
+    context "#subscribe" do
+      before(:each) { define_test_events }
+      
+      it "should store the event in the events hash" do
+        subject.events.has_key?(:client_connected).should be_true
+      end
+      
+      it "should store the instantiated controller in the classes hash" do
+        subject.classes[Object].class.should == Object
+      end
+      
+      it "should set the dispatcher on the instantiated controller" do
+        subject.classes[Object].instance_variable_get(:@_dispatcher).should == dispatcher
+      end
+      
+      it "should store the class constant and method name in the events hash" do
+        subject.events[:client_connected].should == [[Object,:object_id]]
+      end
+    end
+    
+    context "#routes_for" do
+      before(:each) { define_test_events }
+      
+      it "should yield the class constant and method symbol for each route defined for an event" do
+        subject.routes_for(:client_connected) do |controller,method|
+          controller.class.should == Object
+          method.should == :object_id
+        end
+      end
+    end
+    
+  end
+end

data/websocket-rails.gemspec

@@ -17,10 +17,10 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   
   s.add_dependency "rack"
-  s.add_dependency "em-websocket", '~> 0.3.6'
-  s.add_dependency "websocket-rack"
+  s.add_dependency "faye-websocket"
   s.add_dependency "thin"
   s.add_development_dependency "rake"
   s.add_development_dependency "rails"
   s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec-rails"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-26 00:00:00.000000000Z
+date: 2012-06-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,23 +30,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: em-websocket
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.6
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.3.6
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: websocket-rack
+  name: thin
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -62,14 +62,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thin
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -78,7 +78,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -94,7 +94,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -110,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -128,16 +128,20 @@ dependencies:
 description: Seamless Ruby on Rails websocket integration.
 email:
 - dknox@threedotloft.com
-executables: []
+executables:
+- thin-socketrails
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
+- bin/thin-socketrails
 - config/routes.rb
 - lib/websocket-rails.rb
 - lib/websocket_rails/base_controller.rb
@@ -145,44 +149,52 @@ files:
 - lib/websocket_rails/data_store.rb
 - lib/websocket_rails/dispatcher.rb
 - lib/websocket_rails/engine.rb
-- lib/websocket_rails/extensions/common.rb
-- lib/websocket_rails/extensions/websocket_rack.rb
+- lib/websocket_rails/events.rb
 - lib/websocket_rails/version.rb
-- test/dummy/Rakefile
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/javascripts/application.js
-- test/dummy/public/javascripts/controls.js
-- test/dummy/public/javascripts/dragdrop.js
-- test/dummy/public/javascripts/effects.js
-- test/dummy/public/javascripts/prototype.js
-- test/dummy/public/javascripts/rails.js
-- test/dummy/public/stylesheets/.gitkeep
-- test/dummy/script/rails
-- test/integration/navigation_test.rb
-- test/support/integration_case.rb
-- test/test_helper.rb
-- test/websocket_rails_test.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/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/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/events.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/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/production.log
+- spec/dummy/log/server.log
+- spec/dummy/log/test.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/public/stylesheets/.gitkeep
+- spec/dummy/script/rails
+- spec/spec_helper.rb
+- spec/support/mock_web_socket.rb
+- spec/unit/connection_manager_spec.rb
+- spec/unit/data_store_spec.rb
+- spec/unit/dispatcher_spec.rb
+- spec/unit/events_spec.rb
 - websocket-rails.gemspec
 homepage: https://github.com/DanKnox/websocket-rails
 licenses: []
@@ -198,7 +210,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2923788248734806992
+      hash: -1264610493169323064
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -207,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2923788248734806992
+      hash: -1264610493169323064
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.19