class AsposePdfCloud::Configuration
Attributes
Defines the access token (Bearer) used with OAuth2.
App Key
App SID
TLS/SSL setting
Client certificate file (for client certificate)
Set this to false to skip client side validation in the operation. Default to true. @return [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.
@return [true, false]
Defines url host
TLS/SSL setting
Client private key file (for client certificate)
Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.
@return [#debug]
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
Defines url scheme
SelfHost
SelfHost URL
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
Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.
@return [String]
The time limit for HTTP request in seconds. Default to 0 (never times out).
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]
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
The default Configuration
object.
# File lib/aspose_pdf_cloud/configuration.rb, line 142 def self.default @@default ||= Configuration.new end
# File lib/aspose_pdf_cloud/configuration.rb, line 123 def initialize @scheme = 'https' @host = 'api.aspose.cloud' @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
Returns Auth Settings hash for api client.
# File lib/aspose_pdf_cloud/configuration.rb, line 170 def auth_settings { 'JWT' => { type: 'oauth2', in: 'header', key: 'Authorization', value: "Bearer #{access_token}" }, } end
# File lib/aspose_pdf_cloud/configuration.rb, line 160 def base_url if @self_host url = self_host_url else url = "#{scheme}://#{[host, '/v3.0'].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') end URI.encode(url) end
# File lib/aspose_pdf_cloud/configuration.rb, line 146 def configure yield(self) if block_given? end
# File lib/aspose_pdf_cloud/configuration.rb, line 155 def host=(host) # remove http(s):// and anything after a slash @host = host.sub(/https?:\/\//, '').split('/').first end
# File lib/aspose_pdf_cloud/configuration.rb, line 150 def scheme=(scheme) # remove :// from scheme @scheme = scheme.sub(/:\/\//, '') end