Class: OrderCloud::Configuration

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/order_cloud/configuration.rb', line 156

def initialize
  @scheme = 'https'
  @host = 'api.ordercloud.io'
  @base_path = '/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)

  @auth_url = 'https://auth.ordercloud.io/oauth/token'
  @impersonation_token = nil
  @access_token = nil
  @client_id = ''
  @scopes = []

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



84
85
86
 
# File 'lib/order_cloud/configuration.rb', line 84

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)



63
64
65
 
# File 'lib/order_cloud/configuration.rb', line 63

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



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

def api_key_prefix
  @api_key_prefix
end

#auth_url ⇒ Object

Returns the value of attribute auth_url.



31
32
33
 
# File 'lib/order_cloud/configuration.rb', line 31

def auth_url
  @auth_url
end

#base_path ⇒ Object

Defines url base path



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

def base_path
  @base_path
end

#cert_file ⇒ Object

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



139
140
141
 
# File 'lib/order_cloud/configuration.rb', line 139

def cert_file
  @cert_file
end

#client_id ⇒ Object

OrderCloud specific configuration



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

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


91
92
93
 
# File 'lib/order_cloud/configuration.rb', line 91

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



154
155
156
 
# File 'lib/order_cloud/configuration.rb', line 154

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



52
53
54
 
# File 'lib/order_cloud/configuration.rb', line 52

def host
  @host
end

#impersonation_token ⇒ Object

Returns the value of attribute impersonation_token.



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

def impersonation_token
  @impersonation_token
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



152
153
154
 
# File 'lib/order_cloud/configuration.rb', line 152

def inject_format
  @inject_format
end

#key_file ⇒ Object

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



143
144
145
 
# File 'lib/order_cloud/configuration.rb', line 143

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) 


97
98
99
 
# File 'lib/order_cloud/configuration.rb', line 97

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:


150
151
152
 
# File 'lib/order_cloud/configuration.rb', line 150

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


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

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



49
50
51
 
# File 'lib/order_cloud/configuration.rb', line 49

def scheme
  @scheme
end

#scopes ⇒ Object

Returns the value of attribute scopes.



30
31
32
 
# File 'lib/order_cloud/configuration.rb', line 30

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


135
136
137
 
# File 'lib/order_cloud/configuration.rb', line 135

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) 


104
105
106
 
# File 'lib/order_cloud/configuration.rb', line 104

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



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

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


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

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) 


117
118
119
 
# File 'lib/order_cloud/configuration.rb', line 117

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) 


126
127
128
 
# File 'lib/order_cloud/configuration.rb', line 126

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



183
184
185
 
# File 'lib/order_cloud/configuration.rb', line 183

def self.default
  @@default ||= Configuration.new
end

.reset ⇒ Object

Resets the default configuration object to a clean one



188
189
190
 
# File 'lib/order_cloud/configuration.rb', line 188

def self.reset
  @@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



219
220
221
222
223
224
225
 
# File 'lib/order_cloud/configuration.rb', line 219

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.



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/order_cloud/configuration.rb', line 233

def auth_settings
  {
    'oauth2' =>
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{get_access_token.access_token}"
      },
  }
end

#base_url ⇒ Object 



212
213
214
215
 
# File 'lib/order_cloud/configuration.rb', line 212

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



228
229
230
 
# File 'lib/order_cloud/configuration.rb', line 228

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

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

Yields:

  • (_self)

Yield Parameters:



192
193
194
 
# File 'lib/order_cloud/configuration.rb', line 192

def configure
  yield(self) if block_given?
end

#get_access_token ⇒ Object

Returns the appropriate token



40
41
42
43
44
45
46
 
# File 'lib/order_cloud/configuration.rb', line 40

def get_access_token
  if impersonating?
    @impersonation_token
  else
    @access_token
  end
end

#impersonating? ⇒ Boolean

Returns true if impersonation is on, false otherwise

Returns:

  • (Boolean) 


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

def impersonating?
  @impersonation_token
end