punchblock 0.8.4 → 0.9.0

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode # currently in active development, may or may not work for your project
+  - ruby-head
+notifications:
+  irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # develop
 
+# v0.9.0 - 2012-01-30
+  * Bugfix: Remove the rest of the deprecated Tropo components (conference)
+  * Feature: Outbound dials on Asterisk now respect the dial timeout
+  * Bugfix: Registering stanza handlers on an XMPP connection now sets them in the correct order such that they do not override the internally defined handlers
+
 # v0.8.4 - 2012-01-19
   * Bugfix: End, Ringing & Answered events are allowed to have headers
   * Feature: Dial commands may have an optional timeout

data/Rakefile

@@ -10,12 +10,6 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = '--color'
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-  spec.rspec_opts = '--color'
-end
-
 task :default => :spec
 task :ci => ['ci:setup:rspec', :spec]
 task :hudson => :ci

data/lib/punchblock.rb

@@ -44,7 +44,6 @@ module Punchblock
   TransportError = Class.new StandardError
 
   BASE_RAYO_NAMESPACE     = 'urn:xmpp:rayo'
-  BASE_TROPO_NAMESPACE    = 'urn:xmpp:tropo'
   BASE_ASTERISK_NAMESPACE = 'urn:xmpp:rayo:asterisk'
   RAYO_VERSION            = '1'
   RAYO_NAMESPACES         = {:core => [BASE_RAYO_NAMESPACE, RAYO_VERSION].compact.join(':')}
@@ -54,11 +53,6 @@ module Punchblock
     RAYO_NAMESPACES[:"#{ns}_complete"] = [BASE_RAYO_NAMESPACE, ns.to_s, 'complete', RAYO_VERSION].compact.join(':')
   end
 
-  [:conference].each do |ns|
-    RAYO_NAMESPACES[ns] = [BASE_TROPO_NAMESPACE, ns.to_s, RAYO_VERSION].compact.join(':')
-    RAYO_NAMESPACES[:"#{ns}_complete"] = [BASE_TROPO_NAMESPACE, ns.to_s, 'complete', RAYO_VERSION].compact.join(':')
-  end
-
   [:agi, :ami].each do |ns|
     RAYO_NAMESPACES[ns] = [BASE_ASTERISK_NAMESPACE, ns.to_s, RAYO_VERSION].compact.join(':')
     RAYO_NAMESPACES[:"#{ns}_complete"] = [BASE_ASTERISK_NAMESPACE, ns.to_s, 'complete', RAYO_VERSION].compact.join(':')

data/lib/punchblock/command/dial.rb

@@ -11,6 +11,7 @@ module Punchblock
       # @param [Hash] options
       # @option options [String] :to destination to dial
       # @option options [String, Optional] :from what to set the Caller ID to
+      # @option options [Integer, Optional] :timeout in milliseconds
       # @option options [Array[Header], Hash, Optional] :headers SIP headers to attach to
       #   the new call. Can be either a hash of key-value pairs, or an array of
       #   Header objects.

data/lib/punchblock/connection/xmpp.rb

@@ -38,6 +38,8 @@ module Punchblock
         Blather.logger = pb_logger
         Blather.default_log_level = :trace if Blather.respond_to? :default_log_level
 
+        register_handlers
+
         super()
       end
 
@@ -68,7 +70,6 @@ module Punchblock
       # Fire up the connection
       #
       def run
-        register_handlers
         connect
       end
 

data/lib/punchblock/translator/asterisk/call.rb

@@ -49,15 +49,17 @@ module Punchblock
 
         def dial(dial_command)
           @direction = :outbound
+          params = { :async       => true,
+                     :application => 'AGI',
+                     :data        => 'agi:async',
+                     :channel     => dial_command.to,
+                     :callerid    => dial_command.from,
+                     :variable    => "punchblock_call_id=#{id}"
+                   }
+          params[:timeout] = dial_command.timeout unless dial_command.timeout.nil?
+
           originate_action = Punchblock::Component::Asterisk::AMI::Action.new :name => 'Originate',
