Class: AsposeCellsCloud::Configuration
- Inherits:
-
Object
- Object
- AsposeCellsCloud::Configuration
- Defined in:
- lib/aspose_cells_cloud/configuration.rb
Instance Attribute Summary collapse
-
#access_token ⇒ Object
Defines the access token (Bearer) used with OAuth2.
-
#api_version ⇒ Object
Defines api version.
-
#cert_file ⇒ Object
TLS/SSL setting Client certificate file (for client certificate).
-
#client_id ⇒ Object
Client ID.
-
#client_secret ⇒ Object
Client Secret.
-
#client_side_validation ⇒ true, false
Set this to false to skip client side validation in the operation.
-
#debugging ⇒ true, false
Set this to enable/disable debugging.
-
#force_ending_format ⇒ Object
Returns the value of attribute force_ending_format.
-
#host ⇒ Object
Defines url host.
-
#inject_format ⇒ Object
Returns the value of attribute inject_format.
-
#key_file ⇒ Object
TLS/SSL setting Client private key file (for client certificate).
-
#logger ⇒ #debug
Defines the logger used for debugging.
-
#params_encoding ⇒ Object
Set this to customize parameters encoding of array parameter with multi collectionFormat.
-
#scheme ⇒ Object
Defines url scheme.
-
#ssl_ca_cert ⇒ String
TLS/SSL setting Set this to customize the certificate file to verify the peer.
-
#temp_folder_path ⇒ String
Defines the temporary folder to store downloaded files (for API endpoints that have file response).
-
#timeout ⇒ Object
The time limit for HTTP request in seconds.
-
#verify_ssl ⇒ true, false
TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server.
-
#verify_ssl_host ⇒ true, false
TLS/SSL setting Set this to false to skip verifying SSL host name Default to true.
Class Method Summary collapse
-
.default ⇒ Object
The default Configuration object.
Instance Method Summary collapse
-
#auth_settings ⇒ Object
Returns Auth Settings hash for api client.
- #base_url ⇒ Object
- #configure {|_self| ... } ⇒ Object
-
#initialize {|_self| ... } ⇒ Configuration
constructor
A new instance of Configuration.
Constructor Details
#initialize {|_self| ... } ⇒ Configuration
Returns a new instance of Configuration.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# 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 |
Instance Attribute Details
#access_token ⇒ Object
Defines the access token (Bearer) used with OAuth2.
50 51 52 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 50 def access_token @access_token end |
#api_version ⇒ Object
Defines api version
47 48 49 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 47 def api_version @api_version end |
#cert_file ⇒ Object
TLS/SSL setting Client certificate file (for client certificate)
110 111 112 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 110 def cert_file @cert_file end |
#client_id ⇒ Object
Client ID
38 39 40 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 38 def client_id @client_id end |
#client_secret ⇒ Object
Client Secret
35 36 37 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 35 def client_secret @client_secret end |
#client_side_validation ⇒ true, false
Set this to false to skip client side validation in the operation. Default to true.
79 80 81 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 79 def client_side_validation @client_side_validation 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.
57 58 59 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 57 def debugging @debugging end |
#force_ending_format ⇒ Object
Returns the value of attribute force_ending_format.
125 126 127 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 125 def force_ending_format @force_ending_format end |
#host ⇒ Object
Defines url host
44 45 46 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 44 def host @host end |
#inject_format ⇒ Object
Returns the value of attribute inject_format.
123 124 125 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 123 def inject_format @inject_format end |
#key_file ⇒ Object
TLS/SSL setting Client private key file (for client certificate)
114 115 116 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 114 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.
63 64 65 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 63 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
121 122 123 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 121 def params_encoding @params_encoding end |
#scheme ⇒ Object
Defines url scheme
41 42 43 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 41 def scheme @scheme 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
106 107 108 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 106 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`.
70 71 72 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 70 def temp_folder_path @temp_folder_path end |
#timeout ⇒ Object
The time limit for HTTP request in seconds. Default to 0 (never times out).
74 75 76 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 74 def timeout @timeout end |
#verify_ssl ⇒ true, false
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.
88 89 90 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 88 def verify_ssl @verify_ssl end |
#verify_ssl_host ⇒ true, false
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.
97 98 99 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 97 def verify_ssl_host @verify_ssl_host end |
Class Method Details
.default ⇒ Object
The default Configuration object.
147 148 149 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 147 def self.default @@default ||= Configuration.new end |
Instance Method Details
#auth_settings ⇒ Object
Returns Auth Settings hash for api client.
174 175 176 177 178 179 180 181 182 183 184 |
# 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 ⇒ Object
165 166 167 168 169 170 171 |
# 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| ... } ⇒ Object
151 152 153 |
# File 'lib/aspose_cells_cloud/configuration.rb', line 151 def configure yield(self) if block_given? end |