punchblock 1.2.0 → 1.3.0

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

@@ -16,9 +16,9 @@ module Punchblock
             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 }
+            let(:component_id)  { Punchblock.new_uuid }
 
-            before { UUIDTools::UUID.stubs :random_create => component_id }
+            before { stub_uuids component_id }
 
             let :command do
               Punchblock::Component::Asterisk::AGI::Command.new :name => 'EXEC ANSWER'
@@ -31,8 +31,10 @@ module Punchblock
             end
 
             context 'initial execution' do
+              before { command.request! }
+
               it 'should send the appropriate RubyAMI::Action' do
-                mock_call.expects(:send_ami_action!).once.with(expected_action).returns(expected_action)
+                mock_call.expects(:send_ami_action).once.with(expected_action).returns(expected_action)
                 subject.execute
               end
 
@@ -48,7 +50,7 @@ module Punchblock
                 end
 
                 it 'should send the appropriate RubyAMI::Action' do
-                  mock_call.expects(:send_ami_action!).once.with(expected_action).returns(expected_action)
+                  mock_call.expects(:send_ami_action).once.with(expected_action).returns(expected_action)
                   subject.execute
                 end
               end
@@ -125,41 +127,6 @@ module Punchblock
                 end
               end
             end
-
-            describe '#parse_agi_result' do
-              context 'with a simple result with no data' do
-                let(:result_string) { "200%20result=123%0A" }
-
-                it 'should provide the code and result' do
-                  code, result, data = subject.parse_agi_result result_string
-                  code.should be == 200
-                  result.should be == 123
-                  data.should be == ''
-                end
-              end
-
-              context 'with a result and data in parens' do
-                let(:result_string) { "200%20result=-123%20(timeout)%0A" }
-
-                it 'should provide the code and result' do
-                  code, result, data = subject.parse_agi_result result_string
-                  code.should be == 200
-                  result.should be == -123
-                  data.should be == 'timeout'
-                end
-              end
-
-              context 'with a result and key-value data' do
-                let(:result_string) { "200%20result=123%20foo=bar%0A" }
-
-                it 'should provide the code and result' do
-                  code, result, data = subject.parse_agi_result result_string
-                  code.should be == 200
-                  result.should be == 123
-                  data.should be == 'foo=bar'
-                end
-              end
-            end
           end
         end
       end

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

@@ -26,16 +26,16 @@ module Punchblock
             end
 
             context 'initial execution' do
-              let(:component_id) { UUIDTools::UUID.random_create }
+              let(:component_id) { Punchblock.new_uuid }
 
               let :expected_response do
                 Ref.new :id => component_id
               end
 
-              before { UUIDTools::UUID.stubs :random_create => component_id }
+              before { stub_uuids component_id }
 
               it 'should send the appropriate RubyAMI::Action and send the component node a ref with the action ID' do
-                mock_translator.expects(:send_ami_action!).once.with(expected_action).returns(expected_action)
+                mock_translator.expects(:send_ami_action).once.with(expected_action).returns(expected_action)
                 command.expects(:response=).once.with(expected_response)
                 subject.execute
               end

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

@@ -42,12 +42,12 @@ module Punchblock
           describe '#execute' do
             before { original_command.request! }
 
-            it "calls answer_if_not_answered on the call" do
-              call.expects :answer_if_not_answered
+            it "calls send_progress on the call" do
+              call.expects(:send_progress)
               subject.execute
             end
 
-            before { call.stubs :answer_if_not_answered }
+            before { call.stubs :send_progress }
 
             let(:original_command_opts) { {} }
 
@@ -94,6 +94,11 @@ module Punchblock
                 it "should send a success complete event with the relevant data" do
                   reason.should be == expected_event
                 end
+
+                it "should not process further dtmf events" do
+                  subject.expects(:process_dtmf!).never
+                  send_ami_events_for_dtmf 3
+                end
               end
 
               context "when the match is invalid" do

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

@@ -32,16 +32,13 @@ module Punchblock
 
           subject { Output.new original_command, mock_call }
 
+          def expect_answered(value = true)
+            mock_call.expects(:answered?).returns(value).at_least_once
+          end
+
           describe '#execute' do
             before { original_command.request! }
 
-            it "calls answer_if_not_answered on the call" do
-              mock_call.expects :answer_if_not_answered
-              subject.execute
-            end
-
-            before { mock_call.stubs :answer_if_not_answered }
-
             context 'with a media engine of :swift' do
               let(:media_engine) { :swift }
 
@@ -90,6 +87,7 @@ module Punchblock
                 context "set to :any" do
                   let(:command_opts) { { :interrupt_on => :any } }
                   it "should add the interrupt options to the argument" do
+                    expect_answered
                     mock_call.expects(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options('', '|1|1')
                     subject.execute
                   end
@@ -98,6 +96,7 @@ module Punchblock
                 context "set to :dtmf" do
                   let(:command_opts) { { :interrupt_on => :dtmf } }
                   it "should add the interrupt options to the argument" do
+                    expect_answered
                     mock_call.expects(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options('', '|1|1')
                     subject.execute
                   end
@@ -307,6 +306,7 @@ module Punchblock
                 context "set to :any" do
                   let(:command_opts) { { :interrupt_on => :any } }
                   it "should pass the i option to MRCPSynth" do
+                    expect_answered
                     expect_mrcpsynth_with_options(/i=any/)
                     subject.execute
                   end
@@ -315,6 +315,7 @@ module Punchblock
                 context "set to :dtmf" do
                   let(:command_opts) { { :interrupt_on => :dtmf } }
                   it "should pass the i option to MRCPSynth" do
+                    expect_answered
                     expect_mrcpsynth_with_options(/i=any/)
                     subject.execute
                   end
@@ -334,12 +335,12 @@ module Punchblock
             context 'with a media engine of :asterisk' do
               let(:media_engine) { :asterisk }
 
-              def expect_stream_file_with_options(options = nil)
-                mock_call.expects(:send_agi_action!).once.with 'STREAM FILE', audio_filename, options do |*args|
-                  args[2].should be == options
-                  subject.continue!
-                  true
-                end
+              def expect_playback(filename = audio_filename)
+                mock_call.expects(:send_agi_action!).once.with 'EXEC Playback', filename
+              end
+
+              def expect_playback_noanswer
+                mock_call.expects(:send_agi_action!).once.with 'EXEC Playback', audio_filename + ',noanswer'
               end
 
               let(:audio_filename) { 'http://foo.com/bar.mp3' }
@@ -378,12 +379,16 @@ module Punchblock
                     }
                   end
 
-                  it 'should playback the audio file using STREAM FILE' do
-                    expect_stream_file_with_options
+                  it 'should playback the audio file using Playback' do
+                    expect_answered
+                    expect_playback
                     subject.execute
                   end
 
                   it 'should send a complete event when the file finishes playback' do
+                    def mock_call.answered?
+                      true
+                    end
                     def mock_call.send_agi_action!(*args, &block)
                       block.call Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new(:code => 200, :result => 1)
                     end
@@ -400,18 +405,45 @@ module Punchblock
                     }
                   end
 
-                  it 'should playback the audio file using STREAM FILE' do
-                    expect_stream_file_with_options
+                  it 'should playback the audio file using Playback' do
+                    expect_answered
+                    expect_playback
                     subject.execute
                   end
 
                   it 'should send a complete event when the file finishes playback' do
+                    expect_answered
                     def mock_call.send_agi_action!(*args, &block)
                       block.call Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new(:code => 200, :result => 1)
                     end
                     subject.execute
                     original_command.complete_event(0.1).reason.should be_a Punchblock::Component::Output::Complete::Success
                   end
+
+                  context "with early media playback" do
+                    it "should play the file with Playback" do
+                      expect_answered false
+                      expect_playback_noanswer
+                      mock_call.expects(:send_progress)
+                      subject.execute
+                    end
+
+                    context "with interrupt_on set to something that is not nil" do
+                      let(:audio_filename) { 'tt-monkeys' }
+                      let :command_options do
+                        {
+                          :ssml => RubySpeech::SSML.draw { string audio_filename },
+                          :interrupt_on => :any
+                        }
+                      end
+                      it "should return an error when the output is interruptible and it is early media" do
+                        expect_answered false
+                        error = ProtocolError.new.setup 'option error', 'Interrupt digits are not allowed with early media.'
+                        subject.execute
+                        original_command.response(0.1).should be == error
+                      end
+                    end
+                  end
                 end
 
                 context 'with a string (not SSML)' do
@@ -438,29 +470,27 @@ module Punchblock
                     }
                   end
 
-                  it 'should playback each audio file using STREAM FILE' do
+                  it 'should playback all audio files using Playback' do
                     latch = CountDownLatch.new 2
-                    mock_call.expects(:send_agi_action!).once.with 'STREAM FILE', audio_filename1, nil do
-                      subject.continue
-                      latch.countdown!
-                    end
-                    mock_call.expects(:send_agi_action!).once.with 'STREAM FILE', audio_filename2, nil do
-                      subject.continue
-                      latch.countdown!
-                    end
+                    expect_playback [audio_filename1, audio_filename2].join('&')
+                    expect_answered
                     subject.execute
                     latch.wait 2
                     sleep 2
                   end
 
                   it 'should send a complete event after the final file has finished playback' do
+                    expect_answered
                     def mock_call.send_agi_action!(*args, &block)
                       block.call Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new(:code => 200, :result => 1)
                     end
+                    latch = CountDownLatch.new 1
                     original_command.expects(:add_event).once.with do |e|
                       e.reason.should be_a Punchblock::Component::Output::Complete::Success
+                      latch.countdown!
                     end
                     subject.execute
+                    latch.wait(2).should be_true
                   end
                 end
 
@@ -484,8 +514,9 @@ module Punchblock
               describe 'start-offset' do
                 context 'unset' do
                   let(:command_opts) { { :start_offset => nil } }
-                  it 'should not pass any options to STREAM FILE' do
-                    expect_stream_file_with_options
+                  it 'should not pass any options to Playback' do
+                    expect_answered
+                    expect_playback
                     subject.execute
                   end
                 end
@@ -503,8 +534,9 @@ module Punchblock
               describe 'start-paused' do
                 context 'false' do
                   let(:command_opts) { { :start_paused => false } }
-                  it 'should not pass any options to STREAM FILE' do
-                    expect_stream_file_with_options
+                  it 'should not pass any options to Playback' do
+                    expect_answered
+                    expect_playback
                     subject.execute
                   end
                 end
@@ -522,8 +554,9 @@ module Punchblock
               describe 'repeat-interval' do
                 context 'unset' do
                   let(:command_opts) { { :repeat_interval => nil } }
-                  it 'should not pass any options to STREAM FILE' do
-                    expect_stream_file_with_options
+                  it 'should not pass any options to Playback' do
+                    expect_answered
+                    expect_playback
                     subject.execute
                   end
                 end
@@ -541,8 +574,9 @@ module Punchblock
               describe 'repeat-times' do
                 context 'unset' do
                   let(:command_opts) { { :repeat_times => nil } }
-                  it 'should not pass any options to STREAM FILE' do
-                    expect_stream_file_with_options
+                  it 'should not pass any options to Playback' do
+                    expect_answered
+                    expect_playback
                     subject.execute
                   end
                 end
@@ -560,8 +594,9 @@ module Punchblock
               describe 'max-time' do
                 context 'unset' do
                   let(:command_opts) { { :max_time => nil } }
-                  it 'should not pass any options to STREAM FILE' do
-                    expect_stream_file_with_options
+                  it 'should not pass any options to Playback' do
+                    expect_answered
+                    expect_playback
                     subject.execute
                   end
                 end
@@ -579,8 +614,9 @@ module Punchblock
               describe 'voice' do
                 context 'unset' do
                   let(:command_opts) { { :voice => nil } }
-                  it 'should not pass the v option to STREAM FILE' do
-                    expect_stream_file_with_options
+                  it 'should not pass the v option to Playback' do
+                    expect_answered
+                    expect_playback
                     subject.execute
                   end
                 end
@@ -596,27 +632,98 @@ module Punchblock
               end
 
               describe 'interrupt_on' do
