bandwidth-sdk 2.2.2 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a0d3a06b7e019a1602f4a796f096c7ac408e66395b10ff9088f26393c028acf
-  data.tar.gz: 67d9cfdf43befba134e4dabc3abddc1317821db91d0ac18c9d2a92456da270d8
+  metadata.gz: 7589bdf9914178c33cc9928e5ef7aa125787264250cc0dbe94de6ebd9cc4c728
+  data.tar.gz: 19fe33d12e403fe6d0528591d8a5e9ad4a631b4bb4707f8f9f75de110e21ce04
 SHA512:
-  metadata.gz: 94fef92c336e12b4c6bcfc29b51048fbd5f00493ce1868c4baaf539f58f89b5024bc65bc8426aac36eae1c0c04930234e4ed57878bd7d049a719a6b8c96f05e9
-  data.tar.gz: 5d058ccd30dc7b4efa01397d346247a75d81101da1e981d011f00ec437c1e7d12e97651462111861880135e7c56e776a369a11fd7c6b90712038645dbf19f5b3
+  metadata.gz: 4729d4bfc676472e949007c92b09b07dae9d14c6c1376e70980eb9455d666620984eb089a02d17105f8dde864579a633136fa47a77beb3a43f8a3a42ee0844e9
+  data.tar.gz: dd15b63a5fb1cb3b6b23d1a912d5f7878c37fd9375f08eee00d190ca6ce9f95e05c67b7aa30adabb9aa77883bfeb652174aa6b1d6eedbba4d7c9cdc44d22d7ee

data/lib/bandwidth.rb

@@ -35,8 +35,9 @@ require_relative 'bandwidth/configuration.rb'
 # Namespaces
 require_relative 'bandwidth/messaging_lib/messaging'
 require_relative 'bandwidth/http/auth/messaging_basic_auth.rb'
+require_relative 'bandwidth/two_factor_auth_lib/two_factor_auth'
+require_relative 'bandwidth/http/auth/two_factor_auth_basic_auth.rb'
 require_relative 'bandwidth/voice_lib/voice'
 require_relative 'bandwidth/http/auth/voice_basic_auth.rb'
 
-
 # Controllers

data/lib/bandwidth/client.rb

@@ -12,6 +12,11 @@ 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)
+    end
     # Access to voice_client controller.
     # @return [Voice::Client] Returns the client instance.
     def voice_client
@@ -22,6 +27,8 @@ module Bandwidth
                    backoff_factor: 1, environment: Environment::PRODUCTION,
                    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',
                    voice_basic_auth_user_name: 'TODO: Replace',
                    voice_basic_auth_password: 'TODO: Replace', config: nil)
       @config = if config.nil?
@@ -31,6 +38,8 @@ module Bandwidth
                                     environment: environment,
                                     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,
                                     voice_basic_auth_user_name: voice_basic_auth_user_name,
                                     voice_basic_auth_password: voice_basic_auth_password)
                 else

data/lib/bandwidth/configuration.rb

@@ -16,6 +16,7 @@ module Bandwidth
     SERVER = [
       DEFAULT = 'default'.freeze,
       MESSAGINGDEFAULT = 'MessagingDefault'.freeze,
+      TWOFACTORAUTHDEFAULT = 'TwoFactorAuthDefault'.freeze,
       VOICEDEFAULT = 'VoiceDefault'.freeze
     ].freeze
   end
@@ -32,6 +33,8 @@ module Bandwidth
     attr_reader :environment
     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 :voice_basic_auth_user_name
     attr_reader :voice_basic_auth_password
 
@@ -43,6 +46,8 @@ module Bandwidth
                    backoff_factor: 1, environment: Environment::PRODUCTION,
                    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',
                    voice_basic_auth_user_name: 'TODO: Replace',
                    voice_basic_auth_password: 'TODO: Replace')
       # The value to use for connection timeout
@@ -59,7 +64,7 @@ module Bandwidth
       @backoff_factor = backoff_factor
 
       # Current API environment
-      @environment = environment
+      @environment = String(environment)
 
       # The username to use with basic authentication
       @messaging_basic_auth_user_name = messaging_basic_auth_user_name
@@ -67,6 +72,12 @@ module Bandwidth
       # The password to use with basic authentication
       @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
+
+      # The password to use with basic authentication
+      @two_factor_auth_basic_auth_password = two_factor_auth_basic_auth_password
+
       # The username to use with basic authentication
       @voice_basic_auth_user_name = voice_basic_auth_user_name
 
