punchblock 0.8.2 → 0.8.3

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # develop
 
+# v0.8.3 - 2012-01-17
+  * Feature: Return an error when trying to execute a command for unknown calls/components or when not understood
+  * Feature: Log calls/translator shutting down
+  * Feature: Calls and components should log their IDs
+  * Feature: Components marked as internal should send events directly to the component node
+  * Bugfix: Fix Asterisk Call and Component logger IDs
+  * Bugfix: Fix a stupidly high log level
+  * Bugfix: AGI commands executed by a call/component that are a translation of a Rayo command should be marked internal
+  * Bugfix: Asterisk components should sent events via the connection
+  * Bugfix: Shutting down an asterisk connection should do a cascading shutdown of the translator and all of its calls
+  * Bugfix: Component actors should be terminated once they've sent a complete event
+  * Bugfix: Component events should be sent with the call ID
+  * Bugfix: AMIAction components do not have a call
+  * Bugfix: Add test coverage for comparison of complete events
+  * Bugfix: A call being hung up should terminate the call actor
+  * Bugfix: Fix a mock expectation error in a test
+
 # v0.8.2 - 2012-01-10
   * Feature: Support outbound dial on Asterisk
   * Bugfix: Asterisk hangup causes should map to correct Rayo End reason

data/lib/punchblock/client.rb

@@ -24,6 +24,7 @@ module Punchblock
 
     def handle_event(event)
       event.client = self
+      pb_logger.debug "Handling event #{event} with source #{event.source}."
       if event.source
         event.source.add_event event
       else

data/lib/punchblock/connection/asterisk.rb

@@ -18,6 +18,7 @@ module Punchblock
       end
 
       def stop
+        translator.shutdown!
         ami_client.stop
       end
 

data/lib/punchblock/translator/asterisk.rb

@@ -43,6 +43,12 @@ module Punchblock
         @components[component_id]
       end
 
+      def shutdown
+        pb_logger.debug "Shutting down"
+        @calls.values.each &:shutdown!
+        current_actor.terminate!
+      end
+
       def handle_ami_event(event)
         return unless event.is_a? RubyAMI::Event
         pb_logger.trace "Handling AMI event #{event.inspect}"
@@ -95,11 +101,19 @@ module Punchblock
       end
 
       def execute_call_command(command)
-        call_with_id(command.call_id).execute_command! command
+        if call = call_with_id(command.call_id)
+          call.execute_command! command
+        else
+          command.response = ProtocolError.new 'call-not-found', "Could not find a call with ID #{command.call_id}", command.call_id
+        end
       end
 
       def execute_component_command(command)
-        component_with_id(command.component_id).execute_command! command
+        if (component = component_with_id(command.component_id))
+          component.execute_command! command
+        else
+          command.response = ProtocolError.new 'component-not-found', "Could not find a component with ID #{command.component_id}", command.call_id, command.component_id
+        end
       end
 
       def execute_global_command(command)
@@ -112,6 +126,8 @@ module Punchblock
           call = Call.new command.to, current_actor
           register_call call
           call.dial! command
+        else
+          command.response = ProtocolError.new 'command-not-acceptable', "Did not understand command"
         end
       end
 

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

@@ -38,6 +38,11 @@ module Punchblock
           send_pb_event offer_event
         end
 
+        def shutdown
+          pb_logger.debug "Shutting down"
+          current_actor.terminate!
+        end
+
         def to_s
           "#<#{self.class}:#{id} Channel: #{channel.inspect}>"
         end
@@ -76,7 +81,7 @@ module Punchblock
           case ami_event.name
           when 'Hangup'
             pb_logger.debug "Received a Hangup AMI event. Sending End event."
-            send_pb_event Event::End.new(:reason => HANGUP_CAUSE_TO_END_REASON[ami_event['Cause'].to_i])
+            send_end_event HANGUP_CAUSE_TO_END_REASON[ami_event['Cause'].to_i]
           when 'AsyncAGI'
             pb_logger.debug "Received an AsyncAGI event. Looking for matching AGICommand component."
             if component = component_with_id(ami_event['CommandID'])
@@ -100,7 +105,11 @@ module Punchblock
         def execute_command(command)
           pb_logger.debug "Executing command: #{command.inspect}"
           if command.component_id
