punchblock 1.8.2 → 1.9.0

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

@@ -11,8 +11,9 @@ module Punchblock
 
           let(:media_engine)  { nil }
           let(:channel)       { 'SIP/foo' }
-          let(:translator)    { Punchblock::Translator::Asterisk.new mock('AMI'), connection, media_engine }
-          let(:mock_call)     { Punchblock::Translator::Asterisk::Call.new channel, translator }
+          let(:ami_client)    { stub('AMI Client').as_null_object }
+          let(:translator)    { Punchblock::Translator::Asterisk.new ami_client, connection, media_engine }
+          let(:mock_call)     { Punchblock::Translator::Asterisk::Call.new channel, translator, ami_client, connection }
 
           let :original_command do
             Punchblock::Component::Record.new command_options
@@ -40,7 +41,7 @@ module Punchblock
             before { mock_call.stub(:answered?).and_return(true) }
 
             it "sets command response to a reference to the component" do
-              mock_call.async.should_receive(:send_ami_action)
+              ami_client.should_receive(:send_action)
               subject.execute
               original_command.response(0.1).should be_a Ref
               original_command.component_id.should be == subject.id
@@ -48,17 +49,15 @@ module Punchblock
 
             it "starts a recording via AMI, using the component ID as the filename" do
               filename = "#{Record::RECORDING_BASE_PATH}/#{subject.id}"
-              mock_call.async.should_receive(:send_ami_action).once.with('Monitor', 'Channel' => channel, 'File' => filename, 'Format' => 'wav', 'Mix' => true)
+              ami_client.should_receive(:send_action).once.with('Monitor', 'Channel' => channel, 'File' => filename, 'Format' => 'wav', 'Mix' => true)
               subject.execute
             end
 
             it "sends a success complete event when the recording ends" do
               full_filename = "file://#{Record::RECORDING_BASE_PATH}/#{subject.id}.wav"
-              mock_call.async.should_receive(:send_ami_action)
+              ami_client.should_receive(:send_action)
               subject.execute
-              monitor_stop_event = RubyAMI::Event.new('MonitorStop').tap do |e|
-                e['Channel'] = channel
-              end
+              monitor_stop_event = RubyAMI::Event.new 'MonitorStop', 'Channel' => channel
               mock_call.process_ami_event monitor_stop_event
               reason.should be_a Punchblock::Component::Record::Complete::Success
               recording.uri.should be == full_filename
@@ -66,17 +65,15 @@ module Punchblock
             end
 
             it "can be called multiple times on the same call" do
-              mock_call.async.should_receive(:send_ami_action).twice
+              ami_client.should_receive(:send_action).twice
               subject.execute
 
-              monitor_stop_event = RubyAMI::Event.new('MonitorStop').tap do |e|
-                e['Channel'] = channel
-              end
+              monitor_stop_event = RubyAMI::Event.new 'MonitorStop', 'Channel' => channel
 
               mock_call.process_ami_event monitor_stop_event
 
-              (Record.new original_command, mock_call).execute
-              (Punchblock::Component::Record.new command_options).request!
+              Record.new(original_command, mock_call).execute
+              Punchblock::Component::Record.new(command_options).request!
               mock_call.process_ami_event monitor_stop_event
             end
 
@@ -84,7 +81,7 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :start_paused => nil } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_ami_action).once
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -93,7 +90,7 @@ module Punchblock
               context "set to false" do
                 let(:command_options) { { :start_paused => false } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_ami_action).once
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -102,7 +99,7 @@ module Punchblock
               context "set to true" do
                 let(:command_options) { { :start_paused => true } }
                 it "should return an error and not execute any actions" do
-                  mock_call.async.should_receive(:send_agi_action).never
+                  mock_call.should_receive(:execute_agi_command).never
                   subject.execute
                   error = ProtocolError.new.setup 'option error', 'A start-paused value of true is unsupported.'
                   original_command.response(0.1).should be == error
