twilio-rb 2.0.1 → 2.1.0

data/README.md

@@ -10,7 +10,7 @@ It offers an ActiveRecord style API, i.e. one that most Ruby developers are fami
 
 The library has been packaged as a gem and is available from rubygems.org. The version that this readme pertains to is 2.0.0.
 
-<pre>gem install twilio-rb --pre</pre>
+<pre>gem install twilio-rb</pre>
 
 Please use the Github issue tracker to report any issues or bugs you uncover.
 
@@ -32,7 +32,7 @@ Configuration for this library is achieved with `Twilio::Config.setup`. One need
 Twilio::Config.setup \
   :account_sid  => 'AC0000000000000000000000000000',
   :auth_token   => '000000000000000000000000000000'
-end</pre>
+</pre>
 
 Any method that calls the Twilio API will raise `Twilio::ConfigurationError` if either Account SID or Auth Token are not configured.
 
@@ -221,6 +221,15 @@ Twilio::CapabilityToken.create \
   expires:        10.minutes.from_now
 </pre>
 
+# Twilio Connect
+
+With Twilio Connect you can attribute Twilio usage to accounts of customers that have authorised you to perform API calls on there behalf. twilio-rb supports Twilio Connect. To make an API call using a Twilio Connect account, two extra parameters are required, `account_sid` and `connect`
+
+<pre>
+Twilio::SMS.create to: '+12125551234', from: '+6165550000', body: 'this will not be billed to the application developer',
+  account_sid: CONNECT_ACCOUNT_SID, connect: true
+</pre>
+
 # Associations
 
 Certain resources themselves have subresources, e.g. a call can have many recordings. It would be very convenient to access these via an association proxy, so instead of:
@@ -252,7 +261,7 @@ You can create new subaccounts by using `Twilio::Account.create`
 There are three ways to perform an operation on an account other than the master account: you can pass in the subaccount sid
 
 <pre>Twilio::SMS.create :to => '+19175551234' :from => '+16465550000',
-  :body => 'This will be billed to a subaccount, sucka!' :account => 'ACXXXXXXXXXXXXXXXXXXXXXXXX'</pre>
+  :body => 'This will be billed to a subaccount, sucka!' :account_sid => 'ACXXXXXXXXXXXXXXXXXXXXXXXX'</pre>
 
 You can also pass in an object that responds to sid, i.e. an instance of Twilio::Account
 
@@ -313,7 +322,7 @@ So now your Rails app can respond_to :voice. Insane!
 
 <pre>
 class FooController &lt; ApplicationController
-  responds_to :html, :voice
+  respond_to :html, :voice
 
   def index
    ...
@@ -355,8 +364,6 @@ To access properties of a singleton object the property name should be called as
 
 The first time a method is invoked on the object an API call is made to retrieve the data. The methods themselves are not defined until they are called, i.e. lazy evaluation. This strategy means that addtional properties added to subsequent versions of the API should not break the library.
 
-To reload the data when needed `Twilio::Account.reload!` will make another API call and update its own internal state.
-
 Please refer to the Twilio REST API documentation for an up to date list of properties that the sandbox resource implements
 
 # Searching for and purchasing available phone numbers
@@ -385,3 +392,4 @@ A recording resource instance has an extra instance method: `#mp3` this returns
 * TJ Singleton
 * Christopher Durtschi
 * Dan Imrie-Situnayake
+* John Trupiano

data/lib/twilio/association_proxy.rb

@@ -2,7 +2,7 @@ require 'active_support/core_ext/string'
 
 module Twilio
   class AssociationProxy
-    instance_methods.each { |meth| undef_method meth unless meth.to_s =~ /^__/ }
+    instance_methods.each { |meth| undef_method meth unless meth.to_s =~ /^__/ || meth.to_s == 'object_id' }
     def initialize(delegator, target)
       @delegator, @target = delegator, target
       @delegator_name = @delegator.class.name.demodulize.downcase
@@ -15,6 +15,9 @@ module Twilio
     def method_missing(meth, *args, &blk)
       options = args.empty? ? args.<<({})[-1] : args[-1]
       options.update :"#{@delegator_name}_sid" => @delegator.sid
