minato_ruby_api_client 0.2.1 → 0.2.3

data/lib/minato_ruby_api_client/api_error.rb

@@ -1,16 +1,16 @@
-require 'minato_error_handler'
-
-module MinatoRubyApiClient
-  class ApiError < MinatoErrorHandler::Errors::ExternalError
-    attr_reader :status_code
-
-    def initialize(res: nil, req: nil, status_code: 500)
-      super(req: req, res: res)
-      @status_code = status_code
-    end
-
-    def message
-      "An error occurred while communicating with the API."
-    end
-  end
-end
+require 'minato_error_handler'
+
+module MinatoRubyApiClient
+  class ApiError < MinatoErrorHandler::Errors::ExternalError
+    attr_reader :status_code
+
+    def initialize(res: nil, req: nil, status_code: 500)
+      super(req: req, res: res)
+      @status_code = status_code
+    end
+
+    def message
+      "An error occurred while communicating with the API."
+    end
+  end
+end

data/lib/minato_ruby_api_client/configuration.rb

@@ -1,247 +1,247 @@
-module MinatoRubyApiClient
-  class Configuration
-    # Defines url scheme
-    attr_accessor :scheme
-
-    # Defines url host
-    attr_accessor :host
-
-    # Defines url base path
-    attr_accessor :base_path
-
-    # Defines user agent
-    attr_accessor :user_agent
-
-    # Defines API keys used with API Key authentications.
-    #
-    # @return [Hash] key: parameter name, value: parameter value (API key)
-    #
-    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
-    #   config.api_key['api_key'] = 'xxx'
-    attr_accessor :api_key
-
-    # Defines API key prefixes used with API Key authentications.
-    #
-    # @return [Hash] key: parameter name, value: API key prefix
-    #
-    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
-    #   config.api_key_prefix['api_key'] = 'Token'
-    attr_accessor :api_key_prefix
-
-    # Defines the username used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :username
-
-    # Defines the password used with HTTP basic authentication.
-    #
-    # @return [String]
-    attr_accessor :password
-
-    # Defines the access token (Bearer) used with OAuth2.
-    attr_accessor :access_token
-
-    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
-    # details will be logged with `logger.debug` (see the `logger` attribute).
-    # Default to false.
-    #
-    # @return [true, false]
-    attr_accessor :debugging
-
-    # Defines the logger used for debugging.
-    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
-    #
-    # @return [#debug]
-    attr_accessor :logger
-
-    # Defines the temporary folder to store downloaded files
-    # (for API endpoints that have file response).
-    # Default to use `Tempfile`.
-    #
-    # @return [String]
-    attr_accessor :temp_folder_path
-
-    # The time limit for HTTP request in seconds.
-    # Default to 0 (never times out).
-    attr_accessor :timeout
-
-    # Set this to false to skip client side validation in the operation.
-    # Default to true.
-    # @return [true, false]
-    attr_accessor :client_side_validation
-
-    ### TLS/SSL setting
-    # Set this to false to skip verifying SSL certificate when calling API from https server.
-    # Default to true.
-    #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
-    # @return [true, false]
-    attr_accessor :ssl_verify
-
-    ### TLS/SSL setting
-    # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
-    #
-    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
-    #
-    attr_accessor :ssl_verify_mode
-
-    ### TLS/SSL setting
-    # Set this to customize the certificate file to verify the peer.
-    #
-    # @return [String] the path to the certificate file
-    attr_accessor :ssl_ca_file
-
-    ### TLS/SSL setting
-    # Client certificate file (for client certificate)
-    attr_accessor :ssl_client_cert
-
-    ### TLS/SSL setting
-    # Client private key file (for client certificate)
-    attr_accessor :ssl_client_key
-
-    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
-    # Default to nil.
-    #
-    # @see The params_encoding option of Ethon. Related source code:
-    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
-    attr_accessor :params_encoding
-
-    def initialize
-      @scheme = 'https'
-      @host = ''
-      @base_path = ''
-      @user_agent = ''
-      @subscription_key = ''
-      @api_key = {}
-      @api_key_prefix = {}
-      @client_side_validation = true
-      @ssl_verify = true
-      @ssl_verify_mode = nil
-      @ssl_ca_file = nil
-      @ssl_client_cert = nil
-      @ssl_client_key = nil
-      @middlewares = []
-      @request_middlewares = []
-      @response_middlewares = []
-      @timeout = 60
-      @debugging = false
-      @logger = Object.const_defined?(:Rails) ? Rails.logger : Logger.new(STDOUT)
-
-      yield(self) if block_given?
-    end
-
-    # The default Configuration object.
-    def self.default
-      @@default ||= Configuration.new
-    end
-
-    def configure
-      yield(self) if block_given?
-    end
-
-    def scheme=(scheme)
-      # remove :// from scheme
-      @scheme = scheme.sub(/:\/\//, '')
-    end
-
-    def host=(host)
-      # remove http(s):// and anything after a slash
-      @host = host.sub(/https?:\/\//, '').split('/').first
-    end
-
-    def base_path=(base_path)
-      # Add leading and trailing slashes to base_path
-      @base_path = "/#{base_path}".gsub(/\/+/, '/')
-      @base_path = '' if @base_path == '/'
-    end
-
-    # Returns base URL
-    def base_url
-      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-    end
-
-    def debugging
-      return @debugging if @debugging == true
-      ENV['MINATO_RUBY_API_CLIENT_DEBUG'] == 'true'
-    end
-
-    # Gets API key (with prefix if set).
-    # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name, param_alias = nil)
-      key = @api_key[param_name]
-      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
-      if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{key}"
-      else
-        key
-      end
-    end
-
-    # Gets Basic Auth token string
-    def basic_auth_token
-      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
-    end
-
-    # Returns Auth Settings hash for api client.
-    def auth_settings
-      auth_settings = {
-        'bearer_auth' =>
-          {
-            type: 'bearer',
-            in: 'header',
-            key: 'Authorization',
-            value: "Bearer #{access_token}"
-          },
-        'basic_auth' =>
-          {
-            type: 'basic',
-            in: 'header',
-            key: 'Authorization',
-            value: basic_auth_token
-          },
-      }
-
-      api_key.each do |k, v|
-        auth_settings['apikey'] = {
-          type: 'apikey',
-          in: 'header',
-          key: k,
-          value: api_key_with_prefix(k)
-        }
-      end
-
-      auth_settings
-    end
-
-    # Adds middleware to the stack
-    def use(*middleware)
-      @middlewares << middleware
-    end
-
-    # Adds request middleware to the stack
-    def request(*middleware)
-      @request_middlewares << middleware
-    end
-
-    # Adds response middleware to the stack
-    def response(*middleware)
-      @response_middlewares << middleware
-    end
-
-    # Set up middleware on the connection
-    def configure_middleware(connection)
-      @middlewares.each do |middleware|
-        connection.use(*middleware)
-      end
-
-      @request_middlewares.each do |middleware|
-        connection.request(*middleware)
-      end
-
-      @response_middlewares.each do |middleware|
-        connection.response(*middleware)
-      end
-    end
-  end
-end
+module MinatoRubyApiClient
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines user agent
+    attr_accessor :user_agent
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :ssl_verify
+
+    ### TLS/SSL setting
+    # Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    attr_accessor :ssl_verify_mode
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    attr_accessor :ssl_ca_file
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :ssl_client_cert
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :ssl_client_key
+
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+    def initialize
+      @scheme = 'https'
+      @host = ''
+      @base_path = ''
+      @user_agent = ''
+      @subscription_key = ''
+      @api_key = {}
+      @api_key_prefix = {}
+      @client_side_validation = true
+      @ssl_verify = true
+      @ssl_verify_mode = nil
+      @ssl_ca_file = nil
+      @ssl_client_cert = nil
+      @ssl_client_key = nil
+      @middlewares = []
+      @request_middlewares = []
+      @response_middlewares = []
+      @timeout = 60
+      @debugging = false
+      @logger = Object.const_defined?(:Rails) ? Rails.logger : Logger.new(STDOUT)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    # Returns base URL
+    def base_url
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    end
+
+    def debugging
+      return @debugging if @debugging == true
+      ENV['MINATO_RUBY_API_CLIENT_DEBUG'] == 'true'
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{key}"
+      else
+        key
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      auth_settings = {
+        'bearer_auth' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token}"
+          },
+        'basic_auth' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
+      }
+
+      api_key.each do |k, v|
+        auth_settings['apikey'] = {
+          type: 'apikey',
+          in: 'header',
+          key: k,
+          value: api_key_with_prefix(k)
+        }
+      end
+
+      auth_settings
+    end
+
+    # Adds middleware to the stack
+    def use(*middleware)
+      @middlewares << middleware
+    end
+
+    # Adds request middleware to the stack
+    def request(*middleware)
+      @request_middlewares << middleware
+    end
+
+    # Adds response middleware to the stack
+    def response(*middleware)
+      @response_middlewares << middleware
+    end
+
+    # Set up middleware on the connection
+    def configure_middleware(connection)
+      @middlewares.each do |middleware|
+        connection.use(*middleware)
+      end
+
+      @request_middlewares.each do |middleware|
+        connection.request(*middleware)
+      end
+
+      @response_middlewares.each do |middleware|
+        connection.response(*middleware)
+      end
+    end
+  end
+end

