Module: DocusignRest::Configuration

Included in:
DocusignRest
Defined in:
lib/docusign_rest/configuration.rb

Constant Summary collapse

VALID_CONNECTION_KEYS = 
[:endpoint, :api_version, :user_agent, :method].freeze
VALID_OPTIONS_KEYS = 
[:access_token, :username, :password, :integrator_key, :account_id, :format, :ca_file].freeze
VALID_CONFIG_KEYS = 
VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
DEFAULT_ENDPOINT = 
'https://demo.docusign.net/restapi'
DEFAULT_API_VERSION = 
'v2'
DEFAULT_USER_AGENT = 
"DocusignRest API Ruby Gem #{DocusignRest::VERSION}".freeze
DEFAULT_METHOD = 
:get
DEFAULT_ACCESS_TOKEN = 
nil
DEFAULT_USERNAME = 
nil
DEFAULT_PASSWORD = 
nil
DEFAULT_INTEGRATOR_KEY = 
nil
DEFAULT_ACCOUNT_ID = 
nil
DEFAULT_CA_FILE =

often found at: ‘/etc/ssl/certs/cert.pem’

nil
DEFAULT_FORMAT = 
:json

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object

Make sure we have the default values set when we get ‘extended’



26
27
28
 
# File 'lib/docusign_rest/configuration.rb', line 26

def self.extended(base)
  base.reset
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Allow configuration via a block

Yields:

  • (_self)

Yield Parameters:



45
46
47
 
# File 'lib/docusign_rest/configuration.rb', line 45

def configure
  yield self
end

#options ⇒ Object 



49
50
51
 
# File 'lib/docusign_rest/configuration.rb', line 49

def options
  Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
end

#reset ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/docusign_rest/configuration.rb', line 30

def reset
  self.endpoint       = DEFAULT_ENDPOINT
  self.api_version    = DEFAULT_API_VERSION
  self.user_agent     = DEFAULT_USER_AGENT
  self.method         = DEFAULT_METHOD
  self.access_token   = DEFAULT_ACCESS_TOKEN
  self.username       = DEFAULT_USERNAME
  self.password       = DEFAULT_PASSWORD
  self.integrator_key = DEFAULT_INTEGRATOR_KEY
  self.     = DEFAULT_ACCOUNT_ID
  self.format         = DEFAULT_FORMAT
  self.ca_file        = DEFAULT_CA_FILE
end