Class: Onfido::Configuration

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

Constant Summary collapse

REGIONS = 
{
  EU: 'eu',
  CA: 'ca',
  US: 'us'
}.freeze

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:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/onfido/configuration.rb', line 166

def initialize
  @scheme = 'https'
  @host = 'api.eu.onfido.com'
  @base_path = '/v3.6'
  @server_index = nil
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = {}
  @api_key_prefix = {}
  @client_side_validation = true
  @ssl_verify = true
  @ssl_verify_mode = nil
  @ssl_ca_file = nil
  @ssl_client_cert = nil
  @ssl_client_key = nil
  @middlewares = Hash.new { |h, k| h[k] = [] }
  @configure_connection_blocks = []
  @timeout = 30
  # return data as binary instead of file
  @return_binary_data = false
  @params_encoder = nil
  @debugging = false
  @ignore_operation_servers = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)

  use( Faraday::FollowRedirects::Middleware ) 

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



71
72
73
 
# File 'lib/onfido/configuration.rb', line 71

def access_token
  @access_token
end

#access_token_getter ⇒ Proc

Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2. Overrides the access_token if set

Returns:

  • (Proc) 


76
77
78
 
# File 'lib/onfido/configuration.rb', line 76

def access_token_getter
  @access_token_getter
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)



50
51
52
 
# File 'lib/onfido/configuration.rb', line 50

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



58
59
60
 
# File 'lib/onfido/configuration.rb', line 58

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



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

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) 


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

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) 


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

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



164
165
166
 
# File 'lib/onfido/configuration.rb', line 164

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



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

def host
  @host
end

#ignore_operation_servers ⇒ true, false

Set this to ignore operation servers for the API client. This is useful when you need to send requests to a different server than the one specified in the OpenAPI document. Will default to the base url defined in the spec but can be overridden by setting ‘scheme`, `host`, `base_path` directly. Default to false.

Returns:

  • (true, false) 


96
97
98
 
# File 'lib/onfido/configuration.rb', line 96

def ignore_operation_servers
  @ignore_operation_servers
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



162
163
164
 
# File 'lib/onfido/configuration.rb', line 162

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) 


102
103
104
 
# File 'lib/onfido/configuration.rb', line 102

def logger
  @logger
end

#params_encoder ⇒ Object

Set this to customize parameters encoder of array parameter. Default to nil. Faraday uses NestedParamsEncoder when nil.

github.com/lostisland/faraday/tree/main/lib/faraday/encoders

See Also:

  • params_encoder option of Faraday. Related source code:


159
160
161
 
# File 'lib/onfido/configuration.rb', line 159

def params_encoder
  @params_encoder
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


68
69
70
 
# File 'lib/onfido/configuration.rb', line 68

def password
  @password
end

#proxy ⇒ Object

Proxy setting HTTP Proxy settings



152
153
154
 
# File 'lib/onfido/configuration.rb', line 152

def proxy
  @proxy
end

#return_binary_data ⇒ Object

Set this to return data as binary instead of downloading a temp file. When enabled (set to true) HTTP responses with return type ‘File` will be returned as a stream of binary data. Default to false.



81
82
83
 
# File 'lib/onfido/configuration.rb', line 81

def return_binary_data
  @return_binary_data
end

#scheme ⇒ Object

Defines url scheme



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

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



33
34
35
 
# File 'lib/onfido/configuration.rb', line 33

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



36
37
38
 
# File 'lib/onfido/configuration.rb', line 36

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



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

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



39
40
41
 
# File 'lib/onfido/configuration.rb', line 39

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



140
141
142
 
# File 'lib/onfido/configuration.rb', line 140

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

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



144
145
146
 
# File 'lib/onfido/configuration.rb', line 144

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

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



148
149
150
 
# File 'lib/onfido/configuration.rb', line 148

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) 


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

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)



134
135
136
 
# File 'lib/onfido/configuration.rb', line 134

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) 


109
110
111
 
# File 'lib/onfido/configuration.rb', line 109

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



113
114
115
 
# File 'lib/onfido/configuration.rb', line 113

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


63
64
65
 
# File 'lib/onfido/configuration.rb', line 63

def username
  @username
end

Class Method Details

.default ⇒ Object

The default Configuration object.



200
201
202
 
# File 'lib/onfido/configuration.rb', line 200

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

Instance Method Details

#access_token_with_refresh ⇒ Object

Gets access_token using access_token_getter or uses the static access_token



265
266
267
268
 
# File 'lib/onfido/configuration.rb', line 265

def access_token_with_refresh
  return access_token if access_token_getter.nil?
  access_token_getter.call
end

#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



254
255
256
257
258
259
260
261
262
 
# File 'lib/onfido/configuration.rb', line 254

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

#api_token=(api_token) ⇒ Object 



235
236
237
 
# File 'lib/onfido/configuration.rb', line 235

def api_token=(api_token)
  @api_key = {'Token' => "Token token=#{api_token}"}
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/onfido/configuration.rb', line 276