-            component_with_id(command.component_id).execute_command! command
+            if component = component_with_id(command.component_id)
+              component.execute_command! command
+            else
+              command.response = ProtocolError.new 'component-not-found', "Could not find a component with ID #{command.component_id} for call #{id}", id, command.component_id
+            end
           end
           case command
           when Command::Accept
@@ -122,11 +131,13 @@ module Punchblock
               command.response = true
             end
           when Punchblock::Component::Asterisk::AGI::Command
-            execute_agi_command command
+            execute_component Component::Asterisk::AGICommand, command
           when Punchblock::Component::Output
             execute_component Component::Asterisk::Output, command
           when Punchblock::Component::Input
             execute_component Component::Asterisk::Input, command
+          else
+            command.response = ProtocolError.new 'command-not-acceptable', "Did not understand command for call #{id}", id
           end
         end
 
@@ -138,7 +149,7 @@ module Punchblock
             pb_logger.debug "AGI action received complete event #{e.inspect}"
             block.call e
           end
-          execute_agi_command @current_agi_command
+          execute_component Component::Asterisk::AGICommand, @current_agi_command, :internal => true
         end
 
         def send_ami_action(name, headers = {}, &block)
@@ -149,15 +160,21 @@ module Punchblock
           end
         end
 
+        def logger_id
+          "#{self.class}: #{id}"
+        end
+
         private
 
-        def execute_agi_command(command)
-          execute_component Component::Asterisk::AGICommand, command
+        def send_end_event(reason)
+          send_pb_event Event::End.new(:reason => reason)
+          current_actor.terminate!
         end
 
-        def execute_component(type, command)
+        def execute_component(type, command, options = {})
           type.new(command, current_actor).tap do |component|
             register_component component
+            component.internal = true if options[:internal]
             component.execute!
           end
         end

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

@@ -10,6 +10,7 @@ module Punchblock
           include Celluloid
 
           attr_reader :id, :call
+          attr_accessor :internal
 
           def initialize(component_node, call = nil)
             @component_node, @call = component_node, call
@@ -21,6 +22,43 @@ module Punchblock
           def setup
           end
 
+          def execute_command(command)
+            command.response = ProtocolError.new 'command-not-acceptable', "Did not understand command for component #{id}", call_id, id
+          end
+
+          def send_complete_event(reason)
+            event = Punchblock::Event::Complete.new.tap do |c|
+              c.reason = reason
+            end
+            send_event event
+            current_actor.terminate!
+          end
+
+          def send_event(event)
+            event.component_id  = id
+            event.call_id       = call_id
+            pb_logger.debug "Sending event #{event}"
+            if internal
+              @component_node.add_event event
+            else
+              translator.connection.handle_event event
+            end
+          end
+
+          def logger_id
+            "#{self.class}: #{call ? "Call ID: #{call.id}, Component ID: #{id}" : id}"
+          end
+
+          def call_id
+            call.id if call
+          end
+
+          private
+
+          def translator
+            call.translator
+          end
+
           def set_node_response(value)
             pb_logger.debug "Setting response on component node to #{value}"
             @component_node.response = value
@@ -33,18 +71,6 @@ module Punchblock
           def with_error(name, text)
             set_node_response ProtocolError.new(name, text)
           end
-
-          def complete_event(reason)
-            Punchblock::Event::Complete.new.tap do |c|
-              c.reason = reason
-            end
-          end
-
-          def send_event(event)
-            event.component_id = id
-            pb_logger.debug "Sending event #{event}"
-            @component_node.add_event event
-          end
         end
       end
     end

data/lib/punchblock/translator/asterisk/component/asterisk/agi_command.rb

@@ -22,7 +22,7 @@ module Punchblock
               if event.name == 'AsyncAGI'
                 if event['SubEvent'] == 'Exec'
                   pb_logger.debug "Received AsyncAGI:Exec event, sending complete event."
-                  send_event complete_event(success_reason(event))
+                  send_complete_event success_reason(event)
                 end
               end
             end

data/lib/punchblock/translator/asterisk/component/asterisk/ami_action.rb

@@ -4,10 +4,10 @@ module Punchblock
       module Component
         module Asterisk
           class AMIAction < Component
-            attr_reader :action
+            attr_reader :action, :translator
 
             def initialize(component_node, translator)
-              super
+              super component_node, nil
               @translator = translator
             end
 
@@ -21,6 +21,17 @@ module Punchblock
               send_ref
             end
 
