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:


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/oauth/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_tokenObject

Defines the access token (Bearer) used with OAuth2.


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

def access_token
  @access_token
end

#api_keyHash

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)


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

def api_key
  @api_key
end

#api_key_prefixHash

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


39
40
41
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 39

def api_key_prefix
  @api_key_prefix
end

#base_pathObject

Defines url base path


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

def base_path
  @base_path
end

#cert_fileObject

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


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

def cert_file
  @cert_file
end

#client_side_validationtrue, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false)

81
82
83
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 81

def client_side_validation
  @client_side_validation
end

#debuggingtrue, 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)

59
60
61
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 59

def debugging
  @debugging
end

#error_handlerObject

Returns the value of attribute error_handler


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

def error_handler
  @error_handler
end

#force_ending_formatObject

Returns the value of attribute force_ending_format


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

def force_ending_format
  @force_ending_format
end

#hostObject

Defines url host


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

def host
  @host
end

#inject_formatObject

Returns the value of attribute inject_format


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

def inject_format
  @inject_format
end

#key_fileObject

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


116
117
118
# File 'lib/hubspot/codegen/oauth/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.

Returns:

  • (#debug)

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

def logger
  @logger
end

#params_encodingObject

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:

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

def params_encoding
  @params_encoding
end

#passwordString

Defines the password used with HTTP basic authentication.

Returns:

  • (String)

49
50
51
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 49

def password
  @password
end

#schemeObject

Defines url scheme


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

def scheme
  @scheme
end

#ssl_ca_certString

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:

108
109
110
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 108

def ssl_ca_cert
  @ssl_ca_cert
end

#temp_folder_pathString

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use `Tempfile`.

Returns:

  • (String)

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

def temp_folder_path
  @temp_folder_path
end

#timeoutObject

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


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

def timeout
  @timeout
end

#usernameString

Defines the username used with HTTP basic authentication.

Returns:

  • (String)

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

def username
  @username
end

#verify_ssltrue, 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)

90
91
92
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 90

def verify_ssl
  @verify_ssl
end

#verify_ssl_hosttrue, 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)

99
100
101
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 99

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.defaultObject

The default Configuration object.


155
156
157
# File 'lib/hubspot/codegen/oauth/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).

Parameters:

  • param_name (String)

    the parameter name of API key auth


185
186
187
188
189
190
191
# File 'lib/hubspot/codegen/oauth/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_settingsObject

Returns Auth Settings hash for api client.


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

def auth_settings
  {
  }
end

#base_urlObject


179
180
181
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 179

def base_url
  "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
end

#basic_auth_tokenObject

Gets Basic Auth token string


194
195
196
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 194

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

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

Yields:

  • (_self)

Yield Parameters:


159
160
161
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 159

def configure
  yield(self) if block_given?
end

#server_settingsObject

Returns an array of Server setting


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

def server_settings
  [
    {
      url: "https://api.hubapi.com/",
      description: "No description provided",
    }
  ]
end

#server_url(index, variables = {}) ⇒ 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


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/hubspot/codegen/oauth/configuration.rb', line 218

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