websocket-rails 0.2.1 → 0.3.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # WebsocketRails Change Log
 
+## Version 0.3.0
+
+* Extend the event router DSL to accept routes similar to the routes.rb
+  shorthand `controller#action`. - Thanks to @nessche.
+* Add a custom RSpec matcher suite for verifying event routes
+  and easily asserting that WebsocketRails controller actions are
+  triggering  events correctly. - Also thanks to @nessche.
+* Fix fiber yielded across threads bug when running in standalone mode
+  by disabling Thin threaded mode as default option.
+
 ## Version 0.2.1
 
 * Fix default redis driver issue that was causing problems when using

data/README.md

@@ -46,7 +46,18 @@ Map events to controller actions using an Event Router.
 ````ruby
 WebsocketRails::EventMap.describe do
   namespace :tasks do
+  
+    # using a Hash to specify the target
     subscribe :create, :to => TaskController, :with_method => :create
+    
+    # using the same syntax as routes.rb
+    subscribe :update, 'task#update'
+    
+    # if your controller is not a top-level object
+    subscribe :create_admin, :to => Admin::TaskController, :with_method => :create
+
+    subscribe :update_admin, 'admin/task#update'
+
   end
 end
 ````
@@ -192,6 +203,15 @@ Read the [Private Channel Wiki](https://github.com/DanKnox/websocket-rails/wiki/
 private channels from the JavaScript client and handling the
 authorization in your controller.
 
+## Credit where credit is due.
+
+Big thanks to our
+[contributors](https://github.com/DanKnox/websocket-rails/graphs/contributors)
+who have helped keep this project moving.
+
+Special thanks to [@nessche](https://github.com/nessche) who provided the improved routing DSL and
+RSpec matcher suite.
+
 ## Development
 
 This gem is created and maintained by Dan Knox and Kyle Whalen under the MIT License.

data/lib/spec_helpers/matchers/route_matchers.rb

@@ -0,0 +1,64 @@
+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, method|
+          no_of_routes += 1
+          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,30 @@
+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
+
+  end
+
+end
+
+def create_event(name, data)
+  WebsocketRails::SpecHelperEvent.new(name, {data: data})
+end

data/lib/websocket-rails.rb

@@ -73,7 +73,7 @@ module WebsocketRails
       :log => "#{Rails.root}/log/websocket_rails.log",
       :tag => 'websocket_rails',
       :rackup => "#{Rails.root}/config.ru",
-      :threaded => true,
+      :threaded => false,
       :daemonize => true,
       :dirname => Rails.root,
       :max_persistent_conns => 1024,

data/lib/websocket_rails/event.rb

@@ -119,14 +119,6 @@ module WebsocketRails
       connection.trigger self if connection
     end
 
-    private
-
-    def validate_namespace(namespace)
-      namespace = [namespace] unless namespace.is_a?(Array)
-      namespace.unshift :global unless namespace.first == :global
-      namespace.map(&:to_sym) rescue [:global]
-    end
-
     def encoded_name
       if namespace.size > 1
         child_namespace = namespace.dup[1..-1]
@@ -138,5 +130,15 @@ module WebsocketRails
       combined_name
     end
 
+    private
+
+    def validate_namespace(namespace)
+      namespace = [namespace] unless namespace.is_a?(Array)
+      namespace.unshift :global unless namespace.first == :global
+      namespace.map(&:to_sym) rescue [:global]
+    end
+
+
+
   end
 end

data/lib/websocket_rails/event_map.rb

@@ -99,12 +99,13 @@ module WebsocketRails
       # Stores controller/action pairs for events subscribed under
       # this namespace.
       def store(event_name,options)
-        klass  = options[:to] || raise("Must specify a class for to: option in event route")
-        action = options[:with_method] || raise("Must specify a method for with_method: option in event route")
+        klass, action =  TargetValidator.validate_target options
         create_controller_instance_for klass if controllers[klass].nil?
         actions[event_name] << [klass,action]
       end
 
+
+
       # Reloads the controller instances stored in the event map
       # collection, picking up code changes in development.
       def reload_controllers!
@@ -175,4 +176,44 @@ module WebsocketRails
     end
 
   end
+
+  class TargetValidator
+
+    # Parses the target and extracts controller/action pair or raises an error if target is invalid
+    def self.validate_target(target)
+      case target
+        when Hash
+          validate_hash_target target
+        when String
+          validate_string_target target
+      else
+        raise('Must specify the event target either as a string product#new_product or as a Hash to: ProductController, with_method: :new_product')
+      end
+    end
+
+  private
+
+    # Parses the target as a Hash, expecting keys to: and with_method:
+    def self.validate_hash_target(target)
+      klass  = target[:to] || raise("Must specify a class for to: option in event route")
+      action = target[:with_method] || raise("Must specify a method for with_method: option in event route")
+      [klass, action]
+    end
+
+    # Parses the target as a String, expecting it to be in the format "product#new_product"
+    def self.validate_string_target(target)
+      strings = target.split('#')
+      raise('The string must be in a format like product#new_product') unless strings.count == 2
+      klass = constantize_controller strings[0]
+      action = strings[1].to_sym
+      [klass, action]
+    end
+
+    def self.constantize_controller(controller_string)
+      strings = (controller_string << '_controller').split('/')
+      strings.map{|string| string.camelize}.join('::').constantize
+    end
+
+  end
+
 end

data/lib/websocket_rails/spec_helpers.rb

@@ -0,0 +1,3 @@
+require 'spec_helpers/spec_helper_event'
+require 'spec_helpers/matchers/route_matchers'
+require 'spec_helpers/matchers/trigger_matchers'

data/lib/websocket_rails/version.rb

@@ -1,3 +1,3 @@
 module WebsocketRails
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/dummy/log/test.log

@@ -763,3 +763,4 @@ Connecting to database specified by database.yml
 Connecting to database specified by database.yml
 Connecting to database specified by database.yml
 Connecting to database specified by database.yml
+Connecting to database specified by database.yml

data/spec/spec_helper.rb

@@ -14,6 +14,8 @@ 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}
+require 'websocket_rails/spec_helpers'
+require 'rspec-matchers-matchers'
 
 RSpec.configure do |config|
   # == Mock Framework

data/spec/spec_helpers/matchers/route_matchers_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe 'Route Matchers' do
+
+  class RouteSpecProductController < WebsocketRails::BaseController
+
+    def update_product
+    end
+
+    def delete_product
+    end
+
+  end
+
+  class RouteSpecWarehouseController < WebsocketRails::BaseController
+
+    def remove_product
+    end
+
+  end
+
+
+  def define_route_test_events
+    WebsocketRails.route_block = nil
+    WebsocketRails::EventMap.describe do
+
+      namespace :product do
+        subscribe :update, :to => RouteSpecProductController, :with_method => :update_product
+        subscribe :delete, :to => RouteSpecProductController, :with_method => :delete_product
+        subscribe :delete, :to => RouteSpecWarehouseController, :with_method => :remove_product
+      end
+    end
+  end
+
+  before { define_route_test_events }
+
+  describe 'be_routed_to' do
+
+    it 'should return true when the event is routed only to the specified controller' do
+     create_event('product.update', nil).should be_routed_to 'route_spec_product#update_product'
+    end
+
+    it 'should return true when the event is routed also to the specified controller' do
+     create_event('product.delete', nil).should be_routed_to 'route_spec_product#delete_product'
+    end
+
+    it 'should return false when the event is not routed to the specified controller' do
+      create_event('product.update', nil).should_not be_routed_to 'route_spec_product#delete_product'
+    end
+
+    it 'should produce the correct failure message' do
+      event = create_event('route_spec_product.update', nil)
+      matcher = be_routed_to 'route_spec_product#delete_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected event update to be routed to target route_spec_product#delete_product'
+    end
+
+    it 'should produce the correct negative failure message' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_to 'route_spec_product#update_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_negative_failure_message 'expected event update not to be routed to target route_spec_product#update_product'
+    end
+
+    it 'should produce the correct description' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_to 'route_spec_product#update_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_description 'be routed to target route_spec_product#update_product'
+    end
+
+  end
+
+  describe 'be_routed_only_to' do
+
+    it 'should return true when the event is routed only to the specified controller' do
+     create_event('product.update', nil).should be_routed_only_to 'route_spec_product#update_product'
+    end
+
+    it 'should return false when the event is routed also to the specified controller' do
+     create_event('product.delete', nil).should_not be_routed_only_to 'route_spec_product#delete_product'
+    end
+
+    it 'should return false when the event is not routed to the specified controller' do
+      create_event('product.update', nil).should_not be_routed_only_to 'route_spec_product#delete_product'
+    end
+
+    it 'should produce the correct failure message' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_only_to 'route_spec_product#delete_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected event update to be routed only to target route_spec_product#delete_product'
+    end
+
+    it 'should produce the correct negative failure message' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_only_to 'route_spec_product#update_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_negative_failure_message 'expected event update not to be routed only to target route_spec_product#update_product'
+    end
+
+    it 'should produce the correct description' do
+      event = create_event('product.update', nil)
+      matcher = be_routed_only_to 'route_spec_product#update_product'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_description 'be routed only to target route_spec_product#update_product'
+    end
+
+
+  end
+
+
+
+
+
+
+
+end

data/spec/spec_helpers/matchers/trigger_matchers_spec.rb

@@ -0,0 +1,257 @@
+require 'spec_helper'
+
+describe 'Trigger Matchers' do
+
+  class TriggerSpecProductController < WebsocketRails::BaseController
+
+    # a method that does not trigger messages
+    def update_product
+    end
+
+    def delete_product
+      data = message[:data] ? 'Return Data' : nil
+      if message[:confirm_delete]
+        trigger_success(data)
+      else
+        trigger_failure(data)
+      end
+    end
+
+  end
+
+  def define_test_events
+    WebsocketRails.route_block = nil
+    WebsocketRails::EventMap.describe do
+
+      namespace :product do
+        subscribe :update, :to => TriggerSpecProductController, :with_method => :update_product
+        subscribe :delete, :to => TriggerSpecProductController, :with_method => :delete_product
+      end
+    end
+  end
+
+  before { define_test_events }
+
+  around(:each) do |example|
+    EM.run do
+      example.run
+    end
+  end
+
+  after(:each) do
+    EM.stop
+  end
+
+  # as we have have 16 possible combinations of trigger messages and data matching pattern (data|no_data, success|failure,
+  # no_checking|checking_with_any|checking_with_nil|checking_with_exact_data) plus the case of no message at all
+  # for EACH of the matchers, resulting in a total 51 cases, we will not extensively test all cases for all matchers
+  # but we just make sure that coverage is 100%
+
+  describe 'trigger_message' do
+
+    it 'should return false when the event does not trigger any message' do
+      create_event('product.update', nil).dispatch.should_not trigger_message
+    end
+
+    it 'should produce the correct failure message when no trigger is generated' do
+      event = create_event('product.update', nil).dispatch
+      matcher = trigger_message
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.update to trigger message, instead it did not trigger any message'
+    end
+
+    it 'should return true when the message is a failure' do
+      create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should trigger_message
+    end
+
+    it 'should return true when the message is a success' do
+      create_event('product.delete', {confirm_delete: true, data: false}).dispatch.should trigger_message
+    end
+
+    context 'when a message is triggered with no data' do
+
+      it 'should return true when no check is done' do
+        create_event('product.delete', {confirm_delete: true, data: false}).dispatch.should trigger_message
+      end
+
+      it 'should produce the correct negative failure message when no check on data is done' do
+        event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+        matcher = trigger_message
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger message'
+      end
+
+      it 'should return true when explicitly checking no data' do
+        create_event('product.delete', {confirm_delete: false, data: false}).dispatch.should trigger_message :nil
+      end
+
+      it 'should produce the correct negative failure message when explicitly checking no data' do
+        event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+        matcher = trigger_message :nil
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger message with no data'
+      end
+
+      it 'should return false when checking for some data' do
+        create_event('product.delete', {confirm_delete: true, data: false}).dispatch.should_not trigger_message :any
+      end
+
+      it 'should return the correct failure message when checking for some data' do
+        event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+        matcher = trigger_message :any
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_failure_message 'expected product.delete to trigger message with some data, instead it triggered message with no data'
+      end
+
+      it 'should return false when checking for specific data' do
+        create_event('product.delete', {confirm_delete: false, data: false}).dispatch.should_not trigger_message 'Expected Data'
+      end
+
+      it 'should return the correct failure message when checking for specific data' do
+        event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+        matcher = trigger_message 'Expected Data'
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_failure_message 'expected product.delete to trigger message with data Expected Data, instead it triggered message with no data'
+      end
+
+    end
+
+    context 'when a message is triggered with some data' do
+
+      it 'should return true when no check is done' do
+        create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should trigger_message
+      end
+
+      it 'should return false when explicitly checking no data' do
+        create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should_not trigger_message :nil
+      end
+
+      it 'should produce the correct failure message when explicitly checking for no data' do
+        event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+        matcher = trigger_message :nil
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_failure_message 'expected product.delete to trigger message with no data, instead it triggered message with data Return Data'
+      end
+
+      it 'should return true when checking for some data' do
+        create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should trigger_message :any
+      end
+
+      it 'should produce the correct negative failure message when checking for some data' do
+        event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+        matcher = trigger_message :any
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger message with some data'
+      end
+
+      it 'should return false when checking for specific data with wrong data' do
+        create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should_not trigger_message 'Wrong Data'
+      end
+
+      it 'should produce the correct failure message when checking for specific data' do
+        event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+        matcher = trigger_message 'Wrong Data'
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_failure_message 'expected product.delete to trigger message with data Wrong Data, instead it triggered message with data Return Data'
+      end
+
+      it 'should return true when checking for specific data with correct data' do
+        create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should trigger_message 'Return Data'
+      end
+
+      it 'should produce the correct negative failure message when checking for specific data' do
+        event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+        matcher = trigger_message 'Return Data'
+        cache_messages_for_matcher(matcher, event)
+        matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger message with data Return Data'
+      end
+
+    end
+
+    it 'should produce the correct description' do
+      event = create_event('product.update', nil)
+      matcher = trigger_message 'Return Data'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_description 'trigger message with data Return Data'
+    end
+
+
+  end
+
+  describe 'trigger_success_message' do
+
+    it 'should return false when the method does not trigger any message' do
+      create_event('product.update', nil).dispatch.should_not trigger_success_message
+    end
+
+    it 'should produce the correct failure message when the method does not trigger any message' do
+      event = create_event('product.update', nil).dispatch
+      matcher = trigger_success_message 'Return Data'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.update to trigger success message with data Return Data, instead it did not trigger any message'
+    end
+
+    it 'should return true when the method triggers a success message' do
+      create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should trigger_success_message
+    end
+
+    it 'should produce the correct negative failure message when the method triggers a success message' do
+      event = create_event('product.delete', {confirm_delete: true, data: true}).dispatch
+      matcher = trigger_success_message :any
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger success message with some data'
+    end
+
+    it 'should return false when the method triggers a failure message' do
+      create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should_not trigger_success_message
+    end
+
+    it 'should produce the correct failure message when the method triggers a failure message' do
+      event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+      matcher = trigger_success_message
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.delete to trigger success message, instead it triggered a failure message with data Return Data'
+    end
+
+  end
+
+  describe 'trigger_failure_message' do
+
+    it 'should return false when the method does not trigger any message' do
+      create_event('product.update', nil).dispatch.should_not trigger_failure_message
+    end
+
+    it 'should produce the correct failure message when the method does not trigger any message' do
+      event = create_event('product.update', nil).dispatch
+      matcher = trigger_failure_message 'Return Data'
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.update to trigger failure message with data Return Data, instead it did not trigger any message'
+    end
+
+    it 'should return false when the method triggers a success message' do
+      create_event('product.delete', {confirm_delete: true, data: true}).dispatch.should_not trigger_failure_message
+    end
+
+    it 'should produce the correct failure message when the method triggers a success message' do
+      event = create_event('product.delete', {confirm_delete: true, data: false}).dispatch
+      matcher = trigger_failure_message :any
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_failure_message 'expected product.delete to trigger failure message with some data, instead it triggered a success message with no data'
+    end
+
+
+    it 'should return true when the method triggers a failure message' do
+      create_event('product.delete', {confirm_delete: false, data: true}).dispatch.should trigger_failure_message
+    end
+
+    it 'should produce the correct negative failure message when the method triggers a failure message' do
+      event = create_event('product.delete', {confirm_delete: false, data: true}).dispatch
+      matcher = trigger_failure_message
+      cache_messages_for_matcher(matcher, event)
+      matcher.should produce_as_negative_failure_message 'expected product.delete not to trigger failure message'
+    end
+
+  end
+
+
+end

data/spec/spec_helpers/spec_helper_event_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module WebsocketRails
+
+  describe SpecHelperEvent do
+
+    before do
+      @dispatcher = double(:dispatcher)
+      Dispatcher.stub(:new).and_return @dispatcher
+      @event = SpecHelperEvent.new('my_event', data: 'my_data')
+    end
+
+    describe 'initialize' do
+
+      it 'should initialize the name and namespace of the event' do
+        @event.namespace.should == [:global]
+        @event.name.should == :my_event
+      end
+
+      it 'should initialize the data of the event' do
+        @event.data.should == 'my_data'
+      end
+
+      it 'should set the event to not triggered' do
+        @event.should_not be_triggered
+      end
+
+    end
+
+    describe 'trigger' do
+
+      it 'should set the triggered variable to true' do
+        @event.trigger
+        @event.should be_triggered
+      end
+
+    end
+
+    describe 'dispatch' do
+
+      it 'should invoke dispatch on the dispatcher object' do
+        @dispatcher.should_receive(:dispatch).with(@event)
+        @event.dispatch
+      end
+
+      it 'should return itself to be able to chain matchers' do
+        @dispatcher.stub(:dispatch)
+        @event.dispatch.should == @event
+      end
+
+    end
+
+  end
+
+end
+
+describe 'create_event' do
+
+  it 'should create a SpecHelperEvent with the correct parameters' do
+    event = create_event('my_event','my_data')
+    event.should be_a WebsocketRails::SpecHelperEvent
+    event.name.should == :my_event
+    event.data.should == 'my_data'
+  end
+
+end

data/spec/unit/event_map_spec.rb

@@ -1,14 +1,28 @@
 require 'spec_helper'
 
+# this classes are outside the WebsocketRails namespace to better reflect the actual
+# situation in a normal usage
+
+class ProductController < WebsocketRails::BaseController
+  def update_product
+    true
+  end
+end
+
+# name is chosen so that we know camelize is working correctly
+class ComplexProductController < WebsocketRails::BaseController
+
+  def simplify_product
+    true
+  end
+
+end
+
+
 module WebsocketRails
   describe EventMap do
 
-    class ProductController < WebsocketRails::BaseController
-      def update_product
-        true
-      end
-    end
-    
+
     def define_test_events
       WebsocketRails.route_block = nil
       WebsocketRails::EventMap.describe do
@@ -17,6 +31,11 @@ module WebsocketRails
         namespace :product do
           subscribe :update, :to => ProductController, :with_method => :update_product
         end
+
+        namespace :complex_product do
+          subscribe :simplify, 'complex_product#simplify'
+        end
+
       end
     end
     
@@ -55,8 +74,9 @@ module WebsocketRails
 
       before { @namespace = subject.namespace }
       
-      it "should store the event in the correct namespace" do
+      it "should store the event in the correct namespaces" do
         @namespace.namespaces[:product].actions[:update].should be_present
+        @namespace.namespaces[:complex_product].actions[:simplify].should be_present
       end
       
     end
@@ -78,7 +98,7 @@ module WebsocketRails
       end
 
       context "with events in a child namespace" do
-        it "should yield the controller and action name for each route defined for an event" do
+        it "should yield the controller and action name for each route defined with a hash for an event" do
           ProductController.any_instance.should_receive(:action_executed)
           event = HelperMethods::MockEvent.new :update, [:global,:product]
           
@@ -87,7 +107,21 @@ module WebsocketRails
             controller.class.should == ProductController
             method.should == :update_product
           end
-        end 
+
+        end
+
+        it "should yield the controller and action name for each route defined with a string for an event" do
+          ComplexProductController.any_instance.should_receive(:action_executed)
+          event = HelperMethods::MockEvent.new :simplify, [:global,:complex_product]
+
+          subject.routes_for(event) do |controller,method|
+            controller.action_executed
+            controller.class.should == ComplexProductController
+            method.should == :simplify
+          end
+
+        end
+
       end
 
     end

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -157,6 +157,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-matchers-matchers
+  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'
 description: Seamless Ruby on Rails websocket integration.
 email:
 - dknox@threedotloft.com
@@ -177,6 +193,9 @@ files:
 - 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
@@ -193,6 +212,7 @@ files:
 - 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/version.rb
 - bin/thin-socketrails
@@ -251,6 +271,9 @@ files:
 - 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/channel_manager_spec.rb
@@ -266,6 +289,7 @@ files:
 - spec/unit/event_spec.rb
 - spec/unit/logging_spec.rb
 - spec/unit/synchronization_spec.rb
+- spec/unit/target_validator_spec.rb
 - MIT-LICENSE
 - Rakefile
 - Gemfile
@@ -285,7 +309,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -982119143149111185
+      hash: 3143824869554570755
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -294,10 +318,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -982119143149111185
+      hash: 3143824869554570755
 requirements: []
 rubyforge_project: websocket-rails
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Plug and play websocket support for ruby on rails. Includes event router