class Supportify::Configuration
Attributes
Defines the access token (Bearer) used with OAuth2.
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'
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'
Defines url base path
Client certificate file (for client certificate)
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]
Defines url host
Client private key file (for client certificate)
Defines the logger used for debugging. Default to `Rails.logger` (when in Rails) or logging to STDOUT.
@return [#debug]
Defines the password used with HTTP basic authentication.
@return [String]
Defines url scheme
Set this to customize the certificate file to verify the peer.
@return [String] the path to the certificate file
@see The `cainfo` option of Typhoeus, `–cert` option of libcurl. Related source code: github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use `Tempfile`.
@return [String]
The time limit for HTTP request in seconds. Default to 0 (never times out).
Defines the username used with HTTP basic authentication.
@return [String]
TLS/SSL
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]
Public Class Methods
The default Configuration
object.
# File lib/supportify_client/configuration.rb, line 113 def self.default @@default ||= Configuration.new end
# File lib/supportify_client/configuration.rb, line 94 def initialize @scheme = 'https' @host = 'api.supportify.io' @base_path = '/v3' @api_key = {} @api_key_prefix = {} @timeout = 0 @verify_ssl = true @cert_file = nil @key_file = nil @debugging = false @inject_format = false @force_ending_format = false @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT) yield(self) if block_given? end
Public Instance Methods
# File lib/supportify_client/configuration.rb, line 161 def account_api_key @api_key['X-SUPPORTIFY-APIKEY'] end
# File lib/supportify_client/configuration.rb, line 157 def account_api_key=(value) @api_key['X-SUPPORTIFY-APIKEY'] = value end
Gets API key (with prefix if set). @param [String] param_name the parameter name of API key auth
# File lib/supportify_client/configuration.rb, line 144 def api_key_with_prefix(param_name) if @api_key_prefix[param_name] "#{@api_key_prefix[param_name]} #{@api_key[param_name]}" else @api_key[param_name] end end
# File lib/supportify_client/configuration.rb, line 169 def application_api_key @api_key['X-SUPPORTIFY-APPKEY'] end
# File lib/supportify_client/configuration.rb, line 165 def application_api_key=(value) @api_key['X-SUPPORTIFY-APPKEY'] = value end
Returns Auth Settings hash for api client.
# File lib/supportify_client/configuration.rb, line 174 def auth_settings { 'app_key' => { type: 'api_key', in: 'header', key: 'X-SUPPORTIFY-APPKEY', value: api_key_with_prefix('X-SUPPORTIFY-APPKEY') }, 'api_key' => { type: 'api_key', in: 'header', key: 'X-SUPPORTIFY-APIKEY', value: api_key_with_prefix('X-SUPPORTIFY-APIKEY') }, } end
# File lib/supportify_client/configuration.rb, line 131 def base_path=(base_path) # Add leading and trailing slashes to base_path @base_path = "/#{base_path}".gsub(/\/+/, '/') @base_path = "" if @base_path == "/" end
# File lib/supportify_client/configuration.rb, line 137 def base_url url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') URI.encode(url) end
Gets Basic Auth token string
# File lib/supportify_client/configuration.rb, line 153 def basic_auth_token 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n") end
# File lib/supportify_client/configuration.rb, line 117 def configure yield(self) if block_given? end
# File lib/supportify_client/configuration.rb, line 126 def host=(host) # remove http(s):// and anything after a slash @host = host.sub(/https?:\/\//, '').split('/').first end
# File lib/supportify_client/configuration.rb, line 121 def scheme=(scheme) # remove :// from scheme @scheme = scheme.sub(/:\/\//, '') end