twilio-ruby 3.3.1 → 3.4.0

data/README.md

@@ -16,7 +16,7 @@ $ rake gem
 $ gem install pkg/twilio-ruby-{version}
 ```
 
-## Get Started With Client Capability Tokens
+## Getting Started With Client Capability Tokens
 
 If you just need to generate a Capability Token for use with Twilio Client, you
 can do this:
@@ -45,7 +45,7 @@ capability.allow_client_incoming 'andrew'
 There is a slightly more detailed document in the
 [Capability](twilio-ruby/wiki/Capability) section of the wiki.
 
-## Getting Started with TwiML
+## Getting Started With TwiML
 
 TwiML support is based on the [builder][1] library. You can construct a TwiML
 response like this:
@@ -78,7 +78,7 @@ This will print the following (except for the whitespace):
 </Response>
 ```
 
-## Getting Started with REST
+## Getting Started With REST
 
 ### Setup Work
 
@@ -139,7 +139,7 @@ auth_token = '62ea81de3a5b414154eb263595357c69'
 
 # buy the first one
 @number = @numbers[0].phone_number
-@account.incoming_phone_numbers.create(:phone_number => @number)
+@client.account.incoming_phone_numbers.create(:phone_number => @number)
 ```
 
 ## More Information

data/Rakefile

@@ -1,10 +1,10 @@
 require 'rubygems'
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 require 'rspec/core/rake_task'
 
 spec = eval(File.read('twilio-ruby.gemspec'))
 
-Rake::GemPackageTask.new(spec) do |p|
+Gem::PackageTask.new(spec) do |p|
   p.gem_spec = spec
 end
 

data/examples.rb

@@ -7,7 +7,13 @@
 
 ################ ACCOUNTS ################
 
-# grab an account instance resource (no http request)
+# shortcut to grab your account object (account_sid is inferred from the client's auth credentials)
+@account = @client.account 
+
+# list your (sub)accounts
+@client.accounts.list
+
+# grab an account instance resource if you know the sid (no http request)
 @account = @client.accounts.get(@account_sid)
 # http round trip happens here
 puts @account.friendly_name
@@ -15,18 +21,15 @@ puts @account.friendly_name
 # update an account's friendly name (only one http request, for the POST)
 @client.accounts.get(@account_sid).update(:friendly_name => 'A Fabulous Friendly Name')
 
-# shortcut to grab your account object (account_sid is inferred from the client's auth credentials)
-@account = @client.account 
-
 ################ CALLS ################
 
-# print a list of calls (all parameters optional, single http req)
+# print a list of calls (all parameters optional, single http request)
 @account.calls.list({:page => 0, :page_size => 1000, :start_time => '2010-09-01'}).each do |call|
   puts call.sid
 end
 
-# get a particular call and list its recordings (one http req, for each())
-@account.calls.get('CAXXXXXXX').recordings.list.each do {|r| puts r.sid}
+# get a particular call and list its recording urls (one http request for #list)
+@account.calls.get('CAXXXXXXX').recordings.list.each do {|r| puts r.wav}
 
 # make a new outgoing call (this is the same type of object we get
 # from calls.get, except this has attributes since we made an http request)
@@ -61,7 +64,7 @@ puts @account.sms.messages.get('SMXXXXXXXX').body
 
 ################ PHONE NUMBERS ################
 
-# get a list of supported country codes (api currently doesn't support this)
+# get a list of supported country codes
 @account.available_phone_numbers.list
 
 # print some available numbers (only one http request)

data/lib/twilio-ruby.rb

@@ -23,6 +23,8 @@ require 'twilio-ruby/rest/sms'
 require 'twilio-ruby/rest/sms/messages'
 require 'twilio-ruby/rest/sms/short_codes'
 require 'twilio-ruby/rest/applications'
+require 'twilio-ruby/rest/connect_apps'
+require 'twilio-ruby/rest/authorized_connect_apps'
 require 'twilio-ruby/rest/outgoing_caller_ids'
 require 'twilio-ruby/rest/incoming_phone_numbers'
 require 'twilio-ruby/rest/available_phone_numbers'

data/lib/twilio-ruby/rest/accounts.rb

@@ -7,7 +7,8 @@ module Twilio
         super uri, client, params
         resource :sandbox, :available_phone_numbers, :incoming_phone_numbers,
           :calls, :outgoing_caller_ids, :conferences, :sms, :recordings,
-          :transcriptions, :notifications, :applications
+          :transcriptions, :notifications, :applications, :connect_apps,
+          :authorized_connect_apps
       end
     end
   end

data/lib/twilio-ruby/rest/authorized_connect_apps.rb

@@ -0,0 +1,6 @@
+module Twilio
+  module REST
+    class AuthorizedConnectApps < ListResource; end
+    class AuthorizedConnectApp < InstanceResource; end
+  end
+end

data/lib/twilio-ruby/rest/available_phone_numbers.rb

@@ -2,9 +2,9 @@ module Twilio
   module REST
     class AvailablePhoneNumbers < ListResource
       def initialize(uri, client)
-        @resource_name = 'countries'
-        @instance_class = Twilio::REST.const_get 'Country'
         @uri, @client = uri, client
+        @instance_class = Twilio::REST::Country
+        @list_key, @instance_id_key = 'countries', 'country_code'
       end
     end
 

data/lib/twilio-ruby/rest/available_phone_numbers/local.rb

@@ -2,9 +2,9 @@ module Twilio
   module REST
     class Local < ListResource
       def initialize(uri, client)
-        @resource_name = 'available_phone_numbers'
-        @instance_class = Twilio::REST.const_get 'AvailablePhoneNumber'
         @uri, @client = uri, client
+        @instance_class = Twilio::REST::AvailablePhoneNumber
+        @list_key, @instance_id_key = 'available_phone_numbers', 'sid'
       end
     end
   end

data/lib/twilio-ruby/rest/available_phone_numbers/toll_free.rb

@@ -2,9 +2,9 @@ module Twilio
   module REST
     class TollFree < ListResource
       def initialize(uri, client)
-        @resource_name = 'available_phone_numbers'
-        @instance_class = Twilio::REST.const_get 'AvailablePhoneNumber'
         @uri, @client = uri, client
+        @instance_class = Twilio::REST::AvailablePhoneNumber
+        @list_key, @instance_id_key = 'available_phone_numbers', 'sid'
       end
     end
   end

data/lib/twilio-ruby/rest/client.rb

@@ -82,6 +82,14 @@ module Twilio
       # to avoid insecure connection warnings in environments without the proper
       # cert validation chain.
       #
+      # === <tt>:timeout => 30</tt>
+      #
+      # Set the time in seconds to wait before timing out the HTTP request.
+      # Defaults to 30 seconds. If you aren't fetching giant pages of call or
+      # SMS logs you can safely decrease this to something like 3 seconds or
+      # lower. In paricular if you are sending SMS you can set this to 1 second
+      # or less and swallow the exception if you don't care about the response.
+      #
       # === <tt>:proxy_addr => 'proxy.host.domain'</tt>
       #
       # The domain of a proxy through which you'd like the client to make HTTP
@@ -168,7 +176,7 @@ module Twilio
       # a private method documented for completeness.
       def set_up_connection_from(options = {}) # :doc:
         config = {:host => 'api.twilio.com', :port => 443, :use_ssl => true,
-          :ssl_verify_peer => true}.merge! options
+          :ssl_verify_peer => true, :timeout => 30}.merge! options
         connection_class = Net::HTTP::Proxy config[:proxy_addr],
           config[:proxy_port], config[:proxy_user], config[:proxy_pass]
         @connection = connection_class.new config[:host], config[:port]
@@ -176,6 +184,8 @@ module Twilio
         unless config[:ssl_verify_peer]
           @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
+        @connection.open_timeout = options[:timeout]
+        @connection.read_timeout = options[:timeout]
       end
 
       ##

data/lib/twilio-ruby/rest/conferences/participants.rb

@@ -1,9 +1,10 @@
 module Twilio
   module REST
     class Participants < ListResource
-      private
-      def instance_sid_key
-        'call_sid'
+      def initialize(uri, client)
+        super
+        # hard-code the json key since participants don't have sids
+        @instance_id_key = 'call_sid'
       end
     end
 

data/lib/twilio-ruby/rest/connect_apps.rb

@@ -0,0 +1,6 @@
+module Twilio
+  module REST
+    class ConnectApps < ListResource; end
+    class ConnectApp < InstanceResource; end
+  end
+end

data/lib/twilio-ruby/rest/list_resource.rb

@@ -4,9 +4,10 @@ module Twilio
       include Utils
 
       def initialize(uri, client)
-        @resource_name = self.class.name.split('::')[-1]
-        @instance_class = Twilio::REST.const_get @resource_name.chop
         @uri, @client = uri, client
+        resource_name = self.class.name.split('::')[-1]
+        @instance_class = Twilio::REST.const_get resource_name.chop
+        @list_key, @instance_id_key = detwilify(resource_name), 'sid'
       end
 
       def inspect # :nodoc:
@@ -22,13 +23,13 @@ module Twilio
       # of resources you can request is 1000.
       #
       # The optional +params+ hash allows you to filter the list returned. The
-      # filters for each list resource type are defined by Twilio
+      # filters for each list resource type are defined by Twilio.
       def list(params = {})
         raise "Can't get a resource list without a REST Client" unless @client
         response = @client.get @uri, params
-        resources = response[detwilify(@resource_name)]
+        resources = response[@list_key]
         resource_list = resources.map do |resource|
-          @instance_class.new "#{@uri}/#{resource[instance_sid_key]}", @client,
+          @instance_class.new "#{@uri}/#{resource[@instance_id_key]}", @client,
             resource
         end
         # set the +total+ property on the array
@@ -68,21 +69,12 @@ module Twilio
       # the Twilio REST API documentation related to the kind of resource you
       # are attempting to create for details. Calling this method makes an HTTP
       # POST request to <tt>@uri</tt> with the given params
-      def create(params = {})
+      def create(params={})
         raise "Can't create a resource without a REST Client" unless @client
         response = @client.post @uri, params
-        @instance_class.new "#{@uri}/#{response[instance_sid_key]}", @client,
+        @instance_class.new "#{@uri}/#{response[@instance_id_key]}", @client,
           response
       end
-
-      private
-
-      ##
-      # Return the JSON key containing the sid of each instance. Overridden for
-      # conference participants and perhaps other resources.
-      def instance_sid_key
-        'sid'
-      end
     end
   end
 end

data/lib/twilio-ruby/rest/outgoing_caller_ids.rb

@@ -4,8 +4,22 @@ module Twilio
       def add(phone_number)
         create :phone_number => phone_number
       end
+      alias :verify :add
+
+      ##
+      # Override ListResource#create to instantiate the proper instance class.
+      # This doesn't actually matter since all properties are lazily loaded into
+      # whatever object is instantiated. But it might matter in the future.
+      def create(params={}) # :nodoc:
+        old_instance_class = @instance_class
+        @instance_class = Twilio::REST::PhoneNumberVerificationRequest
+        verification_request = super
+        @instance_class = old_instance_class
+        verification_request
+      end
     end
 
     class OutgoingCallerId < InstanceResource; end
+    class PhoneNumberVerificationRequest < InstanceResource; end
   end
 end

data/lib/twilio-ruby/rest/recordings.rb

@@ -10,18 +10,20 @@ module Twilio
         @connection = @client.instance_variable_get :@connection
       end
 
+      ##
+      # Return the wav URL for this recording.
       def wav
-        scheme = @connection.use_ssl ? 'https' : 'http'
-        "#{scheme}://#{@connection.address}#{@uri}.wav"
+        "https://#{@connection.address}#{@uri}.wav"
       end
 
       def wav!(&block)
         @connection.request_get @uri, &block
       end
 
+      ##
+      # Return the mp3 URL for this recording.
       def mp3
-        scheme = @connection.use_ssl ? 'https' : 'http'
-        "#{scheme}://#{@connection.address}#{@uri}.mp3"
+        "https://#{@connection.address}#{@uri}.mp3"
       end
 
       def mp3!(&block)

data/lib/twilio-ruby/rest/sms/messages.rb

@@ -4,7 +4,7 @@ module Twilio
       def initialize(uri, client)
         super
         # hard-code the json key since 'messages' doesn't exist in the response
-        @resource_name = 'sms_messages'
+        @list_key = 'sms_messages'
       end
     end
 

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-  VERSION = '3.3.1'
+  VERSION = '3.4.0'
 end

data/test/twilio_spec.rb

@@ -28,6 +28,15 @@ describe Twilio::REST::Client do
     twilio.instance_variable_get('@connection').use_ssl?.should == true
   end
 
+  it 'should adjust the open and read timeouts on the underlying Net::HTTP object when asked' do
+    timeout = rand(30)
+    twilio = Twilio::REST::Client.new('someSid', 'someToken', :timeout => timeout)
+    twilio.instance_variable_get('@connection').port.should == 443
+    twilio.instance_variable_get('@connection').use_ssl?.should == true
+    twilio.instance_variable_get('@connection').open_timeout.should == timeout
+    twilio.instance_variable_get('@connection').read_timeout.should == timeout
+  end
+
   it 'should set up the proper http ssl connection when a proxy_host is given' do
     twilio = Twilio::REST::Client.new('someSid', 'someToken', :host => 'api.faketwilio.com', :proxy_addr => 'localhost')
     twilio.instance_variable_get('@connection').proxy?.should == true

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: twilio-ruby
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 23
   prerelease: 
   segments: 
   - 3
-  - 3
-  - 1
-  version: 3.3.1
+  - 4
+  - 0
+  version: 3.4.0
 platform: ruby
 authors: 
 - Andrew Benton
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-26 00:00:00 -07:00
+date: 2011-09-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -152,6 +152,7 @@ files:
 - lib/twilio-ruby.rb
 - lib/twilio-ruby/rest/accounts.rb
 - lib/twilio-ruby/rest/applications.rb
+- lib/twilio-ruby/rest/authorized_connect_apps.rb
 - lib/twilio-ruby/rest/available_phone_numbers.rb
 - lib/twilio-ruby/rest/available_phone_numbers/country.rb
 - lib/twilio-ruby/rest/available_phone_numbers/local.rb
@@ -160,6 +161,7 @@ files:
 - lib/twilio-ruby/rest/client.rb
 - lib/twilio-ruby/rest/conferences.rb
 - lib/twilio-ruby/rest/conferences/participants.rb
+- lib/twilio-ruby/rest/connect_apps.rb
 - lib/twilio-ruby/rest/errors.rb
 - lib/twilio-ruby/rest/incoming_phone_numbers.rb
 - lib/twilio-ruby/rest/instance_resource.rb