bandwidth-sdk 6.2.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5539a17ccb877e0e80a53959cbbc354314c0300c3c3ce1e90de0c4b5eae9f18a
-  data.tar.gz: 1f0466592184f21361287991b49a596c46d5de6f34dca9b727884f077591bf72
+  metadata.gz: ee8c7426138e841e2fea1dbff5d5e3c79372a5cd30c20fe6f2b271104d9101d6
+  data.tar.gz: d6463c59e3d52f560968494124e4563a61d7f2aa0b2b0f04f23e92f65f97247a
 SHA512:
-  metadata.gz: fd6452d48d8a62e0bce5fb173132aac42f52918632c696e4153bfedc6d3c6db9769ab2941c0031d5c70b4ed245d35f0bee4929c54a6511441ad60e59c77c1fb5
-  data.tar.gz: 677a0c3e526b2d0f90d4d7905f7b914ce44f8d7a8eee47760693682da200c441cd476030a5e051dc87fdb716aea287d0184584d3c91691cb636ed49ecdaa07be
+  metadata.gz: 255385a80dbc57bccc6dab0f124b9588481eb8075dadce183677b9ca5c7f7d62a65512b876d076d51f051a7de96ca920948e70c4d9b4c1be01cbda03b37f8898
+  data.tar.gz: 755608aac58ac160de2711c5c3e8b0e57426a023f32c80dc047a2d3c7ee3d345eeb3188dfdfdaeec315690dac6cb377253799119a816a5ae3d34f3135686e24c

data/lib/bandwidth/api_helper.rb

@@ -13,13 +13,14 @@ module Bandwidth
     def self.serialize_array(key, array, formatting: 'indexed')
       tuples = []
 
-      if formatting == 'unindexed'
+      case formatting
+      when 'unindexed'
         tuples += array.map { |element| ["#{key}[]", element] }
-      elsif formatting == 'indexed'
+      when 'indexed'
         tuples += array.map.with_index do |element, index|
           ["#{key}[#{index}]", element]
         end
-      elsif formatting == 'plain'
+      when 'plain'
         tuples += array.map { |element| [key, element] }
       else
         raise ArgumentError, 'Invalid format provided.'
@@ -60,7 +61,7 @@ module Bandwidth
         end
 
         # Find the template parameter and replace it with its value.
-        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        query_builder = query_builder.gsub("{#{key}}", replace_value)
       end
       query_builder
     end
@@ -85,15 +86,16 @@ module Bandwidth
         unless value.nil?
           if value.instance_of? Array
             value.compact!
-            query_builder += if array_serialization == 'csv'
+            query_builder += case array_serialization
+                             when 'csv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join(',')}"
-                             elsif array_serialization == 'psv'
+                             when 'psv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join('|')}"
-                             elsif array_serialization == 'tsv'
+                             when 'tsv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join("\t")}"
@@ -119,7 +121,7 @@ module Bandwidth
       raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
 
       # Ensure that the urls are absolute.
-      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      matches = url.match(%r{^(https?://[^/]+)})
       raise ArgumentError, 'Invalid Url format.' if matches.nil?
 
       # Get the http protocol match.
@@ -130,7 +132,7 @@ module Bandwidth
 
       # Remove redundant forward slashes.
       query = url[protocol.length...(!index.nil? ? index : url.length)]
-      query.gsub!(%r{\/\/+}, '/')
+      query.gsub!(%r{//+}, '/')
 
       # Get the parameters.
       parameters = !index.nil? ? url[url.index('?')...url.length] : ''
@@ -142,7 +144,7 @@ module Bandwidth
     # Parses JSON string.
     # @param [String] A JSON string.
     def self.json_deserialize(json)
-      return JSON.parse(json)
+      JSON.parse(json)
     rescue StandardError
       raise TypeError, 'Server responded with invalid JSON.'
     end
@@ -171,6 +173,7 @@ module Bandwidth
       a.each do |key, value_a|
         b.each do |k, value_b|
           next unless key == k
+
           x[k] = []
           if value_a.instance_of? Array
             value_a.each do |v|
@@ -215,13 +218,12 @@ module Bandwidth
       elsif obj.instance_of? Array
         if formatting == 'indexed'
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']'))
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]"))
           end
         elsif serializable_types.map { |x| obj[0].is_a? x }.any?
           obj.each do |value|
             abc = if formatting == 'unindexed'
-                    APIHelper.form_encode(value, instance_name + '[]',
+                    APIHelper.form_encode(value, "#{instance_name}[]",
                                           formatting: formatting)
                   else
                     APIHelper.form_encode(value, instance_name,
@@ -231,14 +233,14 @@ module Bandwidth
           end
         else
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']', formatting: formatting))
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]",
+                                                formatting: formatting))
           end
         end
       elsif obj.instance_of? Hash
         obj.each do |key, value|