+            def handle_response(response)
+              pb_logger.debug "Handling response #{response.inspect}"
+              case response
+              when RubyAMI::Error
+                send_complete_event error_reason(response)
+              when RubyAMI::Response
+                send_events
+                send_complete_event success_reason(response)
+              end
+            end
+
             private
 
             def create_action
@@ -28,8 +39,9 @@ module Punchblock
               @component_node.params_hash.each_pair do |key, value|
                 headers[key.to_s.capitalize] = value
               end
+              component = current_actor
               RubyAMI::Action.new @component_node.name, headers do |response|
-                handle_response response
+                component.handle_response! response
               end
             end
 
@@ -37,17 +49,6 @@ module Punchblock
               @translator.send_ami_action! @action
             end
 
-            def handle_response(response)
-              pb_logger.debug "Handling response #{response.inspect}"
-              case response
-              when RubyAMI::Error
-                send_event complete_event(error_reason(response))
-              when RubyAMI::Response
-                send_events
-                send_event complete_event(success_reason(response))
-              end
-            end
-
             def error_reason(response)
               Punchblock::Event::Complete::Error.new :details => response.message
             end

data/lib/punchblock/translator/asterisk/component/asterisk/input.rb

@@ -106,7 +106,7 @@ module Punchblock
               @active = false
               cancel_initial_timer
               cancel_inter_digit_timer
-              send_event complete_event(reason)
+              send_complete_event reason
             end
           end
         end

data/lib/punchblock/translator/asterisk/component/asterisk/output.rb

@@ -47,7 +47,7 @@ module Punchblock
                 send_ref
                 @call.send_agi_action! 'EXEC MRCPSynth', doc, mrcpsynth_options do |complete_event|
                   pb_logger.debug "MRCPSynth completed with #{complete_event}."
-                  send_event complete_event(success_reason)
+                  send_complete_event success_reason
                 end
               end
             end
@@ -57,7 +57,7 @@ module Punchblock
               pb_logger.debug "Received action completion. Now waiting on #{@pending_actions} actions."
               if @pending_actions < 1
                 pb_logger.debug "Sending complete event"
-                send_event complete_event(success_reason)
+                send_complete_event success_reason
               end
             end
 

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/spec/punchblock/connection/asterisk_spec.rb

@@ -42,6 +42,11 @@ module Punchblock
           subject.ami_client.expects(:stop).once
           subject.stop
         end
+
+        it 'shuts down the translator' do
+          subject.translator.expects(:shutdown!).once
+          subject.stop
+        end
       end
 
       it 'sends events from RubyAMI to the translator' do

data/spec/punchblock/event/complete_spec.rb

@@ -7,6 +7,64 @@ module Punchblock
         RayoNode.class_from_registration(:complete, 'urn:xmpp:rayo:ext:1').should == Complete
       end
 
+      describe "comparing for equality" do
+        subject do
+          Complete.new.tap do |c|
+            c.reason        = Complete::Stop.new
+            c.call_id       = '1234'
+            c.component_id  = 'abcd'
+          end
+        end
+
+        let :other_complete do
+          Complete.new.tap do |c|
+            c.reason        = reason
+            c.call_id       = call_id
+            c.component_id  = component_id
+          end
+        end
+
+        context 'with reason, call id and component id the same' do
+          let(:reason)        { Complete::Stop.new }
+          let(:call_id)       { '1234' }
+          let(:component_id)  { 'abcd' }
+
+          it "should be equal" do
+            subject.should == other_complete
+          end
+        end
+
+        context 'with a different reason' do
+          let(:reason)        { Complete::Hangup.new }
+          let(:call_id)       { '1234' }
+          let(:component_id)  { 'abcd' }
+
+          it "should not be equal" do
+            subject.should_not == other_complete
+          end
+        end
+
+        context 'with a different call id' do
+          let(:reason)        { Complete::Stop.new }
+          let(:call_id)       { '5678' }
+          let(:component_id)  { 'abcd' }
+
+          it "should not be equal" do
+            subject.should_not == other_complete
+          end
+        end
+
+        context 'with a different component id' do
+          let(:reason)        { Complete::Stop.new }
+          let(:call_id)       { '1234' }
+          let(:component_id)  { 'efgh' }
+
+          it "should not be equal" do
+            subject.should_not == other_complete
+          end
+        end
+      end
+
       describe "from a stanza" do
         let :stanza do
           <<-MESSAGE

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

