Module: HelloSign::Configuration

Included in:
HelloSign
Defined in:
lib/hello_sign/configuration.rb

Overview

Defines config attributes and default values for HelloSign module

Author:

  • hellosign

Constant Summary collapse

DEFAULT_ENDPOINT =
'https://api.hellosign.com'
DEFAULT_API_VERSION =
'/v3'
DEFAULT_OAUTH_ENDPOINT =
'https://app.hellosign.com'
VALID_OPTIONS_KEYS =
[:end_point, :oauth_end_point, :api_version, :user_agent, :client_id, :client_secret, :email_address, :password, :api_key, :auth_token, :log_level, :logging, :proxy_uri, :proxy_user, :proxy_pass, :timeout]
DEFAULT_USER_AGENT =
"hellosign-ruby-sdk/" + HelloSign::VERSION

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object

Sets all configuration options to their default values when this module is extended.

Parameters:

  • base (Object)

    New module or class extends this module


42
43
44
# File 'lib/hello_sign/configuration.rb', line 42

def self.extended(base)
  base.reset
end

Instance Method Details

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

Convenience method to allow configuration options to be set in a block.

Yields:

  • (_self)

Yield Parameters:


47
48
49
# File 'lib/hello_sign/configuration.rb', line 47

def configure
  yield self
end

#optionsObject

Creates a hash of options


52
53
54
55
56
# File 'lib/hello_sign/configuration.rb', line 52

def options
  VALID_OPTIONS_KEYS.inject({}) do |option, key|
    option.merge!(key => send(key))
  end
end

#resetObject

Resets all configuration options to the defaults.


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/hello_sign/configuration.rb', line 59

def reset
  self.email_address = nil
  self.client_id = nil
  self.client_secret = nil
  self.auth_token = nil
  self.password = nil
  self.api_key = nil
  self.end_point = DEFAULT_ENDPOINT
  self.oauth_end_point = DEFAULT_OAUTH_ENDPOINT
  self.api_version = DEFAULT_API_VERSION
  self.user_agent = DEFAULT_USER_AGENT
  self.log_level = 3
  self.logging = true
  self.proxy_uri = nil
  self.proxy_user = nil
  self.proxy_pass = nil
  self.timeout = nil
end