Class: Kleister::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/kleister/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:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/kleister/configuration.rb', line 145

def initialize
  @scheme = 'https'
  @host = 'try.kleister.eu'
  @base_path = '/api/v1'
  @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 = 60
  # return data as binary instead of file
  @return_binary_data = false
  @params_encoder = 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.



61
62
63
 
# File 'lib/kleister/configuration.rb', line 61

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) 


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

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)



40
41
42
 
# File 'lib/kleister/configuration.rb', line 40

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



48
49
50
 
# File 'lib/kleister/configuration.rb', line 48

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



20
21
22
 
# File 'lib/kleister/configuration.rb', line 20

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) 


100
101
102
 
# File 'lib/kleister/configuration.rb', line 100

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) 


78
79
80
 
# File 'lib/kleister/configuration.rb', line 78

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



143
144
145
 
# File 'lib/kleister/configuration.rb', line 143

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



17
18
19
 
# File 'lib/kleister/configuration.rb', line 17

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



143
144
145
 
# File 'lib/kleister/configuration.rb', line 143

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) 


84
85
86
 
# File 'lib/kleister/configuration.rb', line 84

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:


141
142
143
 
# File 'lib/kleister/configuration.rb', line 141

def params_encoder
  @params_encoder
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


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

def password
  @password
end

#proxy ⇒ Object

Proxy setting HTTP Proxy settings



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

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.



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

def return_binary_data
  @return_binary_data
end

#scheme ⇒ Object

Defines url scheme



14
15
16
 
# File 'lib/kleister/configuration.rb', line 14

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



23
24
25
 
# File 'lib/kleister/configuration.rb', line 23

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



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

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



32
33
34
 
# File 'lib/kleister/configuration.rb', line 32

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



29
30
31
 
# File 'lib/kleister/configuration.rb', line 29

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



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

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

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



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

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

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



130
131
132
 
# File 'lib/kleister/configuration.rb', line 130

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) 


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

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)



116
117
118
 
# File 'lib/kleister/configuration.rb', line 116

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) 


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

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



95
96
97
 
# File 'lib/kleister/configuration.rb', line 95

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


53
54
55
 
# File 'lib/kleister/configuration.rb', line 53

def username
  @username
end

Class Method Details

.default ⇒ Object

The default Configuration object.



176
177
178
 
# File 'lib/kleister/configuration.rb', line 176

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



223
224
225
226
227
 
# File 'lib/kleister/configuration.rb', line 223

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



212
213
214
215
216
217
218
219
220
 
# File 'lib/kleister/configuration.rb', line 212

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.



235
236
237
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/kleister/configuration.rb', line 235

def auth_settings
  {
    'Header' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-API-Key',
        value: api_key_with_prefix('Header')
      },
    'Bearer' =>
      {
        type: 'bearer',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token_with_refresh}"
      },
    'Basic' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
    'Cookie' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Cookie',
        value: api_key_with_prefix('Cookie')
      }
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



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

def base_url(operation = nil)
  if operation_server_settings.key?(operation)
    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(%r{/+}, '/')}".sub(%r{/+\z}, '') : server_url(server_index, server_variables, nil)
  end
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



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

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

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

Yields:

  • (_self)

Yield Parameters:



180
181
182
 
# File 'lib/kleister/configuration.rb', line 180

def configure
  yield(self) if block_given?
end

#configure_connection(conn) ⇒ Object 



336
337
338
339
340
 
# File 'lib/kleister/configuration.rb', line 336

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



332
333
334
 
# File 'lib/kleister/configuration.rb', line 332

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

#configure_middleware(connection) ⇒ Object

Set up middleware on the connection



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/kleister/configuration.rb', line 379

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

  %i[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 



278
279
280
 
# File 'lib/kleister/configuration.rb', line 278

def operation_server_settings
  {}
end

#request(*middleware) ⇒ Object

Adds request middleware to the stack



348
349
350
 
# File 'lib/kleister/configuration.rb', line 348

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

#response(*middleware) ⇒ Object

Adds response middleware to the stack



353
354
355
 
# File 'lib/kleister/configuration.rb', line 353

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

#server_settings ⇒ Object

Returns an array of Server setting



269
270
271
272
273
274
275
276
 
# File 'lib/kleister/configuration.rb', line 269

def server_settings
  [
    {
      url: 'https://try.kleister.eu/api/v1',
      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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/kleister/configuration.rb', line 286

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

  # check array index out of bound
  if index.nil? || index.negative? || index >= servers.size
    raise 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_key do |name|
    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
        raise 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:



368
369
370
371
372
373
374
375
 
# File 'lib/kleister/configuration.rb', line 368

def set_faraday_middleware(operation, key, *args, &block)
  unless %i[request response use insert insert_before insert_after swap delete].include?(operation)
    raise 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



343
344
345
 
# File 'lib/kleister/configuration.rb', line 343

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