punchblock 1.8.0 → 1.8.1

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

@@ -15,7 +15,7 @@ module Punchblock
             end
           end
 
-          let(:mock_call) { mock 'Call', :id => 'foo' }
+          let(:mock_call) { Call.new 'SIP/foo', mock('Translator') }
           subject { MockComponent.new Hash.new, mock_call }
 
           describe "#execute_command" do
@@ -37,7 +37,7 @@ module Punchblock
               end
 
               it "sets the command response to true" do
-                mock_call.should_receive(:redirect_back!)
+                mock_call.async.should_receive(:redirect_back)
                 mock_call.should_receive(:register_handler).with do |type, *guards|
                   type.should be == :ami
                   guards.should have(2).guards

data/spec/punchblock/translator/asterisk_spec.rb

@@ -32,7 +32,7 @@ module Punchblock
       describe '#shutdown' do
         it "instructs all calls to shutdown" do
           call = Asterisk::Call.new 'foo', subject
-          call.should_receive(:shutdown!).once
+          call.async.should_receive(:shutdown).once
           subject.register_call call
           subject.shutdown
         end
@@ -147,7 +147,7 @@ module Punchblock
           end
 
           it 'sends the command to the call for execution' do
-            call.should_receive(:execute_command!).once.with command
+            call.async.should_receive(:execute_command).once.with command
             subject.execute_call_command command
           end
         end
@@ -235,10 +235,11 @@ module Punchblock
       end
 
       describe '#execute_component_command' do
-        let(:component_id)  { '123abc' }
-        let(:component)     { mock 'Translator::Asterisk::Component', :id => component_id }
+        let(:call)            { Translator::Asterisk::Call.new 'SIP/foo', subject }
+        let(:component_node)  { Component::Output.new }
+        let(:component)       { Translator::Asterisk::Component::Output.new(component_node, call) }
 
-        let(:command) { Component::Stop.new.tap { |c| c.component_id = component_id } }
+        let(:command) { Component::Stop.new.tap { |c| c.component_id = component.id } }
 
         before do
           command.request!
@@ -250,7 +251,7 @@ module Punchblock
           end
 
           it 'sends the command to the component for execution' do
-            component.should_receive(:execute_command!).once.with command
+            component.async.should_receive(:execute_command).once.with command
             subject.execute_component_command command
           end
         end
@@ -258,7 +259,7 @@ module Punchblock
         context "with an unknown component ID" do
           it 'sends an error in response to the command' do
             subject.execute_component_command command
-            command.response.should be == ProtocolError.new.setup(:item_not_found, "Could not find a component with ID #{component_id}", nil, component_id)
+            command.response.should be == ProtocolError.new.setup(:item_not_found, "Could not find a component with ID #{component.id}", nil, component.id)
           end
         end
       end
@@ -283,7 +284,7 @@ module Punchblock
           it 'should instruct the call to send a dial' do
             mock_call = stub('Asterisk::Call').as_null_object
             Asterisk::Call.should_receive(:new_link).once.and_return mock_call
-            mock_call.should_receive(:dial!).once.with command
+            mock_call.async.should_receive(:dial).once.with command
             subject.execute_global_command command
           end
         end
@@ -297,7 +298,7 @@ module Punchblock
 
           it 'should create a component actor and execute it asynchronously' do
             Asterisk::Component::Asterisk::AMIAction.should_receive(:new).once.with(command, subject).and_return mock_action
-            mock_action.should_receive(:execute!).once
+            mock_action.async.should_receive(:execute).once
             subject.execute_global_command command
           end
 
@@ -422,7 +423,7 @@ module Punchblock
             mock_call = stub('Asterisk::Call').as_null_object
             Asterisk::Call.should_receive(:new).once.and_return mock_call
             subject.wrapped_object.should_receive(:link)
-            mock_call.should_receive(:send_offer!).once
+            mock_call.async.should_receive(:send_offer).once
             subject.handle_ami_event ami_event
           end
 
@@ -554,7 +555,7 @@ module Punchblock
           end
 
           it 'sends the AMI event to the call and to the connection as a PB event' do
-            call.should_receive(:process_ami_event!).once.with ami_event
+            call.async.should_receive(:process_ami_event).once.with ami_event
             subject.handle_ami_event ami_event
           end
 
