class DocuSign_eSign::Configuration

Attributes

access_token[RW]

Defines the access token (Bearer) used with OAuth2.

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)

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]

scheme[RW]

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

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/docusign_esign/configuration.rb, line 146
def self.default
  @@default ||= Configuration.new
end

new() { |self| ... } click to toggle source

# File lib/docusign_esign/configuration.rb, line 125
def initialize
  @scheme = 'https'
  @host = 'www.docusign.net'
  @base_path = '/restapi'
  @api_key = {}
  @api_key_prefix = {}
  @timeout = 0
  @verify_ssl = true
  @verify_ssl_host = true
  @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

api_key_with_prefix(param_name) click to toggle source

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

# File lib/docusign_esign/configuration.rb, line 177
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

auth_settings() click to toggle source

Returns Auth Settings hash for api client.

# File lib/docusign_esign/configuration.rb, line 191
def auth_settings
  {
    'docusignAccessCode' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
  }
end

base_path=(base_path) click to toggle source

# File lib/docusign_esign/configuration.rb, line 164
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/docusign_esign/configuration.rb, line 170
def base_url
  url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
  Addressable::URI.encode(url)
end

basic_auth_token() click to toggle source

Gets Basic Auth token string

# File lib/docusign_esign/configuration.rb, line 186
def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

configure() { |self| ... } click to toggle source

# File lib/docusign_esign/configuration.rb, line 150
def configure
  yield(self) if block_given?
end

host=(host) click to toggle source

# File lib/docusign_esign/configuration.rb, line 159
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/docusign_esign/configuration.rb, line 154
def scheme=(scheme)
  # remove :// from scheme
  @scheme = scheme.sub(/:\/\//, '')
end