data/lib/minato_ruby_api_client/version.rb

@@ -1,3 +1,3 @@
-module MinatoRubyApiClient
-  VERSION = '0.2.1'
-end
+module MinatoRubyApiClient
+  VERSION = '0.2.3'
+end

data/lib/minato_ruby_api_client.rb

@@ -1,24 +1,24 @@
-# Common files
-require 'minato_ruby_api_client/api_client'
-require 'minato_ruby_api_client/api_error'
-require 'minato_ruby_api_client/version'
-require 'minato_ruby_api_client/configuration'
-
-
-module MinatoRubyApiClient
-  class << self
-    # Customize default settings for the SDK using block.
-    #   MinatoRubyApiClient.configure do |config|
-    #     config.username = "xxx"
-    #     config.password = "xxx"
-    #   end
-    # If no block given, return the default Configuration object.
-    def configure
-      if block_given?
-        yield(Configuration.default)
-      else
-        Configuration.default
-      end
-    end
-  end
-end
+# Common files
+require 'minato_ruby_api_client/api_client'
+require 'minato_ruby_api_client/api_error'
+require 'minato_ruby_api_client/version'
+require 'minato_ruby_api_client/configuration'
+
+
+module MinatoRubyApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   MinatoRubyApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/minato_ruby_api_client.gemspec