@@ -576,8 +577,8 @@ module Punchblock
               before { subject.register_call call2 }
 
               it 'should send the event to both calls and to the connection once as a PB event' do
-                call.should_receive(:process_ami_event!).once.with ami_event
-                call2.should_receive(:process_ami_event!).once.with ami_event
+                call.async.should_receive(:process_ami_event).once.with ami_event
+                call2.async.should_receive(:process_ami_event).once.with ami_event
                 subject.handle_ami_event ami_event
               end
             end
@@ -612,12 +613,12 @@ module Punchblock
           end
 
           it 'sends the AMI event to the call and to the connection as a PB event if it is an allowed event' do
-            call.should_receive(:process_ami_event!).once.with ami_event
+            call.async.should_receive(:process_ami_event).once.with ami_event
             subject.handle_ami_event ami_event
           end
 
           it 'does not send the AMI event to a bridged channel if it is not allowed' do
-            call.should_receive(:process_ami_event!).never.with ami_event2
+            call.async.should_receive(:process_ami_event).never.with ami_event2
             subject.handle_ami_event ami_event2
           end
 
@@ -632,6 +633,8 @@ module Punchblock
       end
 
       describe '#run_at_fully_booted' do
+        let(:broken_path) { "/this/is/not/a/valid/path" }
+
         let(:passed_show) do
           OpenStruct.new({:text_body => "[ Context 'adhearsion-redirect' created by 'pbx_config' ]\n '1' => 1. AGI(agi:async)[pbx_config]\n\n-= 1 extension (1 priority) in 1 context. =-"})
         end
@@ -658,22 +661,21 @@ module Punchblock
           Punchblock.logger.should_receive(:error).once.with("Punchblock failed to add the #{Asterisk::REDIRECT_EXTENSION} extension to the #{Asterisk::REDIRECT_CONTEXT} context. Please add a [#{Asterisk::REDIRECT_CONTEXT}] entry to your dialplan.")
           subject.run_at_fully_booted
         end
+
+        it 'should check the recording directory for existence' do
+          stub_const('Punchblock::Translator::Asterisk::Component::Record::RECORDING_BASE_PATH', broken_path)
+          ami_client.should_receive(:send_action).once.with 'Command', 'Command' => "dialplan add extension #{Asterisk::REDIRECT_EXTENSION},#{Asterisk::REDIRECT_PRIORITY},AGI,agi:async into #{Asterisk::REDIRECT_CONTEXT}"
+          ami_client.should_receive(:send_action).once.with('Command', 'Command' => "dialplan show #{Asterisk::REDIRECT_CONTEXT}")
+          Punchblock.logger.should_receive(:warn).once.with("Recordings directory #{broken_path} does not exist. Recording might not work. This warning can be ignored if Adhearsion is running on a separate machine than Asterisk. See http://adhearsion.com/docs/call-controllers#recording")
+          subject.run_at_fully_booted
+        end
       end
 
       describe '#check_recording_directory' do
         let(:broken_path) { "/this/is/not/a/valid/path" }
-        before do
-          @new_constant = broken_path
-          @old_constant = Punchblock::Translator::Asterisk::Component::Record::RECORDING_BASE_PATH
-          Punchblock::Translator::Asterisk::Component::Record.__send__(:remove_const,'RECORDING_BASE_PATH')
-          Punchblock::Translator::Asterisk::Component::Record.const_set('RECORDING_BASE_PATH', @new_constant)
-        end
-        after do
-          Punchblock::Translator::Asterisk::Component::Record.__send__(:remove_const,'RECORDING_BASE_PATH')
-          Punchblock::Translator::Asterisk::Component::Record.const_set('RECORDING_BASE_PATH', @old_constant)
-        end
         it 'logs a warning if the recording directory does not exist' do
-          Punchblock.logger.should_receive(:warning).once.with("Recordings directory #{broken_path} does not exist. Recording might not work. This warning can be ignored if Adhearsion is running on a separate machine than Asterisk. See http://adhearsion.com/docs/call-controllers#recording")
+          stub_const('Punchblock::Translator::Asterisk::Component::Record::RECORDING_BASE_PATH', broken_path)
+          Punchblock.logger.should_receive(:warn).once.with("Recordings directory #{broken_path} does not exist. Recording might not work. This warning can be ignored if Adhearsion is running on a separate machine than Asterisk. See http://adhearsion.com/docs/call-controllers#recording")
           subject.check_recording_directory
         end
       end

