tropo-webapi-ruby 0.1.7 → 0.1.8

data/README.rdoc

@@ -9,7 +9,7 @@ your own web servers.
 
 == Requirements
 
-* Ruby v1.8.6+ or JRuby v1.4.0+
+* Unit tests passed on: Ruby MRI v1.8.6/1.8.7 and JRuby v1.5.0
 * RubyGems
 
 Note: If using with ActiveSupport, v2.3.5 or better of ActiveSupport is required.
@@ -185,6 +185,44 @@ Using the great RESTful Web Services framework Sinatra for Ruby.
     Tropo::Generator.reject
   end
 
+==== Setting a default voice for speech synthesis (text-to-speech/TTS)
+
+  post '/speak.json' do
+    t = Tropo::Generator.new(:voice => 'kate')
+    t.say 'Hello!' # Will speak as kate now
+    
+    # or
+
+    t = Tropo::Generator.new
+    t.voice = 'kate'
+    t.say 'Hello!' # Will speak as kate now
+  end
+
+==== Setting a default recognizer for speech recognition (ASR)
+
+  post '/ask.json' do
+    t = Tropo::Generator.new(:recognizer => 'fr-fr')
+    t.ask({ :name    => 'account_number', # Will now use the French speech recognition engine
+            :bargein => 'true', 
+            :timeout => 30,
+            :require => 'true' }) do
+              say     :value => "S'il vous plaît dire votre numéro de compte", :voice => 'florence'
+              choices :value => '[5 DIGITS]'
+            end
+
+    # or
+
+    t = Tropo::Generator.new
+    t.recognizer = 'fr-fr'
+    t.ask({ :name    => 'account_number', # Will now use the French speech recognition engine
+            :bargein => 'true', 
+            :timeout => 30,
+            :require => 'true' }) do
+              say     :value => "S'il vous plaît dire votre numéro de compte", :voice => 'florence'
+              choices :value => '[5 DIGITS]'
+            end
+  end
+
 === Additional Examples
 
 May be found by checking out the project from Github, and then looking in $PROJECT_HOME/examples and $PROJECT_HOME/spec/tropo-webapi-ruby_spec.rb.

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/lib/tropo-webapi-ruby.rb

@@ -1,2 +1,5 @@
 $: << File.expand_path(File.dirname(__FILE__))
 %w(uri json hashie time tropo-webapi-ruby/tropo-webapi-ruby-helpers tropo-webapi-ruby/tropo-webapi-ruby).each { |lib| require lib }
+
+# Add the instance_exec method to the object class for Ruby 1.8.6 support
+require 'tropo-webapi-ruby/object_patch' if RUBY_VERSION == '1.8.6'

data/lib/tropo-webapi-ruby/tropo-webapi-ruby-helpers.rb

@@ -144,7 +144,7 @@ module Tropo
       def decamelize(camel_string)
         camel_string.gsub(/[A-Z]/) { |char| '_' + char.downcase }
       end
-    
+      
       ##
       # Formats the @response instance variable to JSON before making it available to the accessor
       #
@@ -153,6 +153,18 @@ module Tropo
         @response.to_json
       end
       
+      ##
+      # Determines if there is a voice or recognizer specified, if not set it to the default specified and if not default leave it alone
+      # this is for the speech synthesis and speech recognition language to use on a say/ask methods
+      #
+      # @params [Hash] the array of values to check if a voice and recognizer are present
+      # @return [Hash] Will return the params with the appropriate voice/recognizer values set
+      def set_language(params)
+        params.merge!({ :recognizer => @recognizer }) if params[:recognizer].nil? && @recognizer
+        params.merge!({ :voice => @voice }) if params[:voice].nil? && @voice
+        params
+      end
+      
       ##
       # Returns an hash from a collapsed array, using the values of 'key' or 'name' as the collpassed hash key
       #

data/lib/tropo-webapi-ruby/tropo-webapi-ruby.rb

@@ -4,8 +4,10 @@ module Tropo
     include Tropo::Helpers
     
     ##
