punchblock 1.6.1 → 1.7.0

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

@@ -8,33 +8,30 @@ module Punchblock
       module Component
         module Asterisk
           describe AGICommand do
+            include HasMockCallbackConnection
+
             let(:channel)       { 'SIP/foo' }
-            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)  { Punchblock.new_uuid }
 
             before { stub_uuids component_id }
 
-            let :command do
+            let :original_command do
               Punchblock::Component::Asterisk::AGI::Command.new :name => 'EXEC ANSWER'
             end
 
-            subject { AGICommand.new command, mock_call }
+            subject { AGICommand.new original_command, mock_call }
 
             let :expected_action do
               RubyAMI::Action.new 'AGI', 'Channel' => channel, 'Command' => 'EXEC ANSWER', 'CommandID' => component_id
             end
 
             context 'initial execution' do
-              before { command.request! }
+              before { original_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.should_receive(:send_ami_action).once.with(expected_action).and_return(expected_action)
                 subject.execute
               end
 
@@ -45,12 +42,12 @@ module Punchblock
                   RubyAMI::Action.new 'AGI', 'Channel' => channel, 'Command' => 'WAIT FOR DIGIT "1000" "foo"', 'CommandID' => component_id
                 end
 
-                let :command do
+                let :original_command do
                   Punchblock::Component::Asterisk::AGI::Command.new :name => 'WAIT FOR DIGIT', :params => params
                 end
 
                 it 'should send the appropriate RubyAMI::Action' do
-                  mock_call.expects(:send_ami_action).once.with(expected_action).returns(expected_action)
+                  mock_call.should_receive(:send_ami_action).once.with(expected_action).and_return(expected_action)
                   subject.execute
                 end
               end
@@ -58,8 +55,8 @@ module Punchblock
 
             context 'when the AMI action completes' do
               before do
-                command.request!
-                command.execute!
+                original_command.request!
+                original_command.execute!
               end
 
               let :expected_response do
@@ -69,12 +66,12 @@ module Punchblock
               let :response do
                 RubyAMI::Response.new.tap do |r|
                   r['ActionID'] = "552a9d9f-46d7-45d8-a257-06fe95f48d99"
-                  r['Message']  = 'Added AGI command to queue'
+                  r['Message']  = 'Added AGI original_command to queue'
                 end
               end
 
               it 'should send the component node a ref with the action ID' do
-                command.expects(:response=).once.with(expected_response)
+                original_command.should_receive(:response=).once.with(expected_response)
                 subject.action << response
               end
 
@@ -84,7 +81,7 @@ module Punchblock
                 end
 
                 it 'should send the component node false' do
-                  command.expects(:response=).once.with false
+                  original_command.should_receive(:response=).once.with false
                   subject.action << error
                 end
               end
@@ -92,8 +89,8 @@ module Punchblock
 
             describe 'when receiving an AsyncAGI event' do
               before do
-                command.request!
-                command.execute!
+                original_command.request!
+                original_command.execute!
               end
 
               context 'of type start'
@@ -118,9 +115,9 @@ module Punchblock
                 it 'should send a complete event' do
                   subject.handle_ami_event ami_event
 
-                  complete_event = command.complete_event 0.5
+                  complete_event = original_command.complete_event 0.5
 
-                  command.should be_complete
+                  original_command.should be_complete
 
                   complete_event.component_id.should be == component_id.to_s
                   complete_event.reason.should be == expected_complete_reason

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

@@ -8,18 +8,15 @@ module Punchblock
       module Component
         module Asterisk
           describe AMIAction do
-            let(:connection) do
-              mock_connection_with_event_handler do |event|
-                command.add_event event
-              end
-            end
+            include HasMockCallbackConnection
+
             let(:mock_translator) { Punchblock::Translator::Asterisk.new mock('AMI'), connection }
 
-            let :command do
+            let :original_command do
               Punchblock::Component::Asterisk::AMI::Action.new :name => 'ExtensionStatus', :params => { :context => 'default', :exten => 'idonno' }
             end
 
-            subject { AMIAction.new command, mock_translator }
+            subject { AMIAction.new original_command, mock_translator }
 
             let :expected_action do
               RubyAMI::Action.new 'ExtensionStatus', 'Context' => 'default', 'Exten' => 'idonno'
@@ -35,16 +32,16 @@ module Punchblock
               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)
