webficient-twilio 1.0.0 → 1.2.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
+:minor: 2
 :patch: 0
 :major: 1
-:minor: 1

data/lib/twilio/verb.rb

@@ -1,19 +1,45 @@
 module Twilio
+  # Twilio Verbs enable your application to respond to Twilio requests (to your app) with XML responses.
+  #
+  # In addition to the 5 verbs supported by Twilio (say, play, gather, record, dial),
+  # this class also implements dynamic interfaces that allow you to combine useful
+  # operations into a single call. See below methods for examples.
   class Verb
     class << self
+      # The Say verb converts text to speech that is read back to the caller. 
+      # Say is useful for dynamic text that is difficult to prerecord. 
+      #
+      # Examples:
+      #   Twilio::Verb.say('The time is 9:35 PM.')
+      #   Twilio::Verb.say_3_times('The time is 9:35 PM.')
+      #
+      # With numbers, 12345 will be spoken as "twelve thousand three hundred forty five" while
+      # 1 2 3 4 5 will be spoken as "one two three four five."
+      #
+      #   Twilio::Verb.say_4_times('Your PIN is 1234')
+      #   Twilio::Verb.say_4_times('Your PIN is 1 2 3 4')
+      # 
+      # If you need a longer pause between each loop, use the pause form:
+      #
+      #   Twilio::Verb.say_4_times_with_pause('Your PIN is 1 2 3 4')
+      #
+      # Optional params passed in as a hash (see http://www.twilio.com/docs/api_reference/TwiML/say):
+      #    voice: (woman) man
+      #    language: (en) es fr de
+      #    loop: >= 0 (1)
       def say(text, options = {})
         voice = options[:voice] || 'woman'
-        language = options[:language] || 'en'
+        language = options[:language] || 'en'        
         loop_count = Integer(options[:loop]  || 1)
         pause = options[:pause]
         
         xml = Builder::XmlMarkup.new
         xml.instruct!
         xml.Response {
-          if pause
+          if pause                                    
             loop_count.times do |i|
-              xml.Say(text, :voice => voice, :language => language, :loop => 1)
-              xml.Pause unless i+1 == loop_count
+              xml.Say(text, :voice => voice, :language => language)
+              xml.Pause unless i == loop_count-1
             end
           else
             xml.Say(text, :voice => voice, :language => language, :loop => loop_count)
@@ -21,23 +47,51 @@ module Twilio
         }
       end
       
+      #  The Play verb plays an audio URL back to the caller. 
+      # Examples:
+      #   Twilio::Verb.play('http://foo.com/cowbell.mp3')
+      #   Twilio::Verb.play_3_times('http://foo.com/cowbell.mp3')
+      #
+      # If you need a longer pause between each loop, use the pause form:
+      #
+      #   Twilio::Verb.play_3_times_with_pause('http://foo.com/cowbell.mp3')
+      #
+      # Optional params passed in as a hash (see http://www.twilio.com/docs/api_reference/TwiML/play):
+      #    loop: >= 0 (1)      
       def play(audio_url, options = {})
-        raise NotImplementedError.new 'Not yet implemented - coming soon'
+        loop_count = Integer(options[:loop]  || 1)
+        pause = options[:pause]
+        
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.Response {
+          if pause                                    
+            loop_count.times do |i|
+              xml.Play(audio_url)
+              xml.Pause unless i == loop_count-1
+            end
+          else
+            xml.Play(audio_url, :loop => loop_count)
+          end          
+        }
       end
       
+      #Not yet implemented 
       def gather(options = {})
         raise NotImplementedError.new 'Not yet implemented - coming soon'
       end
       
+      #Not yet implemented 
       def record(options = {})
         raise NotImplementedError.new 'Not yet implemented - coming soon'
       end
       
+      #Not yet implemented 
       def dial(phone_number, options = {})
         raise NotImplementedError.new 'Not yet implemented - coming soon'
       end
       
-      def method_missing(method_id, *args)
+      def method_missing(method_id, *args) #:nodoc:
         if match = /(say|play|gather|record|dial)_(\d+)_times(_with_pause$*)/.match(method_id.to_s)
           verb = match.captures.first 
           how_many_times = match.captures[1]

data/test/fixtures/yml/verb_responses.yml

@@ -1,8 +1,20 @@
 say_hi:
   response: <?xml version="1.0" encoding="UTF-8"?><Response><Say loop="1" language="en" voice="woman">hi</Say></Response>
-  
+
+say_hi_in_spanish_with_male_voice:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Say loop="1" language="es" voice="man">hola</Say></Response>
+      
 say_hi_three_times:
   response: <?xml version="1.0" encoding="UTF-8"?><Response><Say loop="3" language="en" voice="woman">hi</Say></Response>
   
 say_hi_three_times_with_pause:
