output.rb in adhearsion-3.0.0.beta1

- old
+ new

@@ -1,7 +1,8 @@
 # encoding: utf-8
 require 'uri'
+require 'i18n'
 
 %w(
   abstract_player
   async_player
   formatter
@@ -16,11 +17,11 @@
 
       #
       # 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
       #
       def say(text, options = {})
         return unless text
@@ -30,11 +31,11 @@
 
       #
       # 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
       #
       def say!(text, options = {})
         return unless text
@@ -47,11 +48,11 @@
       #
       # @example Speak 'abc123' as 'ay bee cee one two three'
       #   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
       #
       def say_characters(characters, options = {})
         player.play_ssml output_formatter.ssml_for_characters(characters), options
@@ -62,11 +63,11 @@
       #
       # @example Speak 'abc123' as 'ay bee cee one two three'
       #   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
       #
       def say_characters!(characters, options = {})
         async_player.play_ssml output_formatter.ssml_for_characters(characters), options
@@ -77,11 +78,11 @@
       # Fixnums (e.g. 1000), Strings which are valid Fixnums (e.g "123"), and direct sound files. To specify how the Date/Time objects are said
       # pass in as an array with the first parameter as the Date/Time/DateTime object along with a hash with the
       # 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'
       #   play '/path/on/disk/hello-world.wav'
       # @example Speak current time
@@ -111,11 +112,11 @@
       # Fixnums (e.g. 1000), Strings which are valid Fixnums (e.g "123"), and direct sound files. To specify how the Date/Time objects are said
       # pass in as an array with the first parameter as the Date/Time/DateTime object along with a hash with the
       # 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'
       #   play '/path/on/disk/hello-world.wav'
       # @example Speak current time
@@ -128,11 +129,11 @@
       #   play %w"http://www.example.com/a-connect-charge-of.wav 22 /path/to/cents-per-minute.wav /path/to/will-apply.mp3"
       # @example Play two sound files
       #   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
         ssml = output_formatter.ssml_for_collection(outputs) || return
         async_player.play_ssml ssml, options
@@ -141,14 +142,13 @@
       end
 
       #
       # 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
       #
       def play_audio(file, options = {})
@@ -157,29 +157,28 @@
       end
 
       #
       # 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)
       end
 
       #
       # Plays the given Date, Time, or Integer (seconds since epoch)
       # 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.
       # @see http://www.w3.org/TR/ssml-sayas/#S3.1
       # @option options [String] :strftime This format is what defines the string that is sent to the Speech Synthesis Engine.
@@ -196,20 +195,20 @@
       #
       # Plays the given Date, Time, or Integer (seconds since epoch)
       # 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.
       # @see http://www.w3.org/TR/ssml-sayas/#S3.1
       # @option options [String] :strftime This format is what defines the string that is sent to the Speech Synthesis Engine.
       #   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)
         async_player.play_ssml output_formatter.ssml_for_time(time, options), options
       end
@@ -218,11 +217,11 @@
       # Plays the given Numeric argument or string representing a decimal number.
       # When playing numbers, Adhearsion assumes you're saying the number, not the digits. For example, play("100")
       # 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
       #
       def play_numeric(number, options = {})
         raise ArgumentError unless number.kind_of?(Numeric) || number =~ /^\d+$/
@@ -234,25 +233,25 @@
       # Plays the given Numeric argument or string representing a decimal number and returns as soon as it begins.
       # When playing numbers, Adhearsion assumes you're saying the number, not the digits. For example, play("100")
       # 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+$/
         async_player.play_ssml output_formatter.ssml_for_numeric(number), options
       end
 
       #
       # 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
       #
       def play_document(url, options = {})
         raise ArgumentError unless url =~ URI::regexp
@@ -262,71 +261,53 @@
 
       #
       # 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
 
-        stopper.stop! if stopper.executing?
-        reason = stopper.complete_event.reason
-        result = reason.respond_to?(:utterance) ? reason.utterance : nil
-        parse_dtmf result
+      def locale
+        call[:locale] || I18n.default_locale
+      end
+
+      def locale=(l)
+        call[:locale] = l
       end
 
       # @private
       def player
         Player.new(self)