twilio-ruby 3.11.5 → 4.0.0

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

@@ -1,3 +1,4 @@
+require 'twilio-ruby/rest/base_client'
 module Twilio
   module REST
     ##
@@ -28,6 +29,12 @@ module Twilio
     #
     #   @client.account.calls
     #
+    # For convenience, the resources of the default account are also available
+    # on the client object. So the following call is equivalent to the example
+    # above
+    #
+    #   @client.calls
+    #
     # represents an account's call list.
     #
     # ==== @client.accounts
@@ -41,75 +48,51 @@ module Twilio
     # methods like ListResource#list to return a (possibly filtered) list of
     # accounts and ListResource#create to create a new account. Use
     # ListResource#get to grab a particular account once you know its sid.
-    class Client
-      include Twilio::Util
-      include Twilio::REST::Utils
-
+    class Client < BaseClient
       API_VERSION = '2010-04-01'
 
-      # 1.8.7 doesn't have the RUBY_ENGINE constant.
-      engine = !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby'
-
-      HTTP_HEADERS = {
-        'Accept' => 'application/json',
-        'Accept-Charset' => 'utf-8',
-        'User-Agent' => "twilio-ruby/#{Twilio::VERSION} (#{engine}/#{RUBY_PLATFORM} #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})",
-      }
+      attr_reader :account, :accounts
 
-      DEFAULTS = {
-        :host => 'api.twilio.com',
-        :port => 443,
-        :use_ssl => true,
-        :ssl_verify_peer => true,
-        :ssl_ca_file => File.dirname(__FILE__) + '/../../../conf/cacert.pem',
-        :timeout => 30,
-        :proxy_addr => nil,
-        :proxy_port => nil,
-        :proxy_user => nil,
-        :proxy_pass => nil,
-        :retry_limit => 1,
-      }
-
-      attr_reader :account_sid, :account, :accounts, :last_request,
-        :last_response
+      host 'api.twilio.com'
 
       ##
       # Instantiate a new HTTP client to talk to Twilio. The parameters
-      # +account_sid+ and +auth_token+ are required and used to generate the
+      # +account_sid+ and +auth_token+ are required, unless you have configured
+      # them already using the block configure syntax, and used to generate the
       # HTTP basic auth header in each request. The +options+ parameter is a
       # hash of connection configuration options. the following keys are
       # supported:
       #
-      # === <tt>:host => 'api.twilio.com'</tt>
+      # === <tt>host: 'api.twilio.com'</tt>
       #
       # The domain to which you'd like the client to make HTTP requests. Useful
       # for testing. Defaults to 'api.twilio.com'.
       #
-      # === <tt>:port => 443</tt>
+      # === <tt>port: 443</tt>
       #
       # The port on which to connect to the above domain. Defaults to 443 and
       # should be left that way except in testing environments.
       #
-      # === <tt>:use_ssl => true</tt>
+      # === <tt>use_ssl: true</tt>
       #
       # Declare whether ssl should be used for connections to the above domain.
       # Defaults to true and should be left alone except when testing.
       #
-      # === <tt>:ssl_verify_peer => true</tt>
+      # === <tt>ssl_verify_peer: true</tt>
       #
       # Declare whether to verify the host's ssl cert when setting up the
       # connection to the above domain. Defaults to true, but can be turned off
       # to avoid ssl certificate verification failures in environments without
       # the necessary ca certificates.
       #
-      # === <tt>:ssl_ca_file => '/path/to/ca/file'</tt>
+      # === <tt>ssl_ca_file: '/path/to/ca/file'</tt>
       #
       # Specify the path to the certificate authority bundle you'd like to use
       # to verify Twilio's SSL certificate on each request. If not specified, a
       # certificate bundle extraced from Firefox is packaged with the gem and
       # used by default.
       #
-      # === <tt>:timeout => 30</tt>
+      # === <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
@@ -117,32 +100,29 @@ module Twilio
       # 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>
+      # === <tt>proxy_addr: 'proxy.host.domain'</tt>
       #
       # The domain of a proxy through which you'd like the client to make HTTP
       # requests. Defaults to nil.
       #