-    # Set a couple of Booleans to indicate the session type as a convenience
-    attr_reader :voice_session, :text_session
+    # Set a couple of Booleans to indicate the session type as a convenience 
+    # Set a default voice for speech synthesis
+    # Set a default recognizer for speech recognition
+    attr_reader :voice_session, :text_session, :voice, :recognizer
     
     ##
     # Defines the actions on self so that we may call them individually
@@ -23,13 +25,18 @@ module Tropo
     #
     # @overload initialize()
     # @overload initialize(params)
+    #   @param [String] voice sets the value of the default voice
     #   @param [Object] pass in an object that may be accessed inside the block
     # @overload initialize(params, &block)
     #   @param [Object] pass in an object that may be accessed inside the block
+    #   @param [String] voice sets the value of the default voice
     #   @param [Block] a block of code to execute (optional)
     # @return [Object] a new Generator object
-    def initialize(params=nil, &block)
+    def initialize(params={}, &block)
       @response = { :tropo => Array.new }
+      @voice = params[:voice] if params[:voice]
+      @recognizer = params[:recognizer] if params[:recognizer]
+      
       if block_given?
         # Lets us know were are in the midst of building a block, so we only rendor the JSON
         # response at the end of executing the block, rather than at each action
@@ -64,6 +71,7 @@ module Tropo
     # @return [String, nil] the JSON string to be passed back to Tropo or nil
     #   if the method has been called from inside a block
     def ask(params={}, &block)
+      params = set_language(params)
       if block_given?
         create_nested_hash('ask', params)
         instance_exec(&block)
@@ -157,7 +165,7 @@ module Tropo
     #   @option params [optional, String] :exit_tone whether to play a beep when this user exits a conference
     # @return [String, nil] the JSON string to be passed back to Tropo or nil
     #   if the method has been called from inside a block
-    def conference(params={}, &block)   
+    def conference(params={}, &block)
       if block_given?
         create_nested_hash('conference', params)
         instance_exec(&block)
@@ -287,6 +295,14 @@ module Tropo
       transformed_response = Hashie::Mash.new(transformed_response)
     end
     
+    ##
+    # Sets the default recognizer for the object
+    #
+    # @param [String] recognizer the value to set the default voice to
+    def recognizer=(recognizer)
+      @recognizer = recognizer
+    end
+    
     ##
     # Plays a prompt (audio file or text to speech) and optionally waits for a response from the caller that is recorded. 
     # If collected, responses may be in the form of DTMF or speech recognition using a simple grammar format defined below. 
@@ -414,10 +430,12 @@ module Tropo
 
       if params.kind_of? Array
         params.each do |param|
+          param = set_language(param)
           hash = build_action('say', param)
           response[:say] << hash
         end
       else
+        params = set_language(params)
         hash = build_action('say', params)
         response[:say] << hash
       end
@@ -513,5 +531,12 @@ module Tropo
       render_response if @building.nil?
     end
     
+    ##
+    # Sets the default voice for the object
+    #
+    # @param [String] voice the value to set the default voice to
+    def voice=(voice)
+      @voice = voice
+    end
   end
 end

data/spec/tropo-webapi-ruby_spec.rb

@@ -487,7 +487,7 @@ describe "Tropo" do
   
   it "should generate a valid JSON string for a record method with a transcription request" do
     hash_result = {"tropo"=>[{"record"=>{"name"=>"foo", "transcription"=>{"email_format"=>"encoded", "url"=>"mailto:jose@voxeo.com", "id"=>"bling"}, "say"=>[{"value"=>"Please say your account number"}], "beep"=>true, "url"=>"http://sendme.com/tropo", "exitTone"=>"#", "sendTones"=>false, "choices"=>{"value"=>"[5 DIGITS]"}}}]}
