Class: VericredClient::Configuration
- Inherits:
-
Object
- Object
- VericredClient::Configuration
- Defined in:
- lib/vericred_client/configuration.rb
Instance Attribute Summary collapse
-
#access_token ⇒ Object
Defines the access token (Bearer) used with OAuth2.
-
#api_key ⇒ Hash
Defines API keys used with API Key authentications.
-
#api_key_prefix ⇒ Hash
Defines API key prefixes used with API Key authentications.
-
#base_path ⇒ Object
Defines url base path.
-
#cert_file ⇒ Object
TLS/SSL setting Client certificate file (for client certificate).
-
#debugging ⇒ true, false
Set this to enable/disable debugging.
-
#force_ending_format ⇒ Object
Returns the value of attribute force_ending_format.
-
#host ⇒ Object
Defines url host.
-
#inject_format ⇒ Object
Returns the value of attribute inject_format.
-
#key_file ⇒ Object
TLS/SSL setting Client private key file (for client certificate).
-
#logger ⇒ #debug
Defines the logger used for debugging.
-
#params_encoding ⇒ Object
Set this to customize parameters encoding of array parameter with multi collectionFormat.
-
#password ⇒ String
Defines the password used with HTTP basic authentication.
-
#scheme ⇒ Object
Defines url scheme.
-
#ssl_ca_cert ⇒ String
TLS/SSL setting Set this to customize the certificate file to verify the peer.
-
#temp_folder_path ⇒ String
Defines the temporary folder to store downloaded files (for API endpoints that have file response).
-
#timeout ⇒ Object
The time limit for HTTP request in seconds.
-
#username ⇒ String
Defines the username used with HTTP basic authentication.
-
#verify_ssl ⇒ true, false
TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server.
-
#verify_ssl_host ⇒ true, false
TLS/SSL setting Set this to false to skip verifying SSL host name Default to true.
Class Method Summary collapse
-
.default ⇒ Object
The default Configuration object.
Instance Method Summary collapse
-
#api_key_with_prefix(param_name) ⇒ Object
Gets API key (with prefix if set).
-
#auth_settings ⇒ Object
Returns Auth Settings hash for api client.
- #base_url ⇒ Object
-
#basic_auth_token ⇒ Object
Gets Basic Auth token string.
- #configure {|_self| ... } ⇒ Object
-
#initialize {|_self| ... } ⇒ Configuration
constructor
A new instance of Configuration.
Constructor Details
#initialize {|_self| ... } ⇒ Configuration
Returns a new instance of Configuration.
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/vericred_client/configuration.rb', line 243 def initialize @scheme = 'https' @host = 'api.vericred.com' @base_path = '/' @api_key = {} @api_key_prefix = {} @timeout = 0 @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.
171 172 173 |
# File 'lib/vericred_client/configuration.rb', line 171 def access_token @access_token end |
#api_key ⇒ Hash
Defines API keys used with API Key authentications.
150 151 152 |
# File 'lib/vericred_client/configuration.rb', line 150 def api_key @api_key end |
#api_key_prefix ⇒ Hash
Defines API key prefixes used with API Key authentications.
158 159 160 |
# File 'lib/vericred_client/configuration.rb', line 158 def api_key_prefix @api_key_prefix end |
#base_path ⇒ Object
Defines url base path
142 143 144 |
# File 'lib/vericred_client/configuration.rb', line 142 def base_path @base_path end |
#cert_file ⇒ Object
TLS/SSL setting Client certificate file (for client certificate)
226 227 228 |
# File 'lib/vericred_client/configuration.rb', line 226 def cert_file @cert_file 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.
178 179 180 |
# File 'lib/vericred_client/configuration.rb', line 178 def debugging @debugging end |
#force_ending_format ⇒ Object
Returns the value of attribute force_ending_format.
241 242 243 |
# File 'lib/vericred_client/configuration.rb', line 241 def force_ending_format @force_ending_format end |
#host ⇒ Object
Defines url host
139 140 141 |
# File 'lib/vericred_client/configuration.rb', line 139 def host @host end |
#inject_format ⇒ Object
Returns the value of attribute inject_format.
239 240 241 |
# File 'lib/vericred_client/configuration.rb', line 239 def inject_format @inject_format end |
#key_file ⇒ Object
TLS/SSL setting Client private key file (for client certificate)
230 231 232 |
# File 'lib/vericred_client/configuration.rb', line 230 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.
184 185 186 |
# File 'lib/vericred_client/configuration.rb', line 184 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
237 238 239 |
# File 'lib/vericred_client/configuration.rb', line 237 def params_encoding @params_encoding end |
#password ⇒ String
Defines the password used with HTTP basic authentication.
168 169 170 |
# File 'lib/vericred_client/configuration.rb', line 168 def password @password end |
#scheme ⇒ Object
Defines url scheme
136 137 138 |
# File 'lib/vericred_client/configuration.rb', line 136 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
222 223 224 |
# File 'lib/vericred_client/configuration.rb', line 222 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`.
191 192 193 |
# File 'lib/vericred_client/configuration.rb', line 191 def temp_folder_path @temp_folder_path end |
#timeout ⇒ Object
The time limit for HTTP request in seconds. Default to 0 (never times out).
195 196 197 |
# File 'lib/vericred_client/configuration.rb', line 195 def timeout @timeout end |
#username ⇒ String
Defines the username used with HTTP basic authentication.
163 164 165 |
# File 'lib/vericred_client/configuration.rb', line 163 def username @username end |
#verify_ssl ⇒ true, false
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.
204 205 206 |
# File 'lib/vericred_client/configuration.rb', line 204 def verify_ssl @verify_ssl end |
#verify_ssl_host ⇒ true, false
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.
213 214 215 |
# File 'lib/vericred_client/configuration.rb', line 213 def verify_ssl_host @verify_ssl_host end |
Class Method Details
.default ⇒ Object
The default Configuration object.
264 265 266 |
# File 'lib/vericred_client/configuration.rb', line 264 def self.default @@default ||= Configuration.new end |
Instance Method Details
#api_key_with_prefix(param_name) ⇒ Object
Gets API key (with prefix if set).
295 296 297 298 299 300 301 |
# File 'lib/vericred_client/configuration.rb', line 295 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.
309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/vericred_client/configuration.rb', line 309 def auth_settings { 'Vericred-Api-Key' => { type: 'api_key', in: 'header', key: 'Vericred-Api-Key', value: api_key_with_prefix('Vericred-Api-Key') }, } end |
#base_url ⇒ Object
288 289 290 291 |
# File 'lib/vericred_client/configuration.rb', line 288 def base_url url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') URI.encode(url) end |
#basic_auth_token ⇒ Object
Gets Basic Auth token string
304 305 306 |
# File 'lib/vericred_client/configuration.rb', line 304 def basic_auth_token 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n") end |
#configure {|_self| ... } ⇒ Object
268 269 270 |
# File 'lib/vericred_client/configuration.rb', line 268 def configure yield(self) if block_given? end |