Class: Trulioo::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/trulioo_sdk/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/trulioo_sdk/configuration.rb', line 131

def initialize
  @scheme = 'https'
  @host = 'gateway.trulioo.com'
  @base_path = ''
  @server_index = 0
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = {}
  @api_key_prefix = {}
  @timeout = 0
  @client_side_validation = true
  @ssl_verify = true
  @ssl_verify_mode = nil
  @ssl_ca_file = nil
  @ssl_client_cert = nil
  @ssl_client_key = nil
  @debugging = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



59
60
61
 
# File 'lib/trulioo_sdk/configuration.rb', line 59

def access_token
  @access_token
end

#api_key ⇒ Hash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • (Hash) —

    key: parameter name, value: parameter value (API key)



38
39
40
 
# File 'lib/trulioo_sdk/configuration.rb', line 38

def api_key
  @api_key
end

#api_key_prefix ⇒ Hash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • (Hash) —

    key: parameter name, value: API key prefix



46
47
48
 
# File 'lib/trulioo_sdk/configuration.rb', line 46

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



18
19
20
 
# File 'lib/trulioo_sdk/configuration.rb', line 18

def base_path
  @base_path
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false) 


88
89
90
 
# File 'lib/trulioo_sdk/configuration.rb', line 88

def client_side_validation
  @client_side_validation
end

#debugging ⇒ true, false

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.

Returns:

  • (true, false) 


66
67
68
 
# File 'lib/trulioo_sdk/configuration.rb', line 66

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



129
130
131
 
# File 'lib/trulioo_sdk/configuration.rb', line 129

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



15
16
17
 
# File 'lib/trulioo_sdk/configuration.rb', line 15

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



127
128
129
 
# File 'lib/trulioo_sdk/configuration.rb', line 127

def inject_format
  @inject_format
end

#logger ⇒ #debug

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

Returns:

  • (#debug) 


72
73
74
 
# File 'lib/trulioo_sdk/configuration.rb', line 72

def logger
  @logger
end

#params_encoding ⇒ Object

Set this to customize parameters encoding of array parameter with multi collectionFormat. Default to nil.

github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96

See Also:

  • params_encoding option of Ethon. Related source code:


125
126
127
 
# File 'lib/trulioo_sdk/configuration.rb', line 125

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


56
57
58
 
# File 'lib/trulioo_sdk/configuration.rb', line 56

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



12
13
14
 
# File 'lib/trulioo_sdk/configuration.rb', line 12

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



21
22
23
 
# File 'lib/trulioo_sdk/configuration.rb', line 21

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



24
25
26
 
# File 'lib/trulioo_sdk/configuration.rb', line 24

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



30
31
32
 
# File 'lib/trulioo_sdk/configuration.rb', line 30

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



27
28
29
 
# File 'lib/trulioo_sdk/configuration.rb', line 27

def server_variables
  @server_variables
end

#ssl_ca_file ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

Returns:

  • (String) —

    the path to the certificate file



110
111
112
 
# File 'lib/trulioo_sdk/configuration.rb', line 110

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

TLS/SSL setting Client certificate file (for client certificate)



114
115
116
 
# File 'lib/trulioo_sdk/configuration.rb', line 114

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

TLS/SSL setting Client private key file (for client certificate)



118
119
120
 
# File 'lib/trulioo_sdk/configuration.rb', line 118

def ssl_client_key
  @ssl_client_key
end

#ssl_verify ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server. Default to true.

Returns:

  • (true, false) 


97
98
99
 
# File 'lib/trulioo_sdk/configuration.rb', line 97

def ssl_verify
  @ssl_verify
end

#ssl_verify_mode ⇒ Object

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Any ‘OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)



104
105
106
 
# File 'lib/trulioo_sdk/configuration.rb', line 104

def ssl_verify_mode
  @ssl_verify_mode
end

#temp_folder_path ⇒ String

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

Returns:

  • (String) 


79
80
81
 
# File 'lib/trulioo_sdk/configuration.rb', line 79

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



83
84
85
 
# File 'lib/trulioo_sdk/configuration.rb', line 83

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


51
52
53
 
# File 'lib/trulioo_sdk/configuration.rb', line 51

def username
  @username
end

Class Method Details

.default ⇒ Object

The default Configuration object.



157
158
159
 
# File 'lib/trulioo_sdk/configuration.rb', line 157

def self.default
  @@default ||= Configuration.new
end

Instance Method Details

#api_key_with_prefix(param_name, param_alias = nil) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



191
192
193
194
195
196
197
198
199
 
# File 'lib/trulioo_sdk/configuration.rb', line 191

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 ⇒ Object

Returns Auth Settings hash for api client.



207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/trulioo_sdk/configuration.rb', line 207

def auth_settings
  {
    'ApiKeyAuth' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'x-trulioo-api-key',
        value: api_key_with_prefix('ApiKeyAuth')
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



182
183
184
185
186
187
 
# File 'lib/trulioo_sdk/configuration.rb', line 182

def base_url(operation = nil)
  index = server_operation_index.fetch(operation, server_index)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

  server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



202
203
204
 
# File 'lib/trulioo_sdk/configuration.rb', line 202

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

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

Yields:

  • (_self)

Yield Parameters:



161
162
163
 
# File 'lib/trulioo_sdk/configuration.rb', line 161

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



229
230
231
232
 
# File 'lib/trulioo_sdk/configuration.rb', line 229

def operation_server_settings
  {
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



220
221
222
223
224
225
226
227
 
# File 'lib/trulioo_sdk/configuration.rb', line 220

def server_settings
  [
    {
      url: "https://gateway.trulioo.com",
      description: "No description provided",
    }
  ]
end

#server_url(index, variables = {}, servers = nil) ⇒ Object

Returns URL based on server settings

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/trulioo_sdk/configuration.rb', line 238

def server_url(index, variables = {}, servers = nil)
  servers = server_settings if servers == nil

  # check array index out of bound
  if (index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. 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