tropo-webapi-ruby 0.1.6 → 0.1.7

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

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

@@ -73,7 +73,9 @@ module Tropo
       # @return [String] the Ruby string camelized
       def camelize(ruby_string)
         split_string = ruby_string.split('_')
-        split_string[0] + split_string[1].capitalize
+        return_string = split_string[0] + split_string[1].capitalize
+        return_string = return_string + split_string[2].capitalize if split_string[2]
+        return_string
       end
     
       ##
@@ -127,7 +129,7 @@ module Tropo
         params.each_pair do |k,v| 
           if k.to_s.include? "_"
             k = camelize k.to_s
-            k = k.to_sym
+            k = k.to_sym if k
           end
           hash.merge!({ k => v })
         end

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

@@ -76,6 +76,44 @@ module Tropo
     end
     alias :prompt :ask
     
+    ##
+    # Prompts initiates a new call. May only be used when no call is active.
+    #
+    # @overload call(params)
+    #   @param [Hash] params the options to create a call action request with.
+    #   @option params [String] :to the destination of the call, may be a phone number, SMS number or IM address
+    #   @option params [optional, String] :from the phone number or IM address the call will come from
+    #   @option params [optional, String] :network which network the call will be initiated with, such as SMS
+    #   @option params [optional, String] :channel the channel the call will be initiated over, may be TEXT or VOICE
+    #   @option params [optional, Integer] :timeout (30) the amount of time, in seconds, to wait for a response before moving on
+    #   @option params [optional, Boolean] :answer_on_media (true) 
+    #   @options params [optional, Hash] :headers A set of key/values to apply as customer SIP headers to the outgoing call
+    #   @options params [optional, Hash] :recording Refer to the recording method for paramaters in the hash
+    # @overload ask(params, &block)
+    #   @param [Hash] params the options to create an message action request with.
+    #   @param [Block] takes a block so that you may trigger actions, such as a say, on a specific event
+    #   @option params [String] :to the destination of the call, may be a phone number, SMS number or IM address
+    #   @option params [optional, String] :from the phone number or IM address the call will come from
+    #   @option params [optional, String] :network which network the call will be initiated with, such as SMS
+    #   @option params [optional, String] :channel the channel the call will be initiated over, may be TEXT or VOICE
+    #   @option params [optional, Integer] :timeout (30) the amount of time, in seconds, to wait for a response before moving on
+    #   @option params [optional, Boolean] :answer_on_media (true) 
+    #   @options params [optional, Hash] :headers A set of key/values to apply as customer SIP headers to the outgoing call
+    #   @options params [optional, Hash] :recording Refer to the recording method for paramaters in the hash
+    # @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 call(params={}, &block)
+      if block_given?
+        create_nested_hash('call', params)
+        instance_exec(&block)
+        @response[:tropo] << @nested_hash
+      else
+        hash = build_action('call', params)
+        @response[:tropo] << hash
+      end
+      render_response if @building.nil?
+    end
+    
     ##
     # Choices to give the user on input
     #
@@ -146,6 +184,45 @@ module Tropo
     end
     alias :disconnect :hangup
     
