punchblock 0.6.2 → 0.7.0

data/.gitignore

@@ -7,7 +7,6 @@ pkg/*
 .rvmrc
 .yardoc
 doc
-log/*
 spec/reports
 vendor
 .rbx/

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # develop
 
+# v0.7.0 - 2011-11-22
+  * Bugfix: Some spec mistakes
+  * Feature: Allow execution of actions against global components on Asterisk
+  * API change: The console has been removed
+  * API change: Components no longer expose a FutureResource at #complete_event, and instead wrap its API in the same way as #response and #response=. Any consumer code which does some_component.complete_event.resource or some_component.complete_event.resource= should now use some_component.complete_event and some_component.complete_event=
+  * Feature: Added the max-silence attribute to the Input component
+  * Bugfix: Bump the Celluloid dependency to avoid spec failures on JRuby and monkey-patching for mockability
+  * API change: Event handlers registered on components are no longer triggered by incoming events internally to Punchblock. These events must be consumed via a Client's event handlers or event queue and manually triggered on a component using ComponentNode#trigger_event_handler
+
 # v0.6.2
   # Feature: Added basic support for running Punchblock apps on Asterisk. Calls coming in to AsyncAGI result in the client receiving an Offer, hangup events are sent, and accept/answer/hangup commands work.
   # API change: The logger is now set using Punchblock.logger= rather than as a hash key to Connection.new

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2, :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/lib/punchblock/client.rb

@@ -53,8 +53,8 @@ module Punchblock
       pb_logger.debug "Executing command: #{command.inspect} with options #{options.inspect}"
       async = options.has_key?(:async) ? options.delete(:async) : true
       command.client = self
-      if command.respond_to?(:register_event_handler)
-        command.register_event_handler do |event|
+      if command.respond_to?(:register_handler)
+        command.register_handler :internal do |event|
           trigger_handler :event, event
         end
       end

data/lib/punchblock/component/component_node.rb

@@ -0,0 +1,72 @@
+module Punchblock
+  module Component
+    class ComponentNode < CommandNode
+      include HasGuardedHandlers
+
+      def initialize(*args)
+        super
+        @complete_event_resource = FutureResource.new
+        register_internal_handlers
+      end
+
+      def register_internal_handlers
+        register_handler :internal, Event::Complete do |event|
+          self.complete_event = event
+          throw :pass
+        end
+      end
+
+      def add_event(event)
+        trigger_handler :internal, event
+      end
+
+      def trigger_event_handler(event)
+        trigger_handler :event, event
+      end
+
+      def register_event_handler(*guards, &block)
+        register_handler :event, *guards, &block
+      end
+
+      def write_action(action)
+        client.execute_command action, :call_id => call_id, :component_id => component_id
+        action
+      end
+
+      def response=(other)
+        if other.is_a?(Ref)
+          @component_id = other.id
+          client.register_component self if client
+        end
+        super
+      end
+
+      def complete_event(timeout = nil)
+        @complete_event_resource.resource timeout
+      end
+
+      def complete_event=(other)
+        return if @complete_event_resource.set_yet?
+        @complete_event_resource.resource = other
+        complete!
+      end
+
+      ##
+      # Create an Rayo stop message
+      #
+      # @return [Stop] an Rayo stop message
+      #
+      def stop_action
+        Stop.new :component_id => component_id, :call_id => call_id
+      end
+
+      ##
+      # Sends an Rayo stop message for the current component
+      #
+      def stop!(options = {})
+        raise InvalidActionError, "Cannot stop a #{self.class.name.split("::").last} that is not executing" unless executing?
+        stop_action.tap { |action| write_action action }
+      end
+    end
+  end
+end

data/lib/punchblock/component/input.rb

@@ -50,6 +50,20 @@ module Punchblock
         write_attr :'max-digits', other
       end
 
+      ##
+      # @return [Integer] the amount of time in milliseconds that an input command will wait until considered that a silence becomes a NO-MATCH
+      #
+      def max_silence
+        read_attr :'max-silence', :to_i
+      end
+
+      ##
+      # @param [Integer] other the amount of time in milliseconds that an input command will wait until considered that a silence becomes a NO-MATCH
+      #
+      def max_silence=(other)
+        write_attr :'max-silence', other
+      end
+
       ##
       # @return [Float] Confidence with which to consider a response acceptable
       #

data/lib/punchblock/component/stop.rb

@@ -0,0 +1,7 @@
+module Punchblock
+  module Component
+    class Stop < CommandNode # :nodoc:
+      register :stop, :core
+    end
+  end
+end

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

@@ -151,12 +151,12 @@ module Punchblock
         end
 
         def register_hold_status_handlers
-          register_event_handler OnHold do |event|
+          register_handler :internal, OnHold do |event|
             onhold!
             throw :pass
           end
 
-          register_event_handler OffHold do |event|
+          register_handler :internal, OffHold do |event|
             offhold!
             throw :pass
           end

data/lib/punchblock/component.rb

@@ -3,74 +3,13 @@ module Punchblock
     extend ActiveSupport::Autoload
 
     autoload :Asterisk
+    autoload :ComponentNode
     autoload :Input
     autoload :Output
     autoload :Record
+    autoload :Stop
     autoload :Tropo
 
     InvalidActionError = Class.new StandardError
-
-    class ComponentNode < CommandNode
-      include HasGuardedHandlers
-
-      attr_accessor :complete_event
-
-      def initialize(*args)
-        super
-        @complete_event = FutureResource.new
-        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
-        trigger_handler :event, event
-      end
-
-      def register_event_handler(*guards, &block)
-        register_handler :event, *guards, &block
-      end
-
-      def write_action(action)
-        client.execute_command action, :call_id => call_id, :component_id => component_id
-        action
-      end
-
-      def response=(other)
-        if other.is_a?(Ref)
-          @component_id = other.id
-          client.register_component self if client
-        end
-        super
-      end
-
-      ##
-      # Create an Rayo stop message
-      #
-      # @return [Stop] an Rayo stop message
-      #
-      def stop_action
-        Stop.new :component_id => component_id, :call_id => call_id
-      end
-
-      ##
-      # Sends an Rayo stop message for the current component
-      #
-      def stop!(options = {})
-        raise InvalidActionError, "Cannot stop a #{self.class.name.split("::").last} that is not executing" unless executing?
-        stop_action.tap { |action| write_action action }
-      end
-    end
-
-    class Stop < CommandNode # :nodoc:
-      register :stop, :core
-    end
   end # Component
 end # Punchblock

data/lib/punchblock/connection/asterisk.rb

@@ -13,7 +13,7 @@ module Punchblock
       end
 
       def run
-        logger.debug "Starting the RubyAMI client"
+        pb_logger.debug "Starting the RubyAMI client"
         ami_client.start
       end
 

data/lib/punchblock/translator/asterisk/call.rb

@@ -23,10 +23,6 @@ module Punchblock
           @components[component_id]
         end
 
-        def execute_component_command(command)
-          component_with_id(command.component_id).execute_command! command
-        end
-
         def send_offer
           send_pb_event offer_event
         end
@@ -42,12 +38,17 @@ module Punchblock
             if component = component_with_id(ami_event['CommandID'])
               pb_logger.debug "Found component #{component.id} for event. Forwarding event..."
               component.handle_ami_event! ami_event
+            else
+              pb_logger.debug "Could not find component for AMI event: #{ami_event}"
             end
           end
         end
 
         def execute_command(command)
           pb_logger.debug "Executing command: #{command.inspect}"
+          if command.component_id
+            component_with_id(command.component_id).execute_command! command
+          end
           case command
           when Command::Accept
             send_agi_action 'EXEC RINGING' do |response|
@@ -70,7 +71,7 @@ module Punchblock
           pb_logger.debug "Sending AGI action #{command}"
           @current_agi_command = Punchblock::Component::Asterisk::AGI::Command.new :name => command, :call_id => id
           @current_agi_command.request!
-          @current_agi_command.register_event_handler Punchblock::Event::Complete do |e|
+          @current_agi_command.register_handler :internal, Punchblock::Event::Complete do |e|
             pb_logger.debug "AGI action received complete event #{e.inspect}"
             block.call e
           end

data/lib/punchblock/translator/asterisk.rb

@@ -1,5 +1,4 @@
 require 'celluloid'
-require 'punchblock/core_ext/celluloid'
 require 'ruby_ami'
 
 module Punchblock
@@ -71,14 +70,14 @@ module Punchblock
       def execute_command(command, options = {})
         pb_logger.debug "Executing command #{command.inspect}"
         command.request!
-        if command.call_id || options[:call_id]
-          command.call_id ||= options[:call_id]
-          if command.component_id || options[:component_id]
-            command.component_id ||= options[:component_id]
-            execute_component_command command
-          else
-            execute_call_command command
-          end
+
+        command.call_id ||= options[:call_id]
+        command.component_id ||= options[:component_id]
+
+        if command.call_id
+          execute_call_command command
+        elsif command.component_id
+          execute_component_command command
         else
           execute_global_command command
         end
@@ -89,12 +88,12 @@ module Punchblock
       end
 
       def execute_component_command(command)
-        call_with_id(command.call_id).execute_component_command! command
+        component_with_id(command.component_id).execute_command! command
       end
 
       def execute_global_command(command)
         component = Component::Asterisk::AMIAction.new command, current_actor
-        # register_component component
+        register_component component
         component.execute!
       end
 

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/lib/punchblock.rb

@@ -15,7 +15,6 @@ module Punchblock
   autoload :CommandNode
   autoload :Component
   autoload :Connection
-  autoload :DSL
   autoload :HasHeaders
   autoload :Header
   autoload :MediaContainer

data/punchblock.gemspec

@@ -24,13 +24,12 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency %q<niceogiri>, [">= 0.0.4"]
   s.add_runtime_dependency %q<blather>, [">= 0.5.7"]
-  s.add_runtime_dependency %q<pry>, [">= 0.8.3"]
   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.1.0"]
-  s.add_runtime_dependency %q<celluloid>, [">= 0.5.0"]
-  s.add_runtime_dependency %q<ruby_ami>, [">= 0.1.2"]
+  s.add_runtime_dependency %q<celluloid>, [">= 0.6.0"]
+  s.add_runtime_dependency %q<ruby_ami>, [">= 0.1.3"]
 
   s.add_development_dependency %q<bundler>, ["~> 1.0.0"]
   s.add_development_dependency %q<rspec>, [">= 2.5.0"]
@@ -41,4 +40,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency %q<mocha>, [">= 0"]
   s.add_development_dependency %q<i18n>, [">= 0"]
   s.add_development_dependency %q<countdownlatch>, [">= 0"]
+  s.add_development_dependency %q<guard-rspec>
 end

data/spec/punchblock/{component_spec.rb → component/component_node_spec.rb}

@@ -1,17 +1,9 @@
 require 'spec_helper'
 
-%w{
-  blather/client/dsl
-  punchblock/core_ext/blather/stanza
-  punchblock/core_ext/blather/stanza/presence
-}.each { |f| require f }
-
 module Punchblock
   module Component
     describe ComponentNode do
-      it "should not initially have a complete event set" do
-        subject.complete_event.set_yet?.should == false
-      end
+      it { should be_new }
 
       describe "#add_event" do
         let(:event) { Event::Complete.new }
@@ -23,16 +15,10 @@ module Punchblock
 
         let(:add_event) { subject.add_event event }
 
-        it "should set the original component on the event" do
-          add_event
-          event.original_component.should == subject
-        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
+            subject.complete_event(0.5).should == event
           end
 
           it "should call #complete!" do
@@ -46,9 +32,18 @@ module Punchblock
 
           it "should not set the complete event resource" do
             add_event
-            subject.complete_event.set_yet?.should == false
+            subject.should_not be_complete
           end
         end
+      end # #add_event
+
+      describe "#trigger_event_handler" do
+        let(:event) { Event::Complete.new }
+
+        before do
+          subject.request!
+          subject.execute!
+        end
 
         describe "with an event handler set" do
           let(:handler) { mock 'Response' }
@@ -59,10 +54,10 @@ module Punchblock
           end
 
           it "should trigger the callback" do
-            add_event
+            subject.trigger_event_handler event
           end
         end
-      end # #add_event
+      end # #trigger_event_handler
 
       describe "#response=" do
         before do
@@ -84,6 +79,24 @@ module Punchblock
           subject.client.find_component_by_id(component_id).should be subject
         end
       end
+
+      describe "#complete_event=" do
+        before do
+          subject.request!
+          subject.execute!
+        end
+
+        it "should set the command to executing status" do
+          subject.complete_event = :foo
+          subject.should be_complete
+        end
+
+        it "should be a no-op if the response has already been set" do
+          subject.complete_event = :foo
+          lambda { subject.complete_event = :bar }.should_not raise_error
+          subject.complete_event(0.5).should == :foo
+        end
+      end
     end # ComponentNode
   end # Component
 end # Punchblock

data/spec/punchblock/component/input_spec.rb

@@ -13,6 +13,7 @@ module Punchblock
                     :mode                 => :speech,
                     :terminator           => '#',
                     :max_digits           => 10,
+                    :max_silence          => 1000,
                     :recognizer           => 'en-US',
                     :initial_timeout      => 2000,
                     :inter_digit_timeout  => 2000,
@@ -27,6 +28,7 @@ module Punchblock
         its(:mode)                { should == :speech }
         its(:terminator)          { should == '#' }
         its(:max_digits)          { should == 10 }
+        its(:max_silence)         { should == 1000 }
         its(:recognizer)          { should == 'en-US' }
         its(:initial_timeout)     { should == 2000 }
         its(:inter_digit_timeout) { should == 2000 }
@@ -44,6 +46,7 @@ module Punchblock
        mode="speech"
        terminator="#"
        max-digits="10"
+       max-silence="1000"
        recognizer="en-US"
        initial-timeout="2000"
        inter-digit-timeout="2000"
@@ -67,6 +70,7 @@ module Punchblock
         its(:mode)                { should == :speech }
         its(:terminator)          { should == '#' }
         its(:max_digits)          { should == 10 }
+        its(:max_silence)         { should == 1000 }
         its(:recognizer)          { should == 'en-US' }
         its(:initial_timeout)     { should == 2000 }
         its(:inter_digit_timeout) { should == 2000 }

data/spec/punchblock/connection/asterisk_spec.rb

@@ -14,7 +14,9 @@ module Punchblock
 
       let(:mock_event_handler) { stub_everything 'Event Handler' }
 
-      subject { Asterisk.new options }
+      let(:connection) { Asterisk.new options }
+
+      subject { connection }
 
       before do
         subject.event_handler = mock_event_handler
@@ -22,6 +24,8 @@ module Punchblock
 
       its(:ami_client) { should be_a RubyAMI::Client }
 
+      after { connection.translator.terminate }
+
       it 'should set the connection on the translator' do
         subject.translator.connection.should be subject
       end

data/spec/punchblock/connection/xmpp_spec.rb

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

data/spec/punchblock/translator/asterisk/call_spec.rb

@@ -112,14 +112,12 @@ module Punchblock
             end
 
             let(:ami_event) do
-              RubyAMI::Event.new("AGIExec").tap do |e|
+              RubyAMI::Event.new("AsyncAGI").tap do |e|
                 e["SubEvent"]   = "End"
                 e["Channel"]    = "SIP/1234-00000000"
-                e["CommandId"]  = component.id
+                e["CommandID"]  = component.id
                 e["Command"]    = "EXEC ANSWER"
-                e["ResultCode"] = "200"
-                e["Result"]     = "Success"
-                e["Data"]       = "FOO"
+                e["Result"]     = "200%20result=123%20(timeout)%0A"
               end
             end
 
@@ -152,7 +150,7 @@ module Punchblock
 
             it "should send an EXEC RINGING AGI command and set the command's response" do
               subject.execute_command command
-              agi_command = subject.actor_subject.instance_variable_get(:'@current_agi_command')
+              agi_command = subject.wrapped_object.instance_variable_get(:'@current_agi_command')
               agi_command.name.should == "EXEC RINGING"
               agi_command.execute!
               agi_command.add_event expected_agi_complete_event
@@ -165,7 +163,7 @@ module Punchblock
 
             it "should send an EXEC ANSWER AGI command and set the command's response" do
               subject.execute_command command
-              agi_command = subject.actor_subject.instance_variable_get(:'@current_agi_command')
+              agi_command = subject.wrapped_object.instance_variable_get(:'@current_agi_command')
               agi_command.name.should == "EXEC ANSWER"
               agi_command.execute!
               agi_command.add_event expected_agi_complete_event
@@ -178,7 +176,7 @@ module Punchblock
 
             it "should send a Hangup AMI command and set the command's response" do
               subject.execute_command command
-              ami_action = subject.actor_subject.instance_variable_get(:'@current_ami_action')
+              ami_action = subject.wrapped_object.instance_variable_get(:'@current_ami_action')
               ami_action.name.should == "hangup"
               ami_action << RubyAMI::Response.new
               command.response(0.5).should be true
@@ -198,12 +196,31 @@ module Punchblock
               subject.execute_command command
             end
           end
+
+          context 'with a component command' do
+            let(:component_id) { 'foobar' }
+
+            let :command do
+              Punchblock::Component::Stop.new :component_id => component_id
+            end
+
+            let :mock_component do
+              mock 'Component', :id => component_id
+            end
+
+            before { subject.register_component mock_component }
+
+            it 'should send the command to the component for execution' do
+              mock_component.expects(:execute_command!).once
+              subject.execute_command command
+            end
+          end
         end
 
         describe '#send_agi_action' do
           it 'should send an appropriate AsyncAGI AMI action' do
             pending
-            subject.actor_subject.expects(:send_ami_action).once.with('AGI', 'Command' => 'FOO', 'Channel' => subject.channel)
+            subject.wrapped_object.expects(:send_ami_action).once.with('AGI', 'Command' => 'FOO', 'Channel' => subject.channel)
             subject.send_agi_action 'FOO'
           end
         end

data/spec/punchblock/translator/asterisk/component/asterisk/agi_command_spec.rb

@@ -93,7 +93,7 @@ module Punchblock
 
                   command.should be_complete
 
-                  complete_event = command.complete_event.resource(0.5)
+                  complete_event = command.complete_event 0.5
 
                   complete_event.component_id.should == subject.id
                   complete_event.reason.should == expected_complete_reason

data/spec/punchblock/translator/asterisk/component/asterisk/ami_action_spec.rb

@@ -61,7 +61,7 @@ module Punchblock
 
                   command.should be_complete
 
-                  complete_event = command.complete_event.resource(0.5)
+                  complete_event = command.complete_event 0.5
 
                   complete_event.component_id.should == subject.id
                   complete_event.reason.should == expected_complete_reason
@@ -115,7 +115,7 @@ module Punchblock
                 end
 
                 it 'should send events to the component node' do
-                  command.register_event_handler Punchblock::Event::Asterisk::AMI::Event do |event|
+                  command.register_handler :internal, Punchblock::Event::Asterisk::AMI::Event do |event|
                     @event = event
                   end
                   subject.action << event
@@ -128,7 +128,7 @@ module Punchblock
                   subject.action << response
                   subject.action << terminating_event
 
-                  command.complete_event.resource(0.5).reason.should == expected_complete_reason
+                  command.complete_event(0.5).reason.should == expected_complete_reason
                 end
               end
 
@@ -144,7 +144,7 @@ module Punchblock
                 it 'should send a complete event to the component node' do
                   subject.action << error
 
-                  complete_event = command.complete_event.resource(0.5)
+                  complete_event = command.complete_event 0.5
 
                   complete_event.component_id.should == subject.id
                   complete_event.reason.should == expected_complete_reason