data/spec/punchblock/translator/freeswitch/call_spec.rb

@@ -279,6 +279,15 @@ module Punchblock
             end
           end
 
+          context 'with no from attribute' do
+            let(:from) { nil }
+
+            it 'sends an originate bgapi command with the cid fields set correctly' do
+              stream.should_receive(:bgapi).once.with "originate {return_ring_ready=true,origination_uuid=#{subject.id}}#{to} &park()"
+              subject.dial dial_command
+            end
+          end
+
           context 'with a timeout specified' do
             let :dial_command_options do
               { :timeout => 10000 }
@@ -765,7 +774,7 @@ module Punchblock
               Punchblock::Component::Output.new
             end
 
-            let(:mock_component) { mock 'Freeswitch::Component::Output', :id => 'foo' }
+            let(:mock_component) { Translator::Freeswitch::Component::Output.new(command, subject) }
 
             ['freeswitch', nil].each do |media_engine|
               let(:media_engine) { media_engine }
@@ -773,9 +782,9 @@ module Punchblock
               context "with a media engine of #{media_engine}" do
                 it 'should create an Output component and execute it asynchronously' do
                   Component::Output.should_receive(:new_link).once.with(command, subject).and_return mock_component
-                  mock_component.should_receive(:execute!).once
+                  mock_component.async.should_receive(:execute).once
                   subject.execute_command command
-                  subject.component_with_id('foo').should be mock_component
+                  subject.component_with_id(mock_component.id).should be mock_component
                 end
               end
             end
@@ -785,9 +794,9 @@ module Punchblock
 
               it 'should create a FliteOutput component and execute it asynchronously using flite and the calls default voice' do
                 Component::FliteOutput.should_receive(:new_link).once.with(command, subject).and_return mock_component
-                mock_component.should_receive(:execute!).once.with(media_engine, default_voice)
+                mock_component.async.should_receive(:execute).once.with(media_engine, default_voice)
                 subject.execute_command command
-                subject.component_with_id('foo').should be mock_component
+                subject.component_with_id(mock_component.id).should be mock_component
               end
             end
 
@@ -796,9 +805,9 @@ module Punchblock
 
               it 'should create a TTSOutput component and execute it asynchronously using cepstral and the calls default voice' do
                 Component::TTSOutput.should_receive(:new_link).once.with(command, subject).and_return mock_component
-                mock_component.should_receive(:execute!).once.with(media_engine, default_voice)
+                mock_component.async.should_receive(:execute).once.with(media_engine, default_voice)
                 subject.execute_command command
-                subject.component_with_id('foo').should be mock_component
+                subject.component_with_id(mock_component.id).should be mock_component
               end
             end
 
@@ -807,9 +816,9 @@ module Punchblock
 
               it 'should create a TTSOutput component and execute it asynchronously using unimrcp and the calls default voice' do
                 Component::TTSOutput.should_receive(:new_link).once.with(command, subject).and_return mock_component
-                mock_component.should_receive(:execute!).once.with(media_engine, default_voice)
+                mock_component.async.should_receive(:execute).once.with(media_engine, default_voice)
                 subject.execute_command command
-                subject.component_with_id('foo').should be mock_component
+                subject.component_with_id(mock_component.id).should be mock_component
               end
             end
 
@@ -822,9 +831,9 @@ module Punchblock
 
               it "should use the component media engine and not the platform one if it is set" do
                 Component::Output.should_receive(:new_link).once.with(command_with_renderer, subject).and_return mock_component
-                mock_component.should_receive(:execute!).once
+                mock_component.async.should_receive(:execute).once
                 subject.execute_command command_with_renderer
-                subject.component_with_id('foo').should be mock_component
+                subject.component_with_id(mock_component.id).should be mock_component
               end
             end
           end
@@ -834,11 +843,11 @@ module Punchblock
               Punchblock::Component::Input.new
             end
 
-            let(:mock_component) { mock 'Freeswitch::Component::Input', :id => 'foo' }
+            let(:mock_component) { Translator::Freeswitch::Component::Input.new(command, subject) }
 
             it 'should create an Input component and execute it asynchronously' do
               Component::Input.should_receive(:new_link).once.with(command, subject).and_return mock_component
-              mock_component.should_receive(:execute!).once
+              mock_component.async.should_receive(:execute).once
               subject.execute_command command
             end
           end
@@ -848,11 +857,11 @@ module Punchblock
               Punchblock::Component::Record.new
             end
 
-            let(:mock_component) { mock 'Freeswitch::Component::Record', :id => 'foo' }
+            let(:mock_component) { Translator::Freeswitch::Component::Record.new(command, subject) }
 
             it 'should create a Record component and execute it asynchronously' do
               Component::Record.should_receive(:new_link).once.with(command, subject).and_return mock_component
-              mock_component.should_receive(:execute!).once
+              mock_component.async.should_receive(:execute).once
               subject.execute_command command
             end
           end

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

@@ -88,7 +88,7 @@ module Punchblock
                 end
 
                 it "should not process further dtmf events" do
-                  subject.should_receive(:process_dtmf!).never
+                  subject.async.should_receive(:process_dtmf).never
                   send_dtmf 3
                 end
               end

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

@@ -270,10 +270,9 @@ module Punchblock
 
               context 'set' do
                 let(:command_opts) { { :voice => 'alison' } }
-                it "should return an error and not execute any actions" do
+                it "should ignore the voice option" do
+                  expect_playback
                   subject.execute
-                  error = ProtocolError.new.setup 'option error', 'A voice value is unsupported.'
-                  original_command.response(0.1).should be == error
                 end
               end
             end

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

@@ -143,7 +143,7 @@ module Punchblock
               context "set to a positive number" do
                 let(:command_options) { { :final_timeout => 10 } }
                 it "should return an error and not execute any actions" do
-                  mock_call.should_receive(:send_agi_action!).never
+                  mock_call.should_receive(:uuid_foo).never
                   subject.execute
                   error = ProtocolError.new.setup 'option error', 'A final-timeout value is unsupported.'
                   original_command.response(0.1).should be == error

data/spec/punchblock/translator/freeswitch_spec.rb

@@ -7,7 +7,7 @@ module Punchblock
     describe Freeswitch do
       let(:connection)    { mock 'Connection::Freeswitch' }
       let(:media_engine)  { :flite }
-      let(:default_voice)  { :hal }
+      let(:default_voice) { :hal }
 
       let(:translator)  { described_class.new connection, media_engine, default_voice }
       let(:stream)      { mock 'RubyFS::Stream' }
@@ -117,7 +117,7 @@ module Punchblock
           end
 
           it 'sends the command to the call for execution' do
-            call.should_receive(:execute_command!).once.with command
+            call.async.should_receive(:execute_command).once.with command
             subject.execute_call_command command
           end
         end
@@ -201,10 +201,11 @@ module Punchblock
       end
 
       describe '#execute_component_command' do
-        let(:component_id)  { '123abc' }
-        let(:component)     { mock 'Translator::Freeswitch::Component', :id => component_id }
+        let(:call)            { Translator::Freeswitch::Call.new 'SIP/foo', subject }
+        let(:component_node)  { Component::Output.new }
+        let(:component)       { Translator::Freeswitch::Component::Output.new(component_node, call) }
 
-        let(:command) { Component::Stop.new.tap { |c| c.component_id = component_id } }
+        let(:command) { Component::Stop.new.tap { |c| c.component_id = component.id } }
 
         before do
           command.request!
@@ -216,7 +217,7 @@ module Punchblock
           end
 
           it 'sends the command to the component for execution' do
-            component.should_receive(:execute_command!).once.with command
+            component.async.should_receive(:execute_command).once.with command
             subject.execute_component_command command
           end
         end
@@ -224,7 +225,7 @@ module Punchblock
         context "with an unknown component ID" do
           it 'sends an error in response to the command' do
             subject.execute_component_command command
-            command.response.should be == ProtocolError.new.setup(:item_not_found, "Could not find a component with ID #{component_id}", nil, component_id)
+            command.response.should be == ProtocolError.new.setup(:item_not_found, "Could not find a component with ID #{component.id}", nil, component.id)
           end
         end
       end
