twilio 1.4.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Phil Misiowiec, Webficient LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,24 @@
+= twilio
+
+This wrapper defines each of the interfaces currently supported by Twilio REST API.
+
+Sample Usage:
+
+First create a connection object:
+
+  c = Twilio::Connection.new('my_twilio_sid', 'my_auth_token')
+  
+Now instantiate other objects by passing in the connection:
+
+  a = Twilio::Account.new(c)
+  a.update_name('sparky')
+  
+  call = Twilio::Call.new(c)
+  call.make('1234567890', '9876543210', 'http://mysite.com/connected_call')
+  
+  recording = Twilio::Recording.new(c)
+  recording.list
+
+== Copyright
+
+Copyright (c) 2009 Phil Misiowiec, Webficient LLC. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "twilio"
+    gem.summary = %Q{Twilio API Client}
+    gem.email = "github@webficient.com"
+    gem.homepage = "http://github.com/webficient/twilio"
+    gem.authors = ["Phil Misiowiec"]
+    gem.add_dependency 'builder'
+    gem.add_dependency 'httparty'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'twilio'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test

data/VERSION.yml

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

data/lib/twilio.rb

@@ -0,0 +1,42 @@
+$:.unshift(File.dirname(__FILE__))
+
+#--
+# Copyright (c) 2009 Phil Misiowiec, phil@webficient.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require 'rubygems'
+gem 'httparty', '>= 0.4.3'
+require 'httparty'
+gem 'builder', '>= 2.1.2'
+require 'builder'
+
+require 'twilio/twilio_object'
+require 'twilio/account'
+require 'twilio/call'
+require 'twilio/connection'
+require 'twilio/incoming_phone_number'
+require 'twilio/local_phone_number'
+require 'twilio/notification'
+require 'twilio/outgoing_caller_id'
+require 'twilio/recording'
+require 'twilio/toll_free_phone_number'
+require 'twilio/verb'

data/lib/twilio/account.rb

@@ -0,0 +1,12 @@
+module Twilio
+  # The Account resource represents your Twilio Account. 
+  class Account < TwilioObject
+    def get
+      self.connection.class.get('')
+    end
+    
+    def update_name(name)
+      self.connection.class.put('', :body => {:FriendlyName => name})
+    end
+  end
+end

data/lib/twilio/call.rb

@@ -0,0 +1,34 @@
+module Twilio
+    # A Call represenents a connection between a telephone and Twilio. This may be 
+    # inbound, when a person calls your application, or outbound when your application 
+    # initiates the call, either via the REST API, or during a call via the Dial Verb. 
+  class Call < TwilioObject
+    #  Example:
+    #  c = Twilio::Connection.new('my_twilio_sid', 'my_auth_token')
+    #  call = Twilio::Call.new(c)
+    #  response = call.make(CALLER_ID, user_number, 'http://myapp.com/twilio_response_handler')
+    def make(caller, called, url, optional = {})
+      self.connection.class.post("/Calls", :body => {:Caller => caller, :Called => called, :Url => url}.merge(optional))
+    end
+
+    def list(optional = {})
+      self.connection.class.get("/Calls", :query => optional)  
+    end
+        
+    def get(call_sid)
+      self.connection.class.get("/Calls/#{call_sid}")  
+    end
+    
+    def segments(call_sid, call_segment_sid = nil)
+      self.connection.class.get("/Calls/#{call_sid}/Segments#{ '/' + call_segment_sid if call_segment_sid }")
+    end
+    
+    def recordings(call_sid)
+      self.connection.class.get("/Calls/#{call_sid}/Recordings")
+    end
+    
+    def notifications(call_sid)
+      self.connection.class.get("/Calls/#{call_sid}/Notifications")
+    end
+  end
+end

data/lib/twilio/connection.rb

@@ -0,0 +1,17 @@
+module Twilio
+  # The Connection class caches the Twilio API base path and authentication credentials.
+  # It is passed into the constructor of other TwilioObject's, avoiding the need to 
+  # explicitly set credentials with each API call.
+  #
+  #  Example:
+  #  c = Twilio::Connection.new('my_twilio_sid', 'my_auth_token')
+  class Connection
+    include HTTParty
+    TWILIO_URL = "https://api.twilio.com/2008-08-01/Accounts"
+    
+    def initialize(account_sid, auth_token)
+      self.class.base_uri "#{TWILIO_URL}/#{account_sid}"
+      self.class.basic_auth account_sid, auth_token     
+    end
+  end
+end

data/lib/twilio/incoming_phone_number.rb

@@ -0,0 +1,13 @@
+module Twilio
+  # An IncomingPhoneNumber resource represents a phone number given to you by 
+  # Twilio to receive incoming phone calls. 
+  class IncomingPhoneNumber < TwilioObject
+    def list(optional = {})
+      self.connection.class.get("/IncomingPhoneNumbers", :query => optional) 
+    end
+    
+    def get(incoming_sid)
+      self.connection.class.get("/IncomingPhoneNumbers/#{incoming_sid}") 
+    end
+  end
+end

data/lib/twilio/local_phone_number.rb

@@ -0,0 +1,18 @@
+module Twilio
+  # This sub-resource represents only Local phone numbers, or in other words, not toll-free numbers. 
+  # Also allows you to request a new local phone number be added to your account. 
+  class LocalPhoneNumber < TwilioObject
+    def create(url, area_code = nil, method = 'POST', friendly_name = nil)
+      self.connection.class.post("/IncomingPhoneNumbers/Local", :body => {
+        :Url => url, 
+        :AreaCode => area_code, 
+        :Method => method,
+        :FriendlyName => friendly_name 
+      })
+    end
+    
+    def list
+      self.connection.class.get("/IncomingPhoneNumbers/Local")
+    end
+  end
+end

