adhearsion 2.2.1 → 2.3.0

data/lib/adhearsion/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Adhearsion
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/spec/adhearsion/call_controller/input_spec.rb

@@ -9,27 +9,47 @@ module Adhearsion
       include CallControllerTestHelpers
 
       describe "#play_sound_files_for_menu" do
+        let(:renderer_options) { { renderer: nil } }
         let(:options) { Hash.new }
         let(:menu_instance) { MenuDSL::Menu.new(options) }
         let(:sound_file) { "press a button" }
         let(:sound_files) { [sound_file] }
 
         it "should play the sound files for the menu" do
-          subject.should_receive(:interruptible_play).with(sound_file).and_return("1")
+          subject.should_receive(:interruptible_play).with(sound_file, renderer_options).and_return("1")
           subject.play_sound_files_for_menu(menu_instance, sound_files).should be == '1'
         end
 
         it "should wait for digit if nothing is pressed during playback" do
-          subject.should_receive(:interruptible_play).with(sound_file).and_return(nil)
+          subject.should_receive(:interruptible_play).with(sound_file, renderer_options).and_return(nil)
           subject.should_receive(:wait_for_digit).with(menu_instance.timeout).and_return("1")
           subject.play_sound_files_for_menu(menu_instance, sound_files).should be == '1'
         end
 
+        context "with a renderer specified" do
+          let(:options) { { :renderer => :native } }
+          let(:renderer_options) { { renderer: :native } }
+          it "should play the sound files for the menu" do
+            subject.should_receive(:interruptible_play).with(sound_file, renderer_options).and_return("1")
+            subject.play_sound_files_for_menu(menu_instance, sound_files).should be == '1'
+          end
+
+        end
+
         context "when the menu is not interruptible" do
           let(:options) { { :interruptible => false } }
-
           it "should play the sound files and wait for digit" do
-            subject.should_receive(:play).with(sound_file).and_return true
+            subject.should_receive(:play).with(sound_file, renderer_options).and_return true
+            subject.should_receive(:wait_for_digit).with(menu_instance.timeout).and_return("1")
+            subject.play_sound_files_for_menu(menu_instance, sound_files).should be == '1'
+          end
+        end
+
+        context "with a renderer specified and not interruptible" do
+          let(:options) { { :renderer => :native, :interruptible => false } }
+          let(:renderer_options) { { renderer: :native } }
+          it "should pass the renderer option to #play" do
+            subject.should_receive(:play).with(sound_file, renderer_options).and_return true
             subject.should_receive(:wait_for_digit).with(menu_instance.timeout).and_return("1")
             subject.play_sound_files_for_menu(menu_instance, sound_files).should be == '1'
           end

data/spec/adhearsion/call_controller/menu_dsl/menu_spec.rb

@@ -117,6 +117,22 @@ module Adhearsion
               end
             end
 
+            context 'when renderer is not specified' do
+              it 'should have a nil renderer' do
+                subject.renderer.should be nil
+              end
+            end
+
+            context 'when renderer is specified' do
+              let(:options) {
+                {:renderer => :native}
+              }
+
+              it 'should have the specified renderer' do
+                subject.renderer.should == :native
+              end
+            end
+
             context 'when matchers are specified' do
               subject do
                 Menu.new do
@@ -347,6 +363,24 @@ module Adhearsion
                   menu_instance.result.should be == '242'
                 end
               end
+
+              context "when a digit limit and validator is defined" do
+                let(:menu_instance) do
+                  Menu.new options.merge(:limit => 3) do
+                    validator { |buffer| buffer == "242" }
+                  end
+                end
+
+                it "applies the validator before checking the digit limit" do
+                  menu_instance << 2
+                  menu_instance << 4
+                  menu_instance << 2
+                  menu_instance.continue.should be_a Menu::MenuValidatorTerminated
+                  menu_instance.continue.should be_a Menu::MenuResultDone
+                  menu_instance.status.should be == :validator_terminated
+                  menu_instance.result.should be == '242'
+                end
+              end
             end
 
           end#continue

data/spec/adhearsion/call_controller/output_spec.rb

@@ -69,6 +69,14 @@ module Adhearsion
             subject.play_audio(audio_file, :fallback => fallback).should be true
           end
         end