-      # === <tt>:proxy_port => 3128</tt>
+      # === <tt>proxy_port: 3128</tt>
       #
       # The port on which to connect to the above proxy. Defaults to nil.
       #
-      # === <tt>:proxy_user => 'username'</tt>
+      # === <tt>proxy_user: 'username'</tt>
       #
       # The user name to use for authentication with the proxy. Defaults to nil.
       #
-      # === <tt>:proxy_pass => 'password'</tt>
+      # === <tt>proxy_pass: 'password'</tt>
       #
       # The password to use for authentication with the proxy. Defaults to nil.
       #
-      # === <tt>:retry_limit => 1</tt>
+      # === <tt>retry_limit: 1</tt>
       #
       # The number of times to retry a request that has failed before throwing
       # an exception. Defaults to one.
-      def initialize(account_sid, auth_token, options={})
-        @account_sid, @auth_token = account_sid.strip, auth_token.strip
-        @config = DEFAULTS.merge! options
-        set_up_connection
-        set_up_subresources
+      def initialize(*args)
+        super(*args)
       end
 
       def inspect # :nodoc:
@@ -150,52 +130,27 @@ module Twilio
       end
 
       ##
-      # Define #get, #put, #post and #delete helper methods for sending HTTP
-      # requests to Twilio. You shouldn't need to use these methods directly,
-      # but they can be useful for debugging. Each method returns a hash
-      # obtained from parsing the JSON object in the response body.
-      [:get, :put, :post, :delete].each do |method|
-        method_class = Net::HTTP.const_get method.to_s.capitalize
-        define_method method do |path, *args|
-          params = twilify args[0]; params = {} if params.empty?
-          unless args[1] # build the full path unless already given
-            path = "#{path}.json"
-            path << "?#{url_encode(params)}" if method == :get && !params.empty?
-          end
-          request = method_class.new path, HTTP_HEADERS
-          request.basic_auth @account_sid, @auth_token
-          request.form_data = params if [:post, :put].include? method
-          connect_and_send request
+      # Delegate account methods from the client. This saves having to call
+      # <tt>client.account</tt> every time for resources on the default
+      # account.
+      def method_missing(method_name, *args, &block)
+        if account.respond_to?(method_name)
+          account.send(method_name, *args, &block)
+        else
+          super
         end
       end
 
-      private
-
-      ##
-      # Set up and cache a Net::HTTP object to use when making requests. This is
-      # a private method documented for completeness.
-      def set_up_connection # :doc:
-        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]
-        set_up_ssl
-        @connection.open_timeout = @config[:timeout]
-        @connection.read_timeout = @config[:timeout]
-      end
- 
-      ##
-      # Set up the ssl properties of the <tt>@connection</tt> Net::HTTP object.
-      # This is a private method documented for completeness.
-      def set_up_ssl # :doc:
-        @connection.use_ssl = @config[:use_ssl]
-        if @config[:ssl_verify_peer]
-          @connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          @connection.ca_file = @config[:ssl_ca_file]
+      def respond_to?(method_name, include_private=false)
+        if account.respond_to?(method_name, include_private)
+          true
         else
-          @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          super
         end
       end
 
+      protected
+
       ##
       # Set up +account+ and +accounts+ attributes.
       def set_up_subresources # :doc:
@@ -204,31 +159,11 @@ module Twilio
       end
 
       ##
-      # Send an HTTP request using the cached <tt>@connection</tt> object and
-      # return the JSON response body parsed into a hash. Also save the raw
-      # Net::HTTP::Request and Net::HTTP::Response objects as
-      # <tt>@last_request</tt> and <tt>@last_response</tt> to allow for
-      # inspection later.
-      def connect_and_send(request) # :doc:
-        @last_request = request
-        retries_left = @config[:retry_limit]
-        begin
-          response = @connection.request request
-          @last_response = response
-          if response.kind_of? Net::HTTPServerError
-            raise Twilio::REST::ServerError
-          end
-        rescue Exception
-          raise if request.class == Net::HTTP::Post
-          if retries_left > 0 then retries_left -= 1; retry else raise end
-        end
-        if response.body and !response.body.empty?
-          object = MultiJson.load response.body
-        end
-        if response.kind_of? Net::HTTPClientError
-          raise Twilio::REST::RequestError.new object['message'], object['code']
-        end
-        object
+      # Builds up full request path
+      def build_full_path(path, params, method)
+        path = "#{path}.json"
+        path << "?#{url_encode(params)}" if method == :get && !params.empty?
+        path
       end
     end
   end

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