@@ -64,6 +64,13 @@ module Punchblock
         its(:translator)  { should be translator }
         its(:agi_env)     { should == agi_env }
 
+        describe '#shutdown' do
+          it 'should terminate the actor' do
+            subject.shutdown
+            subject.should_not be_alive
+          end
+        end
+
         describe '#register_component' do
           it 'should make the component accessible by ID' do
             component_id = 'abc123'
@@ -149,6 +156,15 @@ module Punchblock
               end
             end
 
+            let(:cause)     { '16' }
+            let(:cause_txt) { 'Normal Clearing' }
+
+            it "should cause the actor to be terminated" do
+              translator.expects(:handle_pb_event!).once
+              subject.process_ami_event ami_event
+              subject.should_not be_alive
+            end
+
             context "with a normal clearing cause" do
               let(:cause)     { '16' }
               let(:cause_txt) { 'Normal Clearing' }
@@ -367,7 +383,8 @@ module Punchblock
             let(:command) { Command::Accept.new }
 
             it "should send an EXEC RINGING AGI command and set the command's response" do
-              subject.execute_command command
+              component = subject.execute_command command
+              component.internal.should be_true
               agi_command = subject.wrapped_object.instance_variable_get(:'@current_agi_command')
               agi_command.name.should == "EXEC RINGING"
               agi_command.execute!
@@ -380,7 +397,8 @@ module Punchblock
             let(:command) { Command::Answer.new }
 
             it "should send an EXEC ANSWER AGI command and set the command's response" do
-              subject.execute_command command
+              component = subject.execute_command command
+              component.internal.should be_true
               agi_command = subject.wrapped_object.instance_variable_get(:'@current_agi_command')
               agi_command.name.should == "EXEC ANSWER"
               agi_command.execute!
@@ -409,6 +427,7 @@ module Punchblock
             let(:mock_action) { mock 'Component::Asterisk::AGI::Command', :id => 'foo' }
 
             it 'should create an AGI command component actor and execute it asynchronously' do
+              mock_action.expects(:internal=).never
               Component::Asterisk::AGICommand.expects(:new).once.with(command, subject).returns mock_action
               mock_action.expects(:execute!).once
               subject.execute_command command
@@ -424,6 +443,7 @@ module Punchblock
 
             it 'should create an AGI command component actor and execute it asynchronously' do
               Component::Asterisk::Output.expects(:new).once.with(command, subject).returns mock_action
+              mock_action.expects(:internal=).never
               mock_action.expects(:execute!).once
               subject.execute_command command
             end
@@ -438,6 +458,7 @@ module Punchblock
 
             it 'should create an AGI command component actor and execute it asynchronously' do
               Component::Asterisk::Input.expects(:new).once.with(command, subject).returns mock_action
+              mock_action.expects(:internal=).never
               mock_action.expects(:execute!).once
               subject.execute_command command
             end
@@ -454,11 +475,31 @@ module Punchblock
               mock 'Component', :id => component_id
             end
 
-            before { subject.register_component mock_component }
+            context "for a known component ID" do
+              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
+
+            context "for an unknown component ID" do
+              it 'sends an error in response to the command' do
+                subject.execute_command command
+                command.response.should == ProtocolError.new('component-not-found', "Could not find a component with ID #{component_id} for call #{subject.id}", subject.id, component_id)
+              end
+            end
+          end
+
+          context 'with a command we do not understand' do
+            let :command do
+              Punchblock::Component::Record.new
+            end
 
-            it 'should send the command to the component for execution' do
-              mock_component.expects(:execute_command!).once
+            it 'sends an error in response to the command' do
               subject.execute_command command
+              command.response.should == ProtocolError.new('command-not-acceptable', "Did not understand command for call #{subject.id}", subject.id)
             end
           end
         end

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

@@ -7,7 +7,13 @@ module Punchblock
         module Asterisk
           describe AGICommand do
             let(:channel)       { 'SIP/foo' }
-            let(:mock_call)     { mock 'Call', :channel => channel }
+            let(:connection) do
+              mock_connection_with_event_handler do |event|
+                command.add_event event
+              end
+            end
+            let(:translator)    { Punchblock::Translator::Asterisk.new mock('AMI'), connection }
+            let(:mock_call)     { Punchblock::Translator::Asterisk::Call.new channel, translator }
             let(:component_id)  { UUIDTools::UUID.random_create }
 
             before { UUIDTools::UUID.stubs :random_create => component_id }
