Class: SlidizeCloud::Configuration

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/slidize_cloud/configuration.rb', line 167

def initialize
  @scheme = 'https'
  @host = 'api.slidize.cloud'
  @base_path = '/v1.0/slides'
  @server_index = 0
  @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.



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

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) 


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

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)



59
60
61
 
# File 'lib/slidize_cloud/configuration.rb', line 59

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



67
68
69
 
# File 'lib/slidize_cloud/configuration.rb', line 67

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



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

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) 


119
120
121
 
# File 'lib/slidize_cloud/configuration.rb', line 119

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) 


97
98
99
 
# File 'lib/slidize_cloud/configuration.rb', line 97

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



165
166
167
 
# File 'lib/slidize_cloud/configuration.rb', line 165

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



36
37
38
 
# File 'lib/slidize_cloud/configuration.rb', line 36

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



163
164
165
 
# File 'lib/slidize_cloud/configuration.rb', line 163

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) 


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

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:


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

def params_encoder
  @params_encoder
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


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

def password
  @password
end

#proxy ⇒ Object

Proxy setting HTTP Proxy settings



153
154
155
 
# File 'lib/slidize_cloud/configuration.rb', line 153

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.



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

def return_binary_data
  @return_binary_data
end

#scheme ⇒ Object

Defines url scheme



33
34
35
 
# File 'lib/slidize_cloud/configuration.rb', line 33

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



42
43
44
 
# File 'lib/slidize_cloud/configuration.rb', line 42

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



45
46
47
 
# File 'lib/slidize_cloud/configuration.rb', line 45

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



51
52
53
 
# File 'lib/slidize_cloud/configuration.rb', line 51

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



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

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



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

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

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



145
146
147
 
# File 'lib/slidize_cloud/configuration.rb', line 145

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

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



149
150
151
 
# File 'lib/slidize_cloud/configuration.rb', line 149

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) 


128
129
130
 
# File 'lib/slidize_cloud/configuration.rb', line 128

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)



135
136
137
 
# File 'lib/slidize_cloud/configuration.rb', line 135

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) 


110
111
112
 
# File 'lib/slidize_cloud/configuration.rb', line 110

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



114
115
116
 
# File 'lib/slidize_cloud/configuration.rb', line 114

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


72
73
74
 
# File 'lib/slidize_cloud/configuration.rb', line 72

def username
  @username
end

Class Method Details

.default ⇒ Object

The default Configuration object.



198
199
200
 
# File 'lib/slidize_cloud/configuration.rb', line 198

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



243
244
245
246
 
# File 'lib/slidize_cloud/configuration.rb', line 243

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



232
233
234
235
236
237
238
239
240
 
# File 'lib/slidize_cloud/configuration.rb', line 232

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.



254
255
256
257
 
# File 'lib/slidize_cloud/configuration.rb', line 254

def auth_settings
  {
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



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

def base_url(operation = nil)
  index = server_operation_index[operation]
  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



249
250
251
 
# File 'lib/slidize_cloud/configuration.rb', line 249

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

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

Yields:

  • (_self)

Yield Parameters:



202
203
204
 
# File 'lib/slidize_cloud/configuration.rb', line 202

def configure
  yield(self) if block_given?
end

#configure_connection(conn) ⇒ Object 



328
329
330
331
332
 
# File 'lib/slidize_cloud/configuration.rb', line 328

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



324
325
326
 
# File 'lib/slidize_cloud/configuration.rb', line 324

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

#configure_middleware(connection) ⇒ Object

Set up middleware on the connection



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/slidize_cloud/configuration.rb', line 371

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 



269
270
271
272
 
# File 'lib/slidize_cloud/configuration.rb', line 269

def operation_server_settings
  {
  }
end

#request(*middleware) ⇒ Object

Adds request middleware to the stack



340
341
342
 
# File 'lib/slidize_cloud/configuration.rb', line 340

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

#response(*middleware) ⇒ Object

Adds response middleware to the stack



345
346
347
 
# File 'lib/slidize_cloud/configuration.rb', line 345

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

#server_settings ⇒ Object

Returns an array of Server setting



260
261
262
263
264
265
266
267
 
# File 'lib/slidize_cloud/configuration.rb', line 260

def server_settings
  [
    {
      url: "https://api.slidize.cloud/v1.0/slides",
      description: "API production server",
    }
  ]
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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/slidize_cloud/configuration.rb', line 278

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

#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:



360
361
362
363
364
365
366
367
 
# File 'lib/slidize_cloud/configuration.rb', line 360

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



335
336
337
 
# File 'lib/slidize_cloud/configuration.rb', line 335

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