class VoucherifySdk::Configuration

Attributes

access_token[RW]

Defines the access token (Bearer) used with OAuth2.

access_token_getter[RW]

Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2. Overrides the access_token if set @return [Proc]

api_key[RW]

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'
api_key_prefix[RW]

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'
base_path[RW]

Defines url base path

cert_file[RW]
TLS/SSL setting

Client certificate file (for client certificate)

client_side_validation[RW]

Set this to false to skip client side validation in the operation. Default to true. @return [true, false]

debugging[RW]

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]

force_ending_format[RW]
host[RW]

Defines url host

inject_format[RW]
key_file[RW]
TLS/SSL setting

Client private key file (for client certificate)

logger[RW]

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

@return [#debug]

params_encoding[RW]

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: github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96

password[RW]

Defines the password used with HTTP basic authentication.

@return [String]

return_binary_data[RW]

Set this to return data as binary instead of downloading a temp file. When enabled (set to true) HTTP responses with return type ‘File` will be returned as a stream of binary data. Default to false.

scheme[RW]

Defines url scheme

server_index[RW]

Define server configuration index

server_operation_index[RW]

Define server operation configuration index

server_operation_variables[RW]

Default server operation variables

server_variables[RW]

Default server variables

ssl_ca_cert[RW]
TLS/SSL setting

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

temp_folder_path[RW]

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

@return [String]

timeout[RW]

The time limit for HTTP request in seconds. Default to 0 (never times out).

username[RW]

Defines the username used with HTTP basic authentication.

@return [String]

verify_ssl[RW]
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]

verify_ssl_host[RW]
TLS/SSL setting

Set this to false to skip verifying SSL host name 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

default() click to toggle source

The default Configuration object.

# File lib/VoucherifySdk/configuration.rb, line 177
def self.default
  @@default ||= Configuration.new
end
new() { |self| ... } click to toggle source
# File lib/VoucherifySdk/configuration.rb, line 151
def initialize
  @scheme = 'https'
  @host = 'api.voucherify.io'
  @base_path = ''
  @server_index = nil
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = {}
  @api_key_prefix = {}
  @client_side_validation = true
  @verify_ssl = true
  @verify_ssl_host = true
  @cert_file = nil
  @key_file = nil
  @timeout = 0
  @params_encoding = 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

access_token_with_refresh() click to toggle source

Gets access_token using access_token_getter or uses the static access_token

# File lib/VoucherifySdk/configuration.rb, line 224
def access_token_with_refresh
  return access_token if access_token_getter.nil?
  access_token_getter.call
end
api_key_with_prefix(param_name, param_alias = nil) click to toggle source

Gets API key (with prefix if set). @param [String] param_name the parameter name of API key auth

# File lib/VoucherifySdk/configuration.rb, line 213
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
auth_settings() click to toggle source

Returns Auth Settings hash for api client.

# File lib/VoucherifySdk/configuration.rb, line 235
def auth_settings
  {
    'X-App-Id' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-App-Id',
        value: api_key_with_prefix('X-App-Id')
      },
    'X-App-Token' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-App-Token',
        value: api_key_with_prefix('X-App-Token')
      },
    'X-Client-Token' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-Client-Token',
        value: api_key_with_prefix('X-Client-Token')
      },
    'X-Client-Application-Id' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-Client-Application-Id',
        value: api_key_with_prefix('X-Client-Application-Id')
      },
    'X-Management-Id' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-Management-Id',
        value: api_key_with_prefix('X-Management-Id')
      },
    'X-Management-Token' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-Management-Token',
        value: api_key_with_prefix('X-Management-Token')
      },
  }
end
base_path=(base_path) click to toggle source
# File lib/VoucherifySdk/configuration.rb, line 195
def base_path=(base_path)
  # Add leading and trailing slashes to base_path
  @base_path = "/#{base_path}".gsub(/\/+/, '/')
  @base_path = '' if @base_path == '/'
end
base_url(operation = nil) click to toggle source

Returns base URL for specified operation based on server settings

# File lib/VoucherifySdk/configuration.rb, line 202
def base_url(operation = nil)
  if operation_server_settings.key?(operation) then
    index = server_operation_index.fetch(operation, server_index)
    server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
  else
    server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
  end
end
basic_auth_token() click to toggle source

Gets Basic Auth token string

# File lib/VoucherifySdk/configuration.rb, line 230
def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end
configure() { |self| ... } click to toggle source
# File lib/VoucherifySdk/configuration.rb, line 181
def configure
  yield(self) if block_given?
end
host=(host) click to toggle source
# File lib/VoucherifySdk/configuration.rb, line 190
def host=(host)
  # remove http(s):// and anything after a slash
  @host = host.sub(/https?:\/\//, '').split('/').first
end
operation_server_settings() click to toggle source
# File lib/VoucherifySdk/configuration.rb, line 306
def operation_server_settings
  {
  }
end
scheme=(scheme) click to toggle source
# File lib/VoucherifySdk/configuration.rb, line 185
def scheme=(scheme)
  # remove :// from scheme
  @scheme = scheme.sub(/:\/\//, '')
end
server_settings() click to toggle source

Returns an array of Server setting

# File lib/VoucherifySdk/configuration.rb, line 283
def server_settings
  [
    {
      url: "https://{cluster}.voucherify.io",
      description: "Base URL",
      variables: {
        cluster: {
            description: "No description provided",
            default_value: "api",
            enum_values: [
              "api",
              "us1.api",
              "as1.api",
              "download",
              "us1.download",
              "as1.download"
            ]
          }
        }
    }
  ]
end
server_url(index, variables = {}, servers = nil) click to toggle source

Returns URL based on server settings

@param index array index of the server settings @param variables hash of variable and the corresponding value

# File lib/VoucherifySdk/configuration.rb, line 315
def server_url(index, variables = {}, servers = nil)
  servers = server_settings if servers == nil

  # check array index out of bound
  if (index.nil? || index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
  end

  server = servers[index]
  url = server[:url]

  return url unless server.key? :variables

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
        url.gsub! "{" + name.to_s + "}", variables[name]
      else
        fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
      end
    else
      # use default value
      url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
    end
  end

  url
end