class AsposeImagingCloud::Configuration

Class which contains configuration parameters

Attributes

access_token[RW]

Defines the access token (Bearer) used with OAuth2.

api_key[RW]

Defines API keys used with API Key authentications.

@return [Hash] key: parameter name, value: parameter value (API key)

@example parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'
api_key_prefix[RW]

Defines API key prefixes used with API Key authentications.

@return [Hash] key: parameter name, value: API key prefix

@example parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'
api_version[RW]

Defines api version

base_path[RW]

Defines url base path

cert_file[RW]
TLS/SSL setting

Client certificate file (for client certificate)

client_side_validation[RW]

Set this to false to skip client side validation in the operation. Default to true. @return [true, false]

debugging[RW]

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.

@return [true, false]

force_ending_format[RW]
host[RW]

Defines url host

inject_format[RW]
key_file[RW]
TLS/SSL setting

Client private key file (for client certificate)

logger[RW]

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

@return [#debug]

on_premise[RW]
params_encoding[RW]

Set this to customize parameters encoding of array parameter with multi collectionFormat. Default to nil.

@see The params_encoding option of Ethon. Related source code: github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96

password[RW]

Defines the password used with HTTP basic authentication.

@return [String]

scheme[RW]

Defines url scheme

ssl_ca_cert[RW]
TLS/SSL setting

Set this to customize the certificate file to verify the peer.

@return [String] the path to the certificate file

@see The ‘cainfo` option of Typhoeus, `–cert` option of libcurl. Related source code: github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145

temp_folder_path[RW]

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

@return [String]

timeout[RW]

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

username[RW]

Defines the username used with HTTP basic authentication.

@return [String]

verify_ssl[RW]
TLS/SSL setting

Set this to false to skip verifying SSL certificate when calling API from https server. Default to true.

@note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

@return [true, false]

verify_ssl_host[RW]
TLS/SSL setting

Set this to false to skip verifying SSL host name Default to true.

@note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

@return [true, false]

Public Class Methods

new(client_secret = nil, client_id = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v3.0', debug = false) { |self| ... } click to toggle source

Initializes a new instance. @param [String] client_secret Key to access the server. @param [String] client_id ID to access the server. @param [String] base_url Server URL. @param [String] api_version Api version. @param [Object] debug Debug switch [true, false].

# File lib/aspose-imaging-cloud/configuration.rb, line 157
def initialize(client_secret = nil, client_id = nil, base_url = 'api-qa.aspose.cloud', api_version = 'v3.0', debug = false)
  @scheme = 'https'
  self.host = base_url
  @api_version = api_version
  self.base_path = @api_version
  @api_key = { 'api_key': client_secret || '',
               'client_id': client_id || '' }
  @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 = debug
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
  @on_premise = (!(client_secret || client_id) && base_url)

  yield(self) if block_given?
end

Public Instance Methods

api_key_with_prefix(param_name) click to toggle source

Gets API key (with prefix if set). @param [String] param_name the parameter name of API key auth

# File lib/aspose-imaging-cloud/configuration.rb, line 210
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() click to toggle source

Returns Auth Settings hash for api client.

# File lib/aspose-imaging-cloud/configuration.rb, line 224
def auth_settings
{
  JWT:
  {
    type: 'oauth2',
    in: 'header',
    key: 'Authorization',
    value: "Bearer #{access_token}"
  }
}
end
base_path=(base_path) click to toggle source
# File lib/aspose-imaging-cloud/configuration.rb, line 195
def base_path=(base_path)
  return unless base_path

  # Add leading and trailing slashes to base_path
  @base_path = "/#{base_path}".gsub(/\/+/, '/')
  @base_path = '' if @base_path == '/'
end
base_url() click to toggle source
# File lib/aspose-imaging-cloud/configuration.rb, line 203
def base_url
  url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
  URI.encode(url)
end
basic_auth_token() click to toggle source

Gets Basic Auth token string

# File lib/aspose-imaging-cloud/configuration.rb, line 219
def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end
configure() { |self| ... } click to toggle source
# File lib/aspose-imaging-cloud/configuration.rb, line 181
def configure
  yield(self) if block_given?
end
host=(host) click to toggle source
# File lib/aspose-imaging-cloud/configuration.rb, line 190
def host=(host)
  # remove http(s):// and anything after a slash
  @host = host.sub(/https?:\/\//, '').split('/').first
end
scheme=(scheme) click to toggle source
# File lib/aspose-imaging-cloud/configuration.rb, line 185
def scheme=(scheme)
  # remove :// from scheme
  @scheme = scheme.sub(/:\/\//, '')
end