Class: WebApiActivequerybuilder::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/webapi-active-query-builder/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:


136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/webapi-active-query-builder/configuration.rb', line 136

def initialize
  @scheme = 'https'
  @host = 'webapi.activequerybuilder.com'
  @base_path = ''
  @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)

  yield(self) if block_given?
end

Instance Attribute Details

#access_tokenObject

Defines the access token (Bearer) used with OAuth2.


64
65
66
# File 'lib/webapi-active-query-builder/configuration.rb', line 64

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)


43
44
45
# File 'lib/webapi-active-query-builder/configuration.rb', line 43

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


51
52
53
# File 'lib/webapi-active-query-builder/configuration.rb', line 51

def api_key_prefix
  @api_key_prefix
end

#base_pathObject

Defines url base path


35
36
37
# File 'lib/webapi-active-query-builder/configuration.rb', line 35

def base_path
  @base_path
end

#cert_fileObject

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


119
120
121
# File 'lib/webapi-active-query-builder/configuration.rb', line 119

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

71
72
73
# File 'lib/webapi-active-query-builder/configuration.rb', line 71

def debugging
  @debugging
end

#force_ending_formatObject

Returns the value of attribute force_ending_format


134
135
136
# File 'lib/webapi-active-query-builder/configuration.rb', line 134

def force_ending_format
  @force_ending_format
end

#hostObject

Defines url host


32
33
34
# File 'lib/webapi-active-query-builder/configuration.rb', line 32

def host
  @host
end

#inject_formatObject

Returns the value of attribute inject_format


132
133
134
# File 'lib/webapi-active-query-builder/configuration.rb', line 132

def inject_format
  @inject_format
end

#key_fileObject

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


123
124
125
# File 'lib/webapi-active-query-builder/configuration.rb', line 123

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)

77
78
79
# File 'lib/webapi-active-query-builder/configuration.rb', line 77

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:

130
131
132
# File 'lib/webapi-active-query-builder/configuration.rb', line 130

def params_encoding
  @params_encoding
end

#passwordString

Defines the password used with HTTP basic authentication.

Returns:

  • (String)

61
62
63
# File 'lib/webapi-active-query-builder/configuration.rb', line 61

def password
  @password
end

#schemeObject

Defines url scheme


29
30
31
# File 'lib/webapi-active-query-builder/configuration.rb', line 29

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:

115
116
117
# File 'lib/webapi-active-query-builder/configuration.rb', line 115

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)

84
85
86
# File 'lib/webapi-active-query-builder/configuration.rb', line 84

def temp_folder_path
  @temp_folder_path
end

#timeoutObject

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


88
89
90
# File 'lib/webapi-active-query-builder/configuration.rb', line 88

def timeout
  @timeout
end

#usernameString

Defines the username used with HTTP basic authentication.

Returns:

  • (String)

56
57
58
# File 'lib/webapi-active-query-builder/configuration.rb', line 56

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)

97
98
99
# File 'lib/webapi-active-query-builder/configuration.rb', line 97

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)

106
107
108
# File 'lib/webapi-active-query-builder/configuration.rb', line 106

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.defaultObject

The default Configuration object.


157
158
159
# File 'lib/webapi-active-query-builder/configuration.rb', line 157

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


188
189
190
191
192
193
194
# File 'lib/webapi-active-query-builder/configuration.rb', line 188

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.


202
203
204
205
# File 'lib/webapi-active-query-builder/configuration.rb', line 202

def auth_settings
  {
  }
end

#base_urlObject


181
182
183
184
# File 'lib/webapi-active-query-builder/configuration.rb', line 181

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

#basic_auth_tokenObject

Gets Basic Auth token string


197
198
199
# File 'lib/webapi-active-query-builder/configuration.rb', line 197

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

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

Yields:

  • (_self)

Yield Parameters:


161
162
163
# File 'lib/webapi-active-query-builder/configuration.rb', line 161

def configure
  yield(self) if block_given?
end