punchblock 1.9.4 → 2.0.0.beta1

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

@@ -11,7 +11,7 @@ module Punchblock
             include HasMockCallbackConnection
 
             let(:channel)       { 'SIP/foo' }
-            let(:ami_client)    { stub('AMI Client').as_null_object }
+            let(:ami_client)    { double('AMI Client').as_null_object }
             let(:translator)    { Punchblock::Translator::Asterisk.new ami_client, connection }
             let(:mock_call)     { Punchblock::Translator::Asterisk::Call.new channel, translator, ami_client, connection }
             let(:component_id)  { Punchblock.new_uuid }
@@ -56,7 +56,7 @@ module Punchblock
               end
 
               let :expected_response do
-                Ref.new :id => component_id
+                Ref.new uri: component_id
               end
 
               let :response do
@@ -67,20 +67,42 @@ module Punchblock
               it 'should send the component node a ref with the action ID' do
                 ami_client.should_receive(:send_action).once.and_return response
                 subject.execute
-                original_command.response(1).should eql(expected_response)
+                original_command.response(1).should == expected_response
               end
 
               context 'with an error' do
+                let(:message) { 'Action failed' }
                 let :response do
-                  RubyAMI::Error.new.tap { |e| e.message = 'Action failed' }
+                  RubyAMI::Error.new.tap { |e| e.message = message }
                 end
 
+                before { ami_client.should_receive(:send_action).once.and_raise response }
+
                 it 'should send the component node false' do
-                  ami_client.should_receive(:send_action).once.and_raise response
                   subject.execute
                   original_command.response(1).should be_false
                   subject.should_not be_alive
                 end
+
+                context "which is 'No such channel'" do
+                  let(:message) { 'No such channel' }
+
+                  it "should return an :item_not_found error for the command" do
+                    subject.execute
+                    original_command.response(0.5).should be == ProtocolError.new.setup(:item_not_found, "Could not find a call with ID #{mock_call.id}", mock_call.id)
+                    subject.should_not be_alive
+                  end
+                end
+
+                context "which is 'Channel SIP/nosuchchannel does not exist.'" do
+                  let(:message) { 'Channel SIP/nosuchchannel does not exist.' }
+
+                  it "should return an :item_not_found error for the command" do
+                    subject.execute
+                    original_command.response(0.5).should be == ProtocolError.new.setup(:item_not_found, "Could not find a call with ID #{mock_call.id}", mock_call.id)
+                    subject.should_not be_alive
+                  end
+                end
               end
             end
 
@@ -142,6 +164,7 @@ module Punchblock
 
                     it 'should send an end (hangup) event to the translator' do
                       expected_end_event = Punchblock::Event::End.new reason: :hangup,
+                                                                      platform_code: 16,
                                                                       target_call_id: mock_call.id
 
                       translator.should_receive(:handle_pb_event).once.with kind_of(Punchblock::Event::Complete)

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

@@ -10,7 +10,7 @@ module Punchblock
           describe AMIAction do
             include HasMockCallbackConnection
 
-            let(:ami_client)      { stub('AMI Client').as_null_object }
+            let(:ami_client)      { double('AMI Client').as_null_object }
             let(:mock_translator) { Punchblock::Translator::Asterisk.new ami_client, connection }
 
             let :original_command do
@@ -27,7 +27,7 @@ module Punchblock
               let(:component_id) { Punchblock.new_uuid }
 
               let :expected_response do
-                Ref.new :id => component_id
+                Ref.new uri: component_id
               end
 
               before { stub_uuids component_id }
@@ -49,8 +49,10 @@ module Punchblock
                                       'Status'    => '-1'
               end
 
+              before { response.text_body = 'Some text body' }
+
               let :expected_complete_reason do
-                Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => 'Channel status will follow', :attributes => {:exten => "idonno", :context => "default", :hint => "", :status => "-1"}
+                Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new message: 'Channel status will follow', text_body: 'Some text body', headers: {'Exten' => "idonno", 'Context' => "default", 'Hint' => "", 'Status' => "-1"}
               end
 
               context 'for a non-causal action' do