@@ -114,7 +111,7 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :initial_timeout => nil } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_ami_action).once
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -123,7 +120,7 @@ module Punchblock
               context "set to -1" do
                 let(:command_options) { { :initial_timeout => -1 } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_ami_action).once
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -132,7 +129,7 @@ module Punchblock
               context "set to a positive number" do
                 let(:command_options) { { :initial_timeout => 10 } }
                 it "should return an error and not execute any actions" do
-                  mock_call.async.should_receive(:send_agi_action).never
+                  mock_call.should_receive(:execute_agi_command).never
                   subject.execute
                   error = ProtocolError.new.setup 'option error', 'An initial-timeout value is unsupported.'
                   original_command.response(0.1).should be == error
@@ -144,7 +141,7 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :final_timeout => nil } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_ami_action).once
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -153,7 +150,7 @@ module Punchblock
               context "set to -1" do
                 let(:command_options) { { :final_timeout => -1 } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_ami_action).once
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -162,7 +159,7 @@ module Punchblock
               context "set to a positive number" do
                 let(:command_options) { { :final_timeout => 10 } }
                 it "should return an error and not execute any actions" do
-                  mock_call.async.should_receive(:send_agi_action).never
+                  mock_call.should_receive(:execute_agi_command).never
                   subject.execute
                   error = ProtocolError.new.setup 'option error', 'A final-timeout value is unsupported.'
                   original_command.response(0.1).should be == error
@@ -174,17 +171,15 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :format => nil } }
                 it "should execute as 'wav'" do
-                  mock_call.async.should_receive(:send_ami_action).once.with('Monitor', hash_including('Format' => 'wav'))
+                  ami_client.should_receive(:send_action).once.with('Monitor', hash_including('Format' => 'wav'))
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
 
                 it "provides the correct filename in the recording" do
-                  mock_call.async.should_receive(:send_ami_action)
+                  ami_client.should_receive(:send_action)
                   subject.execute
-                  monitor_stop_event = RubyAMI::Event.new('MonitorStop').tap do |e|
-                    e['Channel'] = channel
-                  end
+                  monitor_stop_event = RubyAMI::Event.new 'MonitorStop', 'Channel' => channel
                   mock_call.process_ami_event monitor_stop_event
                   recording.uri.should match(/.*\.wav$/)
                 end
@@ -193,17 +188,15 @@ module Punchblock
               context "set to 'mp3'" do
                 let(:command_options) { { :format => 'mp3' } }
                 it "should execute as 'mp3'" do
-                  mock_call.async.should_receive(:send_ami_action).once.with('Monitor', hash_including('Format' => 'mp3'))
+                  ami_client.should_receive(:send_action).once.with('Monitor', hash_including('Format' => 'mp3'))
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
 
                 it "provides the correct filename in the recording" do
-                  mock_call.async.should_receive(:send_ami_action)
+                  ami_client.should_receive(:send_action)
                   subject.execute
-                  monitor_stop_event = RubyAMI::Event.new('MonitorStop').tap do |e|
-                    e['Channel'] = channel
-                  end
+                  monitor_stop_event = RubyAMI::Event.new 'MonitorStop', 'Channel' => channel
                   mock_call.process_ami_event monitor_stop_event
                   recording.uri.should match(/.*\.mp3$/)
                 end
@@ -214,8 +207,8 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :start_beep => nil } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_agi_action).never.with('STREAM FILE', 'beep', '""')
-                  mock_call.async.should_receive(:send_ami_action).once
+                  mock_call.should_receive(:execute_agi_command).never.with('STREAM FILE', 'beep', '""')
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -224,8 +217,8 @@ module Punchblock
               context "set to false" do
                 let(:command_options) { { :start_beep => false } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_agi_action).never.with('STREAM FILE', 'beep', '""')
-                  mock_call.async.should_receive(:send_ami_action).once
+                  mock_call.should_receive(:execute_agi_command).never.with('STREAM FILE', 'beep', '""')
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -235,21 +228,22 @@ module Punchblock
                 let(:command_options) { { :start_beep => true } }
 
                 it "should play a beep before recording" do
-                  subject.wrapped_object.should_receive(:wait).once
-                  mock_call.async.should_receive(:send_agi_action).once.with('STREAM FILE', 'beep', '""').ordered
-                  mock_call.async.should_receive(:send_ami_action).once.ordered
+                  mock_call.should_receive(:execute_agi_command).once.with('STREAM FILE', 'beep', '""').ordered.and_return code: 200
+                  ami_client.should_receive(:send_action).once.ordered
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
 
-                it "should wait for the beep to finish before starting recording" do
-                  async_proxy = mock_call.async
-                  def async_proxy.send_agi_action(*args)
-                    yield
+                context "when we get a RubyAMI Error" do
+                  it "should send an error complete event" do
+                    error = RubyAMI::Error.new.tap { |e| e.message = 'FooBar' }
+                    mock_call.should_receive(:execute_agi_command).and_raise error
+                    ami_client.should_receive(:send_action).never
+                    subject.execute
+                    complete_reason = original_command.complete_event(0.1).reason
+                    complete_reason.should be_a Punchblock::Event::Complete::Error
+                    complete_reason.details.should == "Terminated due to AMI error 'FooBar'"
                   end
-                  mock_call.async.should_receive(:send_ami_action).once
-                  subject.execute
-                  original_command.response(0.1).should be_a Ref
                 end
               end
             end
@@ -258,7 +252,7 @@ module Punchblock
               context "set to nil" do
                 let(:command_options) { { :max_duration => nil } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_ami_action).once
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -267,7 +261,7 @@ module Punchblock
               context "set to -1" do
                 let(:command_options) { { :max_duration => -1 } }
                 it "should execute normally" do
-                  mock_call.async.should_receive(:send_ami_action).once
+                  ami_client.should_receive(:send_action).once
                   subject.execute
                   original_command.response(0.1).should be_a Ref
                 end
@@ -289,24 +283,18 @@ module Punchblock
                 let(:command_options) { { :max_duration => 1000 } }
 
                 it "executes a StopMonitor action" do
-                  mock_call.async.should_receive :send_ami_action
-                  mock_call.async.should_receive(:send_ami_action).once.with('StopMonitor', 'Channel' => channel)
+                  ami_client.should_receive :send_action
+                  ami_client.should_receive(:send_action).once.with('StopMonitor', 'Channel' => channel)
                   subject.execute
                   sleep 1.2
                 end
 
                 it "sends the correct complete event" do
-                  async_proxy = mock_call.async
-                  def async_proxy.send_ami_action(*args, &block)
-                    block.call Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new if block
-                  end
                   full_filename = "file://#{Record::RECORDING_BASE_PATH}/#{subject.id}.wav"
                   subject.execute
                   sleep 1.2
 
-                  monitor_stop_event = RubyAMI::Event.new('MonitorStop').tap do |e|
-                    e['Channel'] = channel
-                  end
+                  monitor_stop_event = RubyAMI::Event.new 'MonitorStop', 'Channel' => channel
                   mock_call.process_ami_event monitor_stop_event
 
                   reason.should be_a Punchblock::Component::Record::Complete::Success
@@ -335,7 +323,7 @@ module Punchblock
               let(:command) { Punchblock::Component::Stop.new }
 
               before do
-                mock_call.async.should_receive :send_ami_action
+                ami_client.should_receive :send_action
                 mock_call.should_receive(:answered?).and_return(true)
                 command.request!
                 original_command.request!
@@ -343,34 +331,24 @@ module Punchblock
               end
 
               let :send_stop_event do
-                monitor_stop_event = RubyAMI::Event.new('MonitorStop').tap do |e|
-                  e['Channel'] = channel
-                end
+                monitor_stop_event = RubyAMI::Event.new 'MonitorStop', 'Channel' => channel
                 mock_call.process_ami_event monitor_stop_event
               end
 
               it "sets the command response to true" do
