websocket-rails 0.1.3 → 0.1.4

data/spec/integration/connection_manager_spec.rb

@@ -11,15 +11,15 @@ module WebsocketRails
     def define_test_events
       WebsocketRails.route_block = nil
       WebsocketRails::EventMap.describe do
-        subscribe :client_connected, to: ChatController, with_method: :new_user
-        subscribe :change_username, to: ChatController, with_method: :change_username
-        subscribe :client_error, to: ChatController, with_method: :error_occurred
-        subscribe :client_disconnected, to: ChatController, with_method: :delete_user
+        subscribe :client_connected, :to => ChatController, :with_method => :new_user
+        subscribe :change_username, :to => ChatController, :with_method => :change_username
+        subscribe :client_error, :to => ChatController, :with_method => :error_occurred
+        subscribe :client_disconnected, :to => ChatController, :with_method => :delete_user
 
-        subscribe :update_list, to: ChatController, with_method: :update_user_list
+        subscribe :update_list, :to => ChatController, :with_method => :update_user_list
 
         namespace :products do
-          subscribe :update_list, to: ProductController, with_method: :update_list
+          subscribe :update_list, :to => ProductController, :with_method => :update_list
         end
       end
     end
@@ -41,7 +41,7 @@ module WebsocketRails
       
       context "active connections" do
         context "new message from client" do
-          let(:test_message) { ['change_username',{user_name: 'Joe User'}] }
+          let(:test_message) { ['change_username',{:user_name => 'Joe User'}] }
           let(:encoded_message) { test_message.to_json }
         
           it "should execute the controller action associated with the received event" do
@@ -52,7 +52,7 @@ module WebsocketRails
         end
 
         context "new message from client under a namespace" do
-          let(:test_message) { ['products.update_list',{product: 'x-ray-vision'}] }
+          let(:test_message) { ['products.update_list',{:product => 'x-ray-vision'}] }
           let(:encoded_message) { test_message.to_json }
           
           it "should execute the controller action under the correct namespace" do
@@ -62,6 +62,19 @@ module WebsocketRails
             socket.on_message( encoded_message )
           end
         end
+
+        context "subscribing to a channel" do
+          let(:channel_message) { ['websocket_rails.subscribe',{:channel => 'awesome_channel'}] }
+          let(:encoded_message) { channel_message.to_json }
+
+          it "should subscribe the connection to the correct channel" do
+            @server.call( env )
+            channel = WebsocketRails[:awesome_channel]
+            #channel.should_receive(:subscribe).once.with(socket)
+            Channel.any_instance.stub(:subscribe).and_raise(Exception)
+            socket.on_message encoded_message
+          end
+        end
       
         context "client error" do
           it "should execute the controller action associated with the 'client_error' event" do

data/spec/support/helper_methods.rb

@@ -11,11 +11,11 @@ module WebsocketRails
     end
 
     def encoded_message
-      ['test_event',{user_name: 'Joe User'}].to_json
+      ['test_event',{:user_name => 'Joe User'}].to_json
     end
 
     def received_encoded_message(connection_id)
-      [connection_id,'test_event',{user_name: 'Joe User'}].to_json
+      [connection_id,'test_event',{:user_name => 'Joe User'}].to_json
     end
 
     MockEvent = Struct.new(:name,:namespace)

data/spec/support/mock_web_socket.rb

@@ -25,6 +25,10 @@ module WebsocketRails
       true
     end
 
+    def trigger(event)
+      true
+    end
+
     def id
       object_id.to_i
     end

data/spec/unit/channel_manager_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module WebsocketRails
+
+  describe ".channel_manager" do
+    it "should load a new channel manager when first called" do
+      WebsocketRails.channel_manager.should be_a ChannelManager
+    end
+  end
+
+  describe ".[]" do
+    it "should delegate to channel manager" do
+      ChannelManager.any_instance.should_receive(:[]).with(:awesome_channel)
+      WebsocketRails[:awesome_channel]
+    end
+  end
+
+  describe ChannelManager do
+
+    describe "#[]" do
+      context "accessing a channel" do
+        it "should create the channel if it does not exist" do
+          subject[:awesome_channel].class.should == Channel
+        end
+      end
+    end
+
+  end
+end

