twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/framework/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class Request
     attr_reader :host, :port, :method, :url, :params, :data, :headers, :auth, :timeout

data/lib/twilio-ruby/framework/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class Response
     attr_accessor :status_code, :body, :headers

data/lib/twilio-ruby/framework/{domain.rb → rest/domain.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class Domain
@@ -18,7 +20,7 @@ module Twilio
         url = uri.match(/^http/) ? uri : absolute_url(uri)
 
         @client.request(
-          @host,
+          @base_url,
           @port,
           method,
           url,

data/lib/twilio-ruby/framework/rest/error.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class TwilioError < StandardError
+      # @deprecated all errors that have a body are now 'Twilio::RestError's
+      def body
+        warn "'Twilio::REST::TwilioError#body' has been deprecated. No 'TwilioError' objects are raised with a body."
+        nil
+      end
+    end
+
+    class RestError < TwilioError
+      attr_reader :message, :response, :code, :status_code, :details, :more_info, :error_message
+
+      def initialize(message, response)
+        @status_code = response.status_code
+        @code = response.body.fetch('code', @status_code)
+        @details = response.body.fetch('details', nil)
+        @error_message = response.body.fetch('message', nil)
+        @more_info = response.body.fetch('more_info', nil)
+        @message = format_message(message)
+        @response = response
+      end
+
+      # @deprecated use #response instead
+      def body
+        warn 'This error used to be a "Twilio::REST::TwilioError" but is now a "Twilio::REST::RestError". ' \
+             'Please use #response instead of #body.'
+        @response
+      end
+
+      def to_s
+        message
+      end
+
+      private
+
+      def format_message(initial_message)
+        message = "[HTTP #{status_code}] #{code} : #{initial_message}"
+        message += "\n#{error_message}" if error_message
+        message += "\n#{details}" if details
+        message += "\n#{more_info}" if more_info
+        message + "\n\n"
+      end
+    end
+
+    class ObsoleteError < StandardError
+    end
+  end
+end

data/lib/twilio-ruby/framework/{helper.rb → rest/helper.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     def url_join(left, right)

data/lib/twilio-ruby/framework/{obsolete_client.rb → rest/obsolete_client.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class ObsoleteClient

data/lib/twilio-ruby/framework/{page.rb → rest/page.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     # Page Base Class
@@ -29,7 +31,7 @@ module Twilio
 
       def process_response(response)
         if response.status_code != 200
-          raise Twilio::REST::TwilioError.new('Unable to fetch page', response)
+          raise Twilio::REST::RestError.new('Unable to fetch page', response)
         end
 
         response.body

data/lib/twilio-ruby/framework/{resource.rb → rest/resource.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class ListResource

data/lib/twilio-ruby/framework/{version.rb → rest/version.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module REST
     class Version
@@ -52,19 +54,10 @@ module Twilio
       end
 
       def exception(response, header)
-        message = header
-        code = response.status_code
-
-        if response.body.key?('message')
-          message += ": #{response.body['message']}"
-        end
-
-        code = response.body['code'] if response.body.key?('code')
-
-        Twilio::REST::RestError.new(message, code, response.status_code)
+        Twilio::REST::RestError.new(header, response)
       end
 
-      def fetch(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      def fetch(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
         response = request(
           method,
           uri,
@@ -75,7 +68,8 @@ module Twilio
           timeout
         )
 
-        if response.status_code < 200 || response.status_code >= 300
+        # Note that 3XX response codes are allowed for fetches.
+        if response.status_code < 200 || response.status_code >= 400
           raise exception(response, 'Unable to fetch record')
         end
 
@@ -100,7 +94,7 @@ module Twilio
         response.body
       end
 
-      def delete(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      def delete(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
         response = request(
           method,
           uri,
@@ -119,22 +113,17 @@ module Twilio
       end
 
       def read_limits(limit = nil, page_size = nil)
-        page_limit = nil
-
-        unless limit.nil?
-          # If there is no user-specified page_size, pick the most network efficient size
+        unless limit.nil? || page_size
           page_size = limit
-          page_limit = (limit / page_size.to_f).ceil
         end
 
         {
           limit: limit || nil,
-          page_size: page_size || nil,
-          page_limit: page_limit
+          page_size: page_size || nil
         }
       end
 
-      def page(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      def page(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
         request(
           method,
           uri,

data/lib/twilio-ruby/framework/serialize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   def self.serialize_iso8601_date(date)
     if date.eql?(:unset)

data/lib/twilio-ruby/framework/twilio_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class TwilioResponse
     attr_accessor :status_code, :body

data/lib/twilio-ruby/framework/values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   class Values
     def self.of(hash)

data/lib/twilio-ruby/http/http_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module Twilio
@@ -6,38 +8,45 @@ module Twilio
       attr_accessor :adapter
       attr_reader :timeout, :last_response, :last_request
 
-      def initialize(proxy_addr = nil, proxy_port = nil, proxy_user = nil, proxy_pass = nil, ssl_ca_file = nil,
-                     timeout: nil)
-        @proxy_addr = proxy_addr
-        @proxy_port = proxy_port
-        @proxy_user = proxy_user
-        @proxy_pass = proxy_pass
+      def initialize(proxy_prot = nil, proxy_addr = nil, proxy_port = nil, proxy_user = nil, proxy_pass = nil,
+                     ssl_ca_file = nil, timeout: nil)
+        @proxy_prot = proxy_prot
+        @proxy_path = "#{proxy_addr}:#{proxy_port}" if proxy_addr && proxy_port
+        @proxy_auth = "#{proxy_user}:#{proxy_pass}@" if proxy_pass && proxy_user
         @ssl_ca_file = ssl_ca_file
         @timeout = timeout
         @adapter = Faraday.default_adapter
+        @configure_connection_blocks = []
+      end
+
+      def configure_connection(&block)
+        raise ArgumentError, "#{__method__} must be given a block!" unless block_given?
+
+        @configure_connection_blocks << block
+        nil
       end
 
       def _request(request)
         @connection = Faraday.new(url: request.host + ':' + request.port.to_s, ssl: { verify: true }) do |f|
           f.options.params_encoder = Faraday::FlatParamsEncoder
           f.request :url_encoded
-          f.adapter @adapter
           f.headers = request.headers
-          f.basic_auth(request.auth[0], request.auth[1])
-          if @proxy_addr
-            f.proxy "#{@proxy_user}:#{@proxy_pass}@#{@proxy_addr}:#{@proxy_port}"
-          end
+          f.request(:basic_auth, request.auth[0], request.auth[1])
+          f.proxy = "#{@proxy_prot}://#{@proxy_auth}#{@proxy_path}" if @proxy_prot && @proxy_path
           f.options.open_timeout = request.timeout || @timeout
           f.options.timeout = request.timeout || @timeout
+
+          @configure_connection_blocks.each { |block| block.call(f) }
+          f.adapter @adapter
         end
 
         @last_request = request
         @last_response = nil
-        response = @connection.send(request.method.downcase.to_sym,
-                                    request.url,
-                                    request.method == 'GET' ? request.params : request.data)
 
-        if response.body && !response.body.empty?
+        response = send(request)
+        if response.status == 504
+          object = { message: 'Request timeout', code: 504 }.to_json
+        elsif response.body && !response.body.empty?
           object = response.body
         elsif response.status == 400
           object = { message: 'Bad request', code: 400 }.to_json
@@ -49,6 +58,14 @@ module Twilio
         twilio_response
       end
 
+      def send(request)
+        @connection.send(request.method.downcase.to_sym,
+                         request.url,
+                         request.method == 'GET' ? request.params : request.data)
+      rescue Faraday::Error => e
+        raise Twilio::REST::TwilioError, e
+      end
+
       def request(host, port, method, url, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
         request = Twilio::Request.new(host, port, method, url, params, data, headers, auth, timeout)
         _request(request)

data/lib/twilio-ruby/http.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, 'http/**/*.rb')].sort.each do |file|
+  require file
+end

data/lib/twilio-ruby/jwt/access_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     module AccessTokenGrant
@@ -18,7 +20,8 @@ module Twilio
                     :grants,
                     :nbf,
                     :ttl,
-                    :valid_until
+                    :valid_until,
+                    :region
 
       def initialize(
         account_sid,
@@ -28,7 +31,8 @@ module Twilio
         identity: nil,
         nbf: nil,
         ttl: 3600,
-        valid_until: nil
+        valid_until: nil,
+        region: nil
       )
         super(secret_key: secret,
               issuer: signing_key_sid,
@@ -44,6 +48,7 @@ module Twilio
         @grants = grants
         @ttl = ttl
         @valid_until = valid_until
+        @region = region
       end
 
       def add_grant(grant)
@@ -74,6 +79,8 @@ module Twilio
           cty: 'twilio-fpa;v=1'
         }
 
+        headers[:twr] = region unless region&.nil?
+
         headers
       end
 
@@ -144,7 +151,8 @@ module Twilio
 
       class VoiceGrant
         include AccessTokenGrant
-        attr_accessor :outgoing_application_sid,
+        attr_accessor :incoming_allow,
+                      :outgoing_application_sid,
                       :outgoing_application_params,
                       :push_credential_sid,
                       :endpoint_id
@@ -155,6 +163,7 @@ module Twilio
 
         def _generate_payload
           payload = {}
+          payload[:incoming] = { allow: true } if incoming_allow == true
 
           if outgoing_application_sid
             outgoing = {}

data/lib/twilio-ruby/jwt/client_capability.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     module Scope
@@ -68,7 +70,7 @@ module Twilio
             client_name = "clientName=#{CGI.escape(@client_name)}"
           end
           unless @params.empty?
-            params = 'appParams=' + @params.map { |k, v| CGI.escape("#{k}=#{v}") }.join('&')
+            params = 'appParams=' + @params.map { |k, v| CGI.escape("#{k}=#{v}") }.join(CGI.escape('&'))
           end
 
           suffix = [application_sid, client_name, params].compact.join('&')

data/lib/twilio-ruby/jwt/jwt.rb

@@ -1,5 +1,13 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
 module Twilio
   module JWT
+    autoload :AccessToken, File.join(File.dirname(__FILE__), 'access_token.rb')
+    autoload :ClientCapability, File.join(File.dirname(__FILE__), 'client_capability.rb')
+    autoload :TaskRouterCapability, File.join(File.dirname(__FILE__), 'task_router.rb')
+
     class BaseJWT
       # valid_until overrides ttl if specified
       def initialize(secret_key: nil, issuer: nil, subject: nil, nbf: nil, ttl: 3600, valid_until: nil)

data/lib/twilio-ruby/jwt/task_router.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Twilio
   module JWT
     class TaskRouterCapability < BaseJWT
@@ -82,8 +84,8 @@ module Twilio
           [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces'].join('/')
         end
 
-        def self.workspace(worskspace_sid)
-          [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces', worskspace_sid].join('/')
+        def self.workspace(workspace_sid)
+          [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces', workspace_sid].join('/')
         end
 
         def self.all_workspaces

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

@@ -0,0 +1,186 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Accounts < Domain
+      class V1 < Version
+        class AuthTokenPromotionList < ListResource
+          ##
+          # Initialize the AuthTokenPromotionList
+          # @param [Version] version Version that contains the resource
+          # @return [AuthTokenPromotionList] AuthTokenPromotionList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Accounts.V1.AuthTokenPromotionList>'
+          end
+        end
+
+        class AuthTokenPromotionPage < Page
+          ##
+          # Initialize the AuthTokenPromotionPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [AuthTokenPromotionPage] AuthTokenPromotionPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of AuthTokenPromotionInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [AuthTokenPromotionInstance] AuthTokenPromotionInstance
+          def get_instance(payload)
+            AuthTokenPromotionInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Accounts.V1.AuthTokenPromotionPage>'
+          end
+        end
+
+        class AuthTokenPromotionContext < InstanceContext
+          ##
+          # Initialize the AuthTokenPromotionContext
+          # @param [Version] version Version that contains the resource
+          # @return [AuthTokenPromotionContext] AuthTokenPromotionContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/AuthTokens/Promote"
+          end
+
+          ##
+          # Update the AuthTokenPromotionInstance
+          # @return [AuthTokenPromotionInstance] Updated AuthTokenPromotionInstance
+          def update
+            payload = @version.update('POST', @uri)
+
+            AuthTokenPromotionInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Accounts.V1.AuthTokenPromotionContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Accounts.V1.AuthTokenPromotionContext #{context}>"
+          end
+        end
+
+        class AuthTokenPromotionInstance < InstanceResource
+          ##
+          # Initialize the AuthTokenPromotionInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [AuthTokenPromotionInstance] AuthTokenPromotionInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'auth_token' => payload['auth_token'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [AuthTokenPromotionContext] AuthTokenPromotionContext for this AuthTokenPromotionInstance
+          def context
+            unless @instance_context
+              @instance_context = AuthTokenPromotionContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The SID of the Account that the secondary Auth Token was created for
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The promoted Auth Token
+          def auth_token
+            @properties['auth_token']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 formatted date and time in UTC when the resource was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 formatted date and time in UTC when the resource was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The URI for this resource, relative to `https://accounts.twilio.com`
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the AuthTokenPromotionInstance
+          # @return [AuthTokenPromotionInstance] Updated AuthTokenPromotionInstance
+          def update
+            context.update
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Accounts.V1.AuthTokenPromotionInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Accounts.V1.AuthTokenPromotionInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end