Class: CloudsmithApi::Configuration

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



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

def initialize
  @scheme = 'https'
  @host = 'api.cloudsmith.io'
  @base_path = '/v1'
  @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_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



53
54
55
 
# File 'lib/cloudsmith-api/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/cloudsmith-api/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/cloudsmith-api/configuration.rb', line 40

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



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

def base_path
  @base_path
end

#cert_file ⇒ Object

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



113
114
115
 
# File 'lib/cloudsmith-api/configuration.rb', line 113

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) 


82
83
84
 
# File 'lib/cloudsmith-api/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/cloudsmith-api/configuration.rb', line 60

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



128
129
130
 
# File 'lib/cloudsmith-api/configuration.rb', line 128

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



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

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



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

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



117
118
119
 
# File 'lib/cloudsmith-api/configuration.rb', line 117

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) 


66
67
68
 
# File 'lib/cloudsmith-api/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:


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

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


50
51
52
 
# File 'lib/cloudsmith-api/configuration.rb', line 50

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



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

def scheme
  @scheme
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:


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

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) 


73
74
75
 
# File 'lib/cloudsmith-api/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/cloudsmith-api/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/cloudsmith-api/configuration.rb', line 45

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) 


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

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) 


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

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



152
153
154
 
# File 'lib/cloudsmith-api/configuration.rb', line 152

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



183
184
185
186
187
188
189
 
# File 'lib/cloudsmith-api/configuration.rb', line 183

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.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/cloudsmith-api/configuration.rb', line 197

def auth_settings
  {
    'apikey' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'X-Api-Key',
        value: api_key_with_prefix('X-Api-Key')
      },
    'basic' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
    'token' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Authorization',
        value: api_key_with_prefix('Authorization')
      },
  }
end

#base_url ⇒ Object 



176
177
178
179
 
# File 'lib/cloudsmith-api/configuration.rb', line 176

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

#basic_auth_token ⇒ Object

Gets Basic Auth token string



192
193
194
 
# File 'lib/cloudsmith-api/configuration.rb', line 192

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

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

Yields:

  • (_self)

Yield Parameters:



156
157
158
 
# File 'lib/cloudsmith-api/configuration.rb', line 156

def configure
  yield(self) if block_given?
end