@@ -257,7 +258,7 @@ module Punchblock
           it 'should instruct the call to send a dial' do
             mock_call = stub('Freeswitch::Call').as_null_object
             Freeswitch::Call.should_receive(:new_link).once.and_return mock_call
-            mock_call.should_receive(:dial!).once.with command
+            mock_call.async.should_receive(:dial).once.with command
             subject.execute_global_command command
           end
         end
@@ -532,7 +533,7 @@ module Punchblock
             mock_call = stub('Freeswitch::Call').as_null_object
             Freeswitch::Call.should_receive(:new).once.and_return mock_call
             subject.wrapped_object.should_receive(:link)
-            mock_call.should_receive(:send_offer!).once
+            mock_call.async.should_receive(:send_offer).once
             subject.handle_es_event es_event
           end
 
@@ -550,7 +551,67 @@ module Punchblock
           end
         end
 
-        describe 'with an event with an Other-Leg-Unique-ID value' do
+        describe "with a CHANNEL_BRIDGE event" do
+          describe 'with an Other-Leg-Unique-ID value' do
+            let(:call_a) { Freeswitch::Call.new Punchblock.new_uuid, subject }
+            let(:call_b) { Freeswitch::Call.new Punchblock.new_uuid, subject }
+
+            before do
+              subject.register_call call_a
+              subject.register_call call_b
+            end
+
+            let :es_event do
+              RubyFS::Event.new nil, {
+                :event_name           => 'CHANNEL_BRIDGE',
+                :unique_id            => call_a.id,
+                :other_leg_unique_id  => call_b.id
+              }
+            end
+
+            it "is delivered to the bridging leg" do
+              call_a.async.should_receive(:handle_es_event).once.with es_event
+              subject.handle_es_event es_event
+            end
+
+            it "is delivered to the other leg" do
+              call_b.async.should_receive(:handle_es_event).once.with es_event
+              subject.handle_es_event es_event
+            end
+          end
+        end
+
+        describe "with a CHANNEL_UNBRIDGE event" do
+          describe 'with an Other-Leg-Unique-ID value' do
+            let(:call_a) { Freeswitch::Call.new Punchblock.new_uuid, subject }
+            let(:call_b) { Freeswitch::Call.new Punchblock.new_uuid, subject }
+
+            before do
+              subject.register_call call_a
+              subject.register_call call_b
+            end
+
+            let :es_event do
+              RubyFS::Event.new nil, {
+                :event_name           => 'CHANNEL_UNBRIDGE',
+                :unique_id            => call_a.id,
+                :other_leg_unique_id  => call_b.id
+              }
+            end
+
+            it "is delivered to the bridging leg" do
+              call_a.async.should_receive(:handle_es_event).once.with es_event
+              subject.handle_es_event es_event
+            end
+
+            it "is delivered to the other leg" do
+              call_b.async.should_receive(:handle_es_event).once.with es_event
+              subject.handle_es_event es_event
+            end
+          end
+        end
+
+        describe 'with an Other-Leg-Unique-ID value' do
           let(:call_a) { Freeswitch::Call.new Punchblock.new_uuid, subject }
           let(:call_b) { Freeswitch::Call.new Punchblock.new_uuid, subject }
 
@@ -566,13 +627,9 @@ module Punchblock
             }
           end
 
-          it "is delivered to the bridging leg" do
-            call_a.should_receive(:handle_es_event!).once.with es_event
-            subject.handle_es_event es_event
-          end
-
-          it "is delivered to the other leg" do
-            call_b.should_receive(:handle_es_event!).once.with es_event
+          it "is delivered only to the primary leg" do
+            call_a.async.should_receive(:handle_es_event).once.with es_event
+            call_b.async.should_receive(:handle_es_event).never
             subject.handle_es_event es_event
           end
         end
@@ -587,7 +644,7 @@ module Punchblock
           end
 
           it 'sends the ES event to the call' do
-            call.should_receive(:handle_es_event!).once.with es_event
+            call.async.should_receive(:handle_es_event).once.with es_event
             subject.handle_es_event es_event
           end
         end