-          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-            key.to_s + ']', formatting: formatting))
+          retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{key}]",
+                                              formatting: formatting))
         end
       elsif obj.instance_of? File
         retval[instance_name] = UploadIO.new(
@@ -273,17 +275,5 @@ module Bandwidth
       end
       val
     end
-
-    # Safely converts a string into an rfc3339 DateTime object
-    # @param [String] The datetime string
-    # @return [DateTime] A DateTime object of rfc3339 format
-    def self.rfc3339(date_time)
-      # missing timezone information
-      if date_time.end_with?('Z') || date_time.index('+')
-        DateTime.rfc3339(date_time)
-      else
-        DateTime.rfc3339(date_time + 'Z')
-      end
-    end
   end
 end

data/lib/bandwidth/client.rb

@@ -12,10 +12,10 @@ module Bandwidth
     def messaging_client
       @messaging_client ||= Messaging::Client.new(config: config)
     end
-    # Access to two_factor_auth_client controller.
-    # @return [TwoFactorAuth::Client] Returns the client instance.
-    def two_factor_auth_client
-      @two_factor_auth_client ||= TwoFactorAuth::Client.new(config: config)
+    # Access to multi_factor_auth_client controller.
+    # @return [MultiFactorAuth::Client] Returns the client instance.
+    def multi_factor_auth_client
+      @multi_factor_auth_client ||= MultiFactorAuth::Client.new(config: config)
     end
     # Access to phone_number_lookup_client controller.
     # @return [PhoneNumberLookup::Client] Returns the client instance.
@@ -41,8 +41,8 @@ module Bandwidth
                    base_url: 'https://www.example.com',
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',
-                   two_factor_auth_basic_auth_user_name: 'TODO: Replace',
-                   two_factor_auth_basic_auth_password: 'TODO: Replace',
+                   multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                   multi_factor_auth_basic_auth_password: 'TODO: Replace',
                    phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
                    phone_number_lookup_basic_auth_password: 'TODO: Replace',
                    voice_basic_auth_user_name: 'TODO: Replace',
@@ -59,8 +59,8 @@ module Bandwidth
                                     base_url: base_url,
                                     messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                     messaging_basic_auth_password: messaging_basic_auth_password,
-                                    two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
-                                    two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
+                                    multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
+                                    multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
                                     phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
                                     phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
                                     voice_basic_auth_user_name: voice_basic_auth_user_name,

data/lib/bandwidth/configuration.rb

@@ -17,7 +17,7 @@ module Bandwidth
     SERVER = [
       DEFAULT = 'default'.freeze,
       MESSAGINGDEFAULT = 'MessagingDefault'.freeze,
-      TWOFACTORAUTHDEFAULT = 'TwoFactorAuthDefault'.freeze,
+      MULTIFACTORAUTHDEFAULT = 'MultiFactorAuthDefault'.freeze,
       PHONENUMBERLOOKUPDEFAULT = 'PhoneNumberLookupDefault'.freeze,
       VOICEDEFAULT = 'VoiceDefault'.freeze,
       WEBRTCDEFAULT = 'WebRtcDefault'.freeze
@@ -28,25 +28,13 @@ module Bandwidth
   # are configured in this class.
   class Configuration
     # The attribute readers for properties.
-    attr_reader :http_client
-    attr_reader :timeout
-    attr_reader :max_retries
-    attr_reader :retry_interval
-    attr_reader :backoff_factor
-    attr_reader :retry_statuses
-    attr_reader :retry_methods
-    attr_reader :environment
-    attr_reader :base_url
-    attr_reader :messaging_basic_auth_user_name
-    attr_reader :messaging_basic_auth_password
-    attr_reader :two_factor_auth_basic_auth_user_name
-    attr_reader :two_factor_auth_basic_auth_password
-    attr_reader :phone_number_lookup_basic_auth_user_name
-    attr_reader :phone_number_lookup_basic_auth_password
-    attr_reader :voice_basic_auth_user_name
-    attr_reader :voice_basic_auth_password
-    attr_reader :web_rtc_basic_auth_user_name
-    attr_reader :web_rtc_basic_auth_password
+    attr_reader :http_client, :timeout, :max_retries, :retry_interval, :backoff_factor,
+                :retry_statuses, :retry_methods, :environment, :base_url,
+                :messaging_basic_auth_user_name, :messaging_basic_auth_password,
+                :multi_factor_auth_basic_auth_user_name, :multi_factor_auth_basic_auth_password,
+                :phone_number_lookup_basic_auth_user_name, :phone_number_lookup_basic_auth_password,
+                :voice_basic_auth_user_name, :voice_basic_auth_password,
+                :web_rtc_basic_auth_user_name, :web_rtc_basic_auth_password
 
     class << self
       attr_reader :environments
@@ -60,8 +48,8 @@ module Bandwidth
                    base_url: 'https://www.example.com',
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',
-                   two_factor_auth_basic_auth_user_name: 'TODO: Replace',
-                   two_factor_auth_basic_auth_password: 'TODO: Replace',
+                   multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                   multi_factor_auth_basic_auth_password: 'TODO: Replace',
                    phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
                    phone_number_lookup_basic_auth_password: 'TODO: Replace',
                    voice_basic_auth_user_name: 'TODO: Replace',
@@ -100,10 +88,10 @@ module Bandwidth
       @messaging_basic_auth_password = messaging_basic_auth_password
 
       # The username to use with basic authentication
-      @two_factor_auth_basic_auth_user_name = two_factor_auth_basic_auth_user_name
+      @multi_factor_auth_basic_auth_user_name = multi_factor_auth_basic_auth_user_name
 
       # The password to use with basic authentication
-      @two_factor_auth_basic_auth_password = two_factor_auth_basic_auth_password
+      @multi_factor_auth_basic_auth_password = multi_factor_auth_basic_auth_password
 
       # The username to use with basic authentication
       @phone_number_lookup_basic_auth_user_name = phone_number_lookup_basic_auth_user_name
@@ -132,8 +120,8 @@ module Bandwidth
                    environment: nil, base_url: nil,
                    messaging_basic_auth_user_name: nil,
                    messaging_basic_auth_password: nil,
-                   two_factor_auth_basic_auth_user_name: nil,
-                   two_factor_auth_basic_auth_password: nil,
+                   multi_factor_auth_basic_auth_user_name: nil,
+                   multi_factor_auth_basic_auth_password: nil,
                    phone_number_lookup_basic_auth_user_name: nil,
                    phone_number_lookup_basic_auth_password: nil,
                    voice_basic_auth_user_name: nil,
@@ -150,8 +138,8 @@ module Bandwidth
       base_url ||= self.base_url
       messaging_basic_auth_user_name ||= self.messaging_basic_auth_user_name
       messaging_basic_auth_password ||= self.messaging_basic_auth_password
-      two_factor_auth_basic_auth_user_name ||= self.two_factor_auth_basic_auth_user_name
-      two_factor_auth_basic_auth_password ||= self.two_factor_auth_basic_auth_password
+      multi_factor_auth_basic_auth_user_name ||= self.multi_factor_auth_basic_auth_user_name
+      multi_factor_auth_basic_auth_password ||= self.multi_factor_auth_basic_auth_password
       phone_number_lookup_basic_auth_user_name ||= self.phone_number_lookup_basic_auth_user_name
       phone_number_lookup_basic_auth_password ||= self.phone_number_lookup_basic_auth_password
       voice_basic_auth_user_name ||= self.voice_basic_auth_user_name
@@ -166,8 +154,8 @@ module Bandwidth
         environment: environment, base_url: base_url,
         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
         messaging_basic_auth_password: messaging_basic_auth_password,
-        two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
-        two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
+        multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
+        multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
         phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
         phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
         voice_basic_auth_user_name: voice_basic_auth_user_name,
@@ -190,7 +178,7 @@ module Bandwidth
       Environment::PRODUCTION => {
         Server::DEFAULT => 'api.bandwidth.com',
         Server::MESSAGINGDEFAULT => 'https://messaging.bandwidth.com/api/v2',
-        Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1',
+        Server::MULTIFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1',
         Server::PHONENUMBERLOOKUPDEFAULT => 'https://numbers.bandwidth.com/api/v1',
         Server::VOICEDEFAULT => 'https://voice.bandwidth.com',
         Server::WEBRTCDEFAULT => 'https://api.webrtc.bandwidth.com/v1'
@@ -198,7 +186,7 @@ module Bandwidth
       Environment::CUSTOM => {
         Server::DEFAULT => '{base_url}',
         Server::MESSAGINGDEFAULT => '{base_url}',
-        Server::TWOFACTORAUTHDEFAULT => '{base_url}',
+        Server::MULTIFACTORAUTHDEFAULT => '{base_url}',
         Server::PHONENUMBERLOOKUPDEFAULT => '{base_url}',
         Server::VOICEDEFAULT => '{base_url}',
         Server::WEBRTCDEFAULT => '{base_url}'

data/lib/bandwidth/http/auth/{two_factor_auth_basic_auth.rb → multi_factor_auth_basic_auth.rb}

@@ -7,13 +7,13 @@ require 'base64'
 
 module Bandwidth
   # Utility class for basic authorization.
-  class TwoFactorAuthBasicAuth
+  class MultiFactorAuthBasicAuth
     # Add basic authentication to the request.
     # @param [HttpRequest] The HttpRequest object to which authentication will
     # be added.
     def self.apply(config, http_request)
-      username = config.two_factor_auth_basic_auth_user_name
-      password = config.two_factor_auth_basic_auth_password
+      username = config.multi_factor_auth_basic_auth_user_name
+      password = config.multi_factor_auth_basic_auth_password
       value = Base64.strict_encode64("#{username}:#{password}")
       header_value = "Basic #{value}"
       http_request.headers['Authorization'] = header_value

data/lib/bandwidth/http/faraday_client.rb

@@ -27,7 +27,7 @@ module Bandwidth
                                 methods: retry_methods
         faraday.adapter Faraday.default_adapter
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
-        faraday.options[:timeout] = timeout if timeout > 0
+        faraday.options[:timeout] = timeout if timeout.positive?
       end
     end
 

data/lib/bandwidth/messaging_lib/messaging/client.rb

@@ -16,12 +16,17 @@ module Bandwidth
         end
 
         def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                       backoff_factor: 1, environment: Environment::PRODUCTION,
+                       backoff_factor: 2,
+                       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                       retry_methods: %i[get put get put],
+                       environment: Environment::PRODUCTION,
                        base_url: 'https://www.example.com',
                        messaging_basic_auth_user_name: 'TODO: Replace',
                        messaging_basic_auth_password: 'TODO: Replace',
-                       two_factor_auth_basic_auth_user_name: 'TODO: Replace',
-                       two_factor_auth_basic_auth_password: 'TODO: Replace',
+                       multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                       multi_factor_auth_basic_auth_password: 'TODO: Replace',
+                       phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
+                       phone_number_lookup_basic_auth_password: 'TODO: Replace',
                        voice_basic_auth_user_name: 'TODO: Replace',
                        voice_basic_auth_password: 'TODO: Replace',
                        web_rtc_basic_auth_user_name: 'TODO: Replace',
@@ -32,12 +37,16 @@ module Bandwidth
                                         max_retries: max_retries,
                                         retry_interval: retry_interval,
                                         backoff_factor: backoff_factor,
+                                        retry_statuses: retry_statuses,
+                                        retry_methods: retry_methods,
                                         environment: environment,
                                         base_url: base_url,
                                         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                         messaging_basic_auth_password: messaging_basic_auth_password,
-                                        two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
-                                        two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
+                                        multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
+                                        multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
+                                        phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
+                                        phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
                                         voice_basic_auth_user_name: voice_basic_auth_user_name,
                                         voice_basic_auth_password: voice_basic_auth_password,
                                         web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,