@@ -112,7 +118,7 @@ module Punchblock
 
                   complete_event = command.complete_event 0.5
 
-                  complete_event.component_id.should == subject.id
+                  complete_event.component_id.should == component_id.to_s
                   complete_event.reason.should == expected_complete_reason
                 end
               end

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

@@ -6,7 +6,12 @@ module Punchblock
       module Component
         module Asterisk
           describe AMIAction do
-            let(:mock_translator) { mock 'Translator::Asterisk' }
+            let(:connection) do
+              mock_connection_with_event_handler do |event|
+                command.add_event event
+              end
+            end
+            let(:mock_translator) { Punchblock::Translator::Asterisk.new mock('AMI'), connection }
 
             let :command do
               Punchblock::Component::Asterisk::AMI::Action.new :name => 'ExtensionStatus', :params => { :context => 'default', :exten => 'idonno' }
@@ -57,14 +62,8 @@ module Punchblock
 
               context 'for a non-causal action' do
                 it 'should send a complete event to the component node' do
-                  subject.action.response = response
-
-                  command.should be_complete
-
-                  complete_event = command.complete_event 0.5
-
-                  complete_event.component_id.should == subject.id
-                  complete_event.reason.should == expected_complete_reason
+                  subject.wrapped_object.expects(:send_complete_event).once.with expected_complete_reason
+                  subject.handle_response response
                 end
               end
 
@@ -115,12 +114,14 @@ module Punchblock
                 end
 
                 it 'should send events to the component node' do
+                  event_node
                   command.register_handler :internal, Punchblock::Event::Asterisk::AMI::Event do |event|
                     @event = event
                   end
-                  subject.action << event
-                  subject.action << response
-                  subject.action << terminating_event
+                  action = subject.action
+                  action << event
+                  subject.handle_response response
+                  action << terminating_event
                   @event.should == event_node
                 end
 
@@ -138,16 +139,12 @@ module Punchblock
                 end
 
                 let :expected_complete_reason do
-                  Punchblock::Event::Complete::Error.new :component_id => subject.id, :details => 'Action failed'
+                  Punchblock::Event::Complete::Error.new :details => 'Action failed'
                 end
 
                 it 'should send a complete event to the component node' do
-                  subject.action << error
-
-                  complete_event = command.complete_event 0.5
-
-                  complete_event.component_id.should == subject.id
-                  complete_event.reason.should == expected_complete_reason
+                  subject.wrapped_object.expects(:send_complete_event).once.with expected_complete_reason
+                  subject.handle_response error
                 end
               end
             end

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

@@ -6,10 +6,15 @@ module Punchblock
       module Component
         module Asterisk
           describe Input do
+            let(:connection) do
+              mock_connection_with_event_handler do |event|
+                command.add_event event
+              end
+            end
             let(:media_engine)    { nil }
-            let(:translator)      { Punchblock::Translator::Asterisk.new mock('AMI'), mock('Client'), media_engine }
+            let(:translator)      { Punchblock::Translator::Asterisk.new mock('AMI'), connection, media_engine }
             let(:call)            { Punchblock::Translator::Asterisk::Call.new 'foo', translator }
-            let(:command_options) { nil }
+            let(:command_options) { {} }
 
             let :command do
               Punchblock::Component::Input.new command_options
@@ -31,12 +36,6 @@ module Punchblock
               end
             end
 
-            let :command_options do
-              {
-
-              }
-            end
-
             subject { Input.new command, call }
 
             describe '#execute' do
@@ -72,7 +71,10 @@ module Punchblock
                 let(:reason) { command.complete_event(5).reason }
 
                 describe "receiving DTMF events" do
-                  before { subject.execute }
+                  before do
+                    subject.execute
+                    expected_event
+                  end
 
                   context "when a match is found" do
                     before do
@@ -80,8 +82,17 @@ module Punchblock
                       send_ami_events_for_dtmf 2
                     end
 
+                    let :expected_event do
+                      Punchblock::Component::Input::Complete::Success.new :mode => :dtmf,
+                                                                          :confidence => 1,
+                                                                          :utterance => '12',
+                                                                          :interpretation => 'dtmf-1 dtmf-2',
+                                                                          :component_id => subject.id,
+                                                                          :call_id => call.id
+                    end
+
                     it "should send a success complete event with the relevant data" do
-                      reason.should == Punchblock::Component::Input::Complete::Success.new(:mode => :dtmf, :confidence => 1, :utterance => '12', :interpretation => 'dtmf-1 dtmf-2', :component_id => subject.id)
+                      reason.should == expected_event
                     end
                   end
 
@@ -91,8 +102,13 @@ module Punchblock
                       send_ami_events_for_dtmf '#'
                     end
 
+                    let :expected_event do
+                      Punchblock::Component::Input::Complete::NoMatch.new :component_id => subject.id,
+                                                                          :call_id => call.id
+                    end
+
                     it "should send a nomatch complete event" do
-                      reason.should == Punchblock::Component::Input::Complete::NoMatch.new(:component_id => subject.id)
+                      reason.should == expected_event
                     end
                   end
                 end

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

@@ -6,10 +6,14 @@ module Punchblock
       module Component
         module Asterisk
           describe Output do
-            let(:media_engine)    { nil }
-            let(:translator)      { Punchblock::Translator::Asterisk.new mock('AMI'), mock('Client'), media_engine }
-            let(:mock_call)       { mock 'Call', :translator => translator }
-            let(:command_options) { nil }
+            let(:connection) do
+              mock_connection_with_event_handler do |event|
+                command.add_event event
+              end
+            end
+            let(:media_engine)  { nil }
+            let(:translator)    { Punchblock::Translator::Asterisk.new mock('AMI'), connection, media_engine }
+            let(:mock_call)     { Punchblock::Translator::Asterisk::Call.new 'foo', translator }
 
             let :command do
               Punchblock::Component::Output.new command_options
@@ -316,7 +320,7 @@ module Punchblock
                       end
                       subject.execute
                       latch.wait 2
-                      sleep 0.1
+                      sleep 2
                     end
 
                     it 'should send a complete event after the final file has finished playback' do

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

@@ -6,6 +6,87 @@ module Punchblock
       describe Component do
 
       end
+
+      module Component
+        describe Component do
+          let(:connection)  { Punchblock::Connection::Asterisk.new }
+          let(:translator)  { connection.translator }
+          let(:call)        { Punchblock::Translator::Asterisk::Call.new 'foo', translator }
+          let(:command)     { Punchblock::Component::Input.new }
+
+          subject { Component.new command, call }
+
+          before { command.request! }
+
+          describe "#send_event" do
+            before { command.execute! }
+
+            let :event do
+              Punchblock::Event::Complete.new
+            end
+
+            let :expected_event do
+              Punchblock::Event::Complete.new.tap do |e|
+                e.call_id = call.id
+                e.component_id = subject.id
+              end
+            end
+
+            it "should send the event to the connection" do
+              connection.expects(:handle_event).once.with expected_event
+              subject.send_event event
+            end
+
+            context "when marked internal" do
+              before { subject.internal = true }
+
+              it "should add the event to the command" do
+                command.expects(:add_event).once.with expected_event
+                subject.send_event event
+              end
+            end
+          end
+
+          describe "#send_complete_event" do
+            before { command.execute! }
+
+            let(:reason) { Punchblock::Event::Complete::Stop.new }
+            let :expected_event do
+              Punchblock::Event::Complete.new.tap do |c|
+                c.reason = Punchblock::Event::Complete::Stop.new
+              end
+            end
+
+            it "should send a complete event with the specified reason" do
+              subject.wrapped_object.expects(:send_event).once.with expected_event
+              subject.send_complete_event reason
+            end
+
+            it "should cause the actor to be shut down" do
+              subject.wrapped_object.stubs(:send_event).returns true
+              subject.send_complete_event reason
+              subject.should_not be_alive
+            end
+          end
+
+          describe '#execute_command' do
+            before do
+              component_command.request!
+            end
+
+            context 'with a command we do not understand' do
+              let :component_command do
+                Punchblock::Component::Stop.new :component_id => subject.id
+              end
+
+              it 'sends an error in response to the command' do
+                subject.execute_command component_command
+                component_command.response.should == ProtocolError.new('command-not-acceptable', "Did not understand command for component #{subject.id}", call.id, subject.id)
+              end
+            end
+          end
+        end
+      end
     end
   end
 end

data/spec/punchblock/translator/asterisk_spec.rb

@@ -14,7 +14,7 @@ module Punchblock
       its(:ami_client) { should be ami_client }
       its(:connection) { should be connection }
 
-      after { translator.terminate }
+      after { translator.terminate if translator.alive? }
 
       context 'with a configured media engine of :asterisk' do
         let(:media_engine) { :asterisk }
@@ -26,6 +26,20 @@ module Punchblock
         its(:media_engine) { should == :unimrcp }
       end
 
+      describe '#shutdown' do
+        it "instructs all calls to shutdown" do
+          call = Asterisk::Call.new 'foo', subject
+          call.expects(:shutdown!).once
+          subject.register_call call
+          subject.shutdown
+        end
+
+        it "terminates the actor" do
+          subject.shutdown
+          subject.should_not be_alive
+        end
+      end
+
       describe '#execute_command' do
         describe 'with a call command' do
           let(:command) { Command::Answer.new }
@@ -95,16 +109,29 @@ module Punchblock
       describe '#execute_call_command' do
         let(:call_id) { 'abc123' }
         let(:call)    { Translator::Asterisk::Call.new 'SIP/foo', subject }
-        let(:command) { mock 'Command::Answer', :call_id => call_id }
+        let(:command) { Command::Answer.new.tap { |c| c.call_id = call_id } }
 
         before do
+          command.request!
           call.stubs(:id).returns call_id
-          subject.register_call call
         end
 
-        it 'sends the command to the call for execution' do
-          call.expects(:execute_command!).once.with command
-          subject.execute_call_command command
+        context "with a known call ID" do
+          before do
+            subject.register_call call
+          end
+
+          it 'sends the command to the call for execution' do
+            call.expects(:execute_command!).once.with command
+            subject.execute_call_command command
+          end
+        end
+
+        context "with an unknown call ID" do
+          it 'sends an error in response to the command' do
+            subject.execute_call_command command
+            command.response.should == ProtocolError.new('call-not-found', "Could not find a call with ID #{call_id}", call_id, nil)
+          end
         end
       end
 
@@ -112,15 +139,28 @@ module Punchblock
         let(:component_id)  { '123abc' }
         let(:component)     { mock 'Translator::Asterisk::Component', :id => component_id }
 
-        let(:command) { mock 'Component::Stop', :component_id => component_id }
+        let(:command) { Component::Stop.new.tap { |c| c.component_id = component_id } }
 
         before do
-          subject.register_component component
+          command.request!
         end
 
-        it 'sends the command to the component for execution' do
-          component.expects(:execute_command!).once.with command
-          subject.execute_component_command command
+        context 'with a known component ID' do
+          before do
+            subject.register_component component
+          end
+
+          it 'sends the command to the component for execution' do
+            component.expects(:execute_command!).once.with command
+            subject.execute_component_command command
+          end
+        end
+
+        context "with an unknown component ID" do
+          it 'sends an error in response to the command' do
+            subject.execute_component_command command
+            command.response.should == ProtocolError.new('component-not-found', "Could not find a component with ID #{component_id}", nil, component_id)
+          end
         end
       end
 
@@ -130,9 +170,10 @@ module Punchblock
             Command::Dial.new :to => 'SIP/1234', :from => 'abc123'
           end
 
-          before { command.request! }
-
-          let(:mock_action) { stub_everything 'Asterisk::Component::Asterisk::AMIAction' }
+          before do
+            command.request!
+            ami_client.stub_everything
+          end
 
           it 'should be able to look up the call by channel ID' do
             subject.execute_global_command command
@@ -167,6 +208,17 @@ module Punchblock
             subject.execute_global_command command
           end
         end
+
+        context "with a command we don't understand" do
+          let :command do
+            Command::Answer.new
+          end
+
+          it 'sends an error in response to the command' do
+            subject.execute_command command
+            command.response.should == ProtocolError.new('command-not-acceptable', "Did not understand command")
+          end
+        end
       end
 
       describe '#handle_pb_event' do

data/spec/support/mock_connection_with_event_handler.rb

