Class: Hubspot::Crm::Contacts::Configuration

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 127

def initialize
  @scheme = 'https'
  @host = 'api.hubapi.com'
  @base_path = ''
  @api_key = {}
  @api_key_prefix = {}
  @timeout = 0
  @client_side_validation = true
  @ssl_verify = true
  @ssl_verify_mode = nil
  @ssl_ca_file = nil
  @ssl_client_cert = nil
  @ssl_client_key = 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.



53
54
55
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 53

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)



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

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



40
41
42
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 40

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



24
25
26
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 24

def base_path
  @base_path
end

#client_side_validation ⇒ true, false

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

Returns:

  • (true, false) 


82
83
84
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 82

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) 


60
61
62
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 60

def debugging
  @debugging
end

#error_handler ⇒ Object

Returns the value of attribute error_handler.



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

def error_handler
  @error_handler
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



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

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



21
22
23
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 21

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



121
122
123
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 121

def inject_format
  @inject_format
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

Returns:

  • (#debug) 


66
67
68
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 66

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:


119
120
121
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 119

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


50
51
52
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 50

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



18
19
20
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 18

def scheme
  @scheme
end

#ssl_ca_file ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

Returns:

  • (String) —

    the path to the certificate file



104
105
106
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 104

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

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



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

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

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



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

def ssl_client_key
  @ssl_client_key
end

#ssl_verify ⇒ 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) 


91
92
93
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 91

def ssl_verify
  @ssl_verify
end

#ssl_verify_mode ⇒ Object

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Any ‘OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)



98
99
100
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 98

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


73
74
75
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 73

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



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

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


45
46
47
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 45

def username
  @username
end

Class Method Details

.default ⇒ Object

The default Configuration object.



151
152
153
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 151

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



181
182
183
184
185
186
187
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 181

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.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 195

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 



175
176
177
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 175

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

#basic_auth_token ⇒ Object

Gets Basic Auth token string



190
191
192
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 190

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

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

Yields:

  • (_self)

Yield Parameters:



155
156
157
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 155

def configure
  yield(self) if block_given?
end

#server_settings ⇒ Object

Returns an array of Server setting



215
216
217
218
219
220
221
222
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 215

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/hubspot/codegen/crm/contacts/configuration.rb', line 228

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