class AsposeOmrCloud::Configuration

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'
app_key[RW]

Defines app key

app_sid[RW]

Defines app sid

base_path[RW]

Defines url base path

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]
logger[RW]

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

@return [#debug]

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

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]

Public Class Methods

default() click to toggle source

The default Configuration object.

# File lib/aspose_omr_cloud/configuration.rb, line 147
def self.default
  Configuration.new
end
new() { |self| ... } click to toggle source
# File lib/aspose_omr_cloud/configuration.rb, line 126
def initialize
  @scheme = 'https'
  @host = 'api.aspose.cloud'
  @base_path = '/v1.1'
  @api_key = {}
  @api_key_prefix = {}
  @app_key = nil
  @app_sid = nil
  @access_token = nil
  @timeout = 0
  @client_side_validation = true
  @params_encoding = nil
  @debugging = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)

  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_omr_cloud/configuration.rb, line 178
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_omr_cloud/configuration.rb, line 192
def auth_settings
  {
    'appsid' =>
      {
        type: 'api_key',
        in: 'query',
        key: 'appsid',
        value: api_key_with_prefix('appsid')
      },
    'oauth' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
    'signature' =>
      {
        type: 'api_key',
        in: 'query',
        key: 'signature',
        value: api_key_with_prefix('signature')
      },
  }
end
auth_token_url() click to toggle source

Defines auth token url

# File lib/aspose_omr_cloud/configuration.rb, line 48
def auth_token_url
  return @auth_token_url if defined?(@auth_token_url)
  "#{@scheme}://#{@host}/oauth2/token"

end
auth_token_url=(url) click to toggle source
# File lib/aspose_omr_cloud/configuration.rb, line 53
def auth_token_url=(url)
  @auth_token_url = url
end
base_path=(base_path) click to toggle source
# File lib/aspose_omr_cloud/configuration.rb, line 165
def base_path=(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_omr_cloud/configuration.rb, line 171
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_omr_cloud/configuration.rb, line 187
def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end
configure() { |self| ... } click to toggle source
# File lib/aspose_omr_cloud/configuration.rb, line 151
def configure
  yield(self) if block_given?
end
host=(host) click to toggle source
# File lib/aspose_omr_cloud/configuration.rb, line 160
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_omr_cloud/configuration.rb, line 155
def scheme=(scheme)
  # remove :// from scheme
  @scheme = scheme.sub(/:\/\//, '')
end