+      if @delegator[:connect_app_sid]
+        options.update :connect => true, :account_sid => (@delegator[:account_sid] || @delegator[:sid])
+      end
       @target.__send__ meth, *args, &blk
     end
   end

data/lib/twilio/authorized_connect_app.rb

@@ -0,0 +1,6 @@
+module Twilio
+  class AuthorizedConnectApp
+    include Twilio::Resource
+    extend  Twilio::Finder
+  end
+end

data/lib/twilio/call.rb

@@ -5,7 +5,7 @@ module Twilio
     extend  Twilio::Finder
     extend  Twilio::Associations
 
-    has_many :recordings
+    has_many :recordings, :notifications
 
     mutable_attributes :url, :method, :status
 

data/lib/twilio/conference.rb

@@ -4,7 +4,8 @@ module Twilio
     extend Twilio::Finder
 
     def participants
-      res = self.class.get "/Accounts/#{Twilio::ACCOUNT_SID}/Conferences/#{sid}/Participants.json"
+      account_sid = self[:account_sid] if self[:connect_app_sid]
+      res = self.class.get "/Accounts/#{self[:account_sid]}/Conferences/#{sid}/Participants.json", :account_sid => account_sid
       if (400..599).include? res.code
         raise Twilio::APIError.new "Error ##{res.parsed_response['code']}: #{res.parsed_response['message']}"
       else
@@ -15,4 +16,4 @@ module Twilio
       end
     end
   end
-end
+end

data/lib/twilio/connect_app.rb

@@ -0,0 +1,8 @@
+module Twilio
+  class ConnectApp
+    include Twilio::Resource
+    extend  Twilio::Finder
+
+    mutable_attributes :friendly_name, :authorize_redirect_url, :deauthorize_callback_url, :deauthorize_callback_method, :permissions, :description, :company_name, :homepage_url
+  end
+end

data/lib/twilio/deletable.rb

@@ -1,7 +1,8 @@
 module Twilio
   module Deletable
     def destroy
-      state_guard { freeze && true if self.class.delete path }
+      account_sid = self[:account_sid] if self[:connect_app_sid]
+      state_guard { freeze && true if self.class.delete path, :account_sid => account_sid }
     end
   end
 end

data/lib/twilio/finder.rb

@@ -4,7 +4,9 @@ module Twilio
       opts        = opts.with_indifferent_access
       # Support subaccounts by optionally passing in an account_sid or account object
       account_sid = opts.delete('account_sid') || opts.delete('account').try(:sid) || Twilio::ACCOUNT_SID
-      res  = get "#{resource_path(account_sid)}/#{id}.json"
+      connect     = opts.delete 'connect'
+
+      res  = get "#{resource_path(account_sid)}/#{id}.json", :account_sid => (connect && account_sid)
       hash = res.parsed_response
       if (200..299).include? res.code
         hash['api_version'] = hash['api_version'].to_s # api_version parsed as a date by http_party
@@ -16,16 +18,20 @@ module Twilio
       opts        = opts.with_indifferent_access
       # Support subaccounts by optionally passing in an account_sid or account object
       account_sid = opts.delete('account_sid') || opts.delete('account').try(:sid) || Twilio::ACCOUNT_SID
+      connect     = opts.delete 'connect'
+
       params      = prepare_params opts if opts.any?
-      get("#{resource_path(account_sid)}.json#{params}").parsed_response['total']
+      get("#{resource_path(account_sid)}.json#{params}", :account_sid => (connect && account_sid)).parsed_response['total']
     end
 
     def all(opts={})
       opts        = opts.with_indifferent_access
       # Support subaccounts by optionally passing in an account_sid or account object
       account_sid = opts.delete('account_sid') || opts.delete('account').try(:sid) || Twilio::ACCOUNT_SID
+      connect     = opts.delete 'connect'
+
       params      = prepare_params opts if opts.any?
-      handle_response get "#{resource_path(account_sid)}.json#{params}"
+      handle_response get "#{resource_path(account_sid)}.json#{params}", :account_sid => (connect && account_sid)
     end
 
     private

