punchblock 0.9.2 → 0.10.0

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
@@ -40,6 +42,97 @@ module Punchblock
 
             before { mock_call.stubs :answer_if_not_answered }
 
+            context 'with a media engine of :swift' do
+              let(:media_engine) { :swift }
+
+              let(:audio_filename) { 'http://foo.com/bar.mp3' }
+
+              let :ssml_doc do
+                RubySpeech::SSML.draw do
+                  audio :src => audio_filename
+                  say_as(:interpret_as => :cardinal) { 'FOO' }
+                end
+              end
+
+              let(:command_opts) { {} }
+
+              let :command_options do
+                { :ssml => ssml_doc }.merge(command_opts)
+              end
+
+              def ssml_with_options(prefix = '', postfix = '')
+                base_doc = ssml_doc.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
+                prefix + base_doc + postfix
+              end
+
+              it "should execute Swift" do
+                mock_call.expects(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options
+                subject.execute
+              end
+
+              it 'should send a complete event when Swift completes' do
+                def mock_call.send_agi_action!(*args, &block)
+                  block.call Punchblock::Component::Asterisk::AGI::Command::Complete::Success.new(:code => 200, :result => 1)
+                end
+                subject.execute
+                command.complete_event(0.1).reason.should be_a Punchblock::Component::Output::Complete::Success
+              end
+
+              describe 'interrupt_on' do
+                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
+                    subject.execute
+                  end
+                end
+
+                context "set to :any" do
+                  let(:command_opts) { { :interrupt_on => :any } }
+                  it "should add the interrupt options to the argument" do
+                    mock_call.expects(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options('', '|1|1')
+                    subject.execute
+                  end
+                end
+
+                context "set to :dtmf" do
+                  let(:command_opts) { { :interrupt_on => :dtmf } }
+                  it "should add the interrupt options to the argument" do
+                    mock_call.expects(:send_agi_action!).once.with 'EXEC Swift', ssml_with_options('', '|1|1')
+                    subject.execute
+                  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 'option error', 'An interrupt-on value of speech is unsupported.'
+                    command.response(0.1).should be == error
+                  end
+                end
+              end
+
+              describe 'voice' do
+                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
+                    subject.execute
+                  end
+                end
+
+                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^', '')
+                    subject.execute
+                  end
+                end
+
+              end
+            end
+
             context 'with a media engine of :unimrcp' do
               let(:media_engine) { :unimrcp }
 
@@ -60,7 +153,7 @@ module Punchblock
 
               def expect_mrcpsynth_with_options(options)
                 mock_call.expects(:send_agi_action!).once.with do |*args|
-                  args[0].should == 'EXEC MRCPSynth'
+                  args[0].should be == 'EXEC MRCPSynth'
                   args[2].should match options
                 end
               end
@@ -84,7 +177,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'An SSML document is required.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -103,7 +196,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A start_offset value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -122,7 +215,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A start_paused value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -141,7 +234,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A repeat_interval value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -160,7 +253,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A repeat_times value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -179,7 +272,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A max_time value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -232,7 +325,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'An interrupt-on value of speech is unsupported.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -243,7 +336,7 @@ module Punchblock
 
               def expect_stream_file_with_options(options = nil)
                 mock_call.expects(:send_agi_action!).once.with 'STREAM FILE', audio_filename, options do |*args|
-                  args[2].should == options
+                  args[2].should be == options
                   subject.continue!
                   true
                 end
@@ -273,7 +366,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'An SSML document is required.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
 
@@ -315,12 +408,10 @@ module Punchblock
                     latch = CountDownLatch.new 2
                     mock_call.expects(:send_agi_action!).once.with 'STREAM FILE', audio_filename1, nil do
                       subject.continue
-                      true
                       latch.countdown!
                     end
                     mock_call.expects(:send_agi_action!).once.with 'STREAM FILE', audio_filename2, nil do
                       subject.continue
-                      true
                       latch.countdown!
                     end
                     subject.execute
@@ -351,7 +442,7 @@ module Punchblock
                   it "should return an unrenderable document error" do
                     subject.execute
                     error = ProtocolError.new 'unrenderable document error', 'The provided document could not be rendered.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -370,7 +461,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A start_offset value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -389,7 +480,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A start_paused value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -408,7 +499,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A repeat_interval value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -427,7 +518,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A repeat_times value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -446,7 +537,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A max_time value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -465,7 +556,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'A voice value is unsupported on Asterisk.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end
@@ -500,7 +591,7 @@ module Punchblock
                   it "should return an error and not execute any actions" do
                     subject.execute
                     error = ProtocolError.new 'option error', 'An interrupt-on value of speech is unsupported.'
-                    command.response(0.1).should == error
+                    command.response(0.1).should be == error
                   end
                 end
               end

data/spec/punchblock/translator/asterisk/component_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
@@ -81,7 +83,7 @@ module Punchblock
 
               it 'sends an error in response to the command' do
                 subject.execute_command component_command
-                component_command.response.should == ProtocolError.new('command-not-acceptable', "Did not understand command for component #{subject.id}", call.id, subject.id)
+                component_command.response.should be == ProtocolError.new('command-not-acceptable', "Did not understand command for component #{subject.id}", call.id, subject.id)
               end
             end
           end

data/spec/punchblock/translator/asterisk_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 module Punchblock
@@ -18,12 +20,12 @@ module Punchblock
 
       context 'with a configured media engine of :asterisk' do
         let(:media_engine) { :asterisk }
-        its(:media_engine) { should == :asterisk }
+        its(:media_engine) { should be == :asterisk }
       end
 
       context 'with a configured media engine of :unimrcp' do
         let(:media_engine) { :unimrcp }
-        its(:media_engine) { should == :unimrcp }
+        its(:media_engine) { should be == :unimrcp }
       end
 
       describe '#shutdown' do
@@ -48,7 +50,7 @@ module Punchblock
           it 'executes the call command' do
             subject.wrapped_object.expects(:execute_call_command).with do |c|
               c.should be command
-              c.call_id.should == call_id
+              c.call_id.should be == call_id
             end
             subject.execute_command command, :call_id => call_id
           end
@@ -61,7 +63,7 @@ module Punchblock
           it 'executes the component command' do
             subject.wrapped_object.expects(:execute_component_command).with do |c|
               c.should be command
-              c.component_id.should == component_id
+              c.component_id.should be == component_id
             end
             subject.execute_command command, :component_id => component_id
           end
@@ -130,7 +132,7 @@ module Punchblock
         context "with an unknown call ID" do
           it 'sends an error in response to the command' do
             subject.execute_call_command command
-            command.response.should == ProtocolError.new('call-not-found', "Could not find a call with ID #{call_id}", call_id, nil)
+            command.response.should be == ProtocolError.new('call-not-found', "Could not find a call with ID #{call_id}", call_id, nil)
           end
         end
       end
@@ -159,7 +161,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 == ProtocolError.new('component-not-found', "Could not find a component with ID #{component_id}", nil, component_id)
+            command.response.should be == ProtocolError.new('component-not-found', "Could not find a component with ID #{component_id}", nil, component_id)
           end
         end
       end
@@ -216,7 +218,7 @@ module Punchblock
 
           it 'sends an error in response to the command' do
             subject.execute_command command
-            command.response.should == ProtocolError.new('command-not-acceptable', "Did not understand command")
+            command.response.should be == ProtocolError.new('command-not-acceptable', "Did not understand command")
           end
         end
       end
@@ -272,6 +274,7 @@ module Punchblock
           context 'twice' do
             it 'sends a connected event to the event handler' do
               subject.connection.expects(:handle_event).once.with Connection::Connected.new
+              subject.wrapped_object.expects(:run_at_fully_booted).once
               subject.handle_ami_event ami_event
               subject.handle_ami_event ami_event
             end
@@ -294,7 +297,28 @@ module Punchblock
             call_actor = subject.call_for_channel('SIP/1234-00000000')
             call_actor.wrapped_object.should be_a Asterisk::Call
             call_actor.agi_env.should be_a Hash
-            call_actor.agi_env[:agi_request].should == 'async'
+            call_actor.agi_env.should be == {
+              :agi_request      => 'async',
+              :agi_channel      => 'SIP/1234-00000000',
+              :agi_language     => 'en',
+              :agi_type         => 'SIP',
+              :agi_uniqueid     => '1320835995.0',
+              :agi_version      => '1.8.4.1',
+              :agi_callerid     => '5678',
+              :agi_calleridname => 'Jane Smith',
+              :agi_callingpres  => '0',
+              :agi_callingani2  => '0',
+              :agi_callington   => '0',
+              :agi_callingtns   => '0',
+              :agi_dnid         => '1000',
+              :agi_rdnis        => 'unknown',
+              :agi_context      => 'default',
+              :agi_extension    => '1000',
+              :agi_priority     => '1',
+              :agi_enhanced     => '0.0',
+              :agi_accountcode  => '',
+              :agi_threadid     => '4366221312'
+            }
           end
 
           it 'should instruct the call to send an offer' do
@@ -316,6 +340,46 @@ module Punchblock
               subject.handle_ami_event ami_event
             end
           end
+
+          context "for a 'h' extension" do
+            let :ami_event do
+              RubyAMI::Event.new('AsyncAGI').tap do |e|
+                e['SubEvent'] = "Start"
+                e['Channel']  = "SIP/1234-00000000"
+                e['Env']      = "agi_extension%3A%20h%0A%0A"
+              end
+            end
+
+            it "should not create a new call" do
+              Asterisk::Call.expects(:new).never
+              subject.handle_ami_event ami_event
+            end
+
+            it 'should not be able to look up the call by channel ID' do
+              subject.handle_ami_event ami_event
+              subject.call_for_channel('SIP/1234-00000000').should be nil
+            end
+          end
+
+          context "for a 'Kill' type" do
+            let :ami_event do
+              RubyAMI::Event.new('AsyncAGI').tap do |e|
+                e['SubEvent'] = "Start"
+                e['Channel']  = "SIP/1234-00000000"
+                e['Env']      = "agi_type%3A%20Kill%0A%0A"
+              end
+            end
+
+            it "should not create a new call" do
+              Asterisk::Call.expects(:new).never
+              subject.handle_ami_event ami_event
+            end
+
+            it 'should not be able to look up the call by channel ID' do
+              subject.handle_ami_event ami_event
+              subject.call_for_channel('SIP/1234-00000000').should be nil
+            end
+          end
         end
 
         describe 'with a VarSet event including a punchblock_call_id' do
@@ -348,7 +412,7 @@ module Punchblock
 
             it "should set the correct channel on the call" do
               subject.handle_ami_event ami_event
-              call.channel.should == 'SIP/1234-00000000'
+              call.channel.should be == 'SIP/1234-00000000'
             end
 
             it "should make it possible to look up the call by the full channel name" do
@@ -397,8 +461,34 @@ module Punchblock
             call.expects(:process_ami_event!).once.with ami_event
             subject.handle_ami_event ami_event
           end
+
+          context 'with a Channel1 and Channel2 specified on the event' do
+            let :ami_event do
+              RubyAMI::Event.new('BridgeAction').tap do |e|
+                e['Privilege'] = "call,all"
+                e['Response'] = "Success"
+                e['Channel1']  = "SIP/1234-00000000"
+                e['Channel2']  = "SIP/5678-00000000"
+              end
+            end
+
+            context 'with calls for those channels' do
+              let(:call2) do
+                Asterisk::Call.new "SIP/5678-00000000", subject, "agi_request%3A%20async%0Aagi_channel%3A%20SIP%2F1234-00000000%0Aagi_language%3A%20en%0Aagi_type%3A%20SIP%0Aagi_uniqueid%3A%201320835995.0%0Aagi_version%3A%201.8.4.1%0Aagi_callerid%3A%205678%0Aagi_calleridname%3A%20Jane%20Smith%0Aagi_callingpres%3A%200%0Aagi_callingani2%3A%200%0Aagi_callington%3A%200%0Aagi_callingtns%3A%200%0Aagi_dnid%3A%201000%0Aagi_rdnis%3A%20unknown%0Aagi_context%3A%20default%0Aagi_extension%3A%201000%0Aagi_priority%3A%201%0Aagi_enhanced%3A%200.0%0Aagi_accountcode%3A%20%0Aagi_threadid%3A%204366221312%0A%0A"
+              end
+
+              before { subject.register_call call2 }
+
+              it 'should send the event to both calls and to the connection once as a PB event' do
+                subject.wrapped_object.expects(:handle_pb_event).once
+                call.expects(:process_ami_event!).once.with ami_event
+                call2.expects(:process_ami_event!).once.with ami_event
+                subject.handle_ami_event ami_event
+              end
+            end
+          end
         end
-      end
+      end#handle_ami_event
 
       describe '#send_ami_action' do
         it 'should send the action to the AMI client' do
@@ -406,6 +496,13 @@ module Punchblock
           subject.send_ami_action 'foo', :foo => :bar
         end
       end
+
+      describe '#run_at_fully_booted' do
+        it 'should send the redirect extension Command to the AMI client' do
+          ami_client.expects(:send_action).once.with 'Command', 'Command' => "dialplan add extension #{Asterisk::REDIRECT_EXTENSION},#{Asterisk::REDIRECT_PRIORITY},AGI,agi:async into #{Asterisk::REDIRECT_CONTEXT}"
+          subject.run_at_fully_booted
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-$LOAD_PATH.unshift File.dirname(__FILE__)
+# encoding: utf-8
+
 require 'punchblock'
 require 'mocha'
 require 'countdownlatch'
@@ -7,6 +7,8 @@ require 'logger'
 
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
 
+Thread.abort_on_exception = true
+
 RSpec.configure do |config|
   config.mock_with :mocha
   config.filter_run :focus => true
@@ -15,6 +17,10 @@ RSpec.configure do |config|
   config.before :suite do |variable|
     Punchblock.logger = Logger.new(STDOUT)
   end
+
+  config.after :each do
+    Object.const_defined?(:Celluloid) && Celluloid.shutdown
+  end
 end
 
 def parse_stanza(xml)
@@ -27,8 +33,8 @@ end
 
 # FIXME: change this to rayo_event?  It can be ambigous
 shared_examples_for 'event' do
-  its(:call_id) { should == '9f00061' }
-  its(:component_id) { should == '1' }
+  its(:call_id) { should be == '9f00061' }
+  its(:component_id) { should be == '1' }
 end
 
 shared_examples_for 'command_headers' do
@@ -44,47 +50,47 @@ shared_examples_for 'command_headers' do
 end
 
 shared_examples_for 'event_headers' do
-  its(:headers) { should == [Punchblock::Header.new(:x_skill, 'agent'), Punchblock::Header.new(:x_customer_id, '8877')]}
-  its(:headers_hash) { should == {:x_skill => 'agent', :x_customer_id => '8877'} }
+  its(:headers) { should be == [Punchblock::Header.new(:x_skill, 'agent'), Punchblock::Header.new(:x_customer_id, '8877')]}
+  its(:headers_hash) { should be == {:x_skill => 'agent', :x_customer_id => '8877'} }
 end
 
 shared_examples_for 'key_value_pairs' do
   it 'will auto-inherit nodes' do
     n = parse_stanza "<#{element_name} name='boo' value='bah' />"
     h = class_name.new n.root
-    h.name.should == :boo
-    h.value.should == 'bah'
+    h.name.should be == :boo
+    h.value.should be == 'bah'
   end
 
   it 'has a name attribute' do
     n = class_name.new :boo, 'bah'
-    n.name.should == :boo
+    n.name.should be == :boo
     n.name = :foo
-    n.name.should == :foo
+    n.name.should be == :foo
   end
 
   it "substitutes - for _ on the name attribute when reading" do
     n = parse_stanza "<#{element_name} name='boo-bah' value='foo' />"
     h = class_name.new n.root
-    h.name.should == :boo_bah
+    h.name.should be == :boo_bah
   end
 
   it "substitutes _ for - on the name attribute when writing" do
     h = class_name.new :boo_bah, 'foo'
-    h.to_xml.should == "<#{element_name} name=\"boo-bah\" value=\"foo\"/>"
+    h.to_xml.should be == "<#{element_name} name=\"boo-bah\" value=\"foo\"/>"
   end
 
   it 'has a value param' do
     n = class_name.new :boo, 'en'
-    n.value.should == 'en'
+    n.value.should be == 'en'
     n.value = 'de'
-    n.value.should == 'de'
+    n.value.should be == 'de'
   end
 
   it 'can determine equality' do
     a = class_name.new :boo, 'bah'
-    a.should == class_name.new(:boo, 'bah')
-    a.should_not == class_name.new(:bah, 'bah')
-    a.should_not == class_name.new(:boo, 'boo')
+    a.should be == class_name.new(:boo, 'bah')
+    a.should_not be == class_name.new(:bah, 'bah')
+    a.should_not be == class_name.new(:boo, 'boo')
   end
 end

data/spec/support/mock_connection_with_event_handler.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 # This is a nasty hack due to the fact that Mocha does not support expectations returning a value calculated by executing a block with the parameters passed.
 # If it did, we could do this in our component tests:
 # mc = mock 'Connection'