@@ -81,6 +92,8 @@ module Bandwidth
                    backoff_factor: nil, environment: 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,
                    voice_basic_auth_user_name: nil,
                    voice_basic_auth_password: nil)
       timeout ||= self.timeout
@@ -90,6 +103,8 @@ module Bandwidth
       environment ||= self.environment
       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
       voice_basic_auth_user_name ||= self.voice_basic_auth_user_name
       voice_basic_auth_password ||= self.voice_basic_auth_password
 
@@ -99,6 +114,8 @@ module Bandwidth
         environment: environment,
         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,
         voice_basic_auth_user_name: voice_basic_auth_user_name,
         voice_basic_auth_password: voice_basic_auth_password
       )
@@ -111,20 +128,21 @@ module Bandwidth
     end
 
     # All the environments the SDK can run in.
-    @environments = {
+    ENVIRONMENTS = {
       Environment::PRODUCTION => {
         Server::DEFAULT => 'api.bandwidth.com',
         Server::MESSAGINGDEFAULT => 'https://messaging.bandwidth.com/api/v2',
+        Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1/',
         Server::VOICEDEFAULT => 'https://voice.bandwidth.com'
       }
-    }
+    }.freeze
 
     # Generates the appropriate base URI for the environment and the server.
     # @param [Configuration::Server] The server enum for which the base URI is
     # required.
     # @return [String] The base URI.
     def get_base_uri(server = Server::DEFAULT)
-      self.class.environments[environment][server].clone
+      ENVIRONMENTS[environment][server].clone
     end
   end
 end

data/lib/bandwidth/http/auth/two_factor_auth_basic_auth.rb

@@ -0,0 +1,22 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module Bandwidth
+  # Utility class for basic authorization.
+  class TwoFactorAuthBasicAuth
+    # 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
+      value = Base64.strict_encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers['Authorization'] = header_value
+    end
+  end
+end

data/lib/bandwidth/messaging_lib/messaging.rb

@@ -7,7 +7,6 @@
 require_relative 'messaging/client.rb'
 
 # Models
-require_relative 'messaging/models/field_error.rb'
 require_relative 'messaging/models/media.rb'
 require_relative 'messaging/models/tag.rb'
 require_relative 'messaging/models/deferred_result.rb'
@@ -16,8 +15,7 @@ require_relative 'messaging/models/bandwidth_message.rb'
 require_relative 'messaging/models/message_request.rb'
 
 # Exceptions
-require_relative 'messaging/exceptions/generic_client_exception.rb'
-require_relative 'messaging/exceptions/path_client_exception.rb'
+require_relative 'messaging/exceptions/messaging_exception.rb'
 # Controllers
 require_relative 'messaging/controllers/base_controller.rb'
 require_relative 'messaging/controllers/api_controller.rb'

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

@@ -19,6 +19,8 @@ module Bandwidth
                        backoff_factor: 1, environment: Environment::PRODUCTION,
                        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',
                        voice_basic_auth_user_name: 'TODO: Replace',
                        voice_basic_auth_password: 'TODO: Replace', config: nil)
           @config = if config.nil?
@@ -29,6 +31,8 @@ module Bandwidth
                                         environment: environment,
                                         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,
                                         voice_basic_auth_user_name: voice_basic_auth_user_name,
                                         voice_basic_auth_password: voice_basic_auth_password)
                     else

data/lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb

@@ -11,59 +11,6 @@ module Messaging
       super(config, http_call_back: http_call_back)
     end
 
-    # getMessage
-    # @return [void] response from the API call
-    def get_message
-      # Prepare query url.
-      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/ping'
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url
-      )
-      MessagingBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
-        raise GenericClientException.new(
-          '400 Request is malformed or invalid',
-          _response
-        )
-      elsif _response.status_code == 401
-        raise PathClientException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      elsif _response.status_code == 403
-        raise PathClientException.new(
-          '403 The user does not have access to this API',
-          _response
-        )
-      elsif _response.status_code == 404
-        raise PathClientException.new(
-          '404 Path not found',
-          _response
-        )
-      elsif _response.status_code == 415
-        raise GenericClientException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      elsif _response.status_code == 429
-        raise GenericClientException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      end
-      validate_response(_response)
-
-      # Return appropriate response type.
-      ApiResponse.new(_response)
-    end
-
     # listMedia
     # @param [String] user_id Required parameter: Example:
     # @param [String] continuation_token Optional parameter: Example:
@@ -95,32 +42,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -158,32 +105,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -246,32 +193,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -307,32 +254,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -375,32 +322,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )