punchblock 1.3.0 → 1.4.0

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

@@ -0,0 +1,369 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    class Freeswitch
+      module Component
+        describe Output do
+          let(:connection) do
+            mock_connection_with_event_handler do |event|
+              original_command.add_event event
+            end
+          end
+          let(:translator)  { Punchblock::Translator::Freeswitch.new connection }
+          let(:mock_call)   { Punchblock::Translator::Freeswitch::Call.new 'foo', translator }
+
+          let :original_command do
+            Punchblock::Component::Output.new command_options
+          end
+
+          let :ssml_doc do
+            RubySpeech::SSML.draw do
+              say_as(:interpret_as => :cardinal) { 'FOO' }
+            end
+          end
+
+          let :command_options do
+            { :ssml => ssml_doc }
+          end
+
+          subject { Output.new original_command, mock_call }
+
+          describe '#execute' do
+            before { original_command.request! }
+            def expect_playback(filename = audio_filename)
+              subject.wrapped_object.expects(:application).once.with 'playback', "file_string://#{filename}"
+            end
+
+            let(:audio_filename) { 'http://foo.com/bar.mp3' }
+
+            let :ssml_doc do
+              RubySpeech::SSML.draw do
+                audio :src => audio_filename
+              end
+            end
+
+            let(:command_opts) { {} }
+
+            let :command_options do
+              { :ssml => ssml_doc }.merge(command_opts)
+            end
+
+            let :original_command do
+              Punchblock::Component::Output.new command_options
+            end
+
+            describe 'ssml' do
+              context 'unset' do
+                let(:command_opts) { { :ssml => nil } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'An SSML document is required.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+
+              context 'with a string (not SSML)' do
+                let :command_options do
+                  { :text => 'Foo Bar' }
+                end
+
+                it "should return an unrenderable document error" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'unrenderable document error', 'The provided document could not be rendered.'
+                  original_command.response(0.1).should be == error
+                end
+
+                context 'with a single text node without spaces' do
+                  let(:audio_filename) { 'http://foo.com/bar.mp3' }
+                  let :command_options do
+                    {
+                      :ssml => RubySpeech::SSML.draw { string audio_filename }
+                    }
+                  end
+
+                  it 'should playback the audio file using the playback application' do
+                    expect_playback
+                    subject.execute
+                  end
+                end
+              end
+
+              context 'with a single audio SSML node' do
+                let(:audio_filename) { 'http://foo.com/bar.mp3' }
+                let :command_options do
+                  {
+                    :ssml => RubySpeech::SSML.draw { audio :src => audio_filename }
+                  }
+                end
+
+                it 'should playback the audio file using the playback application' do
+                  expect_playback
+                  subject.execute
+                end
+
+                it 'should send a complete event when the file finishes playback' do
+                  expect_playback.yields true
+                  subject.execute
+                  subject.handle_es_event RubyFS::Event.new(nil, :event_name => "CHANNEL_EXECUTE_COMPLETE", :application_response => 'FILE PLAYED')
+                  original_command.complete_event(0.1).reason.should be_a Punchblock::Component::Output::Complete::Success
+                end
+
+                context "when playback returns an error" do
+                  let(:fs_event) { RubyFS::Event.new(nil, :event_name => "CHANNEL_EXECUTE_COMPLETE", :application_response => "PLAYBACK ERROR") }
+                  let(:complete_reason) { original_command.complete_event(0.1).reason }
+
+                  it "sends a complete event with an error reason" do
+                    expect_playback.yields true
+                    subject.execute
+                    subject.handle_es_event fs_event
+                    complete_reason.should be_a Punchblock::Event::Complete::Error
+                    complete_reason.details.should == 'Engine error: PLAYBACK ERROR'
+                  end
+                end
+              end
+
+              context 'with multiple audio SSML nodes' do
+                let(:audio_filename1) { 'http://foo.com/bar.mp3' }
+                let(:audio_filename2) { 'http://foo.com/baz.mp3' }
+                let :command_options do
+                  {
+                    :ssml => RubySpeech::SSML.draw do
+                      audio :src => audio_filename1
+                      audio :src => audio_filename2
+                    end
+                  }
+                end
+
+                it 'should playback all audio files using playback' do
+                  expect_playback [audio_filename1, audio_filename2].join('!')
+                  subject.execute
+                end
+
+                it 'should send a complete event when the files finish playback' do
+                  expect_playback([audio_filename1, audio_filename2].join('!')).yields true
+                  subject.execute
+                  subject.handle_es_event RubyFS::Event.new(nil, :event_name => "CHANNEL_EXECUTE_COMPLETE", :application_response => "FILE PLAYED")
+                  original_command.complete_event(0.1).reason.should be_a Punchblock::Component::Output::Complete::Success
+                end
+              end
+
+              context "with an SSML document containing elements other than <audio/>" do
+                let :command_options do
+                  {
+                    :ssml => RubySpeech::SSML.draw do
+                      string "Foo Bar"
+                    end
+                  }
+                end
+
+                it "should return an unrenderable document error" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'unrenderable document error', 'The provided document could not be rendered.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'start-offset' do
+              context 'unset' do
+                let(:command_opts) { { :start_offset => nil } }
+                it 'should not pass any options to Playback' do
+                  expect_playback
+                  subject.execute
+                end
+              end
+
+              context 'set' do
+                let(:command_opts) { { :start_offset => 10 } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'A start_offset value is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'start-paused' do
+              context 'false' do
+                let(:command_opts) { { :start_paused => false } }
+                it 'should not pass any options to Playback' do
+                  expect_playback
+                  subject.execute
+                end
+              end
+
+              context 'true' do
+                let(:command_opts) { { :start_paused => true } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'A start_paused value is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'repeat-interval' do
+              context 'unset' do
+                let(:command_opts) { { :repeat_interval => nil } }
+                it 'should not pass any options to Playback' do
+                  expect_playback
+                  subject.execute
+                end
+              end
+
+              context 'set' do
+                let(:command_opts) { { :repeat_interval => 10 } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'A repeat_interval value is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'repeat-times' do
+              context 'unset' do
+                let(:command_opts) { { :repeat_times => nil } }
+                it 'should not pass any options to Playback' do
+                  expect_playback
+                  subject.execute
+                end
+              end
+
+              context 'set' do
+                let(:command_opts) { { :repeat_times => 2 } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'A repeat_times value is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'max-time' do
+              context 'unset' do
+                let(:command_opts) { { :max_time => nil } }
+                it 'should not pass any options to Playback' do
+                  expect_playback
+                  subject.execute
+                end
+              end
+
+              context 'set' do
+                let(:command_opts) { { :max_time => 30 } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'A max_time value is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'voice' do
+              context 'unset' do
+                let(:command_opts) { { :voice => nil } }
+                it 'should not pass the v option to Playback' do
+                  expect_playback
+                  subject.execute
+                end
+              end
+
+              context 'set' do
+                let(:command_opts) { { :voice => 'alison' } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'A voice value is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'interrupt_on' do
+              context "set to nil" do
+                let(:command_opts) { { :interrupt_on => nil } }
+                it "should not pass any digits to Playback" do
+                  expect_playback
+                  subject.execute
+                end
+              end
+
+              context "set to :any" do
+                let(:command_opts) { { :interrupt_on => :any } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'An interrupt-on value of any is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+
+              context "set to :dtmf" do
+                let(:command_opts) { { :interrupt_on => :dtmf } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'An interrupt-on value of dtmf is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+
+              context "set to :speech" do
+                let(:command_opts) { { :interrupt_on => :speech } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'An interrupt-on value of speech is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+          end
+
+          describe "#execute_command" do
+            context "with a command it does not understand" do
+              let(:command) { Punchblock::Component::Output::Pause.new }
+
+              before { command.request! }
+
+              it "returns a ProtocolError response" do
+                subject.execute_command command
+                command.response(0.1).should be_a ProtocolError
+              end
+            end
+
+            context "with a Stop command" do
+              let(:command) { Punchblock::Component::Stop.new }
+              let(:reason) { original_command.complete_event(5).reason }
+
+              before do
+                command.request!
+                original_command.request!
+                original_command.execute!
+              end
+
+              it "sets the command response to true" do
+                subject.wrapped_object.expects(:application)
+                subject.execute_command command
+                command.response(0.1).should be == true
+              end
+
+              it "sends the correct complete event" do
+                subject.wrapped_object.expects(:application)
+                original_command.should_not be_complete
+                subject.execute_command command
+                reason.should be_a Punchblock::Event::Complete::Stop
+                original_command.should be_complete
+              end
+
+              it "breaks the current dialplan application" do
+                subject.wrapped_object.expects(:application).once.with 'break'
+                subject.execute_command command
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,373 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    class Freeswitch
+      module Component
+        describe Record do
+          let(:connection) do
+            mock_connection_with_event_handler do |event|
+              original_command.add_event event
+            end
+          end
+          let(:id)          { Punchblock.new_uuid }
+          let(:translator)  { Punchblock::Translator::Freeswitch.new connection }
+          let(:mock_stream) { mock('RubyFS::Stream') }
+          let(:mock_call)   { Punchblock::Translator::Freeswitch::Call.new id, translator, nil, mock_stream }
+
+          let :original_command do
+            Punchblock::Component::Record.new command_options
+          end
+
+          let :command_options do
+            {}
+          end
+
+          before { mock_stream.stub_everything }
+
+          subject { Record.new original_command, mock_call }
+
+          let(:filename)  { "#{Record::RECORDING_BASE_PATH}/#{subject.id}.wav" }
+
+          describe '#execute' do
+            let(:reason)    { original_command.complete_event(5).reason }
+            let(:recording) { original_command.complete_event(5).recording }
+
+            before { original_command.request! }
+
+            it "sets command response to a reference to the component" do
+              subject.execute
+              original_command.response(0.1).should be_a Ref
+              original_command.component_id.should be == subject.id
+            end
+
+            it "starts a recording via uuid_record, using the component ID as the filename" do
+              mock_call.expects(:uuid_foo).once.with(:record, "start #{filename}")
+              subject.execute
+            end
+
+            it "sends a success complete event when the recording ends" do
+              full_filename = "file://#{filename}"
+              subject.execute
+              record_stop_event = RubyFS::Event.new nil, {
+                :event_name       => 'RECORD_STOP',
+                :record_file_path => filename
+              }
+              mock_call.handle_es_event record_stop_event
+              reason.should be_a Punchblock::Component::Record::Complete::Success
+              recording.uri.should be == full_filename
+              original_command.should be_complete
+            end
+
+            describe 'start_paused' do
+              context "set to nil" do
+                let(:command_options) { { :start_paused => nil } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              context "set to false" do
+                let(:command_options) { { :start_paused => false } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              context "set to true" do
+                let(:command_options) { { :start_paused => true } }
+                it "should return an error and not execute any actions" do
+                  mock_call.expects(:uuid_foo).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
+                end
+              end
+            end
+
+            describe 'initial_timeout' do
+              context "set to nil" do
+                let(:command_options) { { :initial_timeout => nil } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              context "set to -1" do
+                let(:command_options) { { :initial_timeout => -1 } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              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.expects(:uuid_foo).never
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'An initial-timeout value is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'final_timeout' do
+              context "set to nil" do
+                let(:command_options) { { :final_timeout => nil } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              context "set to -1" do
+                let(:command_options) { { :final_timeout => -1 } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              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.expects(:send_agi_action!).never
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'A final-timeout value is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'format' do
+              context "set to nil" do
+                let(:command_options) { { :format => nil } }
+                it "should execute as 'wav'" do
+                  mock_call.expects(:uuid_foo).once.with(:record, regexp_matches(/.wav/))
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+
+                it "provides the correct filename in the recording" do
+                  mock_call.expects(:uuid_foo)
+                  subject.execute
+                  record_stop_event = RubyFS::Event.new nil, {
+                    :event_name       => 'RECORD_STOP',
+                    :record_file_path => "#{Record::RECORDING_BASE_PATH}/#{subject.id}.wav"
+                  }
+                  mock_call.handle_es_event record_stop_event
+                  recording.uri.should match(/.*\.wav$/)
+                end
+              end
+
+              context "set to 'mp3'" do
+                let(:command_options) { { :format => 'mp3' } }
+                it "should execute as 'mp3'" do
+                  mock_call.expects(:uuid_foo).once.with(:record, regexp_matches(/.mp3/))
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+
+                it "provides the correct filename in the recording" do
+                  mock_call.expects(:uuid_foo)
+                  subject.execute
+                  record_stop_event = RubyFS::Event.new nil, {
+                    :event_name       => 'RECORD_STOP',
+                    :record_file_path => "#{Record::RECORDING_BASE_PATH}/#{subject.id}.mp3"
+                  }
+                  mock_call.handle_es_event record_stop_event
+                  recording.uri.should match(/.*\.mp3$/)
+                end
+              end
+            end
+
+            describe 'start_beep' do
+              context "set to nil" do
+                let(:command_options) { { :start_beep => nil } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              context "set to false" do
+                let(:command_options) { { :start_beep => false } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              context "set to true" do
+                let(:command_options) { { :start_beep => true } }
+
+                it "should return an error and not execute any actions" do
+                  mock_call.expects(:uuid_foo).never
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'A start-beep value of true is unsupported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+            end
+
+            describe 'max_duration' do
+              context "set to nil" do
+                let(:command_options) { { :max_duration => nil } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once.with(:record, regexp_matches(/.wav$/))
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              context "set to -1" do
+                let(:command_options) { { :max_duration => -1 } }
+                it "should execute normally" do
+                  mock_call.expects(:uuid_foo).once.with(:record, regexp_matches(/.wav$/))
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+
+              context 'a negative number other than -1' do
+                let(:command_options) { { :max_duration => -1000 } }
+
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'A max-duration value that is negative (and not -1) is invalid.'
+                  original_command.response(0.1).should be == error
+                end
+              end
+
+              context 'a positive number' do
+                let(:reason) { original_command.complete_event(5).reason }
+                let(:recording) { original_command.complete_event(5).recording }
+                let(:command_options) { { :max_duration => 1000 } }
+
+                it "executes the recording with a time limit" do
+                  mock_call.expects(:uuid_foo).once.with(:record, regexp_matches(/.wav 1$/))
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+              end
+            end
+          end
+
+          describe "#execute_command" do
+            let(:reason) { original_command.complete_event(5).reason }
+            let(:recording) { original_command.complete_event(5).recording }
+
+            context "with a command it does not understand" do
+              let(:command) { Punchblock::Component::Output::Pause.new }
+
+              before { command.request! }
+              it "returns a ProtocolError response" do
+                subject.execute_command command
+                command.response(0.1).should be_a ProtocolError
+              end
+            end
+
+            context "with a Stop command" do
+              let(:command) { Punchblock::Component::Stop.new }
+
+              before do
+                mock_call.expects :uuid_foo
+                command.request!
+                original_command.request!
+                subject.execute
+              end
+
+              let :send_stop_event do
+                record_stop_event = RubyFS::Event.new nil, {
+                  :event_name       => 'RECORD_STOP',
+                  :record_file_path => filename
+                }
+                mock_call.handle_es_event record_stop_event
+              end
+
+              it "sets the command response to true" do
+                mock_call.expects :uuid_foo
+                subject.execute_command command
+                send_stop_event
+                command.response(0.1).should be == true
+              end
+
+              it "executes a uuid_record stop command" do
+                mock_call.expects(:uuid_foo).with(:record, "stop #{filename}")
+                subject.execute_command command
+              end
+
+              it "sends the correct complete event" do
+                mock_call.expects(:uuid_foo).with(:record, "stop #{filename}")
+                subject.execute_command command
+                send_stop_event
+                reason.should be_a Punchblock::Event::Complete::Stop
+                recording.uri.should be == "file://#{filename}"
+                original_command.should be_complete
+              end
+            end
+
+            context "with a Pause command" do
+              let(:command) { Punchblock::Component::Record::Pause.new }
+
+              before do
+                pending
+                mock_call.expects :uuid_foo
+                command.request!
+                original_command.request!
+                subject.execute
+              end
+
+              it "sets the command response to true" do
+                subject.execute_command command
+                command.response(0.1).should be == true
+              end
+
+              it "pauses the recording via AMI" do
+                mock_call.expects(:uuid_foo).once.with('PauseMonitor', 'Channel' => channel)
+                subject.execute_command command
+              end
+            end
+
+            context "with a Resume command" do
+              let(:command) { Punchblock::Component::Record::Resume.new }
+
+              before do
+                pending
+                mock_call.expects :uuid_foo
+                command.request!
+                original_command.request!
+                subject.execute
+              end
+
+              it "sets the command response to true" do
+                subject.execute_command command
+                command.response(0.1).should be == true
+              end
+
+              it "resumes the recording via AMI" do
+                mock_call.expects(:uuid_foo).once.with('ResumeMonitor', 'Channel' => channel)
+                subject.execute_command command
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end