Class: AsposeSlidesCloud::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_slides_cloud/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# 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 = true
  @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

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



47
48
49
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 47

def access_token
  @access_token
end

#app_key ⇒ Hash

Defines API secret key used for authentication.

Returns:

  • (Hash) —

    key: parameter name, value: parameter value (API key)



44
45
46
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 44

def app_key
  @app_key
end

#app_sid ⇒ Hash

Defines API keys used for authentication.

Returns:

  • (Hash) —

    key: parameter name, value: parameter value (API key)



39
40
41
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 39

def app_sid
  @app_sid
end

#auth_base_url ⇒ Object

Defines base url for authentication



31
32
33
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 31

def auth_base_url
  @auth_base_url
end

#base_url ⇒ Object

Defines base url



28
29
30
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 28

def base_url
  @base_url
end

#cert_file ⇒ Object

TLS/SSL setting Client certificate file (for client certificate)



115
116
117
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 115

def cert_file
  @cert_file
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false) 


80
81
82
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 80

def client_side_validation
  @client_side_validation
end

#custom_headers ⇒ Hash

Custom HTTP headers for all requests.

Returns:

  • (Hash) 


84
85
86
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 84

def custom_headers
  @custom_headers
end

#debugging ⇒ 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.

Returns:

  • (true, false) 


54
55
56
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 54

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



130
131
132
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 130

def force_ending_format
  @force_ending_format
end

#http_request_timeout ⇒ Object

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



75
76
77
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 75

def http_request_timeout
  @http_request_timeout
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



128
129
130
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 128

def inject_format
  @inject_format
end

#key_file ⇒ Object

TLS/SSL setting Client private key file (for client certificate)



119
120
121
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 119

def key_file
  @key_file
end

#logger ⇒ #debug

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

Returns:

  • (#debug) 


60
61
62
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 60

def logger
  @logger
end

#params_encoding ⇒ Object

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

github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96

See Also:

  • params_encoding option of Ethon. Related source code:


126
127
128
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 126

def params_encoding
  @params_encoding
end

#ssl_ca_cert ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145

Returns:

  • (String) —

    the path to the certificate file

See Also:

  • `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:


111
112
113
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 111

def ssl_ca_cert
  @ssl_ca_cert
end

#temp_folder_path ⇒ String

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

Returns:

  • (String) 


67
68
69
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 67

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



71
72
73
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 71

def timeout
  @timeout
end

#verify_ssl ⇒ true, false

Note:

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

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

Returns:

  • (true, false) 


93
94
95
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 93

def verify_ssl
  @verify_ssl
end

#verify_ssl_host ⇒ true, false

Note:

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

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

Returns:

  • (true, false) 


102
103
104
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 102

def verify_ssl_host
  @verify_ssl_host
end

#version ⇒ Object

Defines platform version



34
35
36
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 34

def version
  @version
end

Class Method Details

.default ⇒ Object

The default Configuration object.



154
155
156
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 154

def self.default
  @@default ||= Configuration.new
end

Instance Method Details

#base_path ⇒ Object 



184
185
186
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 184

def base_path
  "#{[base_url, version].join('/')}".sub(/\/+\z/, '')
end

#configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



158
159
160
 
# File 'lib/aspose_slides_cloud/configuration.rb', line 158

def configure
  yield(self) if block_given?
end

#getUrlHostPart(url) ⇒ Object 



170
171
172
173
174
175
176
 
# 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