data/spec/unit/channel_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module WebsocketRails
+  describe Channel do
+    subject { Channel.new :awesome_channel }
+
+    let(:connection) { double('connection') }
+
+    before do
+      connection.stub!(:trigger)
+    end
+
+    it "should maintain a pool of subscribed connections" do
+      subject.subscribers.should == []
+    end
+
+    describe "#subscribe" do
+      it "should add the connection to the subscriber pool" do
+        subject.subscribe connection
+        subject.subscribers.include?(connection).should be_true
+      end
+    end
+
+    describe "#trigger" do
+      it "should create a new event and trigger it on all subscribers" do
+        event = double('event').as_null_object
+        Event.should_receive(:new) do |name,data,options|
+          name.should == 'event'
+          data.should == 'data'
+          options.should be_a Hash
+          event
+        end
+        connection.should_receive(:trigger).with(event)
+        subject.subscribe connection
+        subject.trigger 'event', 'data'
+      end
+    end
+
+    describe "#trigger_event" do
+      it "should forward the event to the subscribers" do
+        subject.should_receive(:send_data).with('event')
+        subject.trigger_event 'event'
+      end
+    end
+  end
+end

data/spec/unit/connection_adapters_spec.rb

@@ -29,6 +29,7 @@ module WebsocketRails
   module ConnectionAdapters
     describe Base do
       let(:dispatcher) { double('Dispatcher').as_null_object }
+      let(:channel_manager) { double('ChannelManager').as_null_object }
       let(:event) { double('Event').as_null_object }
       before  { Event.stub(:new_from_json).and_return(event) }
       subject { Base.new( env, dispatcher ) }
@@ -88,6 +89,25 @@ module WebsocketRails
         end
       end
       
+      describe "#enqueue" do
+        it "should add the event to the queue" do
+          subject.enqueue 'event'
+          subject.queue.queue.should == ['event']
+        end
+      end
+
+      describe "#trigger" do
+        it "should add the event to the queue" do
+          subject.stub(:flush)
+          subject.should_receive(:enqueue).with('event')
+          subject.trigger 'event'
+        end
+
+        it "should flush the queue" do
+          subject.should_receive(:flush)
+          subject.trigger 'event'
+        end
+      end
     end
   end
 end

data/spec/unit/dispatcher_spec.rb

@@ -50,6 +50,7 @@ module WebsocketRails
         event.stub(:name).and_return(:test_method)
         event.stub(:data).and_return(:some_message)
         event.stub(:connection).and_return(connection)
+        event.stub(:is_channel?).and_return(false)
       end
       
       it "should execute the correct method on the target class" do
@@ -61,6 +62,16 @@ module WebsocketRails
         subject.dispatch(event)
         @target._event.should == event
       end
+
+      context "channel events" do
+        it "should forward the data to the correct channel" do
+          event = Event.new 'test', 'data', :channel => :awesome_channel
+          channel = double('channel')
+          channel.should_receive(:trigger_event).with(event)
+          WebsocketRails.should_receive(:[]).with(:awesome_channel).and_return(channel)
+          subject.dispatch event
+        end
+      end
     end
    
     describe "#send_message" do
@@ -69,7 +80,7 @@ module WebsocketRails
       end
 
       it "should send a message to the event's connection object" do
-        connection.should_receive(:send).with(@event.serialize)
+        connection.should_receive(:trigger).with(@event)
         subject.send_message @event
       end
     end
@@ -81,7 +92,7 @@ module WebsocketRails
       end
 
       it "should send a message to all connected clients" do
-        connection.should_receive(:send).with(@event.serialize)
+        connection.should_receive(:trigger).with(@event)
         subject.broadcast_message @event
       end
     end

data/spec/unit/event_map_spec.rb

@@ -12,10 +12,10 @@ module WebsocketRails
     def define_test_events
       WebsocketRails.route_block = nil
       WebsocketRails::EventMap.describe do
-        subscribe :client_connected, to: ChatController, with_method: :new_user
+        subscribe :client_connected, :to => ChatController, :with_method => :new_user
 
         namespace :product do
-          subscribe :update, to: ProductController, with_method: :update_product
+          subscribe :update, :to => ProductController, :with_method => :update_product
         end
       end
     end

data/spec/unit/event_queue_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module WebsocketRails
+  describe EventQueue do
+
+    describe "#initialize" do
+      it "should create an empty queue" do
+        subject.queue.should == []
+      end
+    end
+
+    describe "#<<" do
+      it "should add the item to the queue" do
+        subject << 'event'
+        subject.queue.should == ['event']
+      end
+    end
+
+    describe "#flush" do
+      before do
+        subject.queue << 'event'
+      end
+
+      it "should yield all items in the queue" do
+        subject.flush do |event|
+          event.should == 'event'
+        end
+      end
+
+      it "should empty the queue" do
+        subject.flush
+        subject.queue.should == []
+      end
+    end
+  end
+end

