class AsposeCellsCloud::Configuration

Attributes

access_token[RW]

Defines the access token (Bearer) used with OAuth2.

api_version[RW]

Defines api version

cert_file[RW]
TLS/SSL setting

Client certificate file (for client certificate)

client_id[RW]

Client ID

client_secret[RW]

Client Secret

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]

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

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).

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

default() click to toggle source

The default Configuration object.

# File lib/aspose_cells_cloud/configuration.rb, line 147
def self.default
  @@default ||= Configuration.new
end
new() { |self| ... } click to toggle source
# File lib/aspose_cells_cloud/configuration.rb, line 127
def initialize
  @scheme = 'https'
  @host = 'api.aspose.cloud'
  @api_version = 'v3.0'
  @timeout = 5 * 60
  @client_side_validation = true
  @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

Public Instance Methods

auth_settings() click to toggle source

Returns Auth Settings hash for api client.

# File lib/aspose_cells_cloud/configuration.rb, line 174
def auth_settings
  {
    'JWT' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
  }
end
base_url() click to toggle source
# File lib/aspose_cells_cloud/configuration.rb, line 165
def base_url
  #url = "#{scheme}://#{[host, '/v3.0'].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
  url = "#{scheme}://#{[host, '/'+ api_version ].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
  # URI.encode(url)
  # URI.encode_www_form_component(url)
  url
end
configure() { |self| ... } click to toggle source
# File lib/aspose_cells_cloud/configuration.rb, line 151
def configure
  yield(self) if block_given?
end
host=(host) click to toggle source
# File lib/aspose_cells_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_cells_cloud/configuration.rb, line 155
def scheme=(scheme)
  # remove :// from scheme
  @scheme = scheme.sub(/:\/\//, '')
end