-                                                                              :params => {
-                                                                                :async       => true,
-                                                                                :application => 'AGI',
-                                                                                :data        => 'agi:async',
-                                                                                :channel     => dial_command.to,
-                                                                                :callerid    => dial_command.from,
-                                                                                :variable    => "punchblock_call_id=#{id}"
-                                                                              }
+                                                                              :params => params
           originate_action.request!
           translator.execute_global_command! originate_action
           dial_command.response = Ref.new :id => id
@@ -133,9 +135,9 @@ module Punchblock
           when Punchblock::Component::Asterisk::AGI::Command
             execute_component Component::Asterisk::AGICommand, command
           when Punchblock::Component::Output
-            execute_component Component::Asterisk::Output, command
+            execute_component Component::Output, command
           when Punchblock::Component::Input
-            execute_component Component::Asterisk::Input, command
+            execute_component Component::Input, command
           else
             command.response = ProtocolError.new 'command-not-acceptable', "Did not understand command for call #{id}", id
           end

data/lib/punchblock/translator/asterisk/component.rb

@@ -5,6 +5,8 @@ module Punchblock
         extend ActiveSupport::Autoload
 
         autoload :Asterisk
+        autoload :Input
+        autoload :Output
 
         class Component
           include Celluloid

data/lib/punchblock/translator/asterisk/component/asterisk.rb

@@ -7,8 +7,6 @@ module Punchblock
 
           autoload :AGICommand
           autoload :AMIAction
-          autoload :Input
-          autoload :Output
         end
       end
     end

data/lib/punchblock/translator/asterisk/component/input.rb

@@ -0,0 +1,114 @@
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        class Input < Component
+
+          attr_reader :grammar, :buffer
+
+          def setup
+            @media_engine = call.translator.media_engine
+            @buffer       = ""
+          end
+
+          def execute
+            initial_timeout = @component_node.initial_timeout || -1
+            @inter_digit_timeout = @component_node.inter_digit_timeout || -1
+
+            return with_error 'option error', 'A grammar document is required.' unless @component_node.grammar
+            return with_error 'option error', 'A mode value other than DTMF is unsupported on Asterisk.' unless @component_node.mode == :dtmf
+            return with_error 'option error', 'An initial timeout value that is negative (and not -1) is invalid.' unless initial_timeout >= -1
+            return with_error 'option error', 'An inter-digit timeout value that is negative (and not -1) is invalid.' unless @inter_digit_timeout >= -1
+
+            send_ref
+
+            case @media_engine
+            when :asterisk, nil
+              @grammar = @component_node.grammar.value.clone
+              grammar.inline!
+              grammar.tokenize!
+              grammar.normalize_whitespace
+
+              begin_initial_timer initial_timeout/1000 unless initial_timeout == -1
+
+              component = current_actor
+
+              @active = true
+
+              call.register_handler :ami, :name => 'DTMF' do |event|
+                component.process_dtmf! event['Digit'] if event['End'] == 'Yes'
+              end
+            end
+          end
+
+          def process_dtmf(digit)
+            return unless @active
+            pb_logger.trace "Processing incoming DTMF digit #{digit}"
+            buffer << digit
+            cancel_initial_timer
+            case (match = grammar.match buffer.dup)
+            when RubySpeech::GRXML::Match
+              pb_logger.trace "Found a match against buffer #{buffer}"
+              complete success_reason(match)
+            when RubySpeech::GRXML::NoMatch
+              pb_logger.trace "Buffer #{buffer} does not match grammar"
+              complete Punchblock::Component::Input::Complete::NoMatch.new
+            when RubySpeech::GRXML::PotentialMatch
+              pb_logger.trace "Buffer #{buffer} potentially matches grammar. Waiting..."
+              reset_inter_digit_timer
+            end
+          end
+
+          private
+
+          def begin_initial_timer(timeout)
+            pb_logger.trace "Setting initial timer for #{timeout} seconds"
+            @initial_timer = after timeout do
+              pb_logger.trace "Initial timer expired."
+              complete Punchblock::Component::Input::Complete::NoInput.new
+            end
+          end
+
+          def cancel_initial_timer
+            return unless @initial_timer
+            @initial_timer.cancel
+            @initial_timer = nil
+          end
+
+          def reset_inter_digit_timer
+            return if @inter_digit_timeout == -1
+            @inter_digit_timer ||= begin
+              pb_logger.trace "Setting inter-digit timer for #{@inter_digit_timeout/1000} seconds"
+              after @inter_digit_timeout/1000 do
+                pb_logger.trace "Inter digit-timer expired."
+                complete Punchblock::Component::Input::Complete::NoMatch.new
+              end
+            end
+            pb_logger.trace "Resetting inter-digit timer"
+            @inter_digit_timer.reset
+          end
+
+          def cancel_inter_digit_timer
+            return unless @inter_digit_timer
+            @inter_digit_timer.cancel
+            @inter_digit_timer = nil
+          end
+
+          def success_reason(match)
+            Punchblock::Component::Input::Complete::Success.new :mode           => match.mode,
+                                                                :confidence     => match.confidence,
+                                                                :utterance      => match.utterance,
+                                                                :interpretation => match.interpretation
+          end
+
+          def complete(reason)
+            @active = false
+            cancel_initial_timer
+            cancel_inter_digit_timer
+            send_complete_event reason
+          end
+        end
+      end
+    end
+  end
+end