@@ -10,11 +10,11 @@ module Twilio
 
     class Participant < InstanceResource
       def mute
-        update :muted => 'true'
+        update muted: 'true'
       end
 
       def unmute
-        update :muted => 'false'
+        update muted: 'false'
       end
 
       alias :kick :delete

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

@@ -8,7 +8,7 @@ module Twilio
       end
 
       def buy(phone_number)
-        create :phone_number => phone_number
+        create phone_number: phone_number
       end
     end
 

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

@@ -32,7 +32,7 @@ module Twilio
       # to handle the update. For example, to update the +VoiceUrl+ of a Twilio
       # Application you could write:
       #
-      #   @app.update :voice_url => 'http://my.other.app.com/handle_voice'
+      #   @app.update voice_url: 'http://my.other.app.com/handle_voice'
       #
       # After returning, the object will contain the most recent state of the
       # instance resource, including the newly updated properties.
@@ -77,25 +77,11 @@ module Twilio
         hash.each do |p,v|
           property = detwilify p
           unless ['client', 'updated'].include? property
-            eigenclass.send :define_method, property.to_sym, &lambda {v}
+            eigenclass.send :define_method, property.to_sym, &lambda { v }
           end
         end
         @updated = !hash.keys.empty?
       end
-
-      def resource(*resources)
-        custom_resource_names = {:sms => 'SMS', :sip => 'SIP'}
-        resources.each do |r|
-          resource = twilify r
-          relative_path = custom_resource_names.fetch(r, resource)
-          path = "#{@path}/#{relative_path}"
-          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}
-      end
-
     end
   end
 end

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

@@ -3,9 +3,14 @@ module Twilio
     class ListResource
       include Utils
 
-
       def initialize(path, client)
-        custom_names = {"Media" => "MediaInstance", "IpAddresses" => "IpAddress"}
+        custom_names = {
+          'Activities' => 'Activity',
+          'Media' => 'MediaInstance',
+          'IpAddresses' => 'IpAddress',
+          'Feedback' => 'FeedbackInstance',
+          'Addresses' => 'Address'
+        }
         @path, @client = path, client
         resource_name = self.class.name.split('::')[-1]
         instance_name = custom_names.fetch(resource_name, resource_name.chop)
@@ -13,7 +18,11 @@ module Twilio
         # 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)
+        full_module_path = if parent_module == "REST"
+          Twilio::REST
+        else
+          Twilio::REST.const_get parent_module
+        end
 
         @instance_class = full_module_path.const_get instance_name
         @list_key, @instance_id_key = detwilify(resource_name), 'sid'
@@ -42,11 +51,17 @@ module Twilio
           @instance_class.new "#{path}/#{resource[@instance_id_key]}", @client,
             resource
         end
-        # set the +total+ and +next_page+ properties on the array
+        # set the +previous_page+ and +next_page+ properties on the array
         client, list_class = @client, self.class
         resource_list.instance_eval do
           eigenclass = class << self; self; end
-          eigenclass.send :define_method, :total, &lambda {response['total']}
+          eigenclass.send :define_method, :previous_page, &lambda {
+            if response['previous_page_uri']
+              list_class.new(response['previous_page_uri'], client).list({}, true)
+            else
+              []
+            end
+          }
           eigenclass.send :define_method, :next_page, &lambda {
             if response['next_page_uri']
               list_class.new(response['next_page_uri'], client).list({}, true)
@@ -58,18 +73,6 @@ module Twilio
         resource_list
       end
 
-      ##
-      # Ask Twilio for the total number of items in the list.
-      # Calling this method makes an HTTP GET request to <tt>@path</tt> with a
-      # page size parameter of 1 to minimize data over the wire while still
-      # obtaining the total. Don't use this if you are planning to
-      # call #list anyway, since the array returned from #list will have a
-      # +total+ attribute as well.
-      def total
-        raise "Can't get a resource total without a REST Client" unless @client
-        @client.get(@path, :page_size => 1)['total']
-      end
-
       ##
       # Return an empty instance resource object with the proper path. Note that
       # this will never raise a Twilio::REST::RequestError on 404 since no HTTP
@@ -92,19 +95,6 @@ module Twilio
         @instance_class.new "#{@path}/#{response[@instance_id_key]}", @client,
           response
       end
-
-      def resource(*resources)
-        custom_resource_names = {:sms => 'SMS', :sip => 'SIP'}
-        resources.each do |r|
-          resource = twilify r
-          relative_path = custom_resource_names.fetch(r, resource)
-          path = "#{@path}/#{relative_path}"
-          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}
-      end
     end
   end
 end

data/lib/twilio-ruby/rest/lookups/phone_numbers.rb

@@ -0,0 +1,17 @@
+module Twilio
+  module REST
+    module Lookups
+      class PhoneNumbers < Twilio::REST::NextGenListResource;
+        include Twilio::Util
+        include Twilio::REST::Utils
+
+        def get(number, query={})
+          full_path = "#{@path}/#{number}"
+          full_path << "?#{url_encode(twilify(query))}" if !query.empty?
+          @instance_class.new full_path, @client
+        end
+      end
+      class PhoneNumber < InstanceResource; end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+require 'twilio-ruby/rest/base_client'
+module Twilio
+  module REST
+    class LookupsClient < BaseClient
+      API_VERSION = 'v1'
+
+      attr_reader :phone_numbers
+
+      host 'lookups.twilio.com'
+
+      ##
+      # Instantiate a new HTTP Lookups client to talk to Twilio. The parameters
+      # +account_sid+, +auth_token+ and +workspace_sid are required, unless you
+      # have configured them already using the block configure syntax, and used
+      # to generate the HTTP basic auth header in each request. The +options+
+      # parameter is a hash of connection configuration options. the following
+      # keys are supported:
+      #
+      # === <tt>host: 'lookups.twilio.com'</tt>
+      #
+      # The domain to which you'd like the client to make HTTP requests. Useful
+      # for testing. Defaults to 'lookups.twilio.com'.
+      #
+      # === <tt>port: 443</tt>
+      #
+      # The port on which to connect to the above domain. Defaults to 443 and
+      # should be left that way except in testing environments.
+      #
+      # === <tt>use_ssl: true</tt>
+      #
+      # Declare whether ssl should be used for connections to the above domain.
+      # Defaults to true and should be left alone except when testing.
+      #
+      # === <tt>ssl_verify_peer: true</tt>
+      #
+      # Declare whether to verify the host's ssl cert when setting up the
+      # connection to the above domain. Defaults to true, but can be turned off
+      # to avoid ssl certificate verification failures in environments without
+      # the necessary ca certificates.
+      #
+      # === <tt>ssl_ca_file: '/path/to/ca/file'</tt>
+      #
+      # Specify the path to the certificate authority bundle you'd like to use
+      # to verify Twilio's SSL certificate on each request. If not specified, a
+      # certificate bundle extraced from Firefox is packaged with the gem and
+      # used by default.
+      #
+      # === <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
+      # requests. Defaults to nil.
+      #
+      # === <tt>proxy_port: 3128</tt>
+      #
+      # The port on which to connect to the above proxy. Defaults to nil.
+      #
+      # === <tt>proxy_user: 'username'</tt>
+      #
+      # The user name to use for authentication with the proxy. Defaults to nil.
+      #
+      # === <tt>proxy_pass: 'password'</tt>
+      #
+      # The password to use for authentication with the proxy. Defaults to nil.
+      #
+      # === <tt>retry_limit: 1</tt>
+      #
+      # The number of times to retry a request that has failed before throwing
+      # an exception. Defaults to one.
+      def inspect # :nodoc:
+        "<Twilio::REST::LookupsClient @account_sid=#{@account_sid}>"
+      end
+
+      protected
+
+      ##
+      # Set up +phone_numbers+ attribute.
+      def set_up_subresources # :doc:
+        @phone_numbers = Twilio::REST::Lookups::PhoneNumbers.new "/#{API_VERSION}/PhoneNumbers", self
+      end
+
+      ##
+      # Builds up full request path
+      def build_full_path(path, params, method)
+        path = path.dup
+        path << "?#{url_encode(params)}" if method == :get && !params.empty?
+        path
+      end
+
+    end
+  end
+end

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