data/lib/twilio/notification.rb

@@ -0,0 +1,17 @@
+module Twilio
+  # A Notification represenents a log entry made by Twilio in the course of handling 
+  # your calls or using the REST API.
+  class Notification < TwilioObject
+    def list(optional = {})
+      self.connection.class.get('/Notifications', :query => optional)
+    end
+    
+    def get(notification_sid)
+      self.connection.class.get("/Notifications/#{notification_sid}")
+    end
+    
+    def delete(notification_sid)
+      self.connection.class.delete("/Notifications/#{notification_sid}")
+    end
+  end
+end

data/lib/twilio/outgoing_caller_id.rb

@@ -0,0 +1,29 @@
+module Twilio
+  # An OutgoingCallerId resource represents an outgoing Caller ID that you have 
+  # registered with Twilio for use when making an outgoing call or using the Dial Verb. 
+  class OutgoingCallerId < TwilioObject
+    def create(phone_number, friendly_name = phone_number, call_delay = 0)
+      self.connection.class.post("/OutgoingCallerIds", :body => {
+        :PhoneNumber => phone_number, 
+        :FriendlyName => friendly_name, 
+        :CallDelay => call_delay 
+      })
+    end
+
+    def list(optional = {})
+      self.connection.class.get("/OutgoingCallerIds", :query => optional) 
+    end
+        
+    def get(callerid_sid)
+      self.connection.class.get("/OutgoingCallerIds/#{callerid_sid}") 
+    end
+    
+    def update_name(callerid_sid, name)
+      self.connection.class.put("/OutgoingCallerIds/#{callerid_sid}", :body => {:FriendlyName => name})
+    end
+    
+    def delete(callerid_sid)
+      self.connection.class.delete("/OutgoingCallerIds/#{callerid_sid}")
+    end
+  end
+end

data/lib/twilio/recording.rb

@@ -0,0 +1,21 @@
+module Twilio
+  # Recordings are generated when you use the Record Verb. Those recordings are 
+  # hosted on Twilio's REST API for you to access. 
+  class Recording < TwilioObject    
+    def list(optional = {})
+      self.connection.class.get("/Recordings", :query => optional)  
+    end
+    
+    def get(recording_sid)
+      self.connection.class.get("/Recordings/#{recording_sid}")  
+    end
+    
+    def delete(recording_sid)
+      self.connection.class.delete("/Recordings/#{recording_sid}")
+    end
+    
+    def transcriptions(recording_sid, transcription_sid = nil)
+      self.connection.class.get("/Recordings/#{recording_sid}/Transcriptions#{ '/' + transcription_sid if transcription_sid }") 
+    end
+  end
+end

data/lib/twilio/toll_free_phone_number.rb

@@ -0,0 +1,18 @@
+module Twilio
+  # This sub-resource represents only Toll Free phone numbers, or in other words, not local numbers. 
+  # Also allows you to request a new toll free phone number be added to your account. 
+  class TollFreePhoneNumber < TwilioObject
+    def create(url, area_code = nil, method = 'POST', friendly_name = nil)
+      self.connection.class.post("/IncomingPhoneNumbers/TollFree", :body => {
+        :Url => url, 
+        :AreaCode => area_code, 
+        :Method => method,
+        :FriendlyName => friendly_name 
+      })
+    end
+    
+    def list
+      self.connection.class.get("/IncomingPhoneNumbers/TollFree")
+    end
+  end
+end

data/lib/twilio/twilio_object.rb

@@ -0,0 +1,11 @@
+module Twilio
+  class TwilioObject  #:nodoc: all
+    include HTTParty
+    
+    attr_reader :connection
+    
+    def initialize(connection)
+      @connection = connection
+    end
+  end
+end

data/lib/twilio/verb.rb

@@ -0,0 +1,186 @@
+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')
+      #
+      # 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'})
+      def say(*args, &block)
+        options = {:voice => 'man', :language => 'en', :loop => 1}
+        args.each do |arg|
+          case arg
+          when String
+            options[:text_to_speak] = arg
+          when Hash
+            options.merge!(arg)
+          else
+            raise ArgumentError, 'say expects String or Hash argument'
+          end
+        end
+        
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.Response {
+          if options[:pause]
+            loop_with_pause(options[:loop], xml) do
+              xml.Say(options[:text_to_speak], :voice => options[:voice], :language => options[:language])
+            end
+          else
+            xml.Say(options[:text_to_speak], :voice => options[:voice], :language => options[:language], :loop => options[:loop])
+          end
+        }
+      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')
+      #
+      # 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)
+        options = {:loop => 1}
+        args.each do |arg|
+          case arg
+          when String
+            options[:audio_url] = arg
+          when Hash
+            options.merge!(arg)
+          else
+            raise ArgumentError, 'play expects String or Hash argument'
+          end
+        end
+
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.Response {
+          if options[:pause]
+            loop_with_pause(options[:loop], xml) do
+              xml.Play(options[:audio_url])
+            end
+          else
+            xml.Play(options[:audio_url], :loop => options[:loop])
+          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) }
+      end
+      
+      # 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
+      
+      # 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:
+        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]
+          pause = match.captures[2] == '_with_pause'
+          self.send(verb, args.first, { :loop => Integer(how_many_times), :pause =>  pause})
+        else
+          raise NoMethodError.new("Method --- #{method_id} --- not found")
+        end
+      end
+            
+      private 
+      
+        def loop_with_pause(loop_count, xml, &verb_action)
+          last_iteration = loop_count-1                               
+          loop_count.times do |i|
+            yield verb_action
+            xml.Pause unless i == last_iteration
+          end
+        end
+    end
+  end
+end