punchblock 1.9.4 → 2.0.0.beta1

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

@@ -0,0 +1,99 @@
+# encoding: utf-8
+
+require 'punchblock/translator/asterisk/unimrcp_app'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      module Component
+        module MRCPRecogPrompt
+          UniMRCPError = Class.new Punchblock::Error
+
+          def execute
+            setup_defaults
+            validate
+            send_ref
+            execute_unimrcp_app
+            complete
+          rescue ChannelGoneError
+            call_ended
+          rescue UniMRCPError
+            complete_with_error 'Terminated due to UniMRCP error'
+          rescue RubyAMI::Error => e
+            complete_with_error "Terminated due to AMI error '#{e.message}'"
+          rescue OptionError => e
+            with_error 'option error', e.message
+          end
+
+          private
+
+          def validate
+            [:interrupt_on, :start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time].each do |opt|
+              raise OptionError, "A #{opt} value is unsupported on Asterisk." if output_node.send opt
+            end
+
+            raise OptionError, "An initial-timeout value must be -1 or a positive integer." if @initial_timeout < -1
+            raise OptionError, "An inter-digit-timeout value must be -1 or a positive integer." if @inter_digit_timeout < -1
+          end
+
+          def execute_app(app, *args)
+            UniMRCPApp.new(app, *args, unimrcp_app_options).execute @call
+            raise UniMRCPError if @call.channel_var('RECOG_STATUS') == 'ERROR'
+          end
+
+          def unimrcp_app_options
+            {uer: 1, b: (@component_node.barge_in == false ? 0 : 1)}.tap do |opts|
+              opts[:nit] = @initial_timeout if @initial_timeout > -1
+              opts[:dit] = @inter_digit_timeout if @inter_digit_timeout > -1
+              opts[:dttc] = input_node.terminator if input_node.terminator
+              yield opts
+            end
+          end
+
+          def setup_defaults
+            @initial_timeout = input_node.initial_timeout || -1
+            @inter_digit_timeout = input_node.inter_digit_timeout || -1
+          end
+
+          def grammars
+            input_node.grammars.map do |d|
+              if d.content_type
+                d.value.to_doc.to_s
+              else
+                d.url
+              end
+            end.join ','
+          end
+
+          def first_doc
+            output_node.render_documents.first
+          end
+
+          def audio_filename
+            first_doc.value.first
+          end
+
+          def output_node
+            @component_node.output
+          end
+
+          def input_node
+            @component_node.input
+          end
+
+          def complete
+            send_complete_event case @call.channel_var('RECOG_COMPLETION_CAUSE')
+            when '000'
+              nlsml = RubySpeech.parse URI.decode(@call.channel_var('RECOG_RESULT'))
+              Punchblock::Component::Input::Complete::Match.new nlsml: nlsml
+            when '001'
+              Punchblock::Component::Input::Complete::NoMatch.new
+            when '002'
+              Punchblock::Component::Input::Complete::NoInput.new
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'active_support/core_ext/string/filters'
+require 'punchblock/translator/asterisk/unimrcp_app'
 
 module Punchblock
   module Translator
@@ -10,14 +11,17 @@ module Punchblock
           include StopByRedirect
 
           UnrenderableDocError  = Class.new OptionError
+          UniMRCPError          = Class.new Punchblock::Error
+          PlaybackError         = Class.new Punchblock::Error
 
           def setup
             @media_engine = @call.translator.media_engine
           end
 
           def execute
-            raise OptionError, 'An SSML document is required.' unless @component_node.ssml
-            raise OptionError, 'An interrupt-on value of speech is unsupported.' if @component_node.interrupt_on == :speech
+            raise OptionError, 'An SSML document is required.' unless @component_node.render_documents.first.value
+            raise OptionError, 'Only a single document is supported.' unless @component_node.render_documents.size == 1
+            raise OptionError, 'An interrupt-on value of speech is unsupported.' if @component_node.interrupt_on == :voice
 
             [:start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time].each do |opt|
               raise OptionError, "A #{opt} value is unsupported on Asterisk." if @component_node.send opt