-    tropo = Tropo::Generator.record({ :name => 'foo', 
+    tropo = Tropo::Generator.record({ :name          => 'foo', 
                                       :url           => 'http://sendme.com/tropo', 
                                       :beep          => true,
                                       :send_tones    => false,
@@ -519,4 +519,95 @@ describe "Tropo" do
                     :choices => { :value => yes_no_choices}
     JSON.parse(t.response).should == hash_result
   end
+  
+  it "should set the voice variable when called" do
+    t = Tropo::Generator.new
+    t.voice.should == nil
+    
+    t = Tropo::Generator.new(:voice => 'barnie')
+    t.voice.should == 'barnie'
+    
+    t = Tropo::Generator.new
+    t.voice = 'barnie'
+    t.voice.should == 'barnie'
+  end
+  
+  it "should handle the setting of the voice parameter based on defaults" do
+    t = Tropo::Generator.new
+    t.say 'Hi there!'
+    JSON.parse(t.response)['tropo'][0]['say'][0]['voice'].should == nil
+    
+    t = Tropo::Generator.new
+    t.say 'Hi there!', :voice => 'barnie'
+    JSON.parse(t.response)['tropo'][0]['say'][0]['voice'].should == 'barnie'
+    
+    t = Tropo::Generator.new(:voice => 'barnie')
+    t.say 'Hi there!'
+    t.say 'Wow!'
+    JSON.parse(t.response)['tropo'][0]['say'][0]['voice'].should == 'barnie'
+    JSON.parse(t.response)['tropo'][1]['say'][0]['voice'].should == 'barnie'
+
+    t = Tropo::Generator.new(:voice => 'barnie')
+    t.say 'Hi there!'
+    t.say 'Wow!', :voice => 'jack'
+    JSON.parse(t.response)['tropo'][0]['say'][0]['voice'].should == 'barnie'
+    JSON.parse(t.response)['tropo'][1]['say'][0]['voice'].should == 'jack'
+    
+    t = Tropo::Generator.new
+    t.voice = 'barnie'
+    t.say 'Hi there!'
+    t.say 'Wow!', :voice => 'jack'
+    JSON.parse(t.response)['tropo'][0]['say'][0]['voice'].should == 'barnie'
+    JSON.parse(t.response)['tropo'][1]['say'][0]['voice'].should == 'jack'
+  end
+  
+  it "should set the recognizer variable when called" do
+    t = Tropo::Generator.new
+    t.recognizer.should == nil
+    
+    t = Tropo::Generator.new(:recognizer => 'fr-fr')
+    t.recognizer.should == 'fr-fr'
+    
+    t = Tropo::Generator.new
+    t.recognizer = 'fr-fr'
+    t.recognizer.should == 'fr-fr'
+  end
+  
+  it "should handle the setting of the recognizer parameter based on defaults" do
+    t = Tropo::Generator.new
+    t.ask({ :name    => 'foo', 
+            :bargein => 'true', 
+            :timeout => 30,
+            :require => 'true' })
+    JSON.parse(t.response)['tropo'][0]['ask']['recognizer'].should == nil
+    
+    t = Tropo::Generator.new(:recognizer => 'fr-fr')
+    t.ask({ :name    => 'foo', 
+            :bargein => 'true', 
+            :timeout => 30,
+            :require => 'true' })
+    JSON.parse(t.response)['tropo'][0]['ask']['recognizer'].should == 'fr-fr'
+    
+    t = Tropo::Generator.new
+    t.recognizer = 'fr-fr'
+    t.ask({ :name    => 'foo', 
+            :bargein => 'true', 
+            :timeout => 30,
+            :require => 'true' })
+    JSON.parse(t.response)['tropo'][0]['ask']['recognizer'].should == 'fr-fr'
+    
+    t = Tropo::Generator.new
+    t.recognizer = 'fr-fr'
+    t.ask({ :name    => 'foo', 
+            :bargein => 'true', 
+            :timeout => 30,
+            :require => 'true' })
+    t.ask({ :name    => 'foo', 
+            :bargein => 'true', 
+            :timeout => 30,
+            :require => 'true',
+            :recognizer => 'de-de' })
+    JSON.parse(t.response)['tropo'][0]['ask']['recognizer'].should == 'fr-fr'
+    JSON.parse(t.response)['tropo'][1]['ask']['recognizer'].should == 'de-de'
+  end
 end

data/tropo-webapi-ruby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tropo-webapi-ruby}
-  s.version = "0.1.7"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Goecke"]
-  s.date = %q{2010-04-29}
+  s.date = %q{2010-05-14}
   s.description = %q{Ruby library for interacting with the Tropo Web API via REST & JSON}
   s.email = %q{jsgoecke@voxeo.com}
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tropo-webapi-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Jason Goecke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 -07:00
+date: 2010-05-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency