twilio-ruby 3.16.1 → 4.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmMzZTI4YTc1YzNjZDlmZDVkMDkxZjVkMTgyMGY3ZDZiZTNmZDlkZg==
+    OTVlYzExOGM0MDgwMzg3NmE4MTM0M2M1MjAyNTY1MmU5Yjk3NjY1Mw==
   data.tar.gz: !binary |-
-    MWE0NTcwY2Y1ZGZjZTc5ODAzZmNmNzA1OTQ5MTVhOTY1ZDBlMjlhZA==
+    MTBlYzkxM2NjYjViMzY2OGU5NzUyMjBhMjNjOGQ5ZWVmN2I5YTdjYw==
 SHA512:
   metadata.gz: !binary |-
-    MWYyYWJiY2FmYjY2MTU0ZGRlMmY3NzkzNWY2M2E1NGE2OGY5NmQzYTA3NWVj
-    Y2M1NDA2OTQzMTIyZDUyMjcxMDcxMDU3MjkyY2YwYmU1OTRjMzcxOWYxZTk0
-    NTY2ZWE2NTBmOGQxYTlkOTE2Mzg5OTE3NjQ5ZDBhNWNmZGMzZWU=
+    Mjk0ZDNjYjIwYTc2NjZiYjAzNmM4NGQ4NWQ4NWJlNGM0NzA2NTI5NmI1OTI4
+    Y2E5ZDEzYzQ0MjNiNTEzM2Y0MWQ5MzBiMTFiM2MwNThmODNjMjY4NmE2MTdi
+    MDM4NWY3OWU0ZGY1NWI4YjU2MTM4NzRiZTRjNmQ4MzNjZDEyOWU=
   data.tar.gz: !binary |-
-    MmMzNjIzMmRkMzM0ZjBiMGM5NzU3NDBhZThlYzg0YjVkOTMwZTE2OTEzOWVm
-    OGQ1ODVlZDUyOGQ4ZjY4NDVjYjljNWZmZGY1YzViMWRkZGFjYTczNmU0Mzhk
-    YzFlMzcwZTFiZTU0YThhYjYwZGRlZjhiMmMyZjE3MGRmNDIzODc=
+    ODBhZjRmYWQ4ZTU3MTA3ZjE5MjEyNjYyODI2ZDk0Njk3Mjg3YjRjYTgyYTA4
+    NGEyMjExNzUzYjhjMGE3ZWM1YmI2MzM4YThmOGEwNGRkZTZmNzc5ZmMwMjli
+    OTNkMmE3YjY2NmIxZjRkZGRmMTc3OWE3NmM2ZjE5MGJmOTViN2E=

data/CHANGES.md

@@ -1,6 +1,16 @@
 twilio-ruby changelog
 =====================
 
+Version 4.0.0
+-------------
+
+Released April 16, 2015
+
+- Remove support for total
+- Use configuration object instead of defaults hash for REST clients
+- Moves statistics from task router client to individual classes
+  - Deprecates statistics methods on task router client
+
 Version 3.16.1
 --------------
 

data/README.md

@@ -11,7 +11,7 @@ A module for using the Twilio REST API and generating valid [TwiML](http://www.t
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 3.12'
+gem 'twilio-ruby', '~> 4.0.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:

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

@@ -12,25 +12,19 @@ module Twilio
                         " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
       }
 
-      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
-      }
+      ##
+      # Override the default host for a REST Client (api.twilio.com)
+      def self.host(host=nil)
+        return @host unless host
+        @host = host
+      end
 
       attr_reader :account_sid, :last_request, :last_response
 
       def initialize(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        @config = get_defaults.merge! options
+        options[:host] ||= self.class.host
+        @config = Twilio::Util::ClientConfig.new options
 
         @account_sid = args[0] || Twilio.account_sid
         @auth_token = args[1] || Twilio.auth_token
@@ -63,13 +57,6 @@ module Twilio
 
       protected
 
-      ##
-      # Get the default config values.
-      def get_defaults
-        # To be overridden
-        DEFAULTS
-      end
-
       ##
       # Builds up full request path
       # Needs implementation in child classes
@@ -81,22 +68,22 @@ module Twilio
       # 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]
+        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]
+        @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.use_ssl = @config.use_ssl
+        if @config.ssl_verify_peer
           @connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          @connection.ca_file = @config[:ssl_ca_file]
+          @connection.ca_file = @config.ssl_ca_file
         else
           @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
@@ -116,7 +103,7 @@ module Twilio
       # inspection later.
       def connect_and_send(request) # :doc:
         @last_request = request
-        retries_left = @config[:retry_limit]
+        retries_left = @config.retry_limit
         begin
           response = @connection.request request
           @last_response = response

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

@@ -53,6 +53,8 @@ module Twilio
 
       attr_reader :account, :accounts
 
+      host 'api.twilio.com'
+
       ##
       # Instantiate a new HTTP client to talk to Twilio. The parameters
       # +account_sid+ and +auth_token+ are required, unless you have configured

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

@@ -51,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)
@@ -67,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

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

@@ -4,22 +4,10 @@ module Twilio
     class LookupsClient < BaseClient
       API_VERSION = 'v1'
 
-      DEFAULTS = {
-          host: 'lookups.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 :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
@@ -92,12 +80,6 @@ module Twilio
 
       protected
 
-      ##
-      # Get the default config values.
-      def get_defaults
-        DEFAULTS
-      end
-
       ##
       # Set up +phone_numbers+ attribute.
       def set_up_subresources # :doc:

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

@@ -21,6 +21,13 @@ module Twilio
               []
             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

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

@@ -17,7 +17,6 @@ module Twilio
         extend Deprecation
          
         deprecate :list
-        deprecate :total
         deprecate :get
         deprecate :create
 

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

@@ -0,0 +1,26 @@
+module Twilio
+  module REST
+    module TaskRouter
+      module Statistics
+        def statistics(args={})
+          path = "#{@path}/Statistics"
+          response = @client.get(path, args, true)
+          statistics_class.new(path, @client, response)
+        end
+
+        private
+
+        ##
+        # Gets the class for the statistics of the current class.
+        # Should just be Object.const_get("#{self.class.to_s}Statistics") but
+        # Ruby 1.9.3 did not agree. Can be updated if support is dropped.
+        def statistics_class
+          current_class = self.class.to_s.split('::').last
+          statistics_class = Twilio::REST::TaskRouter.const_get(
+            "#{current_class}Statistics"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -1,8 +1,17 @@
 module Twilio
   module REST
     module TaskRouter
-      class TaskQueues < Twilio::REST::NextGenListResource; end
-      class TaskQueue < InstanceResource; end
+      class TaskQueues < Twilio::REST::NextGenListResource
+        def statistics(args={})
+          path = "#{@path}/Statistics"
+          stats = Twilio::REST::TaskRouter::TaskQueuesStatistics.new path, @client
+          stats.list args, true
+        end
+      end
+
+      class TaskQueue < InstanceResource
+        include Statistics
+      end
     end
   end
 end

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

@@ -1,8 +1,13 @@
 module Twilio
   module REST
     module TaskRouter
-      class Workers < Twilio::REST::NextGenListResource; end
-      class Worker < InstanceResource; end
+      class Workers < Twilio::REST::NextGenListResource
+        include Twilio::REST::TaskRouter::Statistics
+      end
+
+      class Worker < InstanceResource
+        include Twilio::REST::TaskRouter::Statistics
+      end
     end
   end
 end

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

@@ -2,7 +2,10 @@ module Twilio
   module REST
     module TaskRouter
       class Workflows < Twilio::REST::NextGenListResource; end
-      class Workflow < InstanceResource; end
+
+      class Workflow < InstanceResource
+        include Twilio::REST::TaskRouter::Statistics
+      end
     end
   end
 end

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

@@ -4,6 +4,8 @@ module Twilio
       class Workspaces < Twilio::REST::NextGenListResource; end
 
       class Workspace < InstanceResource
+        include Twilio::REST::TaskRouter::Statistics
+
         def initialize(path, client, params={})
           super path, client, params
           @submodule = :TaskRouter

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

@@ -4,22 +4,10 @@ module Twilio
     class TaskRouterClient < BaseClient
       API_VERSION = 'v1'
 
-      DEFAULTS = {
-          host: 'taskrouter.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 :workspace, :workspace_sid, :workspaces
 
+      host 'taskrouter.twilio.com'
+
       ##
       # Instantiate a new HTTP TaskRouter client to talk to Twilio. The parameters
       # +account_sid+, +auth_token+ and +workspace_sid are required, unless you
@@ -121,68 +109,53 @@ module Twilio
       ##
       # Get statistics of a task queue.
       def task_queue_statistics(task_queue_sid, *args) # :doc:
-        if task_queue_sid.nil?
-          raise ArgumentError, 'Task queue SID is required'
-        end
-        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/TaskQueues/#{task_queue_sid}/Statistics"
-        response = get path, args, true
-        Twilio::REST::TaskRouter::TaskQueueStatistics.new path, self, response
+        warn "[DEPRECATED] task_queue_statistics is deprecated. " \
+             "Please call client.task_queue.get(sid).statistics."
+        task_queues.get(task_queue_sid).statistics
       end
 
       ##
       # Get statistics of task queues.
       def task_queues_statistics(*args) # :doc:
-        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/TaskQueues/Statistics"
-        stats = Twilio::REST::TaskRouter::TaskQueuesStatistics.new path, self
-        stats.list args, true
+        warn "[DEPRECATED] task_queues_statistics is deprecated. " \
+             "Please call client.task_queues.statistics."
+        task_queues.statistics
       end
 
       ##
       # Get statistics of a worker.
       def worker_statistics(worker_sid, *args) # :doc:
-        if worker_sid.nil?
-          raise ArgumentError, 'Worker SID is required'
-        end
-        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/Workers/#{worker_sid}/Statistics"
-        response = get path, args, true
-        Twilio::REST::TaskRouter::WorkerStatistics.new path, self, response
+        warn "[DEPRECATED] worker_statistics is deprecated. " \
+             "Please call client.worker.get(sid).statistics."
+        workers.get(worker_sid).statistics
       end
 
       ##
       # Get statistics of workers.
       def workers_statistics(*args) # :doc:
-        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/Workers/Statistics"
-        response = get path, args, true
-        Twilio::REST::TaskRouter::WorkersStatistics.new path, self, response
+        warn "[DEPRECATED] workers_statistics is deprecated. " \
+             "Please call client.workers.statistics."
+        workers.statistics
       end
 
       ##
       # Get statistics of a workflow.
       def workflow_statistics(workflow_sid, *args) # :doc:
-        if workflow_sid.nil?
-          raise ArgumentError, 'Workflow SID is required'
-        end
-        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/Workflows/#{workflow_sid}/Statistics"
-        response = get path, args, true
-        Twilio::REST::TaskRouter::WorkflowStatistics.new path, self, response
+        warn "[DEPRECATED] workflow_statistics is deprecated. " \
+             "Please call client.workflow.get(sid).statistics."
+        workflows.get(workflow_sid).statistics
       end
 
       ##
       # Get statistics of a workspace.
       def workspace_statistics(*args) # :doc:
-        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/Statistics"
-        response = get path, args, true
-        Twilio::REST::TaskRouter::WorkspaceStatistics.new path, self, response
+        warn "[DEPRECATED] worker_statistics is deprecated. " \
+             "Please call client.workspace.statistics."
+        workspace.statistics
       end
 
       protected
 
-      ##
-      # Get the default config values.
-      def get_defaults
-        DEFAULTS
-      end
-
       ##
       # Set up +workspace+ and +workspaces+ attributes.
       def set_up_subresources # :doc:

data/lib/twilio-ruby/util/client_config.rb

@@ -0,0 +1,29 @@
+module Twilio
+  module Util
+    class ClientConfig
+      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
+      }
+
+      DEFAULTS.each_key do |attribute|
+        attr_accessor attribute
+      end
+
+      def initialize(opts={})
+        DEFAULTS.each do |attribute, value|
+          send("#{attribute}=".to_sym, opts.fetch(attribute, value))
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-  VERSION = '3.16.1'
+  VERSION = '4.0.0'
 end

data/lib/twilio-ruby.rb

@@ -10,6 +10,7 @@ require 'jwt'
 
 require 'twilio-ruby/version' unless defined?(Twilio::VERSION)
 require 'twilio-ruby/util'
+require 'twilio-ruby/util/client_config'
 require 'twilio-ruby/util/configuration'
 require 'twilio-ruby/util/request_validator'
 require 'twilio-ruby/util/capability'
@@ -37,6 +38,7 @@ require 'twilio-ruby/rest/sip/credential_lists'
 require 'twilio-ruby/rest/sip/credential_lists/credentials'
 require 'twilio-ruby/rest/sip/ip_access_control_lists'
 require 'twilio-ruby/rest/sip/ip_access_control_lists/ip_addresses'
+require 'twilio-ruby/rest/task_router/statistics'
 require 'twilio-ruby/rest/task_router/activities'
 require 'twilio-ruby/rest/task_router/events'
 require 'twilio-ruby/rest/task_router/reservations'

data/spec/rest/sms/messages_spec.rb

@@ -28,9 +28,4 @@ describe Twilio::REST::SMS::Messages do
     expect(@messages).to receive(:warn)
     @messages.get sid: "qwerty"
   end  
-
-  it 'should warn of deprecation of SMS Messages total' do
-    expect(@messages).to receive(:warn)
-    @messages.total
-  end  
-end
+end

data/spec/util/client_config_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Twilio::Util::ClientConfig do
+  Twilio::Util::ClientConfig::DEFAULTS.each do |attribute, value|
+    it "sets an attribute with a default value" do
+      config = Twilio::Util::ClientConfig.new
+      expect(config.send(attribute)).to eq(value)
+    end
+
+    it "can update the value for the attribute" do
+      config = Twilio::Util::ClientConfig.new
+      config.send("#{attribute}=", "blah")
+      expect(config.send(attribute)).to eq("blah")
+    end
+
+    it "can set the value from a hash in the initializer" do
+      config = Twilio::Util::ClientConfig.new(attribute => 'blah')
+      expect(config.send(attribute)).to eq("blah")
+    end
+  end
+end

data/spec/util/configuration_spec.rb

@@ -1,3 +1,5 @@
+require 'spec_helper'
+
 describe Twilio::Util::Configuration do
   it 'should have an account sid attribute' do
     config = Twilio::Util::Configuration.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twilio-ruby
 version: !ruby/object:Gem::Version
-  version: 3.16.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Andrew Benton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -179,6 +179,7 @@ files:
 - lib/twilio-ruby/rest/task_router/activities.rb
 - lib/twilio-ruby/rest/task_router/events.rb
 - lib/twilio-ruby/rest/task_router/reservations.rb
+- lib/twilio-ruby/rest/task_router/statistics.rb
 - lib/twilio-ruby/rest/task_router/task_queues.rb
 - lib/twilio-ruby/rest/task_router/task_queues_statistics.rb
 - lib/twilio-ruby/rest/task_router/tasks.rb
@@ -200,6 +201,7 @@ files:
 - lib/twilio-ruby/twiml/response.rb
 - lib/twilio-ruby/util.rb
 - lib/twilio-ruby/util/capability.rb
+- lib/twilio-ruby/util/client_config.rb
 - lib/twilio-ruby/util/configuration.rb
 - lib/twilio-ruby/util/request_validator.rb
 - lib/twilio-ruby/version.rb
@@ -228,6 +230,7 @@ files:
 - spec/task_router_spec.rb
 - spec/twilio_spec.rb
 - spec/util/capability_spec.rb
+- spec/util/client_config_spec.rb
 - spec/util/configuration_spec.rb
 - spec/util/request_validator_spec.rb
 - spec/util/url_encode_spec.rb
@@ -289,6 +292,7 @@ test_files:
 - spec/task_router_spec.rb
 - spec/twilio_spec.rb
 - spec/util/capability_spec.rb
+- spec/util/client_config_spec.rb
 - spec/util/configuration_spec.rb
 - spec/util/request_validator_spec.rb
 - spec/util/url_encode_spec.rb