Class: KlaviyoAPI::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/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:

[View source]

140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 140

def initialize
  @scheme = 'https'
  @host = 'a.klaviyo.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)

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.


62
63
64
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 62

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)


41
42
43
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 41

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


49
50
51
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 49

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path


21
22
23
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 21

def base_path
  @base_path
end

#cert_file ⇒ Object

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


122
123
124
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 122

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) 

91
92
93
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 91

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) 

69
70
71
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 69

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.


138
139
140
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 138

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host


18
19
20
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 18

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.


136
137
138
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 136

def inject_format
  @inject_format
end

#key_file ⇒ Object

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


126
127
128
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 126

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) 

75
76
77
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 75

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:

133
134
135
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 133

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 

59
60
61
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 59

def password
  @password
end

#scheme ⇒ Object

Defines url scheme


15
16
17
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 15

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index


24
25
26
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 24

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index


27
28
29
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 27

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables


33
34
35
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 33

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables


30
31
32
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 30

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:

118
119
120
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 118

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) 

82
83
84
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 82

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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


86
87
88
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 86

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 

54
55
56
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 54

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) 

100
101
102
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 100

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) 

109
110
111
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 109

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.

[View source]

166
167
168
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 166

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

[View source]

200
201
202
203
204
205
206
207
208
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 200

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.

[View source]

216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 216

def auth_settings
  auth = {}
  if api_key_with_prefix('Klaviyo-API-Key')
    auth['Klaviyo-API-Key'] = {
      type: 'api_key',
      in: 'header',
      key: 'Authorization',
      value: api_key_with_prefix('Klaviyo-API-Key')
    }
  end
  if access_token
    auth['OAuth'] = {
      type: 'oauth2',
      in: 'header',
      key: 'Authorization',
      value: "Bearer #{access_token}"
    }
  end
  auth
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings

[View source]

191
192
193
194
195
196
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 191

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

[View source]

211
212
213
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 211

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

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

Yields:

  • (_self)

Yield Parameters:

[View source]

170
171
172
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 170

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object

[View source]

251
252
253
254
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 251

def operation_server_settings
  {
  }
end

#server_settings ⇒ Object

Returns an array of Server setting

[View source]

238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 238

def server_settings
  [
    {
      url: "https://a.klaviyo.com",
      description: "Production",
    },
    {
      url: "http://localhost:8080",
      description: "Local server",
    }
  ]
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

[View source]

260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/klaviyo-api-sdk/configuration.rb', line 260

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