data/spec/unit/event_spec.rb

@@ -6,6 +6,7 @@ module WebsocketRails
     let(:encoded_message_string) { '["new_message","this is a message"]' }
     let(:namespace_encoded_message_string) { '["product.new_message","this is a message"]' }
     let(:namespace_encoded_message) { '["product.new_message",{"message":"this is a message"}]' }
+    let(:channel_encoded_message_string) { '["awesome_channel","new_message","this is a message"]' }
     let(:connection) { double('connection') }
 
     before { connection.stub!(:id).and_return(1) }
@@ -32,7 +33,7 @@ module WebsocketRails
     end
 
     describe ".new_on_open" do
-      before { @event = Event.new_on_open connection, {message: 'connected'} }
+      before { @event = Event.new_on_open connection, {:message => 'connected'} }
 
       it "should create an event named :client_connected" do
         @event.name.should == :client_connected
@@ -67,18 +68,33 @@ module WebsocketRails
 
     context "new namespaced events" do
       it "should store the namespace in the namespace attribute" do
-        event = Event.new "event", {}, connection, :namespace => :product
+        event = Event.new "event", {}, :connection => connection, :namespace => :product
         event.namespace.should == [:global,:product]
         event.name.should == :event
       end
 
       it "should store nested namespaces in the namespace attribute" do
-        event = Event.new "event", {}, connection, :namespace => [:product,:x_ray_vision]
+        event = Event.new "event", {}, :connection => connection, :namespace => [:product,:x_ray_vision]
         event.namespace.should == [:global,:product,:x_ray_vision]
         event.name.should == :event
       end
     end
 
+    context "new channel events" do
+      it "should store the channel name in the channel attribute" do
+        event = Event.new "event", {}, :connection => connection, :channel => :awesome_channel
+        event.channel.should == :awesome_channel
+        event.name.should == :event
+      end
+    end
+
+    describe "#is_channel?" do
+      it "should return true if an event belongs to a channel" do
+        event = Event.new "event", "data", :channel => :awesome_channel
+        event.is_channel?.should be_true
+      end
+    end
+
     describe "#serialize" do
       context "messages in the global namespace" do
         it "should not add the global namespace to the event name" do
@@ -93,6 +109,13 @@ module WebsocketRails
           event.serialize.should == namespace_encoded_message_string
         end
       end
+
+      context "messages for a channel" do
+        it "should add the channel name as the first element of the serialized array" do
+          event = Event.new_from_json channel_encoded_message_string, connection
+          event.serialize.should == channel_encoded_message_string
+        end
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,10 +11,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-22 00:00:00.000000000Z
+date: 2012-06-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -30,7 +30,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faye-websocket
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -46,7 +46,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thin
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -62,30 +62,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
+  name: thin
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -94,7 +78,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -133,8 +117,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/assets/javascripts/websocket_rails/channel.js
+- lib/assets/javascripts/websocket_rails/http_connection.js
+- lib/assets/javascripts/websocket_rails/main.js
+- lib/assets/javascripts/websocket_rails/websocket_connection.js
+- lib/assets/javascripts/websocket_rails/websocket_rails.js
+- lib/generators/websocket_rails/install/install_generator.rb
+- lib/generators/websocket_rails/install/templates/events.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/connection_adapters/http.rb
 - lib/websocket_rails/connection_adapters/web_socket.rb
 - lib/websocket_rails/connection_adapters.rb
@@ -144,11 +137,11 @@ files:
 - 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/version.rb
 - config/routes.rb
 - bin/thin-socketrails
-- assets/javascripts/http_dispatcher.js
-- assets/javascripts/websocket_dispatcher.js
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/chat_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
@@ -190,6 +183,8 @@ files:
 - spec/spec_helper.rb
 - spec/support/helper_methods.rb
 - spec/support/mock_web_socket.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
@@ -197,6 +192,7 @@ files:
 - 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
 - MIT-LICENSE
 - Rakefile
@@ -217,7 +213,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1310952573146011562
+      hash: -3091547921395116505
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -226,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1310952573146011562
+      hash: -3091547921395116505
 requirements: []
 rubyforge_project: websocket-rails
 rubygems_version: 1.8.19