twilio-ruby 3.11.1 → 3.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4463ad95b5c4cdd215f8c1ba739c94356598855
-  data.tar.gz: f7b531fa9490928e9ee8631e660c74068be58366
+  metadata.gz: 06d9012436c3641dc254ae2f2a35f79438f6195f
+  data.tar.gz: 511697c9a9d9acfb74673705b51327fccc51399d
 SHA512:
-  metadata.gz: 414d7a39fe93d2159a6890f057aa54ea741d75e4d6ac5f9b167ea7c17c787ae0d5cd34b8cf029c497816dc8141d1af134c0487322a0fd0edd75e8d813ce8de5f
-  data.tar.gz: e914fd9c3a2c539c4360544338bb4f2808055f56c94dd4845ad0deed1a90ba5dcac850d6a7bcbeb221d864a677179f0f105b4b7637e3b555bb2df04a0545651b
+  metadata.gz: ac1f7697751c9f07664d61a56415189a9fecba1d363be816636f887a22428ed27831e3406f2d62203a0913dcff35e92d1fd08b9398741f71dd15c1c23faf0cd4
+  data.tar.gz: ff659fa106429147fe87947e09695090166e35593b820e6c65a64e7928a40ee6f4cc7be6a9c63ce89860c0ed48e8d7fa4c9f593f287e5c5d09036b6eea5d06c0

data/CHANGES

@@ -1,6 +1,19 @@
 twilio-ruby changelog
 =====================
 
+Version 3.11.3
+
+Released October 15, 2013
+
+- Restore ability of `sms.messages` to make requests to /SMS/Messages.
+
+Version 3.11.1
+--------------
+
+Released September 24, 2013
+
+- Fix a bug causing request the new messages class to fail.
+
 Version 3.11.0
 -------------
 

data/docs/index.rst

@@ -41,6 +41,7 @@ Query the Twilio REST API to create phone calls, send SMS/MMS messages and more!
     :maxdepth: 1
 
     usage/basics
+    usage/errors
     usage/messages
     usage/phone-calls
     usage/phone-numbers

data/docs/usage/accounts.rst

@@ -44,7 +44,7 @@ Subaccounts are easy to make.
     account_sid = "ACXXXXXXXXXXXXXXXXX"
     auth_token = "YYYYYYYYYYYYYYYYYY"
 
-    @client = Twilio::Rest::Client.new account_sid, auth_token
+    @client = Twilio::REST::Client.new account_sid, auth_token
     @subaccount = @client.accounts.create({:name => "My Awesome SubAccount"})
 
 
@@ -61,7 +61,7 @@ Say you have a subaccount for Client X with an account sid `AC123`
     account_sid = "ACXXXXXXXXXXXXXXXXX"
     auth_token = "YYYYYYYYYYYYYYYYYY"
 
-    @client = Twilio::Rest::Client.new account_sid, auth_token
+    @client = Twilio::REST::Client.new account_sid, auth_token
 
     # Client X's subaccount
     @subaccount = @client.accounts.get('AC123')

data/docs/usage/basics.rst

@@ -79,3 +79,24 @@ Provide the :attr:`sid` of the resource you'd like to get.
     @call = @client.account.calls.get("CA123")
     puts @call.to
 
+
+Deleting a Resource
+-------------------------------
+
+Resources can only be deleted via their instance object. This means
+you must instantiate an instance object using :meth:`ListResource.get`
+and then call :meth:`delete` on it.
+
+.. code-block:: ruby
+
+    require 'twilio-ruby'
+
+    # To find these visit https://www.twilio.com/user/account
+    account_sid = "ACXXXXXXXXXXXXXXXXX"
+    auth_token = "YYYYYYYYYYYYYYYYYY"
+
+    @client = Twilio::REST::Client.new account_sid, auth_token
+
+    @recording = @client.account.recordings.get("RC123")
+    @recording.delete()
+

data/docs/usage/errors.rst

@@ -0,0 +1,29 @@
+Error Handling
+==============
+
+Exceptions
+----------
+If the Twilio API returns a 400 or a 500 level HTTP response,
+the twilio-ruby library will throw a :class:`Twilio::REST::RequestError`.
+400-level errors are normal during API operation ("Invalid number",
+"Cannot deliver SMS to that number", for example) and should be
+handled appropriately.
+
+.. code-block:: ruby
+
+    require 'twilio-ruby'
+
+    # To find these visit https://www.twilio.com/user/account
+    account_sid = "ACXXXXXXXXXXXXXXXXX"
+    auth_token = "YYYYYYYYYYYYYYYYYY"
+
+    begin
+        @client = Twilio::REST::Client.new account_sid, auth_token
+        client.account.messages.create({
+            :from => '+1234567890',
+            :to => '+1234567890',
+            :body => 'Hello world'
+        })
+    rescue Twilio::REST::RequestError => e
+        puts e.message
+    end

data/examples/examples.rb

@@ -29,7 +29,9 @@ puts @account.friendly_name
 end
 
 # get a particular call and list its recording urls
-@account.calls.get('CAXXXXXXX').recordings.list.each do {|r| puts r.wav}
+@account.calls.get('CAXXXXXXX').recordings.list.each do |r|
+  puts r.wav
+end
 
 # make a new outgoing call. returns a call object just like calls.get
 @call = @account.calls.create({:from => '+14159341234', :to => '+18004567890', :url => 'http://example.com/call-handler'})
@@ -85,7 +87,9 @@ puts @account.messages.get('SMXXXXXXXX').body
 @participants = @account.conferences.get('CFbbe46ff1274e283f7e3ac1df0072ab39').participants
 
 # list participants
