Class: Fastly::Configuration

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/fastly/configuration.rb', line 151

def initialize
  @scheme = 'https'
  @host = 'api.fastly.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
  @params_encoding = nil
  @cert_file = nil
  @key_file = nil
  @timeout = 0
  @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.



74
75
76
 
# File 'lib/fastly/configuration.rb', line 74

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)



40
41
42
 
# File 'lib/fastly/configuration.rb', line 40

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



48
49
50
 
# File 'lib/fastly/configuration.rb', line 48

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



20
21
22
 
# File 'lib/fastly/configuration.rb', line 20

def base_path
  @base_path
end

#cert_file ⇒ Object

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



134
135
136
 
# File 'lib/fastly/configuration.rb', line 134

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) 


103
104
105
 
# File 'lib/fastly/configuration.rb', line 103

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) 


81
82
83
 
# File 'lib/fastly/configuration.rb', line 81

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



149
150
151
 
# File 'lib/fastly/configuration.rb', line 149

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



17
18
19
 
# File 'lib/fastly/configuration.rb', line 17

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



147
148
149
 
# File 'lib/fastly/configuration.rb', line 147

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



138
139
140
 
# File 'lib/fastly/configuration.rb', line 138

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) 


87
88
89
 
# File 'lib/fastly/configuration.rb', line 87

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:


145
146
147
 
# File 'lib/fastly/configuration.rb', line 145

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


71
72
73
 
# File 'lib/fastly/configuration.rb', line 71

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



14
15
16
 
# File 'lib/fastly/configuration.rb', line 14

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



23
24
25
 
# File 'lib/fastly/configuration.rb', line 23

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



26
27
28
 
# File 'lib/fastly/configuration.rb', line 26

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



32
33
34
 
# File 'lib/fastly/configuration.rb', line 32

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



29
30
31
 
# File 'lib/fastly/configuration.rb', line 29

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:


130
131
132
 
# File 'lib/fastly/configuration.rb', line 130

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) 


94
95
96
 
# File 'lib/fastly/configuration.rb', line 94

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



98
99
100
 
# File 'lib/fastly/configuration.rb', line 98

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


66
67
68
 
# File 'lib/fastly/configuration.rb', line 66

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) 


112
113
114
 
# File 'lib/fastly/configuration.rb', line 112

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) 


121
122
123
 
# File 'lib/fastly/configuration.rb', line 121

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



177
178
179
 
# File 'lib/fastly/configuration.rb', line 177

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/fastly/configuration.rb', line 211

def api_key_with_prefix(param_name, param_alias = nil)
  if param_name == 'token'
    key = self.api_token
    key = ENV['FASTLY_API_TOKEN'] if key.nil?
    return key
  end
  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

#api_token ⇒ String

Defines API token used with API token authentication.

Examples:

API token is “xxx”

config.api_token = 'xxx'

Returns:

  • (String) —

    API token



56
57
58
 
# File 'lib/fastly/configuration.rb', line 56

def api_token
  @api_key['token']
end

#api_token=(val) ⇒ Object 



59
60
61
 
# File 'lib/fastly/configuration.rb', line 59

def api_token=(val)
  @api_key['token'] = val
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



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
259
260
261
262
263
 
# File 'lib/fastly/configuration.rb', line 232

def auth_settings
  {
    'session_password_change' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
    'token' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Fastly-Key',
        value: api_key_with_prefix('token')
      },
    'url_purge' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
    'username_and_password' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



202
203
204
205
206
207
 
# File 'lib/fastly/configuration.rb', line 202

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



227
228
229
 
# File 'lib/fastly/configuration.rb', line 227

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

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

Yields:

  • (_self)

Yield Parameters:



181
182
183
 
# File 'lib/fastly/configuration.rb', line 181

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



279
280
281
282
 
# File 'lib/fastly/configuration.rb', line 279

def operation_server_settings
  {
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/fastly/configuration.rb', line 266

def server_settings
  [
    {
      url: "https://api.fastly.com",
      description: "No description provided",
    },
    {
      url: "https://rt.fastly.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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/fastly/configuration.rb', line 288

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