+    ##
+    # Message initiates a new message to a destination and then hangs up on that destination. Also takes a say method
+    # in order to deliver a message to that desintation and then hangup.
+    #
+    # @overload message(params)
+    #   @param [Hash] params the options to create a message action request with.
+    #   @option params [String] :to the destination of the call, may be a phone number, SMS number or IM address
+    #   @option params [optional, String] :from the phone number or IM address the call will come from
+    #   @option params [optional, String] :network which network the call will be initiated with, such as SMS
+    #   @option params [optional, String] :channel the channel the call will be initiated over, may be TEXT or VOICE
+    #   @option params [optional, Integer] :timeout (30) the amount of time, in seconds, to wait for a response before moving on
+    #   @option params [optional, Boolean] :answer_on_media (true) 
+    #   @options params [optional, Hash] :headers A set of key/values to apply as customer SIP headers to the outgoing call
+    #   @options params [optional, Hash] :recording Refer to the recording method for paramaters in the hash
+    # @overload ask(params, &block)
+    #   @param [Hash] params the options to create an message action request with.
+    #   @param [Block] takes a block so that you may trigger actions, such as a say, on a specific event
+    #   @option params [String] :to the destination of the call, may be a phone number, SMS number or IM address
+    #   @option params [optional, String] :from the phone number or IM address the call will come from
+    #   @option params [optional, String] :network which network the call will be initiated with, such as SMS
+    #   @option params [optional, String] :channel the channel the call will be initiated over, may be TEXT or VOICE
+    #   @option params [optional, Integer] :timeout (30) the amount of time, in seconds, to wait for a response before moving on
+    #   @option params [optional, Boolean] :answer_on_media (true) 
+    #   @options params [optional, Hash] :headers A set of key/values to apply as customer SIP headers to the outgoing call
+    #   @options params [optional, Hash] :recording Refer to the recording method for paramaters in the hash
+    # @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 message(params={}, &block)
+      if block_given?
+        create_nested_hash('message', params)
+        instance_exec(&block)
+        @response[:tropo] << @nested_hash
+      else
+        hash = build_action('message', params)
+        @response[:tropo] << hash
+      end
+      render_response if @building.nil?
+    end
+    
     ##
     # Sets event handlers to call a REST resource when a particular event occurs
     #
@@ -224,6 +301,7 @@ module Tropo
     #   @option params [optional, String] :format (audio/wav) the audio format to record in, either a wav or mp3
     #   @option params [optional, String] :username if posting to FTP, the username for the FTP server
     #   @option params [optional, String] :password if posting to FTP, the password for the FTP server
+    #   @option params [optional, Hash] :transcription parameters used to transcribe the recording
     # @overload record(params, &block)
     #   @param [Hash] params the options to create a message with.
     #   @param [Block] takes a block so that you may trigger actions, such as a say, on a specific event
@@ -232,6 +310,7 @@ module Tropo
     #   @option params [optional, String] :format (audio/wav) the audio format to record in, either a wav or mp3
     #   @option params [optional, String] :username if posting to FTP, the username for the FTP server
     #   @option params [optional, String] :password if posting to FTP, the password for the FTP server
+    #   @option params [optional, Hash] :transcription parameters used to transcribe the recording
     # @option [String, nil] the JSON string to be passed back to Tropo or nil
     #   if the method has been called from inside a block
     def record(params={}, &block)

data/spec/tropo-webapi-ruby_spec.rb

@@ -449,4 +449,74 @@ describe "Tropo" do
     tropo.text_session.should == true
   end
 