-  response: <?xml version="1.0" encoding="UTF-8"?><Response><Say loop="1" language="en" voice="woman">hi</Say><Pause/><Say loop="1" language="en" voice="woman">hi</Say><Pause/><Say loop="1" language="en" voice="woman">hi</Say></Response>
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Say language="en" voice="woman">hi</Say><Pause/><Say language="en" voice="woman">hi</Say><Pause/><Say language="en" voice="woman">hi</Say></Response>
+  
+play_mp3:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Play loop="1">http://foo.com/cowbell.mp3</Play></Response>
+  
+play_mp3_two_times:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Play loop="2">http://foo.com/cowbell.mp3</Play></Response>
+
+play_mp3_two_times_with_pause:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Play>http://foo.com/cowbell.mp3</Play><Pause/><Play>http://foo.com/cowbell.mp3</Play></Response>   

data/test/test_helper.rb

@@ -11,7 +11,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'twilio'
 
-class Test::Unit::TestCase
+class Test::Unit::TestCase #:nodoc: all
 end
 
 def fixture(filename)

data/test/twilio/account_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class AccountTest < Test::Unit::TestCase
+class AccountTest < Test::Unit::TestCase #:nodoc: all
   context "An account" do
     setup do
       @connection = Twilio::Connection.new('mysid', 'mytoken')

data/test/twilio/call_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class CallTest < Test::Unit::TestCase
+class CallTest < Test::Unit::TestCase #:nodoc: all
   context "A call" do
     setup do
       @connection = Twilio::Connection.new('mysid', 'mytoken')

data/test/twilio/connection_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class ConnectionTest < Test::Unit::TestCase
+class ConnectionTest < Test::Unit::TestCase #:nodoc: all
   context "A Twilio connection" do
     setup do
       @connection = Twilio::Connection.new('mysid', 'mytoken')

data/test/twilio/incoming_phone_number_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class IncomingPhoneNumberTest < Test::Unit::TestCase
+class IncomingPhoneNumberTest < Test::Unit::TestCase #:nodoc: all
   context "An incoming phone number" do
     setup do
       @connection = Twilio::Connection.new('mysid', 'mytoken')

data/test/twilio/local_phone_number_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class LocalPhoneNumberTest < Test::Unit::TestCase
+class LocalPhoneNumberTest < Test::Unit::TestCase #:nodoc: all
   context "A local phone number" do
     setup do
       @connection = Twilio::Connection.new('mysid', 'mytoken')

data/test/twilio/notification_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class NotificationTest < Test::Unit::TestCase
+class NotificationTest < Test::Unit::TestCase #:nodoc: all
   context "A recording" do
     setup do
       @connection = Twilio::Connection.new('mysid', 'mytoken')

data/test/twilio/outgoing_caller_id_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class OutgoingCallerIdTest < Test::Unit::TestCase
+class OutgoingCallerIdTest < Test::Unit::TestCase #:nodoc: all
   context "An outgoing caller id" do
     setup do
       @connection = Twilio::Connection.new('mysid', 'mytoken')

data/test/twilio/recording_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class RecordingTest < Test::Unit::TestCase
+class RecordingTest < Test::Unit::TestCase #:nodoc: all
   context "A recording" do
     setup do
       @connection = Twilio::Connection.new('mysid', 'mytoken')

data/test/twilio/toll_free_phone_number_test.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class TollFreePhoneNumberTest < Test::Unit::TestCase
+class TollFreePhoneNumberTest < Test::Unit::TestCase #:nodoc: all
   context "A toll free phone number" do
     setup do
       @connection = Twilio::Connection.new('mysid', 'mytoken')

data/test/twilio/verb_test.rb

@@ -1,23 +1,35 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class VerbTest < Test::Unit::TestCase
+class VerbTest < Test::Unit::TestCase #:nodoc: all
   context "A Twilio Verb" do
-    should "say 'Hi'" do
+    should "say 'hi'" do
       assert_equal verb_response(:say_hi), Twilio::Verb.say('hi')
     end
     
-    should "say 'Hi' three times" do
+    should "say 'hola' in Spanish with male voice" do
+      assert_equal verb_response(:say_hi_in_spanish_with_male_voice), Twilio::Verb.say('hola', {:voice => 'man', :language => 'es'})
+    end
+    
+    should "say 'hi' three times" do
       assert_equal verb_response(:say_hi_three_times), Twilio::Verb.say_3_times('hi')
     end
     
-    should "say 'Hi' three times with pause" do
+    should "say 'hi' three times with pause" do
       assert_equal verb_response(:say_hi_three_times_with_pause), Twilio::Verb.say_3_times_with_pause('hi')
     end
     
-    should "raise not implemented error with play" do
-      assert_raise(NotImplementedError) { Twilio::Verb.play('something') }
+    should "play mp3 response" do
+      assert_equal verb_response(:play_mp3), Twilio::Verb.play('http://foo.com/cowbell.mp3')
     end
     
+    should "play mp3 response two times" do
+      assert_equal verb_response(:play_mp3_two_times), Twilio::Verb.play_2_times('http://foo.com/cowbell.mp3')
+    end
+   
+    should "play mp3 response two times with pause" do
+      assert_equal verb_response(:play_mp3_two_times_with_pause), Twilio::Verb.play_2_times_with_pause('http://foo.com/cowbell.mp3')
+    end
+     
     should "raise not implemented error with gather" do
       assert_raise(NotImplementedError) { Twilio::Verb.gather('something') }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webficient-twilio
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Phil Misiowiec