Class: AsposePdfCloud::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_pdf_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:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# 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

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



46
47
48
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 46

def access_token
  @access_token
end

#app_key ⇒ Object

App Key



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

def app_key
  @app_key
end

#app_sid ⇒ Object

App SID



37
38
39
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 37

def app_sid
  @app_sid
end

#cert_file ⇒ Object

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



106
107
108
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 106

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) 


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

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.

Returns:

  • (true, false) 


53
54
55
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 53

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



121
122
123
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 121

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



43
44
45
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 43

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



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

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



110
111
112
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 110

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) 


59
60
61
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 59

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:


117
118
119
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 117

def params_encoding
  @params_encoding
end

#scheme ⇒ Object

Defines url scheme



40
41
42
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 40

def scheme
  @scheme
end

#self_host ⇒ Object

SelfHost



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

def self_host
  @self_host
end

#self_host_url ⇒ Object

SelfHost URL



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

def self_host_url
  @self_host_url
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:


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

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) 


66
67
68
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 66

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to 0 (never times out).



70
71
72
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 70

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) 


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

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) 


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

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



142
143
144
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 142

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

Instance Method Details

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 170

def auth_settings
  {
    'JWT' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
  }
end

#base_url ⇒ Object 



160
161
162
163
164
165
166
167
 
# 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

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

Yields:

  • (_self)

Yield Parameters:



146
147
148
 
# File 'lib/aspose_pdf_cloud/configuration.rb', line 146

def configure
  yield(self) if block_given?
end