punchblock 0.4.0 → 0.4.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# v0.4.1
+  * Feature/API change: Components no longer have an event queue, but instead it is possible to define guarded event handlers via #register_event_handler
+
+# v0.4.0
+  * First public release

data/lib/punchblock.rb

@@ -1,6 +1,9 @@
-require 'active_support/dependencies/autoload'
-require 'active_support/core_ext/object/blank'
-require 'future-resource'
+%w{
+  active_support/dependencies/autoload
+  active_support/core_ext/object/blank
+  future-resource
+  has_guarded_handlers
+}.each { |l| require l }
 
 module Punchblock
   extend ActiveSupport::Autoload

data/lib/punchblock/component.rb

@@ -10,27 +10,31 @@ module Punchblock
     InvalidActionError = Class.new StandardError
 
     class ComponentNode < CommandNode
-      attr_accessor :event_queue, :complete_event, :event_callback
+      include HasGuardedHandlers
+
+      attr_accessor :complete_event
 
       def initialize(*args)
         super
-        @event_queue    = Queue.new
         @complete_event = FutureResource.new
-        @event_callback = nil
+        register_initial_handlers
+      end
+
+      def register_initial_handlers
+        register_event_handler Event::Complete do |event|
+          complete!
+          complete_event.resource = event
+          throw :pass
+        end
       end
 
       def add_event(event)
         event.original_component = self
-        transition_state! event
-        complete_event.resource = event if event.is_a? Event::Complete
-        if event_callback.respond_to?(:call)
-          add_event_to_queue = event_callback.call event
-        end
-        @event_queue << event unless add_event_to_queue
+        trigger_handler :event, event
       end
 
-      def transition_state!(event)
-        complete! if event.is_a? Event::Complete
+      def register_event_handler(*guards, &block)
+        register_handler :event, *guards, &block
       end
 
       def write_action(action)

data/lib/punchblock/component/tropo/conference.rb

@@ -149,13 +149,15 @@ module Punchblock
           [:name, :mute, :terminator, :tone_passthrough, :moderator, :announcement, :music] + super
         end
 
-        def transition_state!(event)
-          super
-          case event
-          when OnHold
+        def register_initial_handlers
+          register_event_handler OnHold do |event|
             onhold!
-          when OffHold
+            throw :pass
+          end
+
+          register_event_handler OffHold do |event|
             offhold!
+            throw :pass
           end
         end
 

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/punchblock.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency %q<activesupport>, [">= 2.1.0"]
   s.add_runtime_dependency %q<state_machine>, [">= 1.0.1"]
   s.add_runtime_dependency %q<future-resource>, [">= 0.0.2"]