-                mock_call.async.should_receive :send_ami_action
+                ami_client.should_receive :send_action
                 subject.execute_command command
                 send_stop_event
                 command.response(0.1).should be == true
               end
 
               it "executes a StopMonitor action" do
-                mock_call.async.should_receive(:send_ami_action).once.with('StopMonitor', 'Channel' => channel)
+                ami_client.should_receive(:send_action).once.with('StopMonitor', 'Channel' => channel)
                 subject.execute_command command
               end
 
               it "sends the correct complete event" do
-                mock_call.async.instance_exec do
-                  class << self
-                    undef :send_ami_action # This is here because mocha has already defined #send_ami_action above. We need to undef it to prevent a warning on redefinition.
-                  end
-
-                  def send_ami_action(*args, &block)
-                    block.call ::Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new if block
-                  end
-                end
+                ami_client.should_receive(:send_action).and_return RubyAMI::Response.new
 
                 full_filename = "file://#{Record::RECORDING_BASE_PATH}/#{subject.id}.wav"
                 subject.execute_command command
@@ -391,16 +369,13 @@ module Punchblock
               end
 
               it "sets the command response to true" do
-                async_proxy = mock_call.async
-                def async_proxy.send_ami_action(*args, &block)
-                  block.call Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new if block
-                end
+                ami_client.should_receive(:send_action).and_return RubyAMI::Response.new
                 subject.execute_command command
                 command.response(0.1).should be == true
               end
 
               it "pauses the recording via AMI" do
-                mock_call.async.should_receive(:send_ami_action).once.with('PauseMonitor', 'Channel' => channel)
+                ami_client.should_receive(:send_action).once.with('PauseMonitor', 'Channel' => channel)
                 subject.execute_command command
               end
             end
@@ -415,16 +390,13 @@ module Punchblock
               end
 
               it "sets the command response to true" do
-                async_proxy = mock_call.async
-                def async_proxy.send_ami_action(*args, &block)
-                  block.call Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new if block
-                end
+                ami_client.should_receive(:send_action).and_return RubyAMI::Response.new
                 subject.execute_command command
                 command.response(0.1).should be == true
               end
 
               it "resumes the recording via AMI" do
-                mock_call.async.should_receive(:send_ami_action).once.with('ResumeMonitor', 'Channel' => channel)
+                ami_client.should_receive(:send_action).once.with('ResumeMonitor', 'Channel' => channel)
                 subject.execute_command command
               end
             end

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

@@ -15,7 +15,11 @@ module Punchblock
             end
           end
 
-          let(:mock_call) { Call.new 'SIP/foo', mock('Translator') }
+          let(:connection)  { stub 'Connection' }
+          let(:ami_client)  { stub('AMI Client').as_null_object }
+          let(:translator)  { Punchblock::Translator::Asterisk.new ami_client, connection }
+          let(:mock_call)   { Call.new 'SIP/foo', translator, ami_client, connection }
+
           subject { MockComponent.new Hash.new, mock_call }
 
           describe "#execute_command" do

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

@@ -13,7 +13,8 @@ module Punchblock
         describe Component do
           let(:connection)  { Punchblock::Connection::Asterisk.new }
           let(:translator)  { connection.translator }
-          let(:call)        { Punchblock::Translator::Asterisk::Call.new 'foo', translator }
+          let(:ami_client)  { connection.ami_client }
+          let(:call)        { Punchblock::Translator::Asterisk::Call.new 'foo', translator, ami_client, connection }
           let(:command)     { Punchblock::Component::Input.new }
 
           subject { Component.new command, call }
@@ -38,15 +39,6 @@ module Punchblock
               connection.should_receive(: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.should_receive(:add_event).once.with expected_event
-                subject.send_event event
-              end
-            end
           end
 
           describe "#send_complete_event" do