@@ -44,7 +48,7 @@ module Punchblock
               if interrupt
                 output_component = current_actor
                 call.register_handler :ami, :name => 'DTMF', [:[], 'End'] => 'Yes' do |event|
-                  output_component.stop_by_redirect Punchblock::Component::Output::Complete::Success.new
+                  output_component.stop_by_redirect finish_reason
                 end
               end
 
@@ -52,10 +56,12 @@ module Punchblock
 
               opts = early ? "#{path},noanswer" : path
               @call.execute_agi_command 'EXEC Playback', opts
+              raise PlaybackError if @call.channel_var('PLAYBACKSTATUS') == 'FAILED'
             when :unimrcp
               @call.send_progress if early
               send_ref
-              @call.execute_agi_command 'EXEC MRCPSynth', escape_commas(escaped_doc), mrcpsynth_options
+              UniMRCPApp.new('MRCPSynth', render_doc, mrcpsynth_options).execute @call
+              raise UniMRCPError if @call.channel_var('SYNTHSTATUS') == 'ERROR'
             when :swift
               @call.send_progress if early
               send_ref
@@ -63,7 +69,13 @@ module Punchblock
             else
               raise OptionError, "The renderer #{rendering_engine} is unsupported."
             end
-            send_success
+            send_finish
+          rescue ChannelGoneError
+            call_ended
+          rescue PlaybackError
+            complete_with_error 'Terminated due to playback error'
+          rescue UniMRCPError
+            complete_with_error 'Terminated due to UniMRCP error'
           rescue RubyAMI::Error => e
             complete_with_error "Terminated due to AMI error '#{e.message}'"
           rescue UnrenderableDocError => e
@@ -75,10 +87,10 @@ module Punchblock
           private
 
           def filenames
-            @filenames ||= @component_node.ssml.children.map do |node|
+            @filenames ||= render_doc.children.map do |node|
               case node
               when RubySpeech::SSML::Audio
-                node.src
+                node.src.sub('file://', '')
               when String
                 raise if node.include?(' ')
                 node
@@ -90,34 +102,30 @@ module Punchblock
             raise UnrenderableDocError, 'The provided document could not be rendered. See http://adhearsion.com/docs/common_problems#unrenderable-document-error for details.'
           end
 
-          def escaped_doc
-            @component_node.ssml.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
-          end
-
-          def escape_commas(text)
-            text.gsub(',', '\\,')
+          def render_doc
+            @component_node.render_documents.first.value
           end
 
           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 '&'
+            {}.tap do |opts|
+              opts[:i] = 'any' if [:any, :dtmf].include? @component_node.interrupt_on
+              opts[:v] = @component_node.voice if @component_node.voice
+            end
           end
 
           def swift_doc