def auth_settings
  {
    'Token' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Authorization',
        value: api_key_with_prefix('Token')
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



225
226
227
228
229
230
231
232
233
 
# File 'lib/onfido/configuration.rb', line 225

def base_url(operation = nil)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
  if operation_server_settings.key?(operation) then
    index = server_operation_index.fetch(operation, server_index)
    server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
  else
    server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
  end
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



271
272
273
 
# File 'lib/onfido/configuration.rb', line 271

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

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

Yields:

  • (_self)

Yield Parameters:



204
205
206
 
# File 'lib/onfido/configuration.rb', line 204

def configure
  yield(self) if block_given?
end

#configure_connection(conn) ⇒ Object 



368
369
370
371
372
 
# File 'lib/onfido/configuration.rb', line 368

def configure_connection(conn)
  @configure_connection_blocks.each do |block|
    block.call(conn)
  end
end

#configure_faraday_connection(&block) ⇒ Object

Configure Faraday connection directly.

“‘ c.configure_faraday_connection do |conn|

conn.use Faraday::HttpCache, shared_cache: false, logger: logger
conn.response :logger, nil, headers: true, bodies: true, log_level: :debug do |logger|
  logger.filter(/(Authorization: )(.*)/, '\1[REDACTED]')
end

end

c.configure_faraday_connection do |conn|

conn.adapter :typhoeus

end “‘

Parameters:

  • block (Proc) —

    ‘#call`able object that takes one arg, the connection



364
365
366
 
# File 'lib/onfido/configuration.rb', line 364

def configure_faraday_connection(&block)
  @configure_connection_blocks << block
end

#configure_middleware(connection) ⇒ Object

Set up middleware on the connection



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/onfido/configuration.rb', line 411

def configure_middleware(connection)
  return if @middlewares.empty?

  [:request, :response, :use, :insert, :insert_before, :insert_after, :swap].each do |operation|
    next unless @middlewares.key?(operation)

    @middlewares[operation].each do |key, args, block|
      connection.builder.send(operation, key, *args, &block)
    end
  end

  if @middlewares.key?(:delete)
    @middlewares[:delete].each do |key, _args, _block|
      connection.builder.delete(key)
    end
  end
end

#operation_server_settings ⇒ Object 



309
310
311
312
 
# File 'lib/onfido/configuration.rb', line 309

def operation_server_settings
  {
  }
end

#region ⇒ Object 



239
240
241
 
# File 'lib/onfido/configuration.rb', line 239

def region()
  REGIONS
end

#region=(region) ⇒ Object 



243
244
245
246
 
# File 'lib/onfido/configuration.rb', line 243

def region=(region)
  @server_index = 0
  server_variables[:region] = region
end

#request(*middleware) ⇒ Object

Adds request middleware to the stack



380
381
382
 
# File 'lib/onfido/configuration.rb', line 380

def request(*middleware)
  set_faraday_middleware(:request, *middleware)
end

#response(*middleware) ⇒ Object

Adds response middleware to the stack



385
386
387
 
# File 'lib/onfido/configuration.rb', line 385

def response(*middleware)
  set_faraday_middleware(:response, *middleware)
end

#server_settings ⇒ Object

Returns an array of Server setting



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/onfido/configuration.rb', line 289

def server_settings
  [
    {
      url: "https://api.{region}.onfido.com/v3.6",
      description: "No description provided",
      variables: {
        region: {
            description: "No description provided",
            default_value: "eu",
            enum_values: [
              "eu",
              "us",
              "ca"
            ]
          }
        }
    }
  ]
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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/onfido/configuration.rb', line 318

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

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

#set_faraday_middleware(operation, key, *args, &block) ⇒ Object

Adds Faraday middleware setting information to the stack

Examples:

Use the ‘set_faraday_middleware` method to set middleware information

config.set_faraday_middleware(:request, :retry, max: 3, methods: [:get, :post], retry_statuses: [503])
config.set_faraday_middleware(:response, :logger, nil, { bodies: true, log_level: :debug })
config.set_faraday_middleware(:use, Faraday::HttpCache, store: Rails.cache, shared_cache: false)
config.set_faraday_middleware(:insert, 0, FaradayMiddleware::FollowRedirects, { standards_compliant: true, limit: 1 })
config.set_faraday_middleware(:swap, 0, Faraday::Response::Logger)
config.set_faraday_middleware(:delete, Faraday::Multipart::Middleware)

See Also:



400
401
402
403
404
405
406
407
 
# File 'lib/onfido/configuration.rb', line 400

def set_faraday_middleware(operation, key, *args, &block)
  unless [:request, :response, :use, :insert, :insert_before, :insert_after, :swap, :delete].include?(operation)
    fail ArgumentError, "Invalid faraday middleware operation #{operation}. Must be" \
                        " :request, :response, :use, :insert, :insert_before, :insert_after, :swap or :delete."
  end

  @middlewares[operation] << [key, args, block]
end

#use(*middleware) ⇒ Object

Adds middleware to the stack



375
376
377
 
# File 'lib/onfido/configuration.rb', line 375

def use(*middleware)
  set_faraday_middleware(:use, *middleware)
end