+  s.add_runtime_dependency %q<has-guarded-handlers>, [">= 0.0.3"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
   s.add_development_dependency %q<rspec>, ["~> 2.3.0"]

data/spec/punchblock/component/tropo/conference_spec.rb

@@ -40,21 +40,21 @@ module Punchblock
           it { should_not == conference3 }
         end
 
-        describe "#transition_state!" do
+        describe "#add_event" do
           describe "with an on-hold" do
             it "should call #onhold!" do
               subject.expects(:onhold!).once
-              subject.transition_state! Conference::OnHold.new
+              subject.add_event Conference::OnHold.new
             end
           end
 
           describe "with an off-hold" do
             it "should call #offhold!" do
               subject.expects(:offhold!).once
-              subject.transition_state! Conference::OffHold.new
+              subject.add_event Conference::OffHold.new
             end
           end
-        end # #transition_state!
+        end
 
         describe "#requested" do
           context "when requesting to be muted" do

data/spec/punchblock/component_spec.rb

@@ -9,8 +9,6 @@ require 'spec_helper'
 module Punchblock
   module Component
     describe ComponentNode do
-      its(:event_queue) { should be_empty }
-
       it "should not initially have a complete event set" do
         subject.complete_event.set_yet?.should == false
       end
@@ -25,27 +23,22 @@ module Punchblock
 
         let(:add_event) { subject.add_event event }
 
-        it "should add the event to the component's event queue" do
-          add_event
-          subject.event_queue.pop(false).should == event
-        end
-
-        it "should set the original event on the command" do
+        it "should set the original component on the event" do
           add_event
           event.original_component.should == subject
         end
 
-        it "should trigger state transition" do
-          subject.expects(:transition_state!).once.with event
-          add_event
-        end
-
         describe "with a complete event" do
           it "should set the complete event resource" do
             add_event
             subject.complete_event.set_yet?.should == true
             subject.complete_event.resource.should == event
           end
+
+          it "should call #complete!" do
+            subject.expects(:complete!).once
+            add_event
+          end
         end
 
         describe "with another event" do
@@ -57,44 +50,20 @@ module Punchblock
           end
         end
 
-        describe "with an event callback set" do
-          let(:event_callback) { lambda { |event| @foo = :bar } }
+        describe "with an event handler set" do
+          let(:handler) { mock 'Response' }
 
           before do
-            @foo = nil
-            subject.event_callback = event_callback
-            add_event
+            handler.expects(:call).once.with(event)
+            subject.register_event_handler { |event| handler.call event }
           end
 
           it "should trigger the callback" do
-            @foo.should == :bar
-          end
-
-          it "should not write the event to the event queue" do
-            subject.event_queue.should be_empty
-          end
-
-          describe "which returns a falsy value" do
-            let(:event_callback) do
-              lambda { |event| false }
-            end
-
-            it "should add the event to the event queue" do
-              subject.event_queue.should_not be_empty
-            end
+            add_event
           end
         end
       end # #add_event
 
-      describe "#transition_state!" do
-        describe "with a complete" do
-          it "should call #complete!" do
-            subject.expects(:complete!).once
-            subject.transition_state! Event::Complete.new
-          end
-        end
-      end # #transition_state!
-
       describe "#response=" do
         before do
           subject.request!

data/spec/punchblock/connection_spec.rb

@@ -69,7 +69,7 @@ module Punchblock
       MSG
 
       connection.__send__ :handle_presence, example_complete
-      say.event_queue.pop(false).source.should == say
+      say.complete_event.resource.source.should == say
 
       say.component_id.should == 'fgh4590'
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,12 +11,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-15 00:00:00.000000000 +01:00
+date: 2011-09-21 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2168880140 !ruby/object:Gem::Requirement
+  requirement: &2160644940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2168880140
+  version_requirements: *2160644940
 - !ruby/object:Gem::Dependency
   name: blather
-  requirement: &2168879620 !ruby/object:Gem::Requirement
+  requirement: &2160644340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *2168879620
+  version_requirements: *2160644340
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2168879080 !ruby/object:Gem::Requirement
+  requirement: &2160643800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +46,10 @@ dependencies:
         version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *2168879080
+  version_requirements: *2160643800
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2168878540 !ruby/object:Gem::Requirement
+  requirement: &2160643280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2168878540
+  version_requirements: *2160643280
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &2168872980 !ruby/object:Gem::Requirement
+  requirement: &2160642700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -68,10 +68,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2168872980
+  version_requirements: *2160642700
 - !ruby/object:Gem::Dependency
   name: future-resource
-  requirement: &2168872440 !ruby/object:Gem::Requirement
+  requirement: &2160642220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +79,21 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2168872440
+  version_requirements: *2160642220
+- !ruby/object:Gem::Dependency
+  name: has-guarded-handlers
+  requirement: &2160641740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160641740
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2168871920 !ruby/object:Gem::Requirement
+  requirement: &2160641260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,10 +101,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2168871920
+  version_requirements: *2160641260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168871320 !ruby/object:Gem::Requirement
+  requirement: &2160640780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,10 +112,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2168871320
+  version_requirements: *2160640780
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2168870720 !ruby/object:Gem::Requirement
+  requirement: &2160640260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,10 +123,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2168870720
+  version_requirements: *2160640260
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2168870120 !ruby/object:Gem::Requirement
+  requirement: &2160639760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -123,10 +134,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2168870120
+  version_requirements: *2160639760
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &2168869520 !ruby/object:Gem::Requirement
+  requirement: &2160639260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -134,10 +145,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168869520
+  version_requirements: *2160639260
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2168868920 !ruby/object:Gem::Requirement
+  requirement: &2160638780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -145,10 +156,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168868920
+  version_requirements: *2160638780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2168868320 !ruby/object:Gem::Requirement
+  requirement: &2160638280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -156,10 +167,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168868320
+  version_requirements: *2160638280
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2168867720 !ruby/object:Gem::Requirement
+  requirement: &2160637800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -167,10 +178,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168867720
+  version_requirements: *2160637800
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2168867240 !ruby/object:Gem::Requirement
+  requirement: &2160637300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -178,10 +189,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168867240
+  version_requirements: *2160637300
 - !ruby/object:Gem::Dependency
   name: countdownlatch
-  requirement: &2168866660 !ruby/object:Gem::Requirement
+  requirement: &2160636780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -189,7 +200,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168866660
+  version_requirements: *2160636780
 description: Like Rack is to Rails and Sinatra, Punchblock provides a consistent API
   on top of several underlying third-party call control protocols.
 email: punchblock@adhearsion.com
@@ -201,6 +212,7 @@ files:
 - .document
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.markdown