data/lib/punchblock/translator/asterisk/component/output.rb

@@ -0,0 +1,92 @@
+require 'active_support/core_ext/string/filters'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        class Output < Component
+
+          def setup
+            @media_engine = @call.translator.media_engine
+          end
+
+          def execute
+            return with_error 'option error', 'An SSML document is required.' unless @component_node.ssml
+
+            return with_error 'option error', 'An interrupt-on value of speech is unsupported.' if @component_node.interrupt_on == :speech
+
+            [:start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time].each do |opt|
+              return with_error 'option error', "A #{opt} value is unsupported on Asterisk." if @component_node.send opt
+            end
+
+            case @media_engine
+            when :asterisk, nil
+              return with_error 'option error', "A voice value is unsupported on Asterisk." if @component_node.voice
+
+              @execution_elements = @component_node.ssml.children.map do |node|
+                case node
+                when RubySpeech::SSML::Audio
+                  lambda { current_actor.play_audio! node.src }
+                end
+              end.compact
+
+              @pending_actions = @execution_elements.count
+
+              send_ref
+
+              @interrupt_digits = '0123456789*#' if [:any, :dtmf].include? @component_node.interrupt_on
+
+              @execution_elements.each do |element|
+                element.call
+                wait :continue
+                process_playback_completion
+              end
+            when :unimrcp
+              doc = @component_node.ssml.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
+              send_ref
+              @call.send_agi_action! 'EXEC MRCPSynth', doc, mrcpsynth_options do |complete_event|
+                pb_logger.debug "MRCPSynth completed with #{complete_event}."
+                send_complete_event success_reason
+              end
+            end
+          end
+
+          def process_playback_completion
+            @pending_actions -= 1
+            pb_logger.debug "Received action completion. Now waiting on #{@pending_actions} actions."
+            if @pending_actions < 1
+              pb_logger.debug "Sending complete event"
+              send_complete_event success_reason
+            end
+          end
+
+          def continue(event = nil)
+            signal :continue, event
+          end
+
+          def play_audio(path)
+            pb_logger.debug "Playing an audio file (#{path}) via STREAM FILE"
+            op = current_actor
+            @call.send_agi_action! 'STREAM FILE', path, @interrupt_digits do |complete_event|
+              pb_logger.debug "STREAM FILE completed with #{complete_event}. Signalling to continue execution."
+              op.continue! complete_event
+            end
+          end
+
+          private
+
+          def mrcpsynth_options
+            [].tap do |opts|
+              opts << 'i=any' if [:any, :dtmf].include? @component_node.interrupt_on
+              opts << "v=#{@component_node.voice}" if @component_node.voice
+            end.join '&'
+          end
+
+          def success_reason
+            Punchblock::Component::Output::Complete::Success.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/punchblock/version.rb