+                def ami_event_for_dtmf(digit, position)
+                  RubyAMI::Event.new('DTMF').tap do |e|
+                    e['Digit']  = digit.to_s
+                    e['Start']  = position == :start ? 'Yes' : 'No'
+                    e['End']    = position == :end ? 'Yes' : 'No'
+                  end
+                end
+
+                def send_ami_events_for_dtmf(digit)
+                  mock_call.process_ami_event ami_event_for_dtmf(digit, :start)
+                  mock_call.process_ami_event ami_event_for_dtmf(digit, :end)
+                end
+
+                let(:reason) { original_command.complete_event(5).reason }
+                let(:channel) { "SIP/1234-00000000" }
+                let :ami_event do
+                  RubyAMI::Event.new('AsyncAGI').tap do |e|
+                    e['SubEvent'] = "Start"
+                    e['Channel']  = channel
+                    e['Env']      = "agi_request%3A%20async%0Aagi_channel%3A%20SIP%2F1234-00000000%0Aagi_language%3A%20en%0Aagi_type%3A%20SIP%0Aagi_uniqueid%3A%201320835995.0%0Aagi_version%3A%201.8.4.1%0Aagi_callerid%3A%205678%0Aagi_calleridname%3A%20Jane%20Smith%0Aagi_callingpres%3A%200%0Aagi_callingani2%3A%200%0Aagi_callington%3A%200%0Aagi_callingtns%3A%200%0Aagi_dnid%3A%201000%0Aagi_rdnis%3A%20unknown%0Aagi_context%3A%20default%0Aagi_extension%3A%201000%0Aagi_priority%3A%201%0Aagi_enhanced%3A%200.0%0Aagi_accountcode%3A%20%0Aagi_threadid%3A%204366221312%0A%0A"
+                  end
+                end
+
                 context "set to nil" do
                   let(:command_opts) { { :interrupt_on => nil } }
-                  it "should not pass any digits to STREAM FILE" do
-                    expect_stream_file_with_options
+                  it "does not redirect the call" do
+                    expect_answered
+                    expect_playback
+                    mock_call.expects(:redirect_back!).never
                     subject.execute
+                    original_command.response(0.1).should be_a Ref
+                    send_ami_events_for_dtmf 1
                   end
                 end
 
                 context "set to :any" do
                   let(:command_opts) { { :interrupt_on => :any } }
-                  it "should pass all digits to STREAM FILE" do
-                    expect_stream_file_with_options '0123456789*#'
-                    subject.execute
+
+                  before do
+                    expect_answered
+                    expect_playback
+                  end
+
+                  context "when a DTMF digit is received" do
+                    it "sends the correct complete event" do
+                      mock_call.expects :redirect_back!
+                      subject.execute
+                      original_command.response(0.1).should be_a Ref
+                      original_command.should_not be_complete
+                      send_ami_events_for_dtmf 1
+                      mock_call.process_ami_event! ami_event
+                      sleep 0.2
+                      original_command.should be_complete
+                      reason.should be_a Punchblock::Component::Output::Complete::Success
+                    end
+
+                    it "redirects the call back to async AGI" do
+                      mock_call.expects(:redirect_back!).with(nil).once
+                      subject.execute
+                      original_command.response(0.1).should be_a Ref
+                      send_ami_events_for_dtmf 1
+                    end
                   end
                 end
 
                 context "set to :dtmf" do
                   let(:command_opts) { { :interrupt_on => :dtmf } }
-                  it "should pass all digits to STREAM FILE" do
-                    expect_stream_file_with_options '0123456789*#'
-                    subject.execute
+
+                  before do
+                    expect_answered
+                    expect_playback
+                  end
+
+                  context "when a DTMF digit is received" do
+                    it "sends the correct complete event" do
+                      mock_call.expects :redirect_back!
+                      subject.execute
+                      original_command.response(0.1).should be_a Ref
+                      original_command.should_not be_complete
+                      send_ami_events_for_dtmf 1
+                      mock_call.process_ami_event! ami_event
+                      sleep 0.2
+                      original_command.should be_complete
+                      reason.should be_a Punchblock::Component::Output::Complete::Success
+                    end
+
+                    it "redirects the call back to async AGI" do
+                      mock_call.expects(:redirect_back!).with(nil).once
+                      subject.execute
+                      original_command.response(0.1).should be_a Ref
+                      send_ami_events_for_dtmf 1
+                    end
                   end
                 end