slayer-twilio 3.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG.rdoc

@@ -0,0 +1,31 @@
+= Twilio Gem Changelog
+
+== 3.0.1
+
+* Bumped down Builder version requirement for Rails compat
+
+== 3.0
+
+* SSL validation (thanks Kyle Humberto)
+* Available phone numbers search support (thanks Mark Turner)
+* Deprecated Twilio::Connection method has been removed, use Twilio.connect(...)
+* LocalPhoneNumber and TollFreeNumber have been removed to reflect API changes
+* New phone numbers are now provisioned via the IncomingPhoneNumber class
+* Several classes improved to avoid adding a stray "?" when no params were set
+* Compatibility with 1.9.2 (and tested on 1.8.7 MRI and REE)
+* Now uses Bundler, Rspec 2, and WebMock
+
+== 2.9
+
+* Compatibility with Twilio's 2010-04-01 API publish
+
+== 2.8
+
+* SMS callback URLs
+* Ability to delete phone numbers
+
+== 2.7
+
+* SMS functionality
+
+For earlier versions, see https://github.com/webficient/twilio/commits/master

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in twilio.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2010 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,63 @@
+= Slayer's modifications:
+
+* added Reject verb
+
+= Twilio Gem
+
+The Twilio gem provides two major pieces of functionality: (1) a Ruby wrapper for the Twilio REST API and (2) response handlers based on the Twilio Markup XML (TwiML).
+
+See http://www.twilio.com/docs/index for Twilio's API documentation.
+
+== Calling the Twilio REST API
+
+First set your credentials by calling the connect method:
+
+  Twilio.connect('my_twilio_sid', 'my_auth_token')
+  
+Now call any of the Twilio classes:
+  
+  Twilio::Call.make('1234567890', '9876543210', 'http://mysite.com/connected_call')
+  Twilio::Recording.list
+  
+== Responding to Twilio
+
+When Twilio calls your application URL, your response must use the Twilio Markup XML (http://www.twilio.com/docs/api_reference/TwiML/). The Twilio gem makes this very easy 
+by providing a Twilio Verb class. 
+
+For example, in a Ruby on Rails application, you could do the following inside a controller class:
+
+  Twilio::Verb.dial '415-123-4567'
+  
+and you can nest multiple verbs inside a block:
+
+  verb = Twilio::Verb.new { |v|
+    v.say "The time is #{Time.now}"
+    v.hangup
+  }
+  verb.response
+
+== Installation
+
+  gem install twilio
+  
+== Contributing
+
+1. Run 'bundle' from the command line to install dependencies
+2. Write test(s) for your patch
+3. Submit a pull request
+
+Note: don't require 'rubygems' in any file (http://www.rubyinside.com/why-using-require-rubygems-is-wrong-1478.html)
+
+== Copyright
+
+Copyright (c) 2009-2011 Phil Misiowiec, Webficient LLC. See LICENSE for details.
+
+== Contributors
+
+* Kyle Daigle
+* Yuri Gadow
+* Kyle Humberto
+* Jonathan Rudenberg
+* Mark Turner
+* Jeff Wigal
+* Alex K Wolfe

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/twilio.rb

@@ -0,0 +1,53 @@
+#--
+# 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 'httparty'
+require 'builder'
+
+require 'twilio/twilio_object'
+
+require 'twilio/account'
+require 'twilio/available_phone_numbers'
+require 'twilio/call'
+require 'twilio/conference'
+require 'twilio/incoming_phone_number'
+require 'twilio/notification'
+require 'twilio/outgoing_caller_id'
+require 'twilio/recording'
+require 'twilio/sms'
+require 'twilio/verb'
+
+module Twilio  
+  include HTTParty
+  TWILIO_URL = "https://api.twilio.com/2010-04-01/Accounts"
+  SSL_CA_PATH = "/etc/ssl/certs"
+  
+  # The connect method caches your Twilio account id and authentication token
+  # Example:
+  #  Twilio.connect('AC309475e5fede1b49e100272a8640f438', '3a2630a909aadbf60266234756fb15a0')
+  def self.connect(account_sid, auth_token)
+    self.base_uri "#{TWILIO_URL}/#{account_sid}"
+    self.basic_auth account_sid, auth_token
+    self.default_options[:ssl_ca_path] ||= SSL_CA_PATH unless self.default_options[:ssl_ca_file]
+  end  
+end

data/lib/twilio/account.rb

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

data/lib/twilio/available_phone_numbers.rb

@@ -0,0 +1,56 @@
+module Twilio
+  # An AvailablePhoneNumbers resources represents the available phone numbers
+  # that Twilio can provide you based on your search criteria. The valid 
+  # query terms are outlined in the search methods.
+  # Example:
+  #   Twilio.connect('my_twilio_sid', 'my_auth_token')
+  #   Twilio.AvailablePhoneNumbers.search_local(:area_code => 541)
+  class AvailablePhoneNumbers < TwilioObject
+
+    # The Search method handles the searching of both local and toll-free 
+    # numbers. 
+    def search(opts={})
+      iso_country_code = opts[:iso_country_code] || 'US'
+      resource = opts.delete(:resource)
+
+      params = {
+        :AreaCode => opts[:area_code],
+        :InPostalCode => opts[:postal_code],
+        :InRegion => opts[:in_region],
+        :Contains => opts[:contains],
+        :NearLatLong => opts[:near_lat_long],
+        :NearNumber => opts[:near_number],
+        :InLata => opts[:in_lata],
+        :InRateCenter => opts[:in_rate_center],
+        :Distance => opts[:distance]
+      }.reject {|k,v| v == nil} unless opts.empty?
+      
+      Twilio.get("/AvailablePhoneNumbers/#{iso_country_code}/#{resource}", :query => params)
+    end
+
+    # The search_local method searches for numbers in local areas (i.e. state, zip, etc..)
+    # Search Options:
+    #   :area_code
+    #   :postal_code
+    #   :in_region
+    #   :contains
+    #   :near_lat_long
+    #   :near_number
+    #   :in_lata
+    #   :in_rate_center
+    #   :distance
+    def search_local(opts ={})
+      opts = {:resource => 'Local'}.merge(opts)
+      search(opts)
+    end
+
+    # The search_toll_free method searches for available toll-free numbers
+    # Search Options
+    #   :contains
+    def search_toll_free(opts ={})
+      opts = {:resource => 'TollFree'}.merge(opts)
+      search(opts)
+    end
+  end
+end
+

data/lib/twilio/call.rb

@@ -0,0 +1,37 @@
+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:
+    #  Twilio.connect('my_twilio_sid', 'my_auth_token')
+    #  Twilio::Call.make(CALLER_ID, user_number, 'http://myapp.com/twilio_response_handler')
+    def make(from, to, url, opts = {})
+      Twilio.post("/Calls", :body => {:From => from, :To => to, :Url => url}.merge(opts))
+    end
+
+    def list(opts = {})
+      Twilio.get("/Calls", :query => (opts.empty? ? nil : opts))  
+    end
+        
+    def get(call_sid)
+      Twilio.get("/Calls/#{call_sid}")
+    end
+    
+    def redirect(call_sid, new_url, url_action = 'POST')
+      Twilio.post("/Calls/#{call_sid}", :body => {:CurrentUrl => new_url, :CurrentMethod => url_action})
+    end
+    
+    def segments(call_sid, call_segment_sid = nil)
+      Twilio.get("/Calls/#{call_sid}/Segments#{ '/' + call_segment_sid if call_segment_sid }")
+    end
+    
+    def recordings(call_sid)
+      Twilio.get("/Calls/#{call_sid}/Recordings")
+    end
+    
+    def notifications(call_sid)
+      Twilio.get("/Calls/#{call_sid}/Notifications")
+    end
+  end
+end

data/lib/twilio/conference.rb

@@ -0,0 +1,35 @@
+module Twilio
+    # The Conference REST resource allows you to query and manage the state of conferences.
+    # When a caller joins a conference via the Dial verb and Conference noun,
+    # a Conference Instance Resource is created to represent the conference room
+    # and a Participant Instance Resource is created to represent the caller who joined.
+  class Conference < TwilioObject
+    def list(opts = {})
+      Twilio.get("/Conferences", :query => (opts.empty? ? nil : opts))
+    end
+    
+    def get(conference_sid)
+      Twilio.get("/Conferences/#{conference_sid}")
+    end
+    
+    def participants(conference_sid, opts = {})
+      Twilio.get("/Conferences/#{conference_sid}/Participants", :query => (opts.empty? ? nil : opts))
+    end
+    
+    def participant(conference_sid, call_sid)
+      Twilio.get("/Conferences/#{conference_sid}/Participants/#{call_sid}")
+    end
+    
+    def mute_participant(conference_sid, call_sid)
+      Twilio.post("/Conferences/#{conference_sid}/Participants/#{call_sid}", :body => {:Muted => true})
+    end
+    
+    def unmute_participant(conference_sid, call_sid)
+      Twilio.post("/Conferences/#{conference_sid}/Participants/#{call_sid}", :body => {:Muted => false})
+    end
+    
+    def kick_participant(conference_sid, call_sid)
+      Twilio.delete("/Conferences/#{conference_sid}/Participants/#{call_sid}")
+    end
+  end
+end

data/lib/twilio/incoming_phone_number.rb

@@ -0,0 +1,30 @@
+module Twilio
+  # An IncomingPhoneNumber resource represents a phone number given to you by 
+  # Twilio to receive incoming phone calls. 
+  # Example:
+  #   Twilio.connect('my_twilio_sid', 'my_auth_token')
+  #   Twilio::IncomingPhoneNumber.list
+  class IncomingPhoneNumber < TwilioObject
+    def list(opts = {})
+      Twilio.get("/IncomingPhoneNumbers", :query => (opts.empty? ? nil : opts)) 
+    end
+    
+    def get(incoming_sid)
+      Twilio.get("/IncomingPhoneNumbers/#{incoming_sid}") 
+    end
+    
+    # Creates a phone number in Twilio. You must first find an existing number using
+    # the AvailablePhoneNumber class before creating one here.
+    #
+    # Required: you must either set PhoneNumber or AreaCode as a required option
+    # For additional options, see http://www.twilio.com/docs/api/rest/incoming-phone-numbers
+    def create(opts)
+      raise "You must set either :PhoneNumber or :AreaCode" if !opts.include?(:AreaCode) && !opts.include?(:PhoneNumber)
+      Twilio.post("/IncomingPhoneNumbers", :body => opts)
+    end
+    
+    def delete(incoming_sid)
+      Twilio.delete("/IncomingPhoneNumbers/#{incoming_sid}")
+    end
+  end
+end

data/lib/twilio/notification.rb

@@ -0,0 +1,20 @@
+module Twilio
+  # A Notification represenents a log entry made by Twilio in the course of handling 
+  # your calls or using the REST API.
+  # Example:
+  #   Twilio.connect('my_twilio_sid', 'my_auth_token')
+  #   Twilio::Notification.list
+  class Notification < TwilioObject
+    def list(opts = {})
+      Twilio.get('/Notifications', :query => (opts.empty? ? nil : opts))
+    end
+    
+    def get(notification_sid)
+      Twilio.get("/Notifications/#{notification_sid}")
+    end
+    
+    def delete(notification_sid)
+      Twilio.delete("/Notifications/#{notification_sid}")
+    end
+  end
+end

data/lib/twilio/outgoing_caller_id.rb

@@ -0,0 +1,33 @@
+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.
+  # Example:
+  #   Twilio.connect('my_twilio_sid', 'my_auth_token')
+  #   Twilio::OutgoingCallerId.list
+  class OutgoingCallerId < TwilioObject
+    def create(phone_number, friendly_name = phone_number, call_delay = 0, extension = nil)
+      Twilio.post("/OutgoingCallerIds", :body => {
+        :PhoneNumber => phone_number, 
+        :FriendlyName => friendly_name, 
+        :CallDelay => call_delay,
+        :Extension => extension
+      })
+    end
+
+    def list(opts = {})
+      Twilio.get("/OutgoingCallerIds", :query => (opts.empty? ? nil : opts)) 
+    end
+        
+    def get(callerid_sid)
+      Twilio.get("/OutgoingCallerIds/#{callerid_sid}") 
+    end
+    
+    def update_name(callerid_sid, name)
+      Twilio.put("/OutgoingCallerIds/#{callerid_sid}", :body => {:FriendlyName => name})
+    end
+    
+    def delete(callerid_sid)
+      Twilio.delete("/OutgoingCallerIds/#{callerid_sid}")
+    end
+  end
+end

data/lib/twilio/recording.rb

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