+
+        context "with a media engine" do
+          let(:media_engine) { :native }
+          it "should use the specified media engine in the component" do
+            expect_ssml_output ssml, renderer: media_engine
+            subject.play_audio(audio_file, renderer: media_engine).should be true
+          end
+        end
       end
 
       describe "#play_audio!" do
@@ -100,6 +108,14 @@ module Adhearsion
             subject.play_audio!(audio_file, :fallback => fallback).should be_a Punchblock::Component::Output
           end
         end
+
+        context "with a media engine" do
+          let(:media_engine) { :native }
+          it "should use the specified media engine in the SSML" do
+            expect_async_ssml_output ssml, renderer: media_engine
+            subject.play_audio!(audio_file, renderer: media_engine).should be_a Punchblock::Component::Output
+          end
+        end
       end
 
       describe "#play_numeric" do
@@ -319,6 +335,9 @@ module Adhearsion
       end
 
       describe '#play' do
+        let(:extra_options) do
+          { renderer: :native }
+        end
         describe "with a single string" do
           let(:audio_file) { "/foo/bar.wav" }
           let :ssml do
@@ -330,6 +349,11 @@ module Adhearsion
             expect_ssml_output ssml
             subject.play(audio_file).should be true
           end
+
+          it 'plays the audio file with the specified extra options if present' do
+            expect_ssml_output ssml, extra_options
+            subject.play(audio_file, extra_options).should be true
+          end
         end
 
         describe "with multiple arguments" do
@@ -349,6 +373,12 @@ module Adhearsion
             expect_ssml_output ssml
             subject.play(*args).should be true
           end
+
+          it 'plays all arguments in one document with the extra options if present' do
+            expect_ssml_output ssml, extra_options
+            args << extra_options
+            subject.play(*args).should be true
+          end
         end
 
         describe "with a collection of arguments" do
@@ -463,6 +493,9 @@ module Adhearsion
       end
 
       describe '#play!' do
+        let(:extra_options) do
+          { renderer: :native }
+        end
         describe "with a single string" do
           let(:audio_file) { "/foo/bar.wav" }
           let :ssml do
@@ -474,6 +507,11 @@ module Adhearsion
             expect_async_ssml_output ssml
             subject.play!(audio_file).should be_a Punchblock::Component::Output
           end
+
+          it 'plays the audio file with the specified extra options if present' do
+            expect_async_ssml_output ssml, extra_options
+            subject.play!(audio_file, extra_options)
+          end
         end
 
         describe "with multiple arguments" do
@@ -493,6 +531,12 @@ module Adhearsion
             expect_async_ssml_output ssml
             subject.play!(*args).should be_a Punchblock::Component::Output
           end
+
+          it 'plays all arguments in one document with the extra options if present' do
+            expect_async_ssml_output ssml, extra_options
+            args << extra_options
+            subject.play!(*args)
+          end
         end
 
         describe "with a number" do
@@ -591,6 +635,7 @@ module Adhearsion
         let(:output1)       { "one two" }
         let(:output2)       { "three four" }
         let(:non_existing)  { "http://adhearsion.com/nonexistingfile.mp3" }
+        let(:extra_options) { {renderer: :native } }
 
         it "plays two outputs in succession" do
           subject.should_receive(:stream_file).twice
@@ -604,6 +649,13 @@ module Adhearsion
           digit.should be == 2
         end
 
+        it "passes options on to #stream_file" do
+          subject.should_receive(:stream_file).once.with(output1, '0123456789#*', extra_options)
+          subject.should_receive(:stream_file).once.with(output2, '0123456789#*', extra_options)
+          digit = subject.interruptible_play output1, output2, extra_options
+          digit.should be_nil
+        end
+
         it 'raises an exception when output is unsuccessful' do
           subject.should_receive(:stream_file).once.and_raise Output::PlaybackError, "Output failed"
           expect { subject.interruptible_play non_existing }.to raise_error(Output::PlaybackError)
@@ -669,6 +721,19 @@ module Adhearsion
           expect_component_execution output_component
           subject.stream_file(prompt, allowed_digits).should be == '5'
         end
+
+        context "with output options passed in" do
+          let(:extra_options) { {renderer: :native } }
+          it "plays the correct output with options" do
+            def controller.write_and_await_response(input_component)
+              # it is actually a no-op here
+            end
+
+            expect_component_complete_event
+            expect_component_execution Punchblock::Component::Output.new({:ssml => ssml.to_s}.merge(extra_options))
+            subject.stream_file prompt, allowed_digits, extra_options
+          end
+        end
       end
 
       describe "#say" do

data/spec/adhearsion/call_controller/record_spec.rb

@@ -117,6 +117,24 @@ module Adhearsion
           end
         end
 
+        context "with :interruptible => '123'" do
+          let(:interruptible) { '123' }
+
+          let :stopper_grammar do
+            RubySpeech::GRXML.draw :mode => 'dtmf', :root => 'inputdigits' do
+              rule id: 'inputdigits', scope: 'public' do
+                one_of do
+                  item { '1' }
+                  item { '2' }
+                  item { '3' }
+                end
+              end
+            end
+          end
+
+          its(:stopper_component) { should == input_component }
+        end
+
         describe "setting completion handlers" do
           let(:complete_event) { Punchblock::Event::Complete.new }
 

data/spec/adhearsion/call_controller_spec.rb

@@ -94,7 +94,7 @@ module Adhearsion
       class InvokeController < CallController
         def run
           before
-          invoke second_controller, :foo => 'bar'
+          metadata[:invoke_result] = invoke second_controller, :foo => 'bar'
           after
         end
 
@@ -114,7 +114,7 @@ module Adhearsion
       before do
         flexmock subject, :execute_component_and_await_completion => nil
         flexmock call.wrapped_object, :write_and_await_response => nil
-        flexmock call, :register_controller! => nil
+        flexmock call, :register_controller => nil
         flexmock(Events).should_receive(:trigger).with(:exception, Exception).never
       end
 
@@ -126,6 +126,12 @@ module Adhearsion
         subject.execute!
       end
 
+      it "should return the outer controller's run method return value" do
+        flexmock(SecondController).new_instances.should_receive(:run).once.and_return(:run_result)
+        subject.execute!
+        subject.metadata[:invoke_result].should be == :run_result
+      end
+
       it "should invoke the new controller with metadata" do
         flexmock(SecondController).new_instances.should_receive(:md_check).once.with :foo => 'bar'
         subject.execute!
@@ -166,7 +172,7 @@ module Adhearsion
 
       before do
         flexmock call.wrapped_object, :write_and_await_response => nil
-        flexmock call, :register_controller! => nil
+        flexmock call, :register_controller => nil
         flexmock subject, :execute_component_and_await_completion => nil
         flexmock(SecondController).new_instances.should_receive(:md_check).once.with :foo => 'bar'
         flexmock(Events).should_receive(:trigger).with(:exception, Exception).never
@@ -348,15 +354,11 @@ module Adhearsion
 
       describe "with an error response" do
         let(:response) do
-          Punchblock::Event::Complete.new.tap do |complete|
-            complete << error
-          end
+          Punchblock::Event::Complete.new :reason => error
         end
 
-        let(:error) do |error|
-          Punchblock::Event::Complete::Error.new.tap do |e|
-            e << details
-          end
+        let(:error) do
+          Punchblock::Event::Complete::Error.new :details => details
         end
 
         let(:details) { "Oh noes, it's all borked" }

data/spec/adhearsion/call_spec.rb

@@ -30,7 +30,7 @@ module Adhearsion
     end
 
     after do
-      Adhearsion.active_calls.clear!
+      Adhearsion.active_calls.clear
     end
 
     it { should respond_to :<< }
@@ -236,9 +236,7 @@ module Adhearsion
 
       describe "for end events" do
         let :event do
-          Punchblock::Event::End.new.tap do |e|
-            flexmock e, :reason => :hangup
-          end
+          Punchblock::Event::End.new :reason => :hangup
         end
 
         it "should trigger any on_end callbacks set" do
@@ -317,9 +315,7 @@ module Adhearsion
     describe "#<<" do
       describe "with a Punchblock End" do
         let :end_event do
-          Punchblock::Event::End.new.tap do |e|
-            flexmock e, :reason => :hangup
-          end
+          Punchblock::Event::End.new :reason => :hangup
         end
 
         it "should mark the call as ended" do

data/spec/adhearsion/initializer_spec.rb

@@ -43,9 +43,9 @@ describe Adhearsion::Initializer do
 
     it "should create a pid file in the app's path when given 'true' as the pid_file hash key argument" do
       stub_behavior_for_initializer_with_no_path_changing_behavior do
-         flexmock(File).should_receive(:open).with(File.join(path, 'adhearsion.pid'), 'w', Proc).at_least.once
-         ahn = Adhearsion::Initializer.start :pid_file => true
-         ahn.pid_file[0, path.length].should be == path
+        flexmock(File).should_receive(:open).with(File.join(path, 'adhearsion.pid'), 'w', Proc).at_least.once
+        ahn = Adhearsion::Initializer.start :pid_file => true
+        ahn.pid_file[0, path.length].should be == path
       end
     end
 
@@ -58,6 +58,7 @@ describe Adhearsion::Initializer do
 
     it "should create a pid file in the app's path by default when daemonizing" do
       stub_behavior_for_initializer_with_no_path_changing_behavior do
+        flexmock(Adhearsion::CustomDaemonizer).should_receive(:daemonize).and_yield
         flexmock(File).should_receive(:open).once.with(File.join(path, 'adhearsion.pid'), 'w', Proc)
         ahn = Adhearsion::Initializer.start :mode => :daemon
         ahn.pid_file[0, path.size].should be == path
@@ -66,7 +67,8 @@ describe Adhearsion::Initializer do
 
     it "should NOT create a pid file in the app's path when daemonizing and :pid_file is given as false" do
       stub_behavior_for_initializer_with_no_path_changing_behavior do
-        ahn = Adhearsion::Initializer.start :daemon => true, :pid_file => false
+        flexmock(Adhearsion::CustomDaemonizer).should_receive(:daemonize).and_yield
+        ahn = Adhearsion::Initializer.start :mode => :daemon, :pid_file => false
         ahn.pid_file.should be nil
       end
     end

data/spec/adhearsion/plugin_spec.rb

@@ -146,7 +146,7 @@ describe Adhearsion::Plugin do
       it "should add a initializer when Plugin defines it" do
         FooBar = Class.new Adhearsion::Plugin do
           init :foo_bar do
-            FooBar.log "foo bar"
+            log "foo bar"
           end
           def self.log
           end
@@ -245,7 +245,7 @@ describe Adhearsion::Plugin do
       it "should add a runner when Plugin defines it" do
         FooBar = Class.new Adhearsion::Plugin do
           run :foo_bar do
-            FooBar.log "foo bar"
+            log "foo bar"
           end
           def self.log
           end

data/spec/adhearsion/process_spec.rb

@@ -50,7 +50,7 @@ module Adhearsion
       it "should hang up active calls" do
         3.times do
           fake_call = flexmock Call.new, :id => random_call_id
-          flexmock(fake_call).should_receive(:hangup!).once
+          flexmock(fake_call).should_receive(:hangup).once
           Adhearsion.active_calls << fake_call
         end
 

data/spec/adhearsion/punchblock_plugin/initializer_spec.rb

@@ -54,7 +54,7 @@ module Adhearsion
       end
 
       let(:call_id)   { rand }
-      let(:offer)     { Punchblock::Event::Offer.new.tap { |o| o.target_call_id = call_id } }
+      let(:offer)     { Punchblock::Event::Offer.new :target_call_id => call_id }
       let(:mock_call) { flexmock Call.new, :id => call_id }
 
       describe "starts the client with the default values" do
@@ -224,14 +224,16 @@ module Adhearsion
           end
         end
 
-        context "when when Adhearsion::Process is in :running" do
-          let(:process_state) { :running }
+        [ :running, :stopping ].each do |state|
+          context "when when Adhearsion::Process is in :#{state}" do
+            let(:process_state) { state }
 
-          it "should dispatch via the router" do
-            Adhearsion.router do
-              route 'foobar', Class.new
+            it "should dispatch via the router" do
+              Adhearsion.router do
+                route 'foobar', Class.new
+              end
+              flexmock(Adhearsion.router).should_receive(:handle).once.with mock_call
             end
-            flexmock(Adhearsion.router).should_receive(:handle).once.with mock_call
           end
         end