data/lib/twilio/participant.rb

@@ -20,7 +20,7 @@ module Twilio
     private
 
     def path
-      "/Accounts/#{Twilio::ACCOUNT_SID}/Conferences/#{conference_sid}/Participants/#{call_sid}.json"
+      "/Accounts/#{account_sid}/Conferences/#{conference_sid}/Participants/#{call_sid}.json"
     end
   end
 end

data/lib/twilio/persistable.rb

@@ -4,11 +4,15 @@ module Twilio
     def self.included(base)
       base.instance_eval do
         def create(attrs={})
-          attrs       = attrs.with_indifferent_access
+          attrs        = attrs.with_indifferent_access
           # Support subaccounts by optionally passing in an account_sid or account object
-          account_sid = attrs.delete('account_sid') || attrs.delete('account').try(:sid) || Twilio::ACCOUNT_SID
+          account_sid  = attrs.delete('account_sid') || attrs.delete('account').try(:sid) || Twilio::ACCOUNT_SID
+          connect      = attrs.delete 'connect'
+          request_opts = { :body => Hash[attrs.map { |k,v| [k.to_s.camelize, v]}] }
 
-          res = post "#{resource_path(account_sid)}.json", :body => Hash[attrs.map { |k,v| [k.to_s.camelize, v]}]
+          request_opts.update(:account_sid => account_sid) if connect
+
+          res = post "#{resource_path(account_sid)}.json", request_opts
 
           if (400..599).include? res.code
             raise Twilio::APIError.new "Error ##{res.parsed_response['code']}: #{res.parsed_response['message']}"

data/lib/twilio/resource.rb

@@ -1,10 +1,12 @@
 require 'active_support/core_ext/string' # Chill! we only use the bits of AS we need!
 require 'active_support/core_ext/hash'
+require 'active_support/core_ext/array/extract_options'
+
 
 module Twilio
   module Resource
-    def initialize(attrs ={})  #:nodoc:
-      @attributes = attrs.with_indifferent_access
+    def initialize(attrs={})  #:nodoc:
+      @attributes  = attrs.with_indifferent_access
     end
 
     def inspect
@@ -21,20 +23,22 @@ module Twilio
 
     def update_attributes(attrs={})
       state_guard do
-        handle_response klass.post path, :body => Hash[attrs.map { |k,v| [k.to_s.camelize, v]}]
+        # state account sid if this is a resource created with a connect subaccount
+        account_sid = self[:account_sid] if self[:connect_app_sid]
+        handle_response klass.post path, :body => Hash[attrs.map { |k,v| [k.to_s.camelize, v]}], :account_sid => account_sid
       end
     end
 
     private
-    def resource_name
+    def resource_name #:nodoc:
       klass.name.demodulize.pluralize
     end
 
-    def klass
+    def klass #:nodoc:
       self.class == Module ? self : self.class
     end
 
-    def state_guard
+    def state_guard #:nodoc:
       if frozen?
         raise RuntimeError, "#{self.class.name.demodulize} has already been destroyed"
       else
@@ -42,7 +46,7 @@ module Twilio
       end
     end
 
-    def path
+    def path #:nodoc:
       uri[11,uri.length]
     end
 
@@ -55,7 +59,7 @@ module Twilio
       end
     end
 
-    def method_missing(id, *args, &blk) #:nodoc
+    def method_missing(id, *args, &blk) #:nodoc:
       meth = id.to_s
       if meth =~ /\=$/
         add_attr_writer meth
@@ -71,25 +75,25 @@ module Twilio
       end
     end
 
