Class: Hubspot::Events::Configuration
- Inherits:
-
Object
- Object
- Hubspot::Events::Configuration
- Defined in:
- lib/hubspot/codegen/events/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.
-
#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) ⇒ Object
Gets API key (with prefix if set).
-
#auth_settings ⇒ Object
Returns Auth Settings hash for api client.
- #base_url ⇒ Object
-
#basic_auth_token ⇒ Object
Gets Basic Auth token string.
- #configure {|_self| ... } ⇒ Object
-
#initialize {|_self| ... } ⇒ Configuration
constructor
A new instance of Configuration.
-
#server_settings ⇒ Object
Returns an array of Server setting.
-
#server_url(index, variables = {}) ⇒ Object
Returns URL based on server settings.
Constructor Details
#initialize {|_self| ... } ⇒ Configuration
Returns a new instance of Configuration.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 131 def initialize @scheme = 'https' @host = 'api.hubapi.com' @base_path = '' @api_key = {} @api_key_prefix = {} @timeout = 0 @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) # 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.
52 53 54 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 52 def access_token @access_token end |
#api_key ⇒ Hash
Defines API keys used with API Key authentications.
31 32 33 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 31 def api_key @api_key end |
#api_key_prefix ⇒ Hash
Defines API key prefixes used with API Key authentications.
39 40 41 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 39 def api_key_prefix @api_key_prefix end |
#base_path ⇒ Object
Defines url base path
23 24 25 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 23 def base_path @base_path end |
#cert_file ⇒ Object
TLS/SSL setting Client certificate file (for client certificate)
112 113 114 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 112 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.
81 82 83 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 81 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.
59 60 61 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 59 def debugging @debugging end |
#error_handler ⇒ Object
Returns the value of attribute error_handler.
129 130 131 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 129 def error_handler @error_handler end |
#force_ending_format ⇒ Object
Returns the value of attribute force_ending_format.
127 128 129 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 127 def force_ending_format @force_ending_format end |
#host ⇒ Object
Defines url host
20 21 22 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 20 def host @host end |
#inject_format ⇒ Object
Returns the value of attribute inject_format.
125 126 127 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 125 def inject_format @inject_format end |
#key_file ⇒ Object
TLS/SSL setting Client private key file (for client certificate)
116 117 118 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 116 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.
65 66 67 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 65 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
123 124 125 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 123 def params_encoding @params_encoding end |
#password ⇒ String
Defines the password used with HTTP basic authentication.
49 50 51 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 49 def password @password end |
#scheme ⇒ Object
Defines url scheme
17 18 19 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 17 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
108 109 110 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 108 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`.
72 73 74 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 72 def temp_folder_path @temp_folder_path end |
#timeout ⇒ Object
The time limit for HTTP request in seconds. Default to 0 (never times out).
76 77 78 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 76 def timeout @timeout end |
#username ⇒ String
Defines the username used with HTTP basic authentication.
44 45 46 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 44 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.
90 91 92 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 90 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.
99 100 101 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 99 def verify_ssl_host @verify_ssl_host end |
Class Method Details
.default ⇒ Object
The default Configuration object.
155 156 157 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 155 def self.default @@default ||= Configuration.new end |
Instance Method Details
#api_key_with_prefix(param_name) ⇒ Object
Gets API key (with prefix if set).
185 186 187 188 189 190 191 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 185 def api_key_with_prefix(param_name) if @api_key_prefix[param_name] "#{@api_key_prefix[param_name]} #{@api_key[param_name]}" else @api_key[param_name] end end |
#auth_settings ⇒ Object
Returns Auth Settings hash for api client.
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 199 def auth_settings { 'hapikey' => { type: 'api_key', in: 'query', key: 'hapikey', value: api_key_with_prefix('hapikey') }, 'oauth2' => { type: 'oauth2', in: 'header', key: 'Authorization', value: "Bearer #{access_token}" }, } end |
#base_url ⇒ Object
179 180 181 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 179 def base_url "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') end |
#basic_auth_token ⇒ Object
Gets Basic Auth token string
194 195 196 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 194 def basic_auth_token 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n") end |
#configure {|_self| ... } ⇒ Object
159 160 161 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 159 def configure yield(self) if block_given? end |
#server_settings ⇒ Object
Returns an array of Server setting
219 220 221 222 223 224 225 226 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 219 def server_settings [ { url: "https://api.hubapi.com/", description: "No description provided", } ] end |
#server_url(index, variables = {}) ⇒ Object
Returns URL based on server settings
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/hubspot/codegen/events/configuration.rb', line 232 def server_url(index, variables = {}) servers = server_settings # 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] # go through variable and assign a value server[:variables].each do |name, variable| if variables.key?(name) if (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 |