Class: Athenian::Configuration

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



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

def initialize
  @scheme = 'https'
  @host = 'api.athenian.co'
  @base_path = '/v1'
  @server_index = 0
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = {}
  @api_key_prefix = {}
  @client_side_validation = true
  @verify_ssl = true
  @verify_ssl_host = true
  @cert_file = nil
  @key_file = nil
  @timeout = 0
  @params_encoding = 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.



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

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) 


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

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)



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

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



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

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



19
20
21
 
# File 'lib/athenian/configuration.rb', line 19

def base_path
  @base_path
end

#cert_file ⇒ Object

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



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

def cert_file
  @cert_file
end

#client_side_validation ⇒ true, false

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

Returns:

  • (true, false) 


99
100
101
 
# File 'lib/athenian/configuration.rb', line 99

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) 


77
78
79
 
# File 'lib/athenian/configuration.rb', line 77

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



146
147
148
 
# File 'lib/athenian/configuration.rb', line 146

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



16
17
18
 
# File 'lib/athenian/configuration.rb', line 16

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



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

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



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

def key_file
  @key_file
end

#logger ⇒ #debug

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

Returns:

  • (#debug) 


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

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:


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

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


57
58
59
 
# File 'lib/athenian/configuration.rb', line 57

def password
  @password
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.



70
71
72
 
# File 'lib/athenian/configuration.rb', line 70

def return_binary_data
  @return_binary_data
end

#scheme ⇒ Object

Defines url scheme



13
14
15
 
# File 'lib/athenian/configuration.rb', line 13

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



22
23
24
 
# File 'lib/athenian/configuration.rb', line 22

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



25
26
27
 
# File 'lib/athenian/configuration.rb', line 25

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



31
32
33
 
# File 'lib/athenian/configuration.rb', line 31

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



28
29
30
 
# File 'lib/athenian/configuration.rb', line 28

def server_variables
  @server_variables
end

#ssl_ca_cert ⇒ String

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

github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145

Returns:

  • (String) —

    the path to the certificate file

See Also:

  • `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:


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

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


90
91
92
 
# File 'lib/athenian/configuration.rb', line 90

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



94
95
96
 
# File 'lib/athenian/configuration.rb', line 94

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


52
53
54
 
# File 'lib/athenian/configuration.rb', line 52

def username
  @username
end

#verify_ssl ⇒ 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) 


108
109
110
 
# File 'lib/athenian/configuration.rb', line 108

def verify_ssl
  @verify_ssl
end

#verify_ssl_host ⇒ 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 host name Default to true.

Returns:

  • (true, false) 


117
118
119
 
# File 'lib/athenian/configuration.rb', line 117

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



174
175
176
 
# File 'lib/athenian/configuration.rb', line 174

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



219
220
221
222
 
# File 'lib/athenian/configuration.rb', line 219

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



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

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.



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/athenian/configuration.rb', line 230

def auth_settings
  {
    'apiKeyAuth' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-API-Key',
        value: api_key_with_prefix('apiKeyAuth')
      },
    'bearerAuth' =>
      {
        type: 'bearer',
        in: 'header',
        format: 'JWT',
        key: 'Authorization',
        value: "Bearer #{access_token_with_refresh}"
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



199
200
201
202
203
204
 
# File 'lib/athenian/configuration.rb', line 199

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



225
226
227
 
# File 'lib/athenian/configuration.rb', line 225

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

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

Yields:

  • (_self)

Yield Parameters:



178
179
180
 
# File 'lib/athenian/configuration.rb', line 178

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



260
261
262
263
 
# File 'lib/athenian/configuration.rb', line 260

def operation_server_settings
  {
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



251
252
253
254
255
256
257
258
 
# File 'lib/athenian/configuration.rb', line 251

def server_settings
  [
    {
      url: 'https://api.athenian.co/v1',
      description: ' - https://api.athenian.co',
    }
  ]
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



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
297
 
# File 'lib/athenian/configuration.rb', line 269

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