-    def add_predicate(attribute)
+    def add_predicate(attribute) # :nodoc:
       metaclass.class_eval do
         define_method(attribute) { self['status'] =~ /^#{attribute.gsub '?', ''}/i ? true : false }
       end
     end
 
-    def add_attr_writer(attribute) #:nodoc
+    def add_attr_writer(attribute) # :nodoc:
       metaclass.class_eval do
-        define_method(attribute) { |value| self[attribute.to_s.gsub(/\=$/, '').to_sym] = value } unless respond_to? attribute
+        define_method(attribute) { |value| self[attribute.to_s.gsub(/\=$/, '').to_sym] = value }
       end
     end
 
-    def add_attr_reader(attribute) #:nodoc
+    def add_attr_reader(attribute) #:nodoc:
       metaclass.class_eval do
-        define_method(attribute) { self[attribute] }  unless respond_to? attribute
+        define_method(attribute) { self[attribute] }
       end
     end
 
-    def metaclass #:nodoc
+    def metaclass #:nodoc:
       class << self; self; end
     end
 
@@ -105,8 +109,10 @@ module Twilio
         # decorate http methods with authentication
         %w<post get put delete>.each do |meth|
           define_method(meth) do |*args| # splatted args necessary hack since <= 1.8.7 does not support optional block args
-            opts = args[1] || {}
-            super args.first, opts.merge(:basic_auth => { :username => Twilio::ACCOUNT_SID, :password => Twilio::AUTH_TOKEN })
+            opts        = args.extract_options!
+            account_sid = opts.delete :account_sid
+            # if account sid is passed in as an option use it for basic auth (twilio connect)
+            super args.first, opts.merge(:basic_auth => { :username => account_sid || Twilio::ACCOUNT_SID, :password => Twilio::AUTH_TOKEN })
           end
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twilio-rb
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-22 00:00:00.000000000Z
+date: 2011-11-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70316353672100 !ruby/object:Gem::Requirement
+  requirement: &70313885127680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70316353672100
+  version_requirements: *70313885127680
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70316353671640 !ruby/object:Gem::Requirement
+  requirement: &70313885159460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,21 +32,21 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70316353671640
+  version_requirements: *70313885159460
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70316353671180 !ruby/object:Gem::Requirement
+  requirement: &70313885159000 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.7
+        version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *70316353671180
+  version_requirements: *70313885159000
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70316353670720 !ruby/object:Gem::Requirement
+  requirement: &70313885158540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *70316353670720
+  version_requirements: *70313885158540
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70316353670260 !ruby/object:Gem::Requirement
+  requirement: &70313885158080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70316353670260
+  version_requirements: *70313885158080
 - !ruby/object:Gem::Dependency
   name: jwt
-  requirement: &70316353669780 !ruby/object:Gem::Requirement
+  requirement: &70313885157620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *70316353669780
+  version_requirements: *70313885157620
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70316353669320 !ruby/object:Gem::Requirement
+  requirement: &70313885157160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 1.6.1
   type: :development
   prerelease: false
-  version_requirements: *70316353669320
+  version_requirements: *70313885157160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70316353668860 !ruby/object:Gem::Requirement
+  requirement: &70313885156700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *70316353668860
+  version_requirements: *70313885156700
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70316353668400 !ruby/object:Gem::Requirement
+  requirement: &70313885156240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: 0.9.10
   type: :development
   prerelease: false
-  version_requirements: *70316353668400
+  version_requirements: *70313885156240
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70316353667940 !ruby/object:Gem::Requirement
+  requirement: &70313885155780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: 0.3.5
   type: :development
   prerelease: false
-  version_requirements: *70316353667940
+  version_requirements: *70313885155780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70316353667480 !ruby/object:Gem::Requirement
+  requirement: &70313885155320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,7 +131,7 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *70316353667480
+  version_requirements: *70313885155320
 description: A nice Ruby wrapper for the Twilio REST API
 email: sjtgraham@mac.com
 executables: []
@@ -144,11 +144,13 @@ files:
 - lib/twilio/application.rb
 - lib/twilio/association_proxy.rb
 - lib/twilio/associations.rb
+- lib/twilio/authorized_connect_app.rb
 - lib/twilio/available_phone_number.rb
 - lib/twilio/call.rb
 - lib/twilio/capability.rb
 - lib/twilio/conference.rb
 - lib/twilio/config.rb
+- lib/twilio/connect_app.rb
 - lib/twilio/deletable.rb
 - lib/twilio/finder.rb
 - lib/twilio/incoming_phone_number.rb