@@ -88,19 +90,19 @@ module Punchblock
                 end
 
                 let :event_node do
-                  Punchblock::Event::Asterisk::AMI::Event.new :name => 'CoreShowChannel', :component_id => subject.id, :attributes => {
-                    :channel          => 'SIP/127.0.0.1-00000013',
-                    :uniqueid         => '1287686437.19',
-                    :context          => 'adhearsion',
-                    :extension        => '23432',
-                    :priority         => '2',
-                    :channelstate     => '6',
-                    :channelstatedesc => 'Up'
+                  Punchblock::Event::Asterisk::AMI::Event.new name: 'CoreShowChannel', component_id: subject.id, headers: {
+                    'Channel'          => 'SIP/127.0.0.1-00000013',
+                    'UniqueID'         => '1287686437.19',
+                    'Context'          => 'adhearsion',
+                    'Extension'        => '23432',
+                    'Priority'         => '2',
+                    'ChannelState'     => '6',
+                    'ChannelStateDesc' => 'Up'
                   }
                 end
 
                 let :expected_complete_reason do
-                  Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new :message => 'Channel status will follow', :attributes => {:exten => "idonno", :context => "default", :hint => "", :status => "-1", :eventlist => 'Complete', :listitems => '3'}
+                  Punchblock::Component::Asterisk::AMI::Action::Complete::Success.new message: 'Channel status will follow', text_body: 'Some text body', headers: {'Exten' => "idonno", 'Context' => "default", 'Hint' => "", 'Status' => "-1", 'EventList' => 'Complete', 'ListItems' => '3'}
                 end
 
                 before { ami_client.should_receive(:send_action).once.and_return response }
@@ -130,7 +132,7 @@ module Punchblock
                 end
 
                 let :expected_complete_reason do
-                  Punchblock::Event::Complete::Error.new :details => 'Action failed', component_id: subject.id
+                  Punchblock::Event::Complete::Error.new details: 'Action failed'
                 end
 
                 it 'should send a complete event to the component node' do

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

@@ -0,0 +1,237 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        describe ComposedPrompt do
+          class MockConnection
+            attr_reader :events
+
+            def initialize
+              @events = []
+            end
+
+            def handle_event(event)
+              @events << event
+            end
+          end
+
+          let(:connection)    { MockConnection.new }
+          let(:media_engine)  { nil }
+          let(:ami_client)    { double('AMI') }
+          let(:translator)    { Punchblock::Translator::Asterisk.new ami_client, connection, media_engine }
+          let(:call)          { Punchblock::Translator::Asterisk::Call.new 'foo', translator, ami_client, connection }
+
+          let :ssml_doc do
+            RubySpeech::SSML.draw do
+              audio src: 'http://foo.com/bar.mp3'
+            end
+          end
+
+          let :dtmf_grammar do
+            RubySpeech::GRXML.draw mode: 'dtmf', root: 'digit' do
+              rule id: 'digit' do
+                one_of do
+                  item { '1' }
+                  item { '2' }
+                end
+              end
+            end
+          end
+
+          let :output_command_options do
+            { render_document: {value: ssml_doc} }
+          end
+
+          let :input_command_options do
+            {
+              mode: :dtmf,
+              grammar: {value: dtmf_grammar}
+            }
+          end
+
+          let(:command_options) { {} }
+
+          let :output_command do
+            Punchblock::Component::Output.new output_command_options
+          end
+
+          let :input_command do
+            Punchblock::Component::Input.new input_command_options
+          end
+
+          let :original_command do
+            Punchblock::Component::Prompt.new output_command, input_command, command_options
+          end
+
+          subject { described_class.new original_command, call }
+
+          let(:playbackstatus) { 'SUCCESS' }
+
+          before do
+            call.stub answered?: true, execute_agi_command: true
+            call.stub(:channel_var).with('PLAYBACKSTATUS').and_return playbackstatus
+            original_command.request!
+          end
+
+          def ami_event_for_dtmf(digit, position)
+            RubyAMI::Event.new 'DTMF',
+              'Digit' => digit.to_s,
+              'Start' => position == :start ? 'Yes' : 'No',
+              'End'   => position == :end ? 'Yes' : 'No'
+          end
+
+          def send_ami_events_for_dtmf(digit)
+            call.process_ami_event ami_event_for_dtmf(digit, :start)
+            call.process_ami_event ami_event_for_dtmf(digit, :end)
+          end
+
+          describe '#execute' do
+            context '#barge_in' do
+              context 'true' do
+                it "should execute an output component on the call and return a ref" do
+                  call.should_receive(:execute_agi_command).once.with('EXEC Playback', 'http://foo.com/bar.mp3')
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+
+                context "if output fails to start" do
+                  it "should return the error returned by output"
+                end
+
+                context "receiving dtmf during output" do
+                  it "should stop the output"
+
+                  it "should contribute to the input result"
+
+                  it "should return a match complete event"
+                end
+
+                context "when not receiving any DTMF input at all" do
+                  it "should not start the initial timer until output completes"
+                end
+              end
+
+              context 'false' do
+                it "should execute an output component on the call" do
+                  call.should_receive(:execute_agi_command).once.with('EXEC Playback', 'http://foo.com/bar.mp3')
+                  subject.execute
+                  original_command.response(0.1).should be_a Ref
+                end
+
+                context "if output fails to start" do
+                  let(:output_response) { ProtocolError.new.setup 'unrenderable document error', 'The provided document could not be rendered. See http://adhearsion.com/docs/common_problems#unrenderable-document-error for details.' }
+
+                  let :ssml_doc do
+                    RubySpeech::SSML.draw do
+                      string "Foo Bar"
+                    end
+                  end
+
+                  it "should return the error returned by output" do
+                    subject.execute
+                    original_command.response(0.1).should == output_response
+                  end
+                end
+
+                context "receiving dtmf during output" do
+                  it "should not stop the output"
+
+                  it "should not contribute to the input result"
+                end
+
+                context "receiving matching dtmf after output completes" do
+                  let :expected_nlsml do
+                    RubySpeech::NLSML.draw do
+                      interpretation confidence: 1 do
+                        instance "dtmf-1"
+                        input "1", mode: :dtmf
+                      end
+                    end
+                  end
+
+                  let :expected_event do
+                    Punchblock::Event::Complete.new reason: expected_reason,
+                      component_id: subject.id,
+                      target_call_id: call.id
+                  end
+
+                  let :expected_reason do
+                    Punchblock::Component::Input::Complete::Match.new nlsml: expected_nlsml
+                  end
+
+                  it "should return a match complete event" do
+                    expected_event
+                    subject.execute
+                    original_command.response(0.1).should be_a Ref
+                    send_ami_events_for_dtmf 1
+
+                    connection.events.should include(expected_event)
+                  end
+                end
+
+                context "when not receiving any DTMF input at all" do
+                  it "should not start the initial timer until output completes"
+                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(:channel) { "SIP/1234-00000000" }
+              let :ami_event do
+                RubyAMI::Event.new 'AsyncAGI',
+                  'SubEvent'  => "Start",
+                  'Channel'   => channel,
+                  'Env'       => "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 do
+                command.request!
+                original_command.execute!
+              end
+
+              it "sets the command response to true" do
+                call.async.should_receive(:redirect_back).once
+                subject.execute_command command
+                command.response(0.1).should be == true
+              end
+
+              it "sends the correct complete event" do
+                expected_reason = Punchblock::Event::Complete::Stop.new
+                expected_event = Punchblock::Event::Complete.new reason: expected_reason,
+                  component_id: subject.id,
+                  target_call_id: call.id
+
+                call.async.should_receive(:redirect_back)
+                subject.execute_command command
+                original_command.should_not be_complete
+                call.process_ami_event ami_event
+
+                sleep 0.2
+
+                connection.events.should include(expected_event)
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module Punchblock
           include HasMockCallbackConnection
 
           let(:media_engine)    { nil }
-          let(:ami_client)      { mock('AMI') }
+          let(:ami_client)      { double('AMI') }
           let(:translator)      { Punchblock::Translator::Asterisk.new ami_client, connection, media_engine }
           let(:call)            { Punchblock::Translator::Asterisk::Call.new 'foo', translator, ami_client, connection }
           let(:original_command_options) { {} }
@@ -79,13 +79,17 @@ module Punchblock
                   send_ami_events_for_dtmf 2
                 end
 
+                let :expected_nlsml do
+                  RubySpeech::NLSML.draw do
+                    interpretation confidence: 1 do
+                      instance "dtmf-1 dtmf-2"
+                      input "12", mode: :dtmf
+                    end
+                  end
+                end
+
                 let :expected_event do
-                  Punchblock::Component::Input::Complete::Success.new :mode => :dtmf,
-                    :confidence => 1,
-                    :utterance => '12',
-                    :interpretation => 'dtmf-1 dtmf-2',
-                    :component_id => subject.id,
-                    :target_call_id => call.id
+                  Punchblock::Component::Input::Complete::Match.new nlsml: expected_nlsml
                 end
 
                 it "should send a success complete event with the relevant data" do
@@ -105,8 +109,7 @@ module Punchblock
                 end
 
                 let :expected_event do
-                  Punchblock::Component::Input::Complete::NoMatch.new :component_id => subject.id,
-                                                                      :target_call_id => call.id
+                  Punchblock::Component::Input::Complete::NoMatch.new
                 end
 
                 it "should send a nomatch complete event" do
@@ -124,6 +127,15 @@ module Punchblock
                   original_command.response(0.1).should be == error
                 end
               end
+
+              context 'with multiple grammars' do
+                let(:original_command_opts) { { :grammars => [{:value => grammar}, {:value => grammar}] } }
+                it "should return an error and not execute any actions" do
+                  subject.execute
+                  error = ProtocolError.new.setup 'option error', 'Only a single grammar is supported.'
+                  original_command.response(0.1).should be == error
+                end
+              end
             end
 
             describe 'mode' do
@@ -145,8 +157,8 @@ module Punchblock
                 end
               end
 
-              context 'speech' do
-                let(:original_command_opts) { { :mode => :speech } }
+              context 'voice' do
+                let(:original_command_opts) { { :mode => :voice } }
                 it "should return an error and not execute any actions" do
                   subject.execute
                   error = ProtocolError.new.setup 'option error', 'A mode value other than DTMF is unsupported.'
@@ -156,7 +168,85 @@ module Punchblock
             end
 
             describe 'terminator' do
-              pending
+              context 'set' do
+                let(:original_command_opts) { { terminator: '#' } }
+
+                before do
+                  subject.execute
+                  expected_event
+                end
+
+                let :grammar do
+                  RubySpeech::GRXML.draw mode: 'dtmf', root: 'digits' do
+                    rule id: 'digits' do
+                      item repeat: '2-5' do
+                        one_of do
+                          0.upto(9) { |d| item { d.to_s } }
+                        end
+                      end
+                    end
+                  end
+                end
+
+                let :expected_nlsml do
+                  RubySpeech::NLSML.draw do
+                    interpretation confidence: 1 do
+                      instance "dtmf-1 dtmf-2"
+                      input "12", mode: :dtmf
+                    end
+                  end
+                end
+
+                let :expected_event do
+                  Punchblock::Component::Input::Complete::Match.new nlsml: expected_nlsml
+                end
+
+                context "when encountered with a match" do
+                  before do
+                    send_ami_events_for_dtmf 1
+                    send_ami_events_for_dtmf 2
+                    send_ami_events_for_dtmf '#'
+                  end
+
+                  it "should send a match complete event with the relevant data" do
+                    reason.should be == expected_event
+                  end
+
+                  it "should not process further dtmf events" do
+                    subject.async.should_receive(:process_dtmf).never
+                    send_ami_events_for_dtmf 3
+                  end
+                end
+
+                context "when encountered with a NoMatch" do
+                  before do
+                    send_ami_events_for_dtmf '#'
+                  end
+
+                  let :expected_event do
+                    Punchblock::Component::Input::Complete::NoMatch.new
+                  end
+
+                  it "should send a nomatch complete event with the relevant data" do
+                    reason.should be == expected_event
+                  end
+                end
+
+                context "when encountered with a PotentialMatch" do
+                  before do
+                    send_ami_events_for_dtmf 1
+                    send_ami_events_for_dtmf '#'
+                  end
+
+                  let :expected_event do
+                    Punchblock::Component::Input::Complete::NoMatch.new
+                  end
+
+                  it "should send a nomatch complete event with the relevant data" do
+                    reason.should be == expected_event
+                  end
+                end
+              end
             end
 
             describe 'recognizer' do
@@ -172,7 +262,7 @@ module Punchblock
                   send_ami_events_for_dtmf 1
                   sleep 1.5
                   send_ami_events_for_dtmf 2
-                  reason.should be_a Punchblock::Component::Input::Complete::Success
+                  reason.should be_a Punchblock::Component::Input::Complete::Match
                 end
 
                 it "should cause a NoInput complete event to be sent after the timeout" do
@@ -223,7 +313,7 @@ module Punchblock
                   send_ami_events_for_dtmf 1
                   sleep 0.5
                   send_ami_events_for_dtmf 2
-                  reason.should be_a Punchblock::Component::Input::Complete::Success
+                  reason.should be_a Punchblock::Component::Input::Complete::Match
                 end
 
                 it "should cause a NoMatch complete event to be sent after the timeout" do
@@ -234,6 +324,73 @@ module Punchblock
                   send_ami_events_for_dtmf 2
                   reason.should be_a Punchblock::Component::Input::Complete::NoMatch
                 end
+
+                context "with a trailing range repeat" do
+                  let :grammar do
+                    RubySpeech::GRXML.draw mode: 'dtmf', root: 'digits' do
+                      rule id: 'digits', scope: 'public' do
+                        item repeat: '2-5' do
+                          '1'
+                        end
+                      end
+                    end
+                  end
+
+                  context "when the buffer potentially matches the grammar" do
+                    it "should cause a NoMatch complete event to be sent after the timeout" do
+                      subject.execute
+                      sleep 1.5
+                      send_ami_events_for_dtmf 1
+                      sleep 1.5
+                      reason.should be_a Punchblock::Component::Input::Complete::NoMatch
+                    end
+                  end
+
+                  context "when the buffer matches the grammar" do
+                    let :expected_nlsml do
+                      RubySpeech::NLSML.draw do
+                        interpretation confidence: 1 do
+                          instance "dtmf-1 dtmf-1"
+                          input '11', mode: :dtmf
+                        end
+                      end.root
+                    end
+
+                    it "should fire a match on timeout" do
+                      subject.execute
+                      sleep 1.5
+                      send_ami_events_for_dtmf 1
+                      sleep 0.5
+                      send_ami_events_for_dtmf 1
+                      sleep 1.5
+                      reason.should be_a Punchblock::Component::Input::Complete::Match
+                      reason.nlsml.should == expected_nlsml
+                    end
+
+                    context "on the first keypress" do
+                      let :grammar do
+                        RubySpeech::GRXML.draw mode: 'dtmf', root: 'digits' do
+                          rule id: 'digits', scope: 'public' do
+                            item repeat: '1-5' do
+                              '1'
+                            end
+                          end
+                        end
+                      end
+
+                      it "should fire a match on timeout" do
+                        subject.execute
+                        sleep 1.5
+                        send_ami_events_for_dtmf 1
+                        sleep 0.5
+                        send_ami_events_for_dtmf 1
+                        sleep 1.5
+                        reason.should be_a Punchblock::Component::Input::Complete::Match
+                        reason.nlsml.should == expected_nlsml
+                      end
+                    end
+                  end
+                end
               end
 
               context '-1' do