-            doc = escaped_doc
+            doc = render_doc.to_s.squish.gsub(/["\\]/) { |m| "\\#{m}" }
             doc << "|1|1" if [:any, :dtmf].include? @component_node.interrupt_on
             doc.insert 0, "#{@component_node.voice}^" if @component_node.voice
             doc
           end
 
-          def send_success
-            send_complete_event success_reason
+          def send_finish
+            send_complete_event finish_reason
           end
 
-          def success_reason
-            Punchblock::Component::Output::Complete::Success.new
+          def finish_reason
+            Punchblock::Component::Output::Complete::Finish.new
           end
         end
       end

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

@@ -27,8 +27,6 @@ module Punchblock
               component.finished
             end
 
-            send_ref
-
             if @component_node.start_beep
               @call.execute_agi_command 'STREAM FILE', 'beep', '""'
             end
@@ -39,8 +37,12 @@ module Punchblock
                 ami_client.send_action 'StopMonitor', 'Channel' => call.channel
               end
             end
+
+            send_ref
+          rescue ChannelGoneError
+            set_node_response ProtocolError.new.setup(:item_not_found, "Could not find a call with ID #{call_id}", call_id)
           rescue RubyAMI::Error => e
-            complete_with_error "Terminated due to AMI error '#{e.message}'"
+            with_error :platform_error, "Terminated due to AMI error '#{e.message}'"
           rescue OptionError => e
             with_error 'option error', e.message
           end
@@ -63,7 +65,7 @@ module Punchblock
           end
 
           def finished
-            send_complete_event(@complete_reason || success_reason)
+            send_complete_event(@complete_reason || max_duration_reason)
           end
 
           private
@@ -80,8 +82,8 @@ module Punchblock
             Punchblock::Event::Complete::Stop.new
           end
 
-          def success_reason
-            Punchblock::Component::Record::Complete::Success.new
+          def max_duration_reason
+            Punchblock::Component::Record::Complete::MaxDuration.new
           end
 
           def send_complete_event(reason)

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

@@ -7,8 +7,12 @@ module Punchblock
         extend ActiveSupport::Autoload
 
         autoload :Asterisk
+        autoload :ComposedPrompt
         autoload :Input
         autoload :Output
+        autoload :MRCPPrompt
+        autoload :MRCPNativePrompt
+        autoload :MRCPRecogPrompt
         autoload :Record
         autoload :StopByRedirect
 
@@ -36,10 +40,7 @@ module Punchblock
           def send_complete_event(reason, recording = nil, should_terminate = true)
             return if @complete
             @complete = true
-            event = Punchblock::Event::Complete.new.tap do |c|
-              c.reason = reason
-              c << recording if recording
-            end
+            event = Punchblock::Event::Complete.new reason: reason, recording: recording
             send_event event
             terminate if should_terminate
           end
@@ -73,7 +74,7 @@ module Punchblock
           end
 
           def send_ref
-            set_node_response Ref.new :id => id
+            set_node_response Ref.new uri: id
           end
 
           def with_error(name, text)

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

@@ -0,0 +1,26 @@
+require 'punchblock/translator/asterisk/agi_app'
+require 'active_support/core_ext/string/filters'
+
+module Punchblock
+  module Translator
+    class Asterisk
+      class UniMRCPApp
+        def initialize(app, *args, options)
+          args.map! { |o| "\"#{o.to_s.squish.gsub('"', '\"')}\"" }
+          args << prepare_options(options)
+          @agi_app = AGIApp.new(app, *args)
+        end
+
+        def execute(call)
+          @agi_app.execute call
+        end
+
+        private
+
+        def prepare_options(options)
+          options.map { |o| o.join '=' }.join '&'
+        end
+      end
+    end
+  end
+end

data/lib/punchblock/translator/asterisk.rb

@@ -8,10 +8,14 @@ module Punchblock
     class Asterisk
       include Celluloid
 
+      # Indicates that a command was executed against a channel which no longer exists
+      ChannelGoneError = Class.new Punchblock::Error
+
       extend ActiveSupport::Autoload
 
       autoload :AGICommand
       autoload :Call
+      autoload :Channel
       autoload :Component
 
       attr_reader :ami_client, :connection, :media_engine, :calls
@@ -20,15 +24,13 @@ module Punchblock
       REDIRECT_EXTENSION = '1'
       REDIRECT_PRIORITY = '1'
 
-      CHANNEL_NORMALIZATION_REGEXP = /^(?<prefix>Bridge\/)*(?<channel>[^<>]*)(?<suffix><.*>)*$/.freeze
-      EVENTS_ALLOWED_BRIDGED = %w{agiexec asyncagi}
+      EVENTS_ALLOWED_BRIDGED = %w{AGIExec AsyncAGI}
 
       trap_exit :actor_died
 
       def initialize(ami_client, connection, media_engine = nil)
         @ami_client, @connection, @media_engine = ami_client, connection, media_engine
         @calls, @components, @channel_to_call_id = {}, {}, {}
-        @fully_booted_count = 0
       end
 
       def register_call(call)
@@ -36,9 +38,9 @@ module Punchblock
         @calls[call.id] ||= call
       end
 
-      def deregister_call(call)
-        @channel_to_call_id.delete call.channel
-        @calls.delete call.id
+      def deregister_call(id, channel)
+        @channel_to_call_id.delete channel
+        @calls.delete id
       end
 
       def call_with_id(call_id)
@@ -46,7 +48,7 @@ module Punchblock
       end
 
       def call_for_channel(channel)
-        call_with_id @channel_to_call_id[channel.match(CHANNEL_NORMALIZATION_REGEXP)[:channel]]
+        call_with_id @channel_to_call_id[Channel.new(channel).name]
       end
 
       def register_component(component)
@@ -65,7 +67,7 @@ module Punchblock
       def handle_ami_event(event)
         return unless event.is_a? RubyAMI::Event
 
-        if event.name.downcase == "fullybooted"
+        if event.name == 'FullyBooted'
           handle_pb_event Connection::Connected.new
           run_at_fully_booted
           return
@@ -76,7 +78,7 @@ module Punchblock
         ami_dispatch_to_or_create_call event
 
         unless ami_event_known_call?(event)
-          handle_pb_event Event::Asterisk::AMI::Event.new(:name => event.name, :attributes => event.headers)
+          handle_pb_event Event::Asterisk::AMI::Event.new(name: event.name, headers: event.headers)
         end
       end
       exclusive :handle_ami_event
@@ -171,24 +173,24 @@ module Punchblock
       end
 
       def ami_dispatch_to_or_create_call(event)
-        if ami_event_known_call?(event)
-          channels_for_ami_event(event).each do |channel|
-            call = call_for_channel channel
-            if call
-              if channel_is_bridged?(channel)
-                call.async.process_ami_event event if EVENTS_ALLOWED_BRIDGED.include?(event.name.downcase)
-              else
-                call.async.process_ami_event event
-              end
-            end
+        calls_for_event = channels_for_ami_event(event).inject({}) do |h, channel|
+          call = call_for_channel channel
+          h[channel] = call if call
+          h
+        end
+
+        if !calls_for_event.empty?
+          calls_for_event.each_pair do |channel, call|
+            next if channel.bridged? && !EVENTS_ALLOWED_BRIDGED.include?(event.name)
+            call.async.process_ami_event event
           end
-        elsif event.name.downcase == "asyncagi" && event['SubEvent'] == "Start"
+        elsif event.name == "AsyncAGI" && event['SubEvent'] == "Start"
           handle_async_agi_start_event event
         end
       end
 
       def channels_for_ami_event(event)
-        [event['Channel'], event['Channel1'], event['Channel2']].compact
+        [event['Channel'], event['Channel1'], event['Channel2']].compact.map { |channel| Channel.new(channel) }
       end
 
       def ami_event_known_call?(event)
@@ -197,18 +199,12 @@ module Punchblock
           (event['Channel2'] && call_for_channel(event['Channel2']))
       end
 
-      def channel_is_bridged?(channel)
-        matches = channel.match CHANNEL_NORMALIZATION_REGEXP
-        matches[:prefix] || matches[:suffix]
-      end
-
       def handle_async_agi_start_event(event)
         env = RubyAMI::AsyncAGIEnvironmentParser.new(event['Env']).to_hash
 
         return if env[:agi_extension] == 'h' || env[:agi_type] == 'Kill'
 
-        call = Call.new event['Channel'], current_actor, ami_client, connection, env
-        link call
+        call = Call.new_link event['Channel'], current_actor, ami_client, connection, env
         register_call call
         call.async.send_offer
       end

data/lib/punchblock/translator/dtmf_recognizer.rb

@@ -3,42 +3,45 @@
 module Punchblock
   module Translator
     class DTMFRecognizer
-      def initialize(responder, grammar, initial_timeout = nil, inter_digit_timeout = nil)
+      def initialize(responder, grammar, initial_timeout = nil, inter_digit_timeout = nil, terminator = nil)
         @responder = responder
-        self.grammar = grammar
         self.initial_timeout = initial_timeout || -1
         self.inter_digit_timeout = inter_digit_timeout || -1
+        @terminator = terminator
+        @finished = false
 
+        @matcher = RubySpeech::GRXML::Matcher.new RubySpeech::GRXML.import(grammar.to_s)
         @buffer = ""
-
-        begin_initial_timer @initial_timeout/1000 unless @initial_timeout == -1
       end
 
       def <<(digit)
-        @buffer << digit
         cancel_initial_timer
-        case (match = @grammar.match @buffer.dup)
-        when RubySpeech::GRXML::Match
-          @responder.match match.mode, match.confidence, match.utterance, match.interpretation
+        @buffer << digit unless terminating?(digit)
+        case (match = get_match)
         when RubySpeech::GRXML::NoMatch
-          @responder.nomatch
+          finalize :nomatch
+        when RubySpeech::GRXML::MaxMatch
+          finalize :match, match
+        when RubySpeech::GRXML::Match
+          finalize :match, match if terminating?(digit)
         when RubySpeech::GRXML::PotentialMatch
-          reset_inter_digit_timer
+          finalize :nomatch if terminating?(digit)
         end
+        reset_inter_digit_timer unless @finished
       end
 
-      def finalize
-        cancel_initial_timer
-        cancel_inter_digit_timer
+      def start_timers
+        begin_initial_timer @initial_timeout/1000 unless @initial_timeout == -1
       end
 
       private
 
-      def grammar=(other)
-        @grammar = RubySpeech::GRXML.import other.to_s
-        @grammar.inline!
-        @grammar.tokenize!
-        @grammar.normalize_whitespace
+      def terminating?(digit)
+        digit == @terminator
+      end
+
+      def get_match
+        @matcher.match @buffer.dup
       end
 
       def after(*args, &block)
@@ -57,7 +60,7 @@ module Punchblock
 
       def begin_initial_timer(timeout)
         @initial_timer = after timeout do
-          @responder.noinput
+          finalize :noinput
         end
       end
 
@@ -71,7 +74,12 @@ module Punchblock
         return if @inter_digit_timeout == -1
         @inter_digit_timer ||= begin
           after @inter_digit_timeout/1000 do
-            @responder.nomatch
+            case (match = get_match)
+            when RubySpeech::GRXML::Match
+              finalize :match, match
+            else
+              finalize :nomatch
+            end
           end
         end
         @inter_digit_timer.reset
@@ -82,6 +90,17 @@ module Punchblock
         @inter_digit_timer.cancel
         @inter_digit_timer = nil
       end
+
+      def finalize(match_type, match = nil)
+        cancel_initial_timer
+        cancel_inter_digit_timer
+        if match
+          @responder.send match_type, match
+        else
+          @responder.send match_type
+        end
+        @finished = true
+      end
     end
   end
 end

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

@@ -14,9 +14,10 @@ module Punchblock
         HANGUP_CAUSE_TO_END_REASON = Hash.new :error
 
         HANGUP_CAUSE_TO_END_REASON['USER_BUSY'] = :busy
+        HANGUP_CAUSE_TO_END_REASON['MANAGER_REQUEST'] = :hangup_command
 
         %w{
-          NORMAL_CLEARING ORIGINATOR_CANCEL SYSTEM_SHUTDOWN MANAGER_REQUEST
+          NORMAL_CLEARING ORIGINATOR_CANCEL SYSTEM_SHUTDOWN
           BLIND_TRANSFER ATTENDED_TRANSFER PICKED_OFF NORMAL_UNSPECIFIED
         }.each { |c| HANGUP_CAUSE_TO_END_REASON[c] = :hangup }
 
@@ -91,16 +92,16 @@ module Punchblock
             command = @pending_joins[event[:other_leg_unique_id]]
             command.response = true if command
 
-            other_call_id = event[:unique_id] == id ? event[:other_leg_unique_id] : event[:unique_id]
-            send_pb_event Event::Joined.new(:call_id => other_call_id)
+            other_call_uri = event[:unique_id] == id ? event[:other_leg_unique_id] : event[:unique_id]
+            send_pb_event Event::Joined.new(:call_uri => other_call_uri)
           end
 
           register_handler :es, :event_name => 'CHANNEL_UNBRIDGE' do |event|
             command = @pending_unjoins[event[:other_leg_unique_id]]
             command.response = true if command
 
-            other_call_id = event[:unique_id] == id ? event[:other_leg_unique_id] : event[:unique_id]
-            send_pb_event Event::Unjoined.new(:call_id => other_call_id)
+            other_call_uri = event[:unique_id] == id ? event[:other_leg_unique_id] : event[:unique_id]
+            send_pb_event Event::Unjoined.new(:call_uri => other_call_uri)
           end
 
           register_handler :es, [:has_key?, :scope_variable_punchblock_component_id] => true do |event|
@@ -145,8 +146,8 @@ module Punchblock
           options[:origination_caller_id_number] = "'#{cid_number}'" if cid_number.present?
           options[:origination_caller_id_name] = "'#{cid_name}'" if cid_name.present?
           options[:originate_timeout] = dial_command.timeout/1000 if dial_command.timeout
-          dial_command.headers.each do |header|
-            options["sip_h_#{header.name}"] = "'#{header.value}'"
+          dial_command.headers.each do |name, value|
+            options["sip_h_#{name}"] = "'#{value}'"
           end
           opts = options.inject([]) do |a, (k, v)|
             a << "#{k}=#{v}"
@@ -154,7 +155,7 @@ module Punchblock
 
           stream.bgapi "originate {#{opts}}#{dial_command.to} &park()"
 
-          dial_command.response = Ref.new :id => id
+          dial_command.response = Ref.new uri: id
         end
 
         def outbound?
@@ -195,10 +196,10 @@ module Punchblock
             hangup
             command.response = true
           when Command::Join
-            @pending_joins[command.call_id] = command
-            uuid_foo :bridge, command.call_id
+            @pending_joins[command.call_uri] = command
+            uuid_foo :bridge, command.call_uri
           when Command::Unjoin
-            @pending_unjoins[command.call_id] = command
+            @pending_unjoins[command.call_uri] = command
             uuid_foo :transfer, '-both park inline'
           when Command::Reject
             hangup REJECT_TO_HANGUP_REASON[command.reason]
@@ -222,7 +223,7 @@ module Punchblock
           end
         end
 
-        def hangup(reason = 'NORMAL_CLEARING')
+        def hangup(reason = 'MANAGER_REQUEST')
           sendmsg :call_command => 'hangup', :hangup_cause => reason
         end
 
@@ -244,7 +245,7 @@ module Punchblock
 
         def send_end_event(reason)
           send_pb_event Event::End.new(:reason => reason)
-          translator.deregister_call current_actor
+          translator.deregister_call id
           terminate
         end
 
@@ -268,7 +269,7 @@ module Punchblock
 
         def headers
           es_env.to_a.inject({}) do |accumulator, element|
-            accumulator[('x_' + element[0].to_s).to_sym] = element[1] || ''
+            accumulator['X-' + element[0].to_s] = element[1] || ''
             accumulator
           end
         end

data/lib/punchblock/translator/freeswitch/component/abstract_output.rb

@@ -35,20 +35,21 @@ module Punchblock
           end
 
           def validate
-            raise OptionError, 'An SSML document is required.' unless @component_node.ssml
+            raise OptionError, 'An SSML document is required.' unless @component_node.render_documents.first.value
+            raise OptionError, 'Only a single document is supported.' unless @component_node.render_documents.size == 1
 
             [:start_offset, :start_paused, :repeat_interval, :repeat_times, :max_time].each do |opt|
               raise OptionError, "A #{opt} value is unsupported." if @component_node.send opt
             end
 
             case @component_node.interrupt_on
-            when :speech, :dtmf, :any
+            when :voice, :dtmf, :any
               raise OptionError, "An interrupt-on value of #{@component_node.interrupt_on} is unsupported."
             end
           end
 
-          def success_reason
-            Punchblock::Component::Output::Complete::Success.new
+          def finish_reason
+            Punchblock::Component::Output::Complete::Finish.new
           end
         end
       end