@@ -1,3 +1,3 @@
 module Punchblock
-  VERSION = "0.8.4"
+  VERSION = "0.9.0"
 end

data/punchblock.gemspec

@@ -36,7 +36,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency %q<rspec>, ["~> 2.7.0"]
   s.add_development_dependency %q<ci_reporter>, [">= 1.6.3"]
   s.add_development_dependency %q<yard>, ["~> 0.6.0"]
-  s.add_development_dependency %q<rcov>, [">= 0"]
   s.add_development_dependency %q<rake>, [">= 0"]
   s.add_development_dependency %q<mocha>, [">= 0"]
   s.add_development_dependency %q<i18n>, [">= 0"]

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

@@ -67,6 +67,7 @@ module Punchblock
         describe '#shutdown' do
           it 'should terminate the actor' do
             subject.shutdown
+            sleep 0.5
             subject.should_not be_alive
           end
         end
@@ -99,8 +100,10 @@ module Punchblock
         end
 
         describe '#dial' do
+          let(:dial_command_options) { {} }
+
           let :dial_command do
-            Punchblock::Command::Dial.new :to => 'SIP/1234', :from => 'sip:foo@bar.com'
+            Punchblock::Command::Dial.new({:to => 'SIP/1234', :from => 'sip:foo@bar.com'}.merge(dial_command_options))
           end
 
           before { dial_command.request! }
@@ -120,6 +123,28 @@ module Punchblock
             subject.dial dial_command
           end
 
+          context 'with a timeout specified' do
+            let :dial_command_options do
+              { :timeout => 10000 }
+            end
+
+            it 'includes the timeout in the Originate AMI action' do
+              expected_action = Punchblock::Component::Asterisk::AMI::Action.new :name => 'Originate',
+                                                                                 :params => {
+                                                                                   :async       => true,
+                                                                                   :application => 'AGI',
+                                                                                   :data        => 'agi:async',
+                                                                                   :channel     => 'SIP/1234',
+                                                                                   :callerid    => 'sip:foo@bar.com',
+                                                                                   :variable    => "punchblock_call_id=#{subject.id}",
+                                                                                   :timeout     => 10000
+                                                                                 }
+
+              translator.expects(:execute_global_command!).once.with expected_action
+              subject.dial dial_command
+            end
+          end
+
           it 'sends the call ID as a response to the Dial' do
             subject.dial dial_command
             dial_command.response
@@ -162,6 +187,7 @@ module Punchblock
             it "should cause the actor to be terminated" do
               translator.expects(:handle_pb_event!).once
               subject.process_ami_event ami_event
+              sleep 0.5
               subject.should_not be_alive
             end
 
@@ -442,7 +468,7 @@ module Punchblock
             let(:mock_action) { mock 'Component::Asterisk::Output', :id => 'foo' }
 
             it 'should create an AGI command component actor and execute it asynchronously' do
-              Component::Asterisk::Output.expects(:new).once.with(command, subject).returns mock_action
+              Component::Output.expects(:new).once.with(command, subject).returns mock_action
               mock_action.expects(:internal=).never
               mock_action.expects(:execute!).once
               subject.execute_command command
@@ -457,7 +483,7 @@ module Punchblock
             let(:mock_action) { mock 'Component::Asterisk::Input', :id => 'foo' }
 
             it 'should create an AGI command component actor and execute it asynchronously' do
