Class: Plaid::Configuration

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

Constant Summary collapse

Environment =

Plaid Environment mapping production, development, sandbox

{ "production" => 0, "development" => 1, "sandbox" => 2 }

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:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/plaid/configuration.rb', line 139

def initialize
  @scheme = 'https'
  @host = 'production.plaid.com'
  @base_path = ''
  @server_index = 0
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = {
    'Plaid-Version' => '2020-09-14',
  }
  @api_key_prefix = {}
  @timeout = 60
  @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.respond_to?(:logger)) ? 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.



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

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)



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

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



55
56
57
 
# File 'lib/plaid/configuration.rb', line 55

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



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

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) 


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

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) 


75
76
77
 
# File 'lib/plaid/configuration.rb', line 75

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



137
138
139
 
# File 'lib/plaid/configuration.rb', line 137

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



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

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



135
136
137
 
# File 'lib/plaid/configuration.rb', line 135

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) 


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

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:


133
134
135
 
# File 'lib/plaid/configuration.rb', line 133

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


65
66
67
 
# File 'lib/plaid/configuration.rb', line 65

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



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

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



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

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



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

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



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

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



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

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



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

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

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



122
123
124
 
# File 'lib/plaid/configuration.rb', line 122

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

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



126
127
128
 
# File 'lib/plaid/configuration.rb', line 126

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) 


105
106
107
 
# File 'lib/plaid/configuration.rb', line 105

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)



112
113
114
 
# File 'lib/plaid/configuration.rb', line 112

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) 


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

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds.



91
92
93
 
# File 'lib/plaid/configuration.rb', line 91

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


60
61
62
 
# File 'lib/plaid/configuration.rb', line 60

def username
  @username
end

Class Method Details

.default ⇒ Object

The default Configuration object.



167
168
169
 
# File 'lib/plaid/configuration.rb', line 167

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

Instance Method Details

#api_key_with_prefix(param_name) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



201
202
203
204
205
206
207
 
# File 'lib/plaid/configuration.rb', line 201

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

Returns Auth Settings hash for api client.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/plaid/configuration.rb', line 215

def auth_settings
  {
    'clientId' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'PLAID-CLIENT-ID',
        value: api_key_with_prefix('PLAID-CLIENT-ID')
      },
    'plaidVersion' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Plaid-Version',
        value: api_key_with_prefix('Plaid-Version')
      },
    'secret' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'PLAID-SECRET',
        value: api_key_with_prefix('PLAID-SECRET')
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



192
193
194
195
196
197
 
# File 'lib/plaid/configuration.rb', line 192

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



210
211
212
 
# File 'lib/plaid/configuration.rb', line 210

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

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

Yields:

  • (_self)

Yield Parameters:



171
172
173
 
# File 'lib/plaid/configuration.rb', line 171

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



259
260
261
262
 
# File 'lib/plaid/configuration.rb', line 259

def operation_server_settings
  {
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/plaid/configuration.rb', line 242

def server_settings
  [
    {
      url: "https://production.plaid.com",
      description: "Production",
    },
    {
      url: "https://development.plaid.com",
      description: "Development",
    },
    {
      url: "https://sandbox.plaid.com",
      description: "Sandbox",
    }
  ]
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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/plaid/configuration.rb', line 268

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