@@ -1,35 +1,35 @@
-# -*- encoding: utf-8 -*-
-
-=begin
-# Minato Ruby Api Client
-
-The Minato ruby HTTP Client
-
-=end
-
-$:.push File.expand_path("../lib", __FILE__)
-require "minato_ruby_api_client/version"
-
-Gem::Specification.new do |s|
-  s.name        = "minato_ruby_api_client"
-  s.version     = MinatoRubyApiClient::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Ferreri"]
-  s.email       = ["support@ferreri.co"]
-  s.homepage    = "http://ferreri.co"
-  s.summary     = "A Minato ruby HTTP Client"
-  s.description = "Minato HTTP Client"
-  s.license     = "unlicense"
-  s.required_ruby_version = ">= 3.0"
-
-  s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
-  s.add_runtime_dependency 'minato_error_handler', '~> 0.1.9-1'
-  s.add_runtime_dependency 'minato-trace', '~> 0.1.6-8'
-
-  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
-
-  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
-  s.test_files    = `find spec/*`.split("\n")
-  s.executables   = []
-  s.require_paths = ["lib"]
-end
+# -*- encoding: utf-8 -*-
+
+=begin
+# Minato Ruby Api Client
+
+The Minato ruby HTTP Client
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "minato_ruby_api_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "minato_ruby_api_client"
+  s.version     = MinatoRubyApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ferreri"]
+  s.email       = ["support@ferreri.co"]
+  s.homepage    = "http://ferreri.co"
+  s.summary     = "A Minato ruby HTTP Client"
+  s.description = "Minato HTTP Client"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 3.0"
+
+  s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'minato_error_handler', '~> 0.1.12'
+  s.add_runtime_dependency 'minato-trace', '~> 0.2.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end