webficient-twilio 1.3.0 → 1.4.0

data/VERSION.yml

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

data/lib/twilio/verb.rb

@@ -23,7 +23,7 @@ module Twilio
       #
       #   Twilio::Verb.say_4_times_with_pause('Your PIN is 1 2 3 4')
       #
-      # Optional params (see http://www.twilio.com/docs/api_reference/TwiML/say) are passed in as a hash:
+      # Options (see http://www.twilio.com/docs/api_reference/TwiML/say) are passed in as a hash:
       #
       #   Twilio::Verb.say('The time is 9:35 PM.', :voice => 'woman')
       #   Twilio::Verb.say('The time is 9:35 PM.', {:voice => 'woman', :language => 'es'})
@@ -53,7 +53,7 @@ module Twilio
         }
       end
       
-      #  The Play verb plays an audio URL back to the caller. 
+      # 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')
@@ -62,7 +62,7 @@ module Twilio
       #
       #   Twilio::Verb.play_3_times_with_pause('http://foo.com/cowbell.mp3')
       #
-      # Optional params (see http://www.twilio.com/docs/api_reference/TwiML/play) are passed in as a hash,
+      # Options (see http://www.twilio.com/docs/api_reference/TwiML/play) are passed in as a hash,
       # however, since the Play verb only supports 'loop' as the current option, you can instead use the
       # above form to keep things concise. 
       def play(*args, &block)
@@ -90,25 +90,75 @@ module Twilio
           end          
         }
       end
-            
+      
+      # The Gather verb collects digits entered by a caller into their telephone keypad. 
+      # When the caller is done entering data, Twilio submits that data to a provided URL, 
+      # as either a HTTP GET or POST request, just like a web browser submits data from an HTML form. 
+      #
+      # Options (see http://www.twilio.com/docs/api_reference/TwiML/gather) are passed in as a hash
+      #
+      # Examples:
+      #   Twilio::Verb.gather
+      #   Twilio::Verb.gather(:action => 'http://foobar.com')
+      #   Twilio::Verb.gather(:finishOnKey => '*') 
+      #   Twilio::Verb.gather(:action => 'http://foobar.com', :finishOnKey => '*') 
       def gather(*args, &block)
         options = args.shift
-        
         xml = Builder::XmlMarkup.new
         xml.instruct!
-        xml.Response {
-          xml.Gather(options)       
-        }
+        xml.Response { xml.Gather(options) }
       end
       
-      #Not yet implemented 
-      def record(options = {})
-        raise NotImplementedError.new 'Not yet implemented - coming soon'
+      # The Record verb records the caller's voice and returns a URL that links to a file 
+      # containing the audio recording.
+      #
+      # Options (see http://www.twilio.com/docs/api_reference/TwiML/record) are passed in as a hash
+      #
+      # Examples:
+      #   Twilio::Verb.record
+      #   Twilio::Verb.record(:action => 'http://foobar.com')
+      #   Twilio::Verb.record(:finishOnKey => '*') 
+      #   Twilio::Verb.record(:transcribe => true, :transcribeCallback => '/handle_transcribe')
+      def record(*args, &block)
+        options = args.shift
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.Response { xml.Record(options) }
       end
       
-      #Not yet implemented 
-      def dial(phone_number, options = {})
-        raise NotImplementedError.new 'Not yet implemented - coming soon'
+      # The Dial verb connects the current caller to an another phone. If the called party picks up, 
+      # the two parties are connected and can communicate until one hangs up. If the called party does 
+      # not pick up, if a busy signal is received, or the number doesn't exist, the dial verb will finish.
+      #
+      # If an action verb is provided, Twilio will submit the outcome of the call attempt to the action URL. 
+      # If no action is provided, Dial will fall through to the next verb in the document.
+      #
+      # Note: this is different than the behavior of Record and Gather. Dial does not submit back to the 
+      # current document URL if no action is provided.
+      #
+      # Options (see http://www.twilio.com/docs/api_reference/TwiML/dial) are passed in as a hash
+      #
+      # Examples:
+      #   Twilio::Verb.dial('415-123-4567')
+      #   Twilio::Verb.dial('415-123-4567', :action => 'http://foobar.com')
+      #   Twilio::Verb.dial('415-123-4567', {:timeout => 10, :callerId => '858-987-6543'}) 
+      def dial(*args, &block)
+        number_to_dial = ''
+        options = {}
+        args.each do |arg|
+          case arg
+          when String
+            number_to_dial = arg
+          when Hash
+            options.merge!(arg)
+          else
+            raise ArgumentError, 'dial expects String or Hash argument'
+          end
+        end
+        
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.Response { xml.Dial(number_to_dial, options) }
       end
 
       def method_missing(method_id, *args) #:nodoc:

data/test/fixtures/yml/verb_responses.yml

@@ -38,4 +38,52 @@ gather_with_finish_key:
   response: <?xml version="1.0" encoding="UTF-8"?><Response><Gather finishOnKey="*"/></Response>
   
 gather_with_num_digits:
-  response: <?xml version="1.0" encoding="UTF-8"?><Response><Gather numDigits="5"/></Response>
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Gather numDigits="5"/></Response>
+  
+gather_with_all_options_set:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Gather finishOnKey="*" method="GET" action="http://foobar.com" numDigits="5" timeout="10"/></Response>
+  
+record:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Record></Record></Response>
+  
+record_with_action:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Record action="http://foobar.com"/></Response>
+  
+record_with_get_method:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Record method="GET"/></Response>
+  
+record_with_timeout:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Record timeout="10"/></Response>
+  
+record_with_finish_key:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Record finishOnKey="*"/></Response>
+
+record_with_max_length:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Record maxLength="1800"/></Response>
+  
+record_with_transcribe:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Record transcribe="true" transcribeCallback="/handle_transcribe"/></Response>
+
+dial:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Dial>415-123-4567</Dial></Response>
+  
+dial_with_action:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Dial action="http://foobar.com">415-123-4567</Dial></Response>
+  
+dial_with_get_method:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Dial method="GET">415-123-4567</Dial></Response>
+  
+dial_with_timeout:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Dial timeout="10">415-123-4567</Dial></Response>
+  
+dial_with_hangup_on_star:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Dial hangupOnStar="true">415-123-4567</Dial></Response>
+  
+dial_with_time_limit:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Dial timeLimit="3600">415-123-4567</Dial></Response>
+  
+dial_with_caller_id:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Dial callerId="858-987-6543">415-123-4567</Dial></Response>
+  
+dial_with_timeout_and_caller_id:
+  response: <?xml version="1.0" encoding="UTF-8"?><Response><Dial callerId="858-987-6543" timeout="10">415-123-4567</Dial></Response>

data/test/twilio/verb_test.rb

@@ -58,12 +58,68 @@ class VerbTest < Test::Unit::TestCase #:nodoc: all
       assert_equal verb_response(:gather_with_num_digits), Twilio::Verb.gather(:numDigits => 5)
     end
     
-    should "raise not implemented error with record" do
-      assert_raise(NotImplementedError) { Twilio::Verb.record('something') }
+    should "gather with all options set" do
+      assert_equal verb_response(:gather_with_all_options_set), Twilio::Verb.gather(:action => 'http://foobar.com', :method => 'GET', :timeout => 10, :finishOnKey => '*', :numDigits => 5)
     end
     
-    should "raise not implemented error with dial" do
-      assert_raise(NotImplementedError) { Twilio::Verb.record('dial') }
+    should "record" do
+      assert_equal verb_response(:record), Twilio::Verb.record
+    end
+    
+    should "record with action" do
+      assert_equal verb_response(:record_with_action), Twilio::Verb.record(:action => 'http://foobar.com')
+    end
+    
+    should "record with GET method" do
+      assert_equal verb_response(:record_with_get_method), Twilio::Verb.record(:method => 'GET')
+    end
+    
+    should "record with timeout" do
+      assert_equal verb_response(:record_with_timeout), Twilio::Verb.record(:timeout => 10)
+    end
+    
+    should "record with finish key" do
+      assert_equal verb_response(:record_with_finish_key), Twilio::Verb.record(:finishOnKey => '*')
+    end
+    
+    should "record with max length" do
+      assert_equal verb_response(:record_with_max_length), Twilio::Verb.record(:maxLength => 1800)      
+    end
+    
+    should "record with transcribe" do
+      assert_equal verb_response(:record_with_transcribe), Twilio::Verb.record(:transcribe => true, :transcribeCallback => '/handle_transcribe')            
+    end
+    
+    should "dial" do
+      assert_equal verb_response(:dial), Twilio::Verb.dial('415-123-4567')
+    end
+    
+    should "dial with action" do
+      assert_equal verb_response(:dial_with_action), Twilio::Verb.dial('415-123-4567', :action => 'http://foobar.com')
+    end
+    
+    should "dial with GET method" do
+      assert_equal verb_response(:dial_with_get_method), Twilio::Verb.dial('415-123-4567', :method => 'GET')
+    end
+    
+    should "dial with timeout" do
+      assert_equal verb_response(:dial_with_timeout), Twilio::Verb.dial('415-123-4567', :timeout => 10)
+    end
+    
+    should "dial with hangup on star" do
+      assert_equal verb_response(:dial_with_hangup_on_star), Twilio::Verb.dial('415-123-4567', :hangupOnStar => true)
+    end
+    
+    should "dial with time limit" do
+      assert_equal verb_response(:dial_with_time_limit), Twilio::Verb.dial('415-123-4567', :timeLimit => 3600)
+    end
+    
+    should "dial with caller id" do
+      assert_equal verb_response(:dial_with_caller_id), Twilio::Verb.dial('415-123-4567', :callerId => '858-987-6543')
+    end
+    
+    should "dial with timeout and caller id" do
+      assert_equal verb_response(:dial_with_timeout_and_caller_id), Twilio::Verb.dial('415-123-4567', {:timeout => 10, :callerId => '858-987-6543'})
     end
   end
   

metadata

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