+  it "should generate a valid JSON string for a call method" do
+    json_result = "{\"tropo\":[{\"call\":{\"recording\":{\"password\":\"passwd\",\"username\":\"jose\",\"method\":\"POST\",\"url\":\"http://foobar\",\"format\":\"audio/mp3\"},\"timeout\":10,\"network\":\"SMS\",\"channel\":\"TEXT\",\"to\":\"foo\",\"from\":\"bar\",\"headers\":{\"foo\":\"foo\",\"bar\":\"bar\"},\"answerOnMedia\":false}}]}"
+    tropo = Tropo::Generator.call({ :to              => 'foo', 
+                                    :from            => 'bar',
+                                    :network         => 'SMS',
+                                    :channel         => 'TEXT',
+                                    :timeout         => 10,
+                                    :answer_on_media => false,
+                                    :headers         => { :foo => 'foo', :bar => 'bar' },
+                                    :recording       => { :url      => 'http://foobar',
+                                                          :method   => 'POST',
+                                                          :format   => 'audio/mp3',
+                                                          :username => 'jose',
+                                                          :password => 'passwd' } })
+    JSON.parse(tropo).should == JSON.parse(json_result)
+  end
+  
+  it "should generate a valid JSON string for a message method" do
+    hash_result = {"tropo"=>[{"message"=>{"say"=>[{"value"=>"Please say your account number"}], "from"=>"bar", "timeout"=>10, "to"=>"foo", "network"=>"SMS", "answerOnMedia"=>false, "channel"=>"TEXT", "recording"=>{"format"=>"audio/mp3", "method"=>"POST", "url"=>"http://foobar", "username"=>"jose", "password"=>"passwd"}, "headers"=>{"foo"=>"foo", "bar"=>"bar"}}}]}
+    tropo = Tropo::Generator.message({ :to              => 'foo', 
+                                       :from            => 'bar',
+                                       :network         => 'SMS',
+                                       :channel         => 'TEXT',
+                                       :timeout         => 10,
+                                       :answer_on_media => false,
+                                       :headers         => { :foo => 'foo', :bar => 'bar' },
+                                       :recording       => { :url      => 'http://foobar',
+                                                             :method   => 'POST',
+                                                             :format   => 'audio/mp3',
+                                                             :username => 'jose',
+                                                             :password => 'passwd' } }) do
+                                         say     :value => 'Please say your account number'
+                                       end            
+    JSON.parse(tropo).should == hash_result
+  end
+  
+  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', 
+                                      :url           => 'http://sendme.com/tropo', 
+                                      :beep          => true,
+                                      :send_tones    => false,
+                                      :transcription => { :id           => 'bling',
+                                                          :url          => 'mailto:jose@voxeo.com',
+                                                          :email_format => 'encoded' },
+                                      :exit_tone     => '#' }) do
+                                        say     :value => 'Please say your account number'
+                                        choices :value => '[5 DIGITS]'
+                                      end 
+    JSON.parse(tropo).should == hash_result
+  end
+  
+  it "should properly generate a JSON document when calling an ask with says as hash elements rather than as methods" do
+    hash_result = {"tropo"=>[{"ask"=>{"name"=>"donate_to_id", "say"=>[{"event"=>"timeout", "value"=>"Sorry, I did not hear anything."}, {"event"=>"nomatch:1 nomatch:2 nomatch:3", "value"=>"Sorry, that wasn't a valid answer. You can press or say 1 for 'yes', or 2 for 'no'."}, {"value"=>"You chose organization foobar. Are you ready to donate to them? If you say no, I will tell you a little more about the organization."}, {"event"=>"nomatch:3", "value"=>"This is your last attempt."}], "bargein"=>true, "silenceTimeout"=>10, "timeout"=>10, "attempts"=>4, "choices"=>{"value"=>"true(1,yes,sure,affirmative), false(2,no,no thank you,negative), 0(0,help,i do not know, agent, operator, assistance, representative, real person, human), 9(9,quit,stop,shut up)"}}}]}
+    help_stop_choices = "0(0,help,i do not know, agent, operator, assistance, representative, real person, human), 9(9,quit,stop,shut up)"
+    yes_no_choices = "true(1,yes,sure,affirmative), false(2,no,no thank you,negative), " + help_stop_choices
+    
+    t = Tropo::Generator.new
+    t.ask :name => 'donate_to_id', 
+          :bargein => true, 
+          :timeout => 10, 
+          :silence_timeout => 10, 
+          :attempts => 4,
+          :say => [{:event => "timeout", :value => "Sorry, I did not hear anything."},
+                   {:event => "nomatch:1 nomatch:2 nomatch:3", :value => "Sorry, that wasn't a valid answer. You can press or say 1 for 'yes', or 2 for 'no'."},
+                   {:value => "You chose organization foobar. Are you ready to donate to them? If you say no, I will tell you a little more about the organization."},
+                   {:event => "nomatch:3", :value => "This is your last attempt."}],
+                    :choices => { :value => yes_no_choices}
+    JSON.parse(t.response).should == hash_result
+  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.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Goecke"]
-  s.date = %q{2010-04-26}
+  s.date = %q{2010-04-29}
   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.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Jason Goecke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-26 00:00:00 -07:00
+date: 2010-04-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency