Class: WindcaveRest::Configuration

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/windcave_rest/configuration.rb', line 135

def initialize
  @scheme = 'https'
  @host = 'uat.windcave.com'
  @supported_environments = { :test => "uat.windcave.com", :live => "sec.windcave.com" }
  @environment = "test"
  @base_path = '/api/v1'
  @api_key = {}
  @api_key_prefix = {}
  @timeout = 0
  @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)
  @api_version = '1'
  @retry_interval = 0
  @num_retries =  3      
  @user_agent = "windcave_rest/#{VERSION}/ruby"

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



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

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)



27
28
29
 
# File 'lib/windcave_rest/configuration.rb', line 27

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



35
36
37
 
# File 'lib/windcave_rest/configuration.rb', line 35

def api_key_prefix
  @api_key_prefix
end

#api_version ⇒ Object

Returns the value of attribute api_version.



129
130
131
 
# File 'lib/windcave_rest/configuration.rb', line 129

def api_version
  @api_version
end

#base_path ⇒ Object

Defines url base path



13
14
15
 
# File 'lib/windcave_rest/configuration.rb', line 13

def base_path
  @base_path
end

#cert_file ⇒ Object

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



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

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


55
56
57
 
# File 'lib/windcave_rest/configuration.rb', line 55

def debugging
  @debugging
end

#environment ⇒ Object

Current environment



19
20
21
 
# File 'lib/windcave_rest/configuration.rb', line 19

def environment
  @environment
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



127
128
129
 
# File 'lib/windcave_rest/configuration.rb', line 127

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



10
11
12
 
# File 'lib/windcave_rest/configuration.rb', line 10

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



125
126
127
 
# File 'lib/windcave_rest/configuration.rb', line 125

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



116
117
118
 
# File 'lib/windcave_rest/configuration.rb', line 116

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) 


61
62
63
 
# File 'lib/windcave_rest/configuration.rb', line 61

def logger
  @logger
end

#num_retries ⇒ Object

Number of retries allowed if the first one fails. Default to 0 (no retries).



76
77
78
 
# File 'lib/windcave_rest/configuration.rb', line 76

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


123
124
125
 
# File 'lib/windcave_rest/configuration.rb', line 123

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:



45
46
47
 
# File 'lib/windcave_rest/configuration.rb', line 45

def password
  @password
end

#platform ⇒ Object

Returns the value of attribute platform.



131
132
133
 
# File 'lib/windcave_rest/configuration.rb', line 131

def platform
  @platform
end

#retry_interval ⇒ Object

Retry interval. Default to 0 (retry immediately).



80
81
82
 
# File 'lib/windcave_rest/configuration.rb', line 80

def retry_interval
  @retry_interval
end

#scheme ⇒ Object

Defines url scheme



7
8
9
 
# File 'lib/windcave_rest/configuration.rb', line 7

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:


108
109
110
 
# File 'lib/windcave_rest/configuration.rb', line 108

def ssl_ca_cert
  @ssl_ca_cert
end

#supported_environments ⇒ Object

Supported environments



16
17
18
 
# File 'lib/windcave_rest/configuration.rb', line 16

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



68
69
70
 
# File 'lib/windcave_rest/configuration.rb', line 68

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



72
73
74
 
# File 'lib/windcave_rest/configuration.rb', line 72

def timeout
  @timeout
end

#user_agent ⇒ Object

Returns the value of attribute user_agent.



133
134
135
 
# File 'lib/windcave_rest/configuration.rb', line 133

def user_agent
  @user_agent
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:



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

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) 


90
91
92
 
# File 'lib/windcave_rest/configuration.rb', line 90

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) 


99
100
101
 
# File 'lib/windcave_rest/configuration.rb', line 99

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



162
163
164
 
# File 'lib/windcave_rest/configuration.rb', line 162

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



200
201
202
203
204
205
206
 
# File 'lib/windcave_rest/configuration.rb', line 200

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.



222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/windcave_rest/configuration.rb', line 222

def auth_settings
  {
    'Authorization' =>
      {
        type: 'api_key',
        in: 'header',
        key: 'Authorization',
        value: api_key_with_prefix('Authorization')
      },
  }
end

#base_url ⇒ Object 



193
194
195
196
 
# File 'lib/windcave_rest/configuration.rb', line 193

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

#basic_auth_token ⇒ Object

Gets Basic Auth token string



209
210
211
 
# File 'lib/windcave_rest/configuration.rb', line 209

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

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

Yields:

  • (_self)

Yield Parameters:



166
167
168
 
# File 'lib/windcave_rest/configuration.rb', line 166

def configure
  yield(self) if block_given?
end