Class: NucleusApi::Configuration

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

Direct Known Subclasses

AuthConfiguration

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:



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

def initialize
  @scheme = 'https'
  @host = 'sandbox.hydrogenplatform.com'
  @admin_path = '/admin/v1'
  @base_path = '/nucleus/v1'
  @api_key = {}
  @api_key_prefix = {}
  @timeout = 0
  @client_side_validation = true
  @verify_ssl = true
  @verify_ssl_host = true
  @params_encoding = nil
  @cert_file = nil
  @key_file = 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.



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

def access_token
  @access_token
end

#admin_path ⇒ Object

Defines url admin_path



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

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



35
36
37
 
# File 'lib/nucleus_api/configuration.rb', line 35

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



43
44
45
 
# File 'lib/nucleus_api/configuration.rb', line 43

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



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

def base_path
  @base_path
end

#cert_file ⇒ Object

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



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

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) 


85
86
87
 
# File 'lib/nucleus_api/configuration.rb', line 85

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) 


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

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



131
132
133
 
# File 'lib/nucleus_api/configuration.rb', line 131

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



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

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



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

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



120
121
122
 
# File 'lib/nucleus_api/configuration.rb', line 120

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) 


69
70
71
 
# File 'lib/nucleus_api/configuration.rb', line 69

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:


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

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


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

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



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

def scheme
  @scheme
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:


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

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) 


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

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



80
81
82
 
# File 'lib/nucleus_api/configuration.rb', line 80

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


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

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) 


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

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) 


103
104
105
 
# File 'lib/nucleus_api/configuration.rb', line 103

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



156
157
158
 
# File 'lib/nucleus_api/configuration.rb', line 156

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

Instance Method Details

#admin_url ⇒ Object 



191
192
193
194
 
# File 'lib/nucleus_api/configuration.rb', line 191

def admin_url
  url = "#{scheme}://#{[host, admin_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
  Addressable::URI.encode(url)
end

#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



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

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.



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

def auth_settings
  {
    'oauth2' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
  }
end

#base_url ⇒ Object 



186
187
188
189
 
# File 'lib/nucleus_api/configuration.rb', line 186

def base_url
  url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
  Addressable::URI.encode(url)
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



207
208
209
 
# File 'lib/nucleus_api/configuration.rb', line 207

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

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

Yields:

  • (_self)

Yield Parameters:



160
161
162
 
# File 'lib/nucleus_api/configuration.rb', line 160

def configure
  yield(self) if block_given?
end