Class: SourcesApiClient::Configuration

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


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/sources-api-client/configuration.rb', line 128

def initialize
  @scheme = 'https'
  @host = 'cloud.redhat.com'
  @base_path = '//api/sources/v3.0'
  @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)

  yield(self) if block_given?
end

Instance Attribute Details

#access_tokenObject

Defines the access token (Bearer) used with OAuth2.


51
52
53
# File 'lib/sources-api-client/configuration.rb', line 51

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)


30
31
32
# File 'lib/sources-api-client/configuration.rb', line 30

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


38
39
40
# File 'lib/sources-api-client/configuration.rb', line 38

def api_key_prefix
  @api_key_prefix
end

#base_pathObject

Defines url base path


22
23
24
# File 'lib/sources-api-client/configuration.rb', line 22

def base_path
  @base_path
end

#cert_fileObject

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


111
112
113
# File 'lib/sources-api-client/configuration.rb', line 111

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)

80
81
82
# File 'lib/sources-api-client/configuration.rb', line 80

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)

58
59
60
# File 'lib/sources-api-client/configuration.rb', line 58

def debugging
  @debugging
end

#force_ending_formatObject

Returns the value of attribute force_ending_format


126
127
128
# File 'lib/sources-api-client/configuration.rb', line 126

def force_ending_format
  @force_ending_format
end

#hostObject

Defines url host


19
20
21
# File 'lib/sources-api-client/configuration.rb', line 19

def host
  @host
end

#inject_formatObject

Returns the value of attribute inject_format


124
125
126
# File 'lib/sources-api-client/configuration.rb', line 124

def inject_format
  @inject_format
end

#key_fileObject

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


115
116
117
# File 'lib/sources-api-client/configuration.rb', line 115

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)

64
65
66
# File 'lib/sources-api-client/configuration.rb', line 64

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:

122
123
124
# File 'lib/sources-api-client/configuration.rb', line 122

def params_encoding
  @params_encoding
end

#passwordString

Defines the password used with HTTP basic authentication.

Returns:

  • (String)

48
49
50
# File 'lib/sources-api-client/configuration.rb', line 48

def password
  @password
end

#schemeObject

Defines url scheme


16
17
18
# File 'lib/sources-api-client/configuration.rb', line 16

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:

107
108
109
# File 'lib/sources-api-client/configuration.rb', line 107

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)

71
72
73
# File 'lib/sources-api-client/configuration.rb', line 71

def temp_folder_path
  @temp_folder_path
end

#timeoutObject

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


75
76
77
# File 'lib/sources-api-client/configuration.rb', line 75

def timeout
  @timeout
end

#usernameString

Defines the username used with HTTP basic authentication.

Returns:

  • (String)

43
44
45
# File 'lib/sources-api-client/configuration.rb', line 43

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)

89
90
91
# File 'lib/sources-api-client/configuration.rb', line 89

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)

98
99
100
# File 'lib/sources-api-client/configuration.rb', line 98

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.defaultObject

The default Configuration object.


150
151
152
# File 'lib/sources-api-client/configuration.rb', line 150

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


180
181
182
183
184
185
186
# File 'lib/sources-api-client/configuration.rb', line 180

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.


194
195
196
197
198
199
200
201
202
203
204
# File 'lib/sources-api-client/configuration.rb', line 194

def auth_settings
  {
    'UserSecurity' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
  }
end

#base_urlObject


174
175
176
# File 'lib/sources-api-client/configuration.rb', line 174

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

#basic_auth_tokenObject

Gets Basic Auth token string


189
190
191
# File 'lib/sources-api-client/configuration.rb', line 189

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

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

Yields:

  • (_self)

Yield Parameters:


154
155
156
# File 'lib/sources-api-client/configuration.rb', line 154

def configure
  yield(self) if block_given?
end

#server_settingsObject

Returns an array of Server setting


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# File 'lib/sources-api-client/configuration.rb', line 207

def server_settings
  [
    {
      url: "https://cloud.redhat.com/{basePath}",
      description: "Production Server",
      variables: {
        basePath: {
            description: "No descriptoin provided",
            default_value: "/api/sources/v3.0",
          }
        }
    },
    {
      url: "http://localhost:{port}/{basePath}",
      description: "Development Server",
      variables: {
        port: {
            description: "No descriptoin provided",
            default_value: "3000",
          },
        basePath: {
            description: "No descriptoin provided",
            default_value: "/api/sources/v3.0",
          }
        }
    }
  ]
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


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/sources-api-client/configuration.rb', line 240

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