@@ -12,6 +12,11 @@ module Twilio
         super
         resource :media
       end
+
+      def redact()
+        update({body: ''})
+      end
+
     end
   end
 end

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

@@ -0,0 +1,36 @@
+module Twilio
+  module REST
+    class NextGenListResource < Twilio::REST::ListResource
+      def list(params={}, full_path=false)
+        raise "Can't get a resource list without a REST Client" unless @client
+        response = @client.get @path, params, full_path
+        list_key = response['meta']['key']
+        raise "Couldn't find a list key in response meta" unless list_key
+        resources = response[list_key]
+        resource_list = resources.map do |resource|
+          @instance_class.new "#{@path}/#{resource[@instance_id_key]}", @client,
+                              resource
+        end
+        client, list_class = @client, self.class
+        resource_list.instance_eval do
+          eigenclass = class << self; self; end
+          eigenclass.send :define_method, :next_page, &lambda {
+            if response['meta']['next_page_url']
+              list_class.new(response['meta']['next_page_url'], client).list({})
+            else
+              []
+            end
+          }
+          eigenclass.send :define_method, :previous_page, &lambda {
+            if response['meta']['previous_page_url']
+              list_class.new(response['meta']['previous_page_url'], client).list({})
+            else
+              []
+            end
+          }
+        end
+        resource_list
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ module Twilio
   module REST
     class OutgoingCallerIds < ListResource
       def add(phone_number)
-        create :phone_number => phone_number
+        create phone_number: phone_number
       end
       alias :verify :add
 

data/lib/twilio-ruby/rest/queues/members.rb

@@ -22,7 +22,7 @@ module Twilio
 
     class Member < InstanceResource
       def dequeue(url, method='POST')
-        update :url => url, :method => method
+        update url: url, method: method
       end
     end
   end

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

@@ -3,9 +3,7 @@ module Twilio
     class Sip < InstanceResource
       def initialize(path, client, params={})
         super
-        resource :domains, 
-            :ip_access_control_lists,
-            :credential_lists
+        resource :domains, :ip_access_control_lists, :credential_lists
       end
     end
   end

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

@@ -1,7 +1,25 @@
 module Twilio
   module REST
     module SMS
+      
+      module Deprecation
+        def deprecate(method_name)
+          old_method = "_deprecated_#{method_name}"
+          alias_method old_method, method_name
+          define_method method_name do |*args, &block|
+            warn "[DEPRECATED] SMS Resource is deprecated. Please use Messages (https://www.twilio.com/docs/api/rest/message)"
+            send old_method, *args, &block
+          end
+        end
+      end
+
       class Messages < ListResource
+        extend Deprecation
+         
+        deprecate :list
+        deprecate :get
+        deprecate :create
+
         def initialize(path, client)
           super
           @list_key = 'sms_messages'
@@ -9,6 +27,11 @@ module Twilio
       end
 
       class Message < InstanceResource
+        extend Deprecation
+
+        deprecate :update
+        deprecate :refresh
+        deprecate :delete
       end
     end
   end

data/lib/twilio-ruby/rest/task_router/activities.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Activities < Twilio::REST::NextGenListResource; end
+      class Activity < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/events.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Events < ListResource; end
+      class Event < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/reservations.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Reservations < Twilio::REST::NextGenListResource; end
+      class Reservation < InstanceResource; end
+    end
+  end
+end