-              Component::Asterisk::Input.expects(:new).once.with(command, subject).returns mock_action
+              Component::Input.expects(:new).once.with(command, subject).returns mock_action
               mock_action.expects(:internal=).never
               mock_action.expects(:execute!).once
               subject.execute_command command

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

@@ -0,0 +1,282 @@
+require 'spec_helper'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        describe Input do
+          let(:connection) do
+            mock_connection_with_event_handler do |event|
+              command.add_event event
+            end
+          end
+          let(:media_engine)    { nil }
+          let(:translator)      { Punchblock::Translator::Asterisk.new mock('AMI'), connection, media_engine }
+          let(:call)            { Punchblock::Translator::Asterisk::Call.new 'foo', translator }
+          let(:command_options) { {} }
+
+          let :command do
+            Punchblock::Component::Input.new command_options
+          end
+
+          let :grammar do
+            RubySpeech::GRXML.draw :mode => 'dtmf', :root => 'pin' do
+              rule id: 'digit' do
+                one_of do
+                  0.upto(9) { |d| item { d.to_s } }
+                end
+              end
+
+              rule id: 'pin', scope: 'public' do
+                item repeat: '2' do
+                  ruleref uri: '#digit'
+                end
+              end
+            end
+          end
+
+          subject { Input.new command, call }
+
+          describe '#execute' do
+            before { command.request! }
+
+            context 'with a media engine of :unimrcp' do
+              pending
+              let(:media_engine) { :unimrcp }
+            end
+
+            context 'with a media engine of :asterisk' do
+              let(:media_engine) { :asterisk }
+
+              let(:command_opts) { {} }
+
+              let :command_options do
+                { :mode => :dtmf, :grammar => { :value => grammar } }.merge(command_opts)
+              end
+
+              def ami_event_for_dtmf(digit, position)
+                RubyAMI::Event.new('DTMF').tap do |e|
+                  e['Digit']  = digit.to_s
+                  e['Start']  = position == :start ? 'Yes' : 'No'
+                  e['End']    = position == :end ? 'Yes' : 'No'
+                end
+              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
+
+              let(:reason) { command.complete_event(5).reason }
+
+              describe "receiving DTMF events" do
+                before do
+                  subject.execute
+                  expected_event
+                end
+
+                context "when a match is found" do
+                  before do
+                    send_ami_events_for_dtmf 1
+                    send_ami_events_for_dtmf 2
+                  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,
+                                                                        :call_id => call.id
+                  end
+
+                  it "should send a success complete event with the relevant data" do
+                    reason.should == expected_event
+                  end
+                end
+
+                context "when the match is invalid" 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 :component_id => subject.id,
+                                                                        :call_id => call.id
+                  end
+
+                  it "should send a nomatch complete event" do
+                    reason.should == expected_event
+                  end
+                end
+              end
+
+              describe 'grammar' do
+                context 'unset' do
+                  let(:command_opts) { { :grammar => nil } }
+                  it "should return an error and not execute any actions" do
+                    subject.execute
+                    error = ProtocolError.new 'option error', 'A grammar document is required.'
+                    command.response(0.1).should == error
+                  end
+                end
+              end
+
+              describe 'mode' do
+                context 'unset' do
+                  let(:command_opts) { { :mode => nil } }
+                  it "should return an error and not execute any actions" do
+                    subject.execute
+                    error = ProtocolError.new 'option error', 'A mode value other than DTMF is unsupported on Asterisk.'
+                    command.response(0.1).should == error
+                  end
+                end
+
+                context 'any' do
+                  let(:command_opts) { { :mode => :any } }
+                  it "should return an error and not execute any actions" do
+                    subject.execute
+                    error = ProtocolError.new 'option error', 'A mode value other than DTMF is unsupported on Asterisk.'
+                    command.response(0.1).should == error
+                  end
+                end
+
+                context 'speech' do
+                  let(:command_opts) { { :mode => :speech } }
+                  it "should return an error and not execute any actions" do
+                    subject.execute
+                    error = ProtocolError.new 'option error', 'A mode value other than DTMF is unsupported on Asterisk.'
+                    command.response(0.1).should == error
+                  end
+                end
+              end
+
+              describe 'terminator' do
+                pending
+              end
+
+              describe 'recognizer' do
+                pending
+              end
+
+              describe 'initial-timeout' do
+                context 'a positive number' do
+                  let(:command_opts) { { :initial_timeout => 1000 } }
+
+                  it "should not cause a NoInput if first input is received in time" do
+                    subject.execute
+                    send_ami_events_for_dtmf 1
+                    sleep 1.5
+                    send_ami_events_for_dtmf 2
+                    reason.should be_a Punchblock::Component::Input::Complete::Success
+                  end
+
+                  it "should cause a NoInput complete event to be sent after the timeout" do
+                    subject.execute
+                    sleep 1.5
+                    send_ami_events_for_dtmf 1
+                    send_ami_events_for_dtmf 2
+                    reason.should be_a Punchblock::Component::Input::Complete::NoInput
+                  end
+                end
+
+                context '-1' do
+                  let(:command_opts) { { :initial_timeout => -1 } }
+
+                  it "should not start a timer" do
+                    subject.wrapped_object.expects(:begin_initial_timer).never
+                    subject.execute
+                  end
+                end
+
+                context 'unset' do
+                  let(:command_opts) { { :initial_timeout => nil } }
+
+                  it "should not start a timer" do
+                    subject.wrapped_object.expects(:begin_initial_timer).never
+                    subject.execute
+                  end
+                end
+
+                context 'a negative number other than -1' do
+                  let(:command_opts) { { :initial_timeout => -1000 } }
+
+                  it "should return an error and not execute any actions" do
+                    subject.execute
+                    error = ProtocolError.new 'option error', 'An initial timeout value that is negative (and not -1) is invalid.'
+                    command.response(0.1).should == error
+                  end
+                end
+              end
+
+              describe 'inter-digit-timeout' do
+                context 'a positive number' do
+                  let(:command_opts) { { :inter_digit_timeout => 1000 } }
+
+                  it "should not prevent a Match if input is received in time" do
+                    subject.execute
+                    sleep 1.5
+                    send_ami_events_for_dtmf 1
+                    sleep 0.5
+                    send_ami_events_for_dtmf 2
+                    reason.should be_a Punchblock::Component::Input::Complete::Success
+                  end
+
+                  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
+                    send_ami_events_for_dtmf 2
+                    reason.should be_a Punchblock::Component::Input::Complete::NoMatch
+                  end
+                end
+
+                context '-1' do
+                  let(:command_opts) { { :inter_digit_timeout => -1 } }
+
+                  it "should not start a timer" do
+                    subject.wrapped_object.expects(:begin_inter_digit_timer).never
+                    subject.execute
+                  end
+                end
+
+                context 'unset' do
+                  let(:command_opts) { { :inter_digit_timeout => nil } }
+
+                  it "should not start a timer" do
+                    subject.wrapped_object.expects(:begin_inter_digit_timer).never
+                    subject.execute
+                  end
+                end
+
+                context 'a negative number other than -1' do
+                  let(:command_opts) { { :inter_digit_timeout => -1000 } }
+
+                  it "should return an error and not execute any actions" do
+                    subject.execute
+                    error = ProtocolError.new 'option error', 'An inter-digit timeout value that is negative (and not -1) is invalid.'
+                    command.response(0.1).should == error
+                  end
+                end
+              end
+
+              describe 'sensitivity' do
+                pending
+              end
+
+              describe 'min-confidence' do
+                pending
+              end
+
+              describe 'max-silence' do
+                pending
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end