class AsposeSlidesCloud::Configuration

Attributes

access_token[RW]

Defines the access token (Bearer) used with OAuth2.

app_key[RW]

Defines API secret key used for authentication.

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

app_sid[RW]

Defines API keys used for authentication.

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

auth_base_url[RW]

Defines base url for authentication

base_url[RW]

Defines base url

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]

custom_headers[RW]

Custom HTTP headers for all requests. @return [Hash]

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

The time limit for HTTP request in seconds. Default to 300.

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

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]

slides operaion timeout in seconds. The timeout applies to the Slides operation, not to the HTTP request. Default to 0 (no timeout).

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]

version[RW]

Defines platform version

Public Class Methods

default() click to toggle source

The default Configuration object.

# File lib/aspose_slides_cloud/configuration.rb, line 154
def self.default
  @@default ||= Configuration.new
end
new() { |self| ... } click to toggle source
# File lib/aspose_slides_cloud/configuration.rb, line 132
def initialize
  @base_url = 'https://api.aspose.cloud'
  @auth_base_url = 'https://api.aspose.cloud'
  @version = 'v3.0'
  @http_request_timeout = 300
  @timeout = 0
  @custom_headers = Hash.new
  @client_side_validation = true
  @verify_ssl = false
  @verify_ssl_host = false
  @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_base_url=(auth_base_url) click to toggle source
# File lib/aspose_slides_cloud/configuration.rb, line 166
def auth_base_url=(auth_base_url)
  @auth_base_url = getUrlHostPart(auth_base_url)
end
base_path() click to toggle source
# File lib/aspose_slides_cloud/configuration.rb, line 184
def base_path
  URI.encode("#{[base_url, version].join('/')}".sub(/\/+\z/, ''))
end
base_url=(base_url) click to toggle source
# File lib/aspose_slides_cloud/configuration.rb, line 162
def base_url=(base_url)
  @base_url = getUrlHostPart(base_url)
end
configure() { |self| ... } click to toggle source
# File lib/aspose_slides_cloud/configuration.rb, line 158
def configure
  yield(self) if block_given?
end
getUrlHostPart(url) click to toggle source
# File lib/aspose_slides_cloud/configuration.rb, line 170
def getUrlHostPart(url)
  parts = url.split('//')
  if (parts.length > 1)
    return "#{parts[0]}//#{parts[1].split('/').first}";
  end
  parts[0].split('/').first
end
version=(version) click to toggle source
# File lib/aspose_slides_cloud/configuration.rb, line 178
def version=(version)
  # Add leading and trailing slashes to base_path
  @version = "/#{version}".gsub(/\/+/, '/')
  @version = '' if @version == '/'
end