Class: MxPlatformRuby::Configuration
- Inherits:
-
Object
- Object
- MxPlatformRuby::Configuration
- Defined in:
- lib/mx-platform-ruby/configuration.rb
Instance Attribute Summary collapse
-
#access_token ⇒ Object
Defines the access token (Bearer) used with OAuth2.
-
#access_token_getter ⇒ Proc
Defines a Proc used to fetch or refresh access tokens (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.
-
#client_side_validation ⇒ true, false
Set this to false to skip client side validation in the operation.
-
#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.
-
#ignore_operation_servers ⇒ true, false
Set this to ignore operation servers for the API client.
-
#inject_format ⇒ Object
Returns the value of attribute inject_format.
-
#logger ⇒ #debug
Defines the logger used for debugging.
-
#params_encoder ⇒ Object
Set this to customize parameters encoder of array parameter.
-
#password ⇒ String
Defines the password used with HTTP basic authentication.
-
#proxy ⇒ Object
Proxy setting HTTP Proxy settings.
-
#return_binary_data ⇒ Object
Set this to return data as binary instead of downloading a temp file.
-
#scheme ⇒ Object
Defines url scheme.
-
#server_index ⇒ Object
Define server configuration index.
-
#server_operation_index ⇒ Object
Define server operation configuration index.
-
#server_operation_variables ⇒ Object
Default server operation variables.
-
#server_variables ⇒ Object
Default server variables.
-
#ssl_ca_file ⇒ String
TLS/SSL setting Set this to customize the certificate file to verify the peer.
-
#ssl_client_cert ⇒ Object
TLS/SSL setting Client certificate file (for client certificate).
-
#ssl_client_key ⇒ Object
TLS/SSL setting Client private key file (for client certificate).
-
#ssl_verify ⇒ true, false
TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server.
-
#ssl_verify_mode ⇒ Object
TLS/SSL setting Any ‘OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html).
-
#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.
Class Method Summary collapse
-
.default ⇒ Object
The default Configuration object.
Instance Method Summary collapse
-
#access_token_with_refresh ⇒ Object
Gets access_token using access_token_getter or uses the static access_token.
-
#api_key_with_prefix(param_name, param_alias = nil) ⇒ Object
Gets API key (with prefix if set).
-
#auth_settings ⇒ Object
Returns Auth Settings hash for api client.
-
#base_url(operation = nil) ⇒ Object
Returns base URL for specified operation based on server settings.
-
#basic_auth_token ⇒ Object
Gets Basic Auth token string.
- #configure {|_self| ... } ⇒ Object
- #configure_connection(conn) ⇒ Object
-
#configure_faraday_connection(&block) ⇒ Object
Configure Faraday connection directly.
-
#configure_middleware(connection) ⇒ Object
Set up middleware on the connection.
-
#initialize {|_self| ... } ⇒ Configuration
constructor
A new instance of Configuration.
- #operation_server_settings ⇒ Object
-
#request(*middleware) ⇒ Object
Adds request middleware to the stack.
-
#response(*middleware) ⇒ Object
Adds response middleware to the stack.
-
#server_settings ⇒ Object
Returns an array of Server setting.
-
#server_url(index, variables = {}, servers = nil) ⇒ Object
Returns URL based on server settings.
-
#set_faraday_middleware(operation, key, *args, &block) ⇒ Object
Adds Faraday middleware setting information to the stack.
-
#use(*middleware) ⇒ Object
Adds middleware to the stack.
Constructor Details
#initialize {|_self| ... } ⇒ Configuration
Returns a new instance of Configuration.
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/mx-platform-ruby/configuration.rb', line 158 def initialize @scheme = 'https' @host = 'api.mx.com' @base_path = '' @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 @ignore_operation_servers = 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.
63 64 65 |
# File 'lib/mx-platform-ruby/configuration.rb', line 63 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
68 69 70 |
# File 'lib/mx-platform-ruby/configuration.rb', line 68 def access_token_getter @access_token_getter end |
#api_key ⇒ Hash
Defines API keys used with API Key authentications.
42 43 44 |
# File 'lib/mx-platform-ruby/configuration.rb', line 42 def api_key @api_key end |
#api_key_prefix ⇒ Hash
Defines API key prefixes used with API Key authentications.
50 51 52 |
# File 'lib/mx-platform-ruby/configuration.rb', line 50 def api_key_prefix @api_key_prefix end |
#base_path ⇒ Object
Defines url base path
22 23 24 |
# File 'lib/mx-platform-ruby/configuration.rb', line 22 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.
110 111 112 |
# File 'lib/mx-platform-ruby/configuration.rb', line 110 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.
80 81 82 |
# File 'lib/mx-platform-ruby/configuration.rb', line 80 def debugging @debugging end |
#force_ending_format ⇒ Object
Returns the value of attribute force_ending_format.
156 157 158 |
# File 'lib/mx-platform-ruby/configuration.rb', line 156 def force_ending_format @force_ending_format end |
#host ⇒ Object
Defines url host
19 20 21 |
# File 'lib/mx-platform-ruby/configuration.rb', line 19 def host @host end |
#ignore_operation_servers ⇒ true, false
Set this to ignore operation servers for the API client. This is useful when you need to send requests to a different server than the one specified in the OpenAPI document. Will default to the base url defined in the spec but can be overridden by setting ‘scheme`, `host`, `base_path` directly. Default to false.
88 89 90 |
# File 'lib/mx-platform-ruby/configuration.rb', line 88 def ignore_operation_servers @ignore_operation_servers end |
#inject_format ⇒ Object
Returns the value of attribute inject_format.
154 155 156 |
# File 'lib/mx-platform-ruby/configuration.rb', line 154 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.
94 95 96 |
# File 'lib/mx-platform-ruby/configuration.rb', line 94 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
151 152 153 |
# File 'lib/mx-platform-ruby/configuration.rb', line 151 def params_encoder @params_encoder end |
#password ⇒ String
Defines the password used with HTTP basic authentication.
60 61 62 |
# File 'lib/mx-platform-ruby/configuration.rb', line 60 def password @password end |
#proxy ⇒ Object
Proxy setting HTTP Proxy settings
144 145 146 |
# File 'lib/mx-platform-ruby/configuration.rb', line 144 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.
73 74 75 |
# File 'lib/mx-platform-ruby/configuration.rb', line 73 def return_binary_data @return_binary_data end |
#scheme ⇒ Object
Defines url scheme
16 17 18 |
# File 'lib/mx-platform-ruby/configuration.rb', line 16 def scheme @scheme end |
#server_index ⇒ Object
Define server configuration index
25 26 27 |
# File 'lib/mx-platform-ruby/configuration.rb', line 25 def server_index @server_index end |
#server_operation_index ⇒ Object
Define server operation configuration index
28 29 30 |
# File 'lib/mx-platform-ruby/configuration.rb', line 28 def server_operation_index @server_operation_index end |
#server_operation_variables ⇒ Object
Default server operation variables
34 35 36 |
# File 'lib/mx-platform-ruby/configuration.rb', line 34 def server_operation_variables @server_operation_variables end |
#server_variables ⇒ Object
Default server variables
31 32 33 |
# File 'lib/mx-platform-ruby/configuration.rb', line 31 def server_variables @server_variables end |
#ssl_ca_file ⇒ String
TLS/SSL setting Set this to customize the certificate file to verify the peer.
132 133 134 |
# File 'lib/mx-platform-ruby/configuration.rb', line 132 def ssl_ca_file @ssl_ca_file end |
#ssl_client_cert ⇒ Object
TLS/SSL setting Client certificate file (for client certificate)
136 137 138 |
# File 'lib/mx-platform-ruby/configuration.rb', line 136 def ssl_client_cert @ssl_client_cert end |
#ssl_client_key ⇒ Object
TLS/SSL setting Client private key file (for client certificate)
140 141 142 |
# File 'lib/mx-platform-ruby/configuration.rb', line 140 def ssl_client_key @ssl_client_key end |
#ssl_verify ⇒ 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.
119 120 121 |
# File 'lib/mx-platform-ruby/configuration.rb', line 119 def ssl_verify @ssl_verify end |
#ssl_verify_mode ⇒ Object
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)
126 127 128 |
# File 'lib/mx-platform-ruby/configuration.rb', line 126 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`.
101 102 103 |
# File 'lib/mx-platform-ruby/configuration.rb', line 101 def temp_folder_path @temp_folder_path end |
#timeout ⇒ Object
The time limit for HTTP request in seconds. Default to 0 (never times out).
105 106 107 |
# File 'lib/mx-platform-ruby/configuration.rb', line 105 def timeout @timeout end |
#username ⇒ String
Defines the username used with HTTP basic authentication.
55 56 57 |
# File 'lib/mx-platform-ruby/configuration.rb', line 55 def username @username end |
Class Method Details
.default ⇒ Object
The default Configuration object.
190 191 192 |
# File 'lib/mx-platform-ruby/configuration.rb', line 190 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
238 239 240 241 |
# File 'lib/mx-platform-ruby/configuration.rb', line 238 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).
227 228 229 230 231 232 233 234 235 |
# File 'lib/mx-platform-ruby/configuration.rb', line 227 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.
249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/mx-platform-ruby/configuration.rb', line 249 def auth_settings { 'basicAuth' => { type: 'basic', in: 'header', key: 'Authorization', value: basic_auth_token }, } end |
#base_url(operation = nil) ⇒ Object
Returns base URL for specified operation based on server settings
215 216 217 218 219 220 221 222 223 |
# File 'lib/mx-platform-ruby/configuration.rb', line 215 def base_url(operation = nil) return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers if operation_server_settings.key?(operation) then 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(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil) end end |
#basic_auth_token ⇒ Object
Gets Basic Auth token string
244 245 246 |
# File 'lib/mx-platform-ruby/configuration.rb', line 244 def basic_auth_token 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n") end |
#configure {|_self| ... } ⇒ Object
194 195 196 |
# File 'lib/mx-platform-ruby/configuration.rb', line 194 def configure yield(self) if block_given? end |
#configure_connection(conn) ⇒ Object
334 335 336 337 338 |
# File 'lib/mx-platform-ruby/configuration.rb', line 334 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 “‘
330 331 332 |
# File 'lib/mx-platform-ruby/configuration.rb', line 330 def configure_faraday_connection(&block) @configure_connection_blocks << block end |
#configure_middleware(connection) ⇒ Object
Set up middleware on the connection
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/mx-platform-ruby/configuration.rb', line 377 def configure_middleware(connection) return if @middlewares.empty? [: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
275 276 277 278 |
# File 'lib/mx-platform-ruby/configuration.rb', line 275 def operation_server_settings { } end |
#request(*middleware) ⇒ Object
Adds request middleware to the stack
346 347 348 |
# File 'lib/mx-platform-ruby/configuration.rb', line 346 def request(*middleware) set_faraday_middleware(:request, *middleware) end |
#response(*middleware) ⇒ Object
Adds response middleware to the stack
351 352 353 |
# File 'lib/mx-platform-ruby/configuration.rb', line 351 def response(*middleware) set_faraday_middleware(:response, *middleware) end |
#server_settings ⇒ Object
Returns an array of Server setting
262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/mx-platform-ruby/configuration.rb', line 262 def server_settings [ { url: "https://api.mx.com", description: "No description provided", }, { url: "https://int-api.mx.com", description: "No description provided", } ] end |
#server_url(index, variables = {}, servers = nil) ⇒ Object
Returns URL based on server settings
284 285 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 |
# File 'lib/mx-platform-ruby/configuration.rb', line 284 def server_url(index, variables = {}, servers = nil) servers = server_settings if servers == nil # check array index out of bound if (index.nil? || index < 0 || index >= servers.size) fail 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 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 |
#set_faraday_middleware(operation, key, *args, &block) ⇒ Object
Adds Faraday middleware setting information to the stack
366 367 368 369 370 371 372 373 |
# File 'lib/mx-platform-ruby/configuration.rb', line 366 def set_faraday_middleware(operation, key, *args, &block) unless [:request, :response, :use, :insert, :insert_before, :insert_after, :swap, :delete].include?(operation) fail 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
341 342 343 |
# File 'lib/mx-platform-ruby/configuration.rb', line 341 def use(*middleware) set_faraday_middleware(:use, *middleware) end |