-                command.expects(:response=).once.with(expected_response)
+                mock_translator.should_receive(:send_ami_action).once.with(expected_action).and_return(expected_action)
+                original_command.should_receive(:response=).once.with(expected_response)
                 subject.execute
               end
             end
 
             context 'when the AMI action completes' do
               before do
-                command.request!
-                command.execute!
+                original_command.request!
+                original_command.execute!
               end
 
               let :response do
@@ -64,13 +61,13 @@ module Punchblock
 
               context 'for a non-causal action' do
                 it 'should send a complete event to the component node' do
-                  subject.wrapped_object.expects(:send_complete_event).once.with expected_complete_reason
+                  subject.wrapped_object.should_receive(:send_complete_event).once.with expected_complete_reason
                   subject.handle_response response
                 end
               end
 
               context 'for a causal action' do
-                let :command do
+                let :original_command do
                   Punchblock::Component::Asterisk::AMI::Action.new :name => 'CoreShowChannels'
                 end
 
@@ -117,7 +114,7 @@ module Punchblock
 
                 it 'should send events to the component node' do
                   event_node
-                  command.register_handler :internal, Punchblock::Event::Asterisk::AMI::Event do |event|
+                  original_command.register_handler :internal, Punchblock::Event::Asterisk::AMI::Event do |event|
                     @event = event
                   end
                   action = subject.action
@@ -131,7 +128,7 @@ module Punchblock
                   subject.action << response
                   subject.action << terminating_event
 
-                  command.complete_event(0.5).reason.should be == expected_complete_reason
+                  original_command.complete_event(0.5).reason.should be == expected_complete_reason
                 end
               end
 
@@ -145,7 +142,7 @@ module Punchblock
                 end
 
                 it 'should send a complete event to the component node' do
-                  subject.wrapped_object.expects(:send_complete_event).once.with expected_complete_reason
+                  subject.wrapped_object.should_receive(:send_complete_event).once.with expected_complete_reason
                   subject.handle_response error
                 end
               end

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

@@ -7,11 +7,8 @@ module Punchblock
     class Asterisk
       module Component
         describe Input do
-          let(:connection) do
-            mock_connection_with_event_handler do |event|
-              original_command.add_event event
-            end
-          end
+          include HasMockCallbackConnection
+
           let(:media_engine)    { nil }
           let(:translator)      { Punchblock::Translator::Asterisk.new mock('AMI'), connection, media_engine }
           let(:call)            { Punchblock::Translator::Asterisk::Call.new 'foo', translator }
@@ -43,11 +40,11 @@ module Punchblock
             before { original_command.request! }
 
             it "calls send_progress on the call" do
-              call.expects(:send_progress)
+              call.should_receive(:send_progress)
               subject.execute
             end
 
-            before { call.stubs :send_progress }
+            before { call.stub :send_progress }
 
             let(:original_command_opts) { {} }
 
@@ -96,7 +93,7 @@ module Punchblock
                 end
 
                 it "should not process further dtmf events" do
-                  subject.expects(:process_dtmf!).never
+                  subject.should_receive(:process_dtmf!).never
                   send_ami_events_for_dtmf 3
                 end
               end
@@ -191,7 +188,7 @@ module Punchblock
                 let(:original_command_opts) { { :initial_timeout => -1 } }
 
                 it "should not start a timer" do
-                  subject.wrapped_object.expects(:begin_initial_timer).never
+                  subject.wrapped_object.should_receive(:begin_initial_timer).never
                   subject.execute
                 end
               end
@@ -200,7 +197,7 @@ module Punchblock
                 let(:original_command_opts) { { :initial_timeout => nil } }
 
                 it "should not start a timer" do
-                  subject.wrapped_object.expects(:begin_initial_timer).never
+                  subject.wrapped_object.should_receive(:begin_initial_timer).never
                   subject.execute
                 end
               end
@@ -243,7 +240,7 @@ module Punchblock
                 let(:original_command_opts) { { :inter_digit_timeout => -1 } }
 
                 it "should not start a timer" do
-                  subject.wrapped_object.expects(:begin_inter_digit_timer).never
+                  subject.wrapped_object.should_receive(:begin_inter_digit_timer).never
                   subject.execute
                 end
               end