@@ -0,0 +1,22 @@
+# This is a nasty hack due to the fact that Mocha does not support expectations returning a value calculated by executing a block with the parameters passed.
+# If it did, we could do this in our component tests:
+# mc = mock 'Connection'
+# mc.stubs(:handle_event).returns { |event| command.add_event event }
+#
+# Mocha does not support this feature because really, it's a smell in the tests
+# We shouldn't really be mocking out behaviour like this if we actually need it to have side effects
+# We only do this because of the difficulties in synchronising the tests with an asynchronous target in another thread.
+#
+def mock_connection_with_event_handler(&block)
+  mock('Connection').tap do |mc|
+    class << mc
+      attr_accessor :target
+    end
+
+    mc.target = block
+
+    def mc.handle_event(event)
+      target.call event
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchblock
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-10 00:00:00.000000000 Z
+date: 2012-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2168470140 !ruby/object:Gem::Requirement
+  requirement: &2155905140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2168470140
+  version_requirements: *2155905140
 - !ruby/object:Gem::Dependency
   name: blather
-  requirement: &2168468720 !ruby/object:Gem::Requirement
+  requirement: &2155903300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 0.5.12
   type: :runtime
   prerelease: false
-  version_requirements: *2168468720
+  version_requirements: *2155903300
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2168467360 !ruby/object:Gem::Requirement
+  requirement: &2155901420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2168467360
+  version_requirements: *2155901420
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &2168466140 !ruby/object:Gem::Requirement
+  requirement: &2168536880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *2168466140
+  version_requirements: *2168536880
 - !ruby/object:Gem::Dependency
   name: future-resource
-  requirement: &2168464520 !ruby/object:Gem::Requirement
+  requirement: &2168535180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2168464520
+  version_requirements: *2168535180
 - !ruby/object:Gem::Dependency
   name: has-guarded-handlers
-  requirement: &2168508400 !ruby/object:Gem::Requirement
+  requirement: &2168531860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2168508400
+  version_requirements: *2168531860
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &2168506560 !ruby/object:Gem::Requirement
+  requirement: &2168527860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2168506560
+  version_requirements: *2168527860
 - !ruby/object:Gem::Dependency
   name: ruby_ami
-  requirement: &2168504680 !ruby/object:Gem::Requirement
+  requirement: &2168526320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *2168504680
+  version_requirements: *2168526320
 - !ruby/object:Gem::Dependency
   name: ruby_speech
-  requirement: &2168503400 !ruby/object:Gem::Requirement
+  requirement: &2168524860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: 0.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *2168503400
+  version_requirements: *2168524860
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2168500560 !ruby/object:Gem::Requirement
+  requirement: &2168523980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -122,10 +122,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2168500560
+  version_requirements: *2168523980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168497720 !ruby/object:Gem::Requirement
+  requirement: &2168522200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -133,10 +133,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2168497720
+  version_requirements: *2168522200
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2152104200 !ruby/object:Gem::Requirement
+  requirement: &2168516560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,10 +144,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2152104200
+  version_requirements: *2168516560
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152102500 !ruby/object:Gem::Requirement
+  requirement: &2168515600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -155,10 +155,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2152102500
+  version_requirements: *2168515600
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2152101300 !ruby/object:Gem::Requirement
+  requirement: &2168475680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -166,10 +166,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152101300
+  version_requirements: *2168475680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152100160 !ruby/object:Gem::Requirement
+  requirement: &2168496000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -177,10 +177,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152100160
+  version_requirements: *2168496000
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152097280 !ruby/object:Gem::Requirement
+  requirement: &2152431080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -188,10 +188,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152097280
+  version_requirements: *2152431080
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2152084420 !ruby/object:Gem::Requirement
+  requirement: &2152427440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -199,10 +199,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152084420
+  version_requirements: *2152427440
 - !ruby/object:Gem::Dependency
   name: countdownlatch
-  requirement: &2152079640 !ruby/object:Gem::Requirement
+  requirement: &2152370940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -210,10 +210,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152079640
+  version_requirements: *2152370940
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2152075260 !ruby/object:Gem::Requirement
+  requirement: &2152361220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -221,7 +221,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152075260
+  version_requirements: *2152361220
 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
@@ -348,6 +348,7 @@ files:
 - spec/punchblock/translator/asterisk/component_spec.rb
 - spec/punchblock/translator/asterisk_spec.rb
 - spec/spec_helper.rb
+- spec/support/mock_connection_with_event_handler.rb
 homepage: http://github.com/adhearsion/punchblock
 licenses:
 - MIT
@@ -363,7 +364,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2044158183945900193
+      hash: 243839831400829248
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -419,3 +420,4 @@ test_files:
 - spec/punchblock/translator/asterisk/component_spec.rb
 - spec/punchblock/translator/asterisk_spec.rb
 - spec/spec_helper.rb
+- spec/support/mock_connection_with_event_handler.rb