-@participants.list.each do {|p| puts p.sid}
+@participants.list.each do |p|
+  puts p.sid
+end
 
 # update a conference participant
 @participants.get('CA386025c9bf5d6052a1d1ea42b4d16662').update({:muted => 'true'})

data/lib/twilio-ruby.rb

@@ -21,6 +21,7 @@ require 'twilio-ruby/rest/accounts'
 require 'twilio-ruby/rest/calls'
 require 'twilio-ruby/rest/sms'
 require 'twilio-ruby/rest/sms/short_codes'
+require 'twilio-ruby/rest/sms/messages'
 require 'twilio-ruby/rest/sip'
 require 'twilio-ruby/rest/sip/domains'
 require 'twilio-ruby/rest/sip/domains/ip_access_control_list_mappings'

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

@@ -89,7 +89,8 @@ module Twilio
           resource = twilify r
           relative_path = custom_resource_names.fetch(r, resource)
           path = "#{@path}/#{relative_path}"
-          resource_class = Twilio::REST.const_get resource
+          enclosing_module = @submodule == nil ? (Twilio::REST) : (Twilio::REST.const_get(@submodule))
+          resource_class = enclosing_module.const_get resource
           instance_variable_set("@#{r}", resource_class.new(path, @client))
         end
         self.class.instance_eval {attr_reader *resources}

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

@@ -9,7 +9,13 @@ module Twilio
         @path, @client = path, client
         resource_name = self.class.name.split('::')[-1]
         instance_name = custom_names.fetch(resource_name, resource_name.chop)
-        @instance_class = Twilio::REST.const_get instance_name
+
+        # The next line grabs the enclosing module. Necessary for resources
+        # contained in their own submodule like /SMS/Messages
+        parent_module = self.class.to_s.split('::')[-2]
+        full_module_path = parent_module == "REST" ? (Twilio::REST) : (Twilio::REST.const_get parent_module)
+
+        @instance_class = full_module_path.const_get instance_name
         @list_key, @instance_id_key = detwilify(resource_name), 'sid'
       end
 

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

@@ -3,6 +3,7 @@ module Twilio
     class Sms < InstanceResource
       def initialize(path, client, params={})
         super
+        @submodule = :SMS
         resource :messages, :short_codes
       end
     end

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

@@ -0,0 +1,15 @@
+module Twilio
+  module REST
+    module SMS
+      class Messages < ListResource
+        def initialize(path, client)
+          super
+          @list_key = 'sms_messages'
+        end
+      end
+
+      class Message < InstanceResource
+      end
+    end
+  end
+end

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

@@ -1,6 +1,8 @@
 module Twilio
   module REST
-    class ShortCodes < ListResource; end
-    class ShortCode < InstanceResource; end
+    module SMS
+      class ShortCodes < ListResource; end
+      class ShortCode < InstanceResource; end
+    end
   end
 end

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-  VERSION = '3.11.1'
+  VERSION = '3.11.3'
 end

data/pull.txt

@@ -0,0 +1,21 @@
+This pull moves the /SMS endpoints into their own `SMS` module. This allows both of the `Message` classes to coexist, since one is in its own namespace, so I was able to bring back the class living at `sms.messages`. This means `@client.account.sms.messages` will once again make requests to the `/SMS/Messages` endpoint. This change re-enables Test Credentials for the `sms.messages` class.
+
+This required a change to both `instance_resource.rb` and `list_resource.rb` because both were relying on the assumption that all classes live in the Twilio::REST module.
+
+To use the new submodule functionality, just set the `@submodule` variable to the name of the new submodule on the class declaring the subresources. Here is how it was done for `/SMS/Messages`.
+
+```ruby
+module Twilio
+  module REST
+    class Sms < InstanceResource
+      def initialize(path, client, params={})
+        super
+        @submodule = :SMS
+        resource :messages, :short_codes
+      end
+    end
+  end
+end
+```
+
+@labcoder @carlosdp @alexcchan

data/spec/rest/message_spec.rb

@@ -9,9 +9,4 @@ describe Twilio::REST::Message do
     @message.should respond_to(:media)
     @message.media.instance_variable_get('@path').should == 'someUri/Media'
   end
-
-  it 'does not use the old endpoint' do
-    client = Twilio::REST::Client.new('someId', 'sometoken')
-    client.account.sms.messages.instance_variable_get('@path').include?('/SMS').should be_false
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twilio-ruby
 version: !ruby/object:Gem::Version
-  version: 3.11.1
+  version: 3.11.3
 platform: ruby
 authors:
 - Andrew Benton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -151,6 +151,7 @@ files:
 - docs/usage/basics.rst
 - docs/usage/caller-ids.rst
 - docs/usage/conferences.rst
+- docs/usage/errors.rst
 - docs/usage/messages.rst
 - docs/usage/notifications.rst
 - docs/usage/phone-calls.rst
@@ -198,6 +199,7 @@ files:
 - lib/twilio-ruby/rest/sip/ip_access_control_lists.rb
 - lib/twilio-ruby/rest/sip/ip_access_control_lists/ip_addresses.rb
 - lib/twilio-ruby/rest/sms.rb
+- lib/twilio-ruby/rest/sms/messages.rb
 - lib/twilio-ruby/rest/sms/short_codes.rb
 - lib/twilio-ruby/rest/transcriptions.rb
 - lib/twilio-ruby/rest/usage.rb
@@ -209,6 +211,7 @@ files:
 - lib/twilio-ruby/util/capability.rb
 - lib/twilio-ruby/util/request_validator.rb
 - lib/twilio-ruby/version.rb
+- pull.txt
 - spec/rest/account_spec.rb
 - spec/rest/call_spec.rb
 - spec/rest/client_spec.rb