Class: Hubspot::Cms::Hubdb::Configuration
- Inherits:
-
Object
- Object
- Hubspot::Cms::Hubdb::Configuration
- Defined in:
- lib/hubspot/codegen/cms/hubdb/configuration.rb
Instance Attribute Summary collapse
-
#access_token ⇒ Object
Defines the access token (Bearer) used with OAuth2.
-
#api_key ⇒ Hash
Defines API keys used with API Key authentications.
-
#api_key_prefix ⇒ Hash
Defines API key prefixes used with API Key authentications.
-
#base_path ⇒ Object
Defines url base path.
-
#cert_file ⇒ Object
TLS/SSL setting Client certificate file (for client certificate).
-
#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.
-
#error_handler ⇒ Object
Returns the value of attribute error_handler.
-
#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.
-
#password ⇒ String
Defines the password used with HTTP basic authentication.
-
#scheme ⇒ Object
Defines url scheme.
-
#server_index ⇒ Object
Define server configuration index.
-
#server_operation_index ⇒ Object
Define server operation configuration index.
-
#server_operation_variables ⇒ Object
Default server operation variables.
-
#server_variables ⇒ Object
Default server variables.
-
#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.
-
#username ⇒ String
Defines the username used with HTTP basic authentication.
-
#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
-
#api_key_with_prefix(param_name, param_alias = nil) ⇒ Object
Gets API key (with prefix if set).
-
#auth_settings ⇒ Object
Returns Auth Settings hash for api client.
-
#base_url(operation = nil) ⇒ Object
Returns base URL for specified operation based on server settings.
-
#basic_auth_token ⇒ Object
Gets Basic Auth token string.
- #configure {|_self| ... } ⇒ Object
-
#initialize {|_self| ... } ⇒ Configuration
constructor
A new instance of Configuration.
- #operation_server_settings ⇒ Object
-
#server_settings ⇒ Object
Returns an array of Server setting.
-
#server_url(index, variables = {}, servers = nil) ⇒ Object
Returns URL based on server settings.
Constructor Details
#initialize {|_self| ... } ⇒ Configuration
Returns a new instance of Configuration.
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 145 def initialize @scheme = 'https' @host = 'api.hubapi.com' @base_path = '' @server_index = 0 @server_operation_index = {} @server_variables = {} @server_operation_variables = {} @api_key = {} @api_key_prefix = {} @client_side_validation = true @verify_ssl = true @verify_ssl_host = true @cert_file = nil @key_file = nil @timeout = 0 @params_encoding = nil @debugging = false @inject_format = false @force_ending_format = false @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT) # error_handler params: { 'status_code': { max_retries: ..., seconds_delay: ... }, ... } @error_handler = {} yield(self) if block_given? end |
Instance Attribute Details
#access_token ⇒ Object
Defines the access token (Bearer) used with OAuth2.
65 66 67 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 65 def access_token @access_token end |
#api_key ⇒ Hash
Defines API keys used with API Key authentications.
44 45 46 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 44 def api_key @api_key end |
#api_key_prefix ⇒ Hash
Defines API key prefixes used with API Key authentications.
52 53 54 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 52 def api_key_prefix @api_key_prefix end |
#base_path ⇒ Object
Defines url base path
24 25 26 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 24 def base_path @base_path end |
#cert_file ⇒ Object
TLS/SSL setting Client certificate file (for client certificate)
125 126 127 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 125 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.
94 95 96 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 94 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.
72 73 74 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 72 def debugging @debugging end |
#error_handler ⇒ Object
Returns the value of attribute error_handler.
143 144 145 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 143 def error_handler @error_handler end |
#force_ending_format ⇒ Object
Returns the value of attribute force_ending_format.
141 142 143 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 141 def force_ending_format @force_ending_format end |
#host ⇒ Object
Defines url host
21 22 23 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 21 def host @host end |
#inject_format ⇒ Object
Returns the value of attribute inject_format.
139 140 141 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 139 def inject_format @inject_format end |
#key_file ⇒ Object
TLS/SSL setting Client private key file (for client certificate)
129 130 131 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 129 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.
78 79 80 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 78 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
136 137 138 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 136 def params_encoding @params_encoding end |
#password ⇒ String
Defines the password used with HTTP basic authentication.
62 63 64 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 62 def password @password end |
#scheme ⇒ Object
Defines url scheme
18 19 20 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 18 def scheme @scheme end |
#server_index ⇒ Object
Define server configuration index
27 28 29 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 27 def server_index @server_index end |
#server_operation_index ⇒ Object
Define server operation configuration index
30 31 32 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 30 def server_operation_index @server_operation_index end |
#server_operation_variables ⇒ Object
Default server operation variables
36 37 38 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 36 def server_operation_variables @server_operation_variables end |
#server_variables ⇒ Object
Default server variables
33 34 35 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 33 def server_variables @server_variables 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
121 122 123 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 121 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`.
85 86 87 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 85 def temp_folder_path @temp_folder_path end |
#timeout ⇒ Object
The time limit for HTTP request in seconds. Default to 0 (never times out).
89 90 91 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 89 def timeout @timeout end |
#username ⇒ String
Defines the username used with HTTP basic authentication.
57 58 59 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 57 def username @username 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.
103 104 105 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 103 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.
112 113 114 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 112 def verify_ssl_host @verify_ssl_host end |
Class Method Details
.default ⇒ Object
The default Configuration object.
173 174 175 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 173 def self.default @@default ||= Configuration.new end |
Instance Method Details
#api_key_with_prefix(param_name, param_alias = nil) ⇒ Object
Gets API key (with prefix if set).
207 208 209 210 211 212 213 214 215 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 207 def api_key_with_prefix(param_name, param_alias = nil) key = @api_key[param_name] key = @api_key.fetch(param_alias, key) unless param_alias.nil? if @api_key_prefix[param_name] "#{@api_key_prefix[param_name]} #{key}" else key end end |
#auth_settings ⇒ Object
Returns Auth Settings hash for api client.
223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 223 def auth_settings { 'oauth2' => { type: 'oauth2', in: 'header', key: 'Authorization', value: "Bearer #{access_token}" }, } end |
#base_url(operation = nil) ⇒ Object
Returns base URL for specified operation based on server settings
198 199 200 201 202 203 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 198 def base_url(operation = nil) index = server_operation_index.fetch(operation, server_index) return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation]) end |
#basic_auth_token ⇒ Object
Gets Basic Auth token string
218 219 220 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 218 def basic_auth_token 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n") end |
#configure {|_self| ... } ⇒ Object
177 178 179 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 177 def configure yield(self) if block_given? end |
#operation_server_settings ⇒ Object
245 246 247 248 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 245 def operation_server_settings { } end |
#server_settings ⇒ Object
Returns an array of Server setting
236 237 238 239 240 241 242 243 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 236 def server_settings [ { url: "https://api.hubapi.com", description: "No description provided", } ] end |
#server_url(index, variables = {}, servers = nil) ⇒ Object
Returns URL based on server settings
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/hubspot/codegen/cms/hubdb/configuration.rb', line 254 def server_url(index, variables = {}, servers = nil) servers = server_settings if servers == nil # check array index out of bound if (index < 0 || index >= servers.size) fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}" end server = servers[index] url = server[:url] return url unless server.key? :variables # go through variable and assign a value server[:variables].each do |name, variable| if variables.key?(name) if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name])) url.gsub! "{" + name.to_s + "}", variables[name] else fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}." end else # use default value url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value] end end url end |