@@ -252,7 +249,7 @@ module Punchblock
                 let(:original_command_opts) { { :inter_digit_timeout => nil } }
 
                 it "should not start a timer" do
-                  subject.wrapped_object.expects(:begin_inter_digit_timer).never
+                  subject.wrapped_object.should_receive(:begin_inter_digit_timer).never
                   subject.execute
                 end
               end

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

@@ -7,11 +7,8 @@ module Punchblock
     class Asterisk
       module Component
         describe Output do
-          let(:connection) do
-            mock_connection_with_event_handler do |event|
-              original_command.add_event event
-            end
-          end
+          include HasMockCallbackConnection
+
           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 }
@@ -33,14 +30,24 @@ module Punchblock
           subject { Output.new original_command, mock_call }
 
           def expect_answered(value = true)
-            mock_call.expects(:answered?).returns(value).at_least_once
+            mock_call.should_receive(:answered?).at_least(:once).and_return(value)
           end
 
           describe '#execute' do
             before { original_command.request! }
 
+            context 'with an invalid media engine' do
+              let(:media_engine) { 'foobar' }
+
+              it "should return an error and not execute any actions" do
+                subject.execute
+                error = ProtocolError.new.setup 'option error', 'The renderer foobar is unsupported.'
+                original_command.response(0.1).should be == error
+              end
+            end
+
             context 'with a media engine of :swift' do
-              let(:media_engine) { :swift }
+              let(:media_engine) { 'swift' }
 
               let(:audio_filename) { 'http://foo.com/bar.mp3' }
 
@@ -63,7 +70,7 @@ module Punchblock
               end
 
               it "should execute Swift" do
-                mock_call.expects(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options
+                mock_call.should_receive(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options
                 subject.execute
               end
 
@@ -79,7 +86,7 @@ module Punchblock
                 context "set to nil" do
                   let(:command_opts) { { :interrupt_on => nil } }
                   it "should not add interrupt arguments" do
-                    mock_call.expects(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options
+                    mock_call.should_receive(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options
                     subject.execute
                   end
                 end
@@ -88,7 +95,7 @@ module Punchblock
                   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')
+                    mock_call.should_receive(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options('', '|1|1')
                     subject.execute
                   end
                 end
@@ -97,7 +104,7 @@ module Punchblock
                   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')
+                    mock_call.should_receive(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options('', '|1|1')
                     subject.execute
                   end
                 end
@@ -116,7 +123,7 @@ module Punchblock
                 context "set to nil" do
                   let(:command_opts) { { :voice => nil } }
                   it "should not add a voice at the beginning of the argument" do
-                    mock_call.expects(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options
+                    mock_call.should_receive(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options
                     subject.execute
                   end
                 end
@@ -124,7 +131,7 @@ module Punchblock
                 context "set to Leonard" do
                   let(:command_opts) { { :voice => "Leonard" } }
                   it "should add a voice at the beginning of the argument" do
-                    mock_call.expects(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options('Leonard^', '')
+                    mock_call.should_receive(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options('Leonard^', '')
                     subject.execute
                   end
                 end
@@ -151,14 +158,14 @@ module Punchblock
               end
 
               def expect_mrcpsynth_with_options(options)
-                mock_call.expects(:send_agi_action!).once.with do |*args|
+                mock_call.should_receive(:send_agi_action!).once.with do |*args|
                   args[0].should be == 'EXEC MRCPSynth'
                   args[2].should match options
                 end
               end
 
               it "should execute MRCPSynth" do
-                mock_call.expects(:send_agi_action!).once.with 'EXEC MRCPSynth', ssml_doc.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }, ''
+                mock_call.should_receive(:send_agi_action!).once.with 'EXEC MRCPSynth', ssml_doc.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }, ''
                 subject.execute
               end
 
@@ -170,7 +177,7 @@ module Punchblock
                 end
 
                 it 'should escape TTS strings containing a comma' do
-                  mock_call.expects(:send_agi_action!).once.with do |*args|
+                  mock_call.should_receive(:send_agi_action!).once.with do |*args|
                     args[0].should be == 'EXEC MRCPSynth'
                     args[1].should match(/this\\, here\\, is a test/)
                   end
@@ -352,11 +359,11 @@ module Punchblock
               let(:media_engine) { :asterisk }
 
               def expect_playback(filename = audio_filename)
-                mock_call.expects(:send_agi_action!).once.with 'EXEC Playback', filename
+                mock_call.should_receive(: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'
+                mock_call.should_receive(:send_agi_action!).once.with 'EXEC Playback', audio_filename + ',noanswer'
               end
 
               let(:audio_filename) { 'http://foo.com/bar.mp3' }
@@ -440,7 +447,7 @@ module Punchblock
                     it "should play the file with Playback" do
                       expect_answered false
                       expect_playback_noanswer
-                      mock_call.expects(:send_progress)
+                      mock_call.should_receive(:send_progress)
                       subject.execute
                     end
 
@@ -501,7 +508,7 @@ module Punchblock
                       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|
+                    original_command.should_receive(:add_event).once.with do |e|
                       e.reason.should be_a Punchblock::Component::Output::Complete::Success
                       latch.countdown!
                     end
@@ -676,7 +683,7 @@ module Punchblock
                   it "does not redirect the call" do
                     expect_answered
                     expect_playback
-                    mock_call.expects(:redirect_back!).never
+                    mock_call.should_receive(:redirect_back!).never
                     subject.execute
                     original_command.response(0.1).should be_a Ref
                     send_ami_events_for_dtmf 1
@@ -693,7 +700,7 @@ module Punchblock
 
                   context "when a DTMF digit is received" do
                     it "sends the correct complete event" do
-                      mock_call.expects :redirect_back!
+                      mock_call.should_receive :redirect_back!
                       subject.execute
                       original_command.response(0.1).should be_a Ref
                       original_command.should_not be_complete
@@ -705,7 +712,7 @@ module Punchblock
                     end
 
                     it "redirects the call back to async AGI" do
-                      mock_call.expects(:redirect_back!).with(nil).once
+                      mock_call.should_receive(:redirect_back!).once
                       subject.execute
                       original_command.response(0.1).should be_a Ref
                       send_ami_events_for_dtmf 1
@@ -723,7 +730,7 @@ module Punchblock
 
                   context "when a DTMF digit is received" do
                     it "sends the correct complete event" do
-                      mock_call.expects :redirect_back!
+                      mock_call.should_receive :redirect_back!
                       subject.execute
                       original_command.response(0.1).should be_a Ref
                       original_command.should_not be_complete
@@ -735,7 +742,7 @@ module Punchblock
                     end
 
                     it "redirects the call back to async AGI" do
-                      mock_call.expects(:redirect_back!).with(nil).once
+                      mock_call.should_receive(:redirect_back!).once
                       subject.execute
                       original_command.response(0.1).should be_a Ref
                       send_ami_events_for_dtmf 1
@@ -753,6 +760,32 @@ module Punchblock
                 end
               end
             end
+
+            context "with a media renderer set on itself" do
+              let(:media_engine) { :swift }
+              let(:audio_filename) { '/foo/bar.wav' }
+              let :ssml_doc do
+                RubySpeech::SSML.draw do
+                  audio :src => audio_filename
+                end
+              end
+
+              let(:command_opts) { {:renderer => :asterisk} }
+
+              let :command_options do
+                { :ssml => ssml_doc }.merge(command_opts)
+              end
+
+              let :original_command do
+                Punchblock::Component::Output.new command_options
+              end
+
+              it "should use the media renderer set and not the platform default" do
+                expect_answered
+                mock_call.should_receive(:send_agi_action!).once.with 'EXEC Playback', audio_filename
+                subject.execute
+              end
+            end
           end
 
           describe "#execute_command" do
@@ -785,22 +818,22 @@ module Punchblock
               end
 
               it "sets the command response to true" do
-                mock_call.expects(:redirect_back!)
+                mock_call.should_receive(:redirect_back!)
                 subject.execute_command command
                 command.response(0.1).should be == true
               end
 
               it "sends the correct complete event" do
-                mock_call.expects(:redirect_back!)
+                mock_call.should_receive(:redirect_back!)
                 subject.execute_command command
                 original_command.should_not be_complete
-                mock_call.process_ami_event! ami_event
+                mock_call.process_ami_event ami_event
                 reason.should be_a Punchblock::Event::Complete::Stop
                 original_command.should be_complete
               end
 
               it "redirects the call by unjoining it" do
-                mock_call.expects(:redirect_back!).with(nil)
+                mock_call.should_receive(:redirect_back!)
                 subject.execute_command command
               end
             end