class Wallee::Configuration

Attributes

authentication_key[RW]

Defines the authentication_key used for request authentication.

@return [String]

base_path[R]

Defines url base path

cert_file[RW]
TLS/SSL setting

Client certificate file (for client certificate)

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[R]

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

scheme[R]

Defines url scheme

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).

user_id[RW]

Defines the user_id used for request authentication.

@return [String]

Public Class Methods

default() click to toggle source

The default Configuration object.

# File lib/wallee-ruby-sdk/configuration.rb, line 110
def self.default
  @@default ||= Configuration.new
end
new() { |self| ... } click to toggle source
# File lib/wallee-ruby-sdk/configuration.rb, line 93
def initialize
  @scheme = 'https'
  @host = 'app-wallee.com:443'
  @base_path = '/api'
  @timeout = 0
  @params_encoding = nil
  @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

base_path=(base_path) click to toggle source
# File lib/wallee-ruby-sdk/configuration.rb, line 128
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() click to toggle source
# File lib/wallee-ruby-sdk/configuration.rb, line 134
def base_url
  url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
      Addressable::URI.encode(url)
end
configure() { |self| ... } click to toggle source
# File lib/wallee-ruby-sdk/configuration.rb, line 114
def configure
  yield(self) if block_given?
end
host=(host) click to toggle source
# File lib/wallee-ruby-sdk/configuration.rb, line 123
def host=(host)
  # remove http(s):// and anything after a slash
  @host = host.sub(/https?:\/\//, '').split('/').first
end
scheme=(scheme) click to toggle source
# File lib/wallee-ruby-sdk/configuration.rb, line 118
def scheme=(scheme)
  # remove :// from scheme
  @scheme = scheme.sub(/:\/\//, '')
end