Class: Hubspot::OAuth::Configuration

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



144
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
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 144

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.



64
65
66
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 64

def access_token
  @access_token
end

#api_key ⇒ Hash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • (Hash) —

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



43
44
45
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 43

def api_key
  @api_key
end

#api_key_prefix ⇒ Hash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • (Hash) —

    key: parameter name, value: API key prefix



51
52
53
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 51

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



23
24
25
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 23

def base_path
  @base_path
end

#cert_file ⇒ Object

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



124
125
126
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 124

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) 


93
94
95
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 93

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) 


71
72
73
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 71

def debugging
  @debugging
end

#error_handler ⇒ Object

Returns the value of attribute error_handler.



142
143
144
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 142

def error_handler
  @error_handler
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



140
141
142
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 140

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



20
21
22
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 20

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



138
139
140
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 138

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



128
129
130
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 128

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) 


77
78
79
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 77

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:


135
136
137
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 135

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


61
62
63
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 61

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



17
18
19
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 17

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



26
27
28
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 26

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



29
30
31
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 29

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



35
36
37
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 35

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



32
33
34
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 32

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

Returns:

  • (String) —

    the path to the certificate file

See Also:

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


120
121
122
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 120

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) 


84
85
86
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 84

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



88
89
90
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 88

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


56
57
58
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 56

def username
  @username
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) 


102
103
104
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 102

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) 


111
112
113
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 111

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



172
173
174
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 172

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).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



206
207
208
209
210
211
212
213
214
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 206

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.



222
223
224
225
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 222

def auth_settings
  {
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



197
198
199
200
201
202
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 197

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



217
218
219
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 217

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

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

Yields:

  • (_self)

Yield Parameters:



176
177
178
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 176

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



237
238
239
240
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 237

def operation_server_settings
  {
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



228
229
230
231
232
233
234
235
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 228

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

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 246

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