adhearsion 2.6.4 → 3.0.0.beta1

data/lib/adhearsion/call_controller/input/ask_grammar_builder.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module Input
+      class AskGrammarBuilder
+        def initialize(options)
+          @options = options
+        end
+
+        def grammars
+          @grammars ||= build_grammars
+        end
+
+      private
+
+        def build_grammars
+          grammars = []
+
+          grammars.concat [@options[:grammar]].flatten.compact.map { |val| {value: val} } if @options[:grammar]
+          grammars.concat [@options[:grammar_url]].flatten.compact.map { |val| {url: val} } if @options[:grammar_url]
+
+          if grammars.empty?
+            limit = @options[:limit]
+            grammar = RubySpeech::GRXML.draw mode: :dtmf, root: 'digits' do
+              rule id: 'digits', scope: 'public' do
+                item repeat: "0-#{limit}" do
+                  one_of do
+                    0.upto(9) { |d| item { d.to_s } }
+                    item { "#" }
+                    item { "*" }
+                  end
+                end
+              end
+            end
+            grammars << {value: grammar}
+          end
+
+          grammars
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/input/menu_builder.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+
+require 'adhearsion/call_controller/input/prompt_builder'
+
+module Adhearsion
+  class CallController
+    module Input
+      class MenuBuilder
+        def initialize(options, &block)
+          @options = options
+          @matchers = []
+          @callbacks = {}
+          build(&block)
+        end
+
+        def match(*args, &block)
+          payload = block || args.pop
+
+          @matchers << Matcher.new(payload, args)
+        end
+
+        def invalid(&block)
+          register_user_supplied_callback :nomatch, &block
+        end
+
+        def timeout(&block)
+          register_user_supplied_callback :noinput, &block
+        end
+
+        def failure(&block)
+          register_user_supplied_callback :failure, &block
+        end
+
+        def execute(output_document, controller)
+          catch :match do
+            (@options[:tries] || 1).times do
+              result = PromptBuilder.new(output_document, grammars, @options).execute(controller)
+              process_result result
+            end
+            execute_hook :failure
+          end
+        end
+
+      private
+
+        def grammars
+          @grammar ||= [{value: build_grammar}]
+        end
+
+        def process_result(result)
+          if result.status == :match
+            handle_match result
+          else
+            execute_hook result.status
+          end
+        end
+
+        def register_user_supplied_callback(name, &block)
+          @callbacks[name] = block
+        end
+
+        def execute_hook(hook_name)
+          callback = @callbacks[hook_name]
+          return unless callback
+          @context.instance_exec(&callback)
+        end
+
+        def handle_match(result)
+          match = @matchers[result.interpretation.to_i]
+          match.dispatch @context, result.utterance
+          throw :match
+        end
+
+        def build(&block)
+          @context = eval "self", block.binding
+          instance_eval(&block)
+        end
+
+        def method_missing(method_name, *args, &block)
+          if @context
+            @context.send method_name, *args, &block
+          else
+            super
+          end
+        end
+
+        def build_grammar
+          raise ArgumentError, "You must specify one or more matches." if @matchers.count < 1
+          matchers = @matchers
+
+          RubySpeech::GRXML.draw mode: (@options[:mode] || :dtmf), root: 'options', tag_format: 'semantics/1.0-literals' do
+            rule id: 'options', scope: 'public' do
+              item do
+                one_of do
+                  matchers.each_with_index do |matcher, index|
+                    item do
+                      tag { index.to_s }
+                      matcher.apply_to_grammar self
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        Matcher = Struct.new(:payload, :keys) do
+          def dispatch(controller, utterance)
+            if payload.is_a?(Proc)
+              controller.instance_exec utterance, &payload
+            else
+              controller.invoke payload, extension: utterance
+            end
+          end
+
+          def apply_to_grammar(grammar)
+            possible_options = calculate_possible_options
+            if possible_options.count > 1
+              grammar.one_of do
+                possible_options.each do |key|
+                  item { key.to_s }
+                end
+              end
+            else
+              keys.first.to_s
+            end
+          end
+
+          def calculate_possible_options
+            keys.map { |key| key.respond_to?(:to_a) ? key.to_a : key }.flatten
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/input/prompt_builder.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+require 'adhearsion/call_controller/input/result'
+
+module Adhearsion
+  class CallController
+    module Input
+      class PromptBuilder
+        def initialize(output_document, grammars, options)
+          input_options = {
+            mode: options[:mode] || :dtmf,
+            initial_timeout: timeout(options[:timeout] || Adhearsion.config.core.media.timeout),
+            inter_digit_timeout: timeout(options[:inter_digit_timeout] || Adhearsion.config.core.media.inter_digit_timeout),
+            max_silence: timeout(options[:timeout] || Adhearsion.config.core.media.timeout),
+            min_confidence: Adhearsion.config.core.media.min_confidence,
+            grammars: grammars,
+            recognizer: Adhearsion.config.core.media.recognizer,
+            language: Adhearsion.config.core.media.input_language,
+            terminator: options[:terminator]
+          }.merge(options[:input_options] || {})
+
+          @prompt = if output_document || options[:render_document]
+            output_options = {
+              render_document: options[:render_document] || {value: output_document},
+              renderer: Adhearsion.config.core.media.default_renderer,
+              voice: Adhearsion.config.core.media.default_voice
+            }.merge(options[:output_options] || {})
+
+            Adhearsion::Rayo::Component::Prompt.new output_options, input_options, barge_in: options.has_key?(:interruptible) ? options[:interruptible] : true
+          else
+            Adhearsion::Rayo::Component::Input.new input_options
+          end
+        end
+
+        def execute(controller)
+          controller.execute_component_and_await_completion @prompt
+
+          result @prompt.complete_event.reason
+        rescue Adhearsion::Call::ExpiredError
+          raise Adhearsion::Call::Hangup
+        end
+
+      private
+
+        def result(reason)
+          Result.new.tap do |result|
+            case reason
+            when proc { |r| r.respond_to? :nlsml }
+              result.status         = :match
+              result.mode           = reason.mode
+              result.confidence     = reason.confidence
+              result.utterance      = reason.utterance
+              result.interpretation = reason.interpretation
+              result.nlsml          = reason.nlsml
+            when Adhearsion::Event::Complete::Error
+              raise InputError, reason.details
+            when Adhearsion::Rayo::Component::Input::Complete::NoMatch
+              result.status = :nomatch
+            when Adhearsion::Rayo::Component::Input::Complete::NoInput
+              result.status = :noinput
+            when Adhearsion::Event::Complete::Hangup
+              result.status = :hangup
+            when Adhearsion::Event::Complete::Stop
+              result.status = :stop
+            else
+              raise "Unknown completion reason received: #{reason}"
+            end
+            logger.debug "Ask completed with result #{result.inspect}"
+          end
+        end
+
+        def timeout(value)
+          value > 0 ? value * 1000 : value
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/input/result.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+module Adhearsion
+  class CallController
+    module Input
+      Result = Struct.new(:status, :mode, :confidence, :utterance, :interpretation, :nlsml) do
+        def to_s
+          utterance
+        end
+
+        def inspect
+          "#<#{self.class} status=#{status.inspect}, confidence=#{confidence.inspect}, utterance=#{utterance.inspect}, interpretation=#{interpretation.inspect}, nlsml=#{nlsml.inspect}>"
+        end
+
+        def utterance=(other)
+          self[:utterance] = mode == :dtmf ? parse_dtmf(other) : other
+        end
+
+        def match?
+          status == :match
+        end
+
+      private
+
+        def parse_dtmf(dtmf)
+          return if dtmf.nil? || dtmf.empty?
+          dtmf.split(' ').inject '' do |final, digit|
+            final << parse_dtmf_digit(digit)
+          end
+        end
+
+        # @private
+        def parse_dtmf_digit(digit)
+          case tone = digit.split('-').last
+          when 'star'
+            '*'
+          when 'pound'
+            '#'
+          else
+            tone
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/call_controller/output.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require 'uri'
+require 'i18n'
 
 %w(
   abstract_player
@@ -18,7 +19,7 @@ module Adhearsion
       # Speak output using text-to-speech (TTS)
       #
       # @param [String, #to_s] text The text to be rendered
-      # @param [Hash] options A set of options for output. Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options A set of options for output. Includes everything in Adhearsion::Rayo::Component::Output.new.
       #
       # @raise [PlaybackError] if the given argument could not be played
       #
@@ -32,7 +33,7 @@ module Adhearsion
       # Speak output using text-to-speech (TTS) and return as soon as it begins
       #
       # @param [String, #to_s] text The text to be rendered
-      # @param [Hash] options A set of options for output. Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options A set of options for output. Includes everything in Adhearsion::Rayo::Component::Output.new.
       #
       # @raise [PlaybackError] if the given argument could not be played
       #
@@ -49,7 +50,7 @@ module Adhearsion
       #   say_characters('abc123')
       #
       # @param [String, #to_s] characters The string of characters to be spoken
-      # @param [Hash] options A set of options for output. Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options A set of options for output. Includes everything in Adhearsion::Rayo::Component::Output.new.
       #
       # @raise [PlaybackError] if the given argument could not be played
       #
@@ -64,7 +65,7 @@ module Adhearsion
       #   say_characters!('abc123')
       #
       # @param [String, #to_s] characters The string of characters to be spoken
-      # @param [Hash] options A set of options for output. Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options A set of options for output. Includes everything in Adhearsion::Rayo::Component::Output.new.
       #
       # @raise [PlaybackError] if the given argument could not be played
       #
@@ -79,7 +80,7 @@ module Adhearsion
       # additional options. See play_time for more information.
       #
       # @param [Array<String, Fixnum, Time, Date>, String, Fixnum, Time, Date] outputs A collection of outputs to render.
-      # @param [Hash] options A set of options for output. Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options A set of options for output. Includes everything in Adhearsion::Rayo::Component::Output.new.
       #
       # @example Play file hello-world
       #   play 'http://www.example.com/hello-world.mp3'
@@ -113,7 +114,7 @@ module Adhearsion
       # additional options. See play_time for more information.
       #
       # @param [Array<String, Fixnum, Time, Date>, String, Fixnum, Time, Date] outputs A collection of outputs to render.
-      # @param [Hash] options A set of options for output. Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options A set of options for output. Includes everything in Adhearsion::Rayo::Component::Output.new.
       #
       # @example Play file hello-world
       #   play 'http://www.example.com/hello-world.mp3'
@@ -130,7 +131,7 @@ module Adhearsion
       #   play "/path/to/you-sound-cute.mp3", "/path/to/what-are-you-wearing.wav"
       #
       # @raise [PlaybackError] if (one of) the given argument(s) could not be played
-      # @return [Punchblock::Component::Output]
+      # @return [Adhearsion::Rayo::Component::Output]
       #
       def play!(*outputs, options)
         options = process_output_options outputs, options
@@ -143,10 +144,9 @@ module Adhearsion
       #
       # Plays the given audio file.
       # SSML supports http:// paths and full disk paths.
-      # The Punchblock backend will have to handle cases like Asterisk where there is a fixed sounds directory.
       #
       # @param [String] file http:// URL or full disk path to the sound file
-      # @param [Hash] options Additional options Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options Additional options Includes everything in Adhearsion::Rayo::Component::Output.new.
       # @option options [String] :fallback The text to play if the file is not available
       #
       # @raise [PlaybackError] if (one of) the given argument(s) could not be played
@@ -159,14 +159,13 @@ module Adhearsion
       #
       # Plays the given audio file and returns as soon as it begins.
       # SSML supports http:// paths and full disk paths.
-      # The Punchblock backend will have to handle cases like Asterisk where there is a fixed sounds directory.
       #
       # @param [String] file http:// URL or full disk path to the sound file
-      # @param [Hash] options Additional options to specify how exactly to say time specified. Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options Additional options to specify how exactly to say time specified. Includes everything in Adhearsion::Rayo::Component::Output.new.
       # @option options [String] :fallback The text to play if the file is not available
       #
       # @raise [PlaybackError] if (one of) the given argument(s) could not be played
-      # @return [Punchblock::Component::Output]
+      # @return [Adhearsion::Rayo::Component::Output]
       #
       def play_audio!(file, options = {})
         async_player.play_ssml(output_formatter.ssml_for_audio(file, options), options)
@@ -177,7 +176,7 @@ module Adhearsion
       # using the given timezone and format.
       #
       # @param [Date, Time, DateTime] time Time to be said.
-      # @param [Hash] options Additional options to specify how exactly to say time specified. Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options Additional options to specify how exactly to say time specified. Includes everything in Adhearsion::Rayo::Component::Output.new.
       # @option options [String] :format This format is used only to disambiguate times that could be interpreted in different ways.
       #   For example, 01/06/2011 could mean either the 1st of June or the 6th of January.
       #   Please refer to the SSML specification.
@@ -198,7 +197,7 @@ module Adhearsion
       # using the given timezone and format and returns as soon as it begins.
       #
       # @param [Date, Time, DateTime] time Time to be said.
-      # @param [Hash] options Additional options to specify how exactly to say time specified. Includes everything in Punchblock::Component::Output.new.
+      # @param [Hash] options Additional options to specify how exactly to say time specified. Includes everything in Adhearsion::Rayo::Component::Output.new.
       # @option options [String] :format This format is used only to disambiguate times that could be interpreted in different ways.
       #   For example, 01/06/2011 could mean either the 1st of June or the 6th of January.
       #   Please refer to the SSML specification.
@@ -207,7 +206,7 @@ module Adhearsion
       #   It uses Time::strftime symbols.
       #
       # @raise [ArgumentError] if the given argument can not be played
-      # @return [Punchblock::Component::Output]
+      # @return [Adhearsion::Rayo::Component::Output]
       #
       def play_time!(time, options = {})
         raise ArgumentError unless [Date, Time, DateTime].include?(time.class) && options.is_a?(Hash)
@@ -220,7 +219,7 @@ module Adhearsion
       # is pronounced as "one hundred" instead of "one zero zero".
       #
       # @param [Numeric, String] number Numeric or String containing a valid Numeric, like "321".
-      # @param [Hash] options A set of options for output. See Punchblock::Component::Output.new for details.
+      # @param [Hash] options A set of options for output. See Adhearsion::Rayo::Component::Output.new for details.
       #
       # @raise [ArgumentError] if the given argument can not be played
       #
@@ -236,10 +235,10 @@ module Adhearsion
       # is pronounced as "one hundred" instead of "one zero zero".
       #
       # @param [Numeric, String] number Numeric or String containing a valid Numeric, like "321".
-      # @param [Hash] options A set of options for output. See Punchblock::Component::Output.new for details.
+      # @param [Hash] options A set of options for output. See Adhearsion::Rayo::Component::Output.new for details.
       #
       # @raise [ArgumentError] if the given argument can not be played
-      # @return [Punchblock::Component::Output]
+      # @return [Adhearsion::Rayo::Component::Output]
       #
       def play_numeric!(number, options = {})
         raise ArgumentError unless number.kind_of?(Numeric) || number =~ /^\d+$/
@@ -250,7 +249,7 @@ module Adhearsion
       # Plays the given SSML document from a URL.
       #
       # @param [String] url String containing a valid URL, like "http://example.com/document.ssml".
-      # @param [Hash] options A set of options for output. See Punchblock::Component::Output.new for details.
+      # @param [Hash] options A set of options for output. See Adhearsion::Rayo::Component::Output.new for details.
       #
       # @raise [ArgumentError] if the given argument can not be played
       #
@@ -264,68 +263,50 @@ module Adhearsion
       # Plays the given SSML document from a URL and returns as soon as it begins.
       #
       # @param [String] url String containing a valid URL, like "http://example.com/document.ssml".
-      # @param [Hash] options A set of options for output. See Punchblock::Component::Output.new for details.
+      # @param [Hash] options A set of options for output. See Adhearsion::Rayo::Component::Output.new for details.
       #
       # @raise [ArgumentError] if the given argument can not be played
-      # @return [Punchblock::Component::Output]
+      # @return [Adhearsion::Rayo::Component::Output]
       #
       def play_document!(url, options = {})
         raise ArgumentError unless url =~ URI::regexp
         async_player.play_url url, options
       end
 
-      #
-      # Plays the given output, allowing for DTMF input of a single digit from the user
-      # At the end of the played file it returns nil
-      #
-      # @example Ask the user for a number, then play it back
-      #   ssml = RubySpeech::SSML.draw do
-      #     "Please press a button"
-      #   end
-      #   input = interruptible_play ssml
-      #   play input unless input.nil?
-      #
-      # @param [String, Numeric, Date, Time, RubySpeech::SSML::Speak, Array, Hash] outputs The argument to play to the user, or an array of arguments.
-      # @param [Hash] options Additional options.
-      #
-      # @return [String, nil] The single DTMF character entered by the user, or nil if nothing was entered
-      # @raise [PlaybackError] if (one of) the given argument(s) could not be played
-      #
-      def interruptible_play(*outputs, options)
-        options = process_output_options outputs, options
-        outputs.find do |output|
-          digit = stream_file output, '0123456789#*', options
-          return digit if digit
+      def t(key, options = {})
+        this_locale = options[:locale] || locale
+        options = {default: '', locale: locale}.merge(options)
+        prompt = ::I18n.t "#{key}.audio", options
+        text   = ::I18n.t "#{key}.text", options
+
+        if prompt.empty? && text.empty?
+          # Look for a translation key that doesn't follow the Adhearsion-I18n structure
+          text = ::I18n.t key, options
         end
-      end
 
-      #
-      # Plays a single output, not only files, accepting interruption by one of the digits specified
-      #
-      # @param [Object] argument String or Hash specifying output and options
-      # @param [String] digits String with the digits that are allowed to interrupt output
-      #
-      # @return [String, nil] The pressed digit, or nil if nothing was pressed
-      # @private
-      #
-      def stream_file(argument, digits = '0123456789#*', output_options = {})
-        result = nil
-        stopper = Punchblock::Component::Input.new :mode => :dtmf,
-          :grammar => {
-            :value => grammar_accept(digits)
-          }
+        unless prompt.empty?
+          prompt = "file://#{Adhearsion.root + "/" unless Adhearsion.config.core.i18n.audio_path.start_with?("/")}#{Adhearsion.config.core.i18n.audio_path}/#{this_locale}/#{prompt}"
+        end
 
-        player.output output_formatter.ssml_for(argument), output_options do |output_component|
-          stopper.register_event_handler Punchblock::Event::Complete do |event|
-            output_component.stop! unless output_component.complete?
+        RubySpeech::SSML.draw language: this_locale do
+          if prompt.empty?
+            string text
+          else
+            if Adhearsion.config.core.i18n.fallback
+              audio(src: prompt) { string text }
+            else
+              audio(src: prompt)
+            end
           end
-          write_and_await_response stopper
         end
+      end
+
+      def locale
+        call[:locale] || I18n.default_locale
+      end
 
-        stopper.stop! if stopper.executing?
-        reason = stopper.complete_event.reason
-        result = reason.respond_to?(:utterance) ? reason.utterance : nil
-        parse_dtmf result
+      def locale=(l)
+        call[:locale] = l
       end
 
       # @private