Class: TransferZero::Configuration

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/transferzero-sdk/configuration.rb', line 122

def initialize
  @scheme = 'https'
  @host = 'api-sandbox.transferzero.com'
  @base_path = '/v1'
  @server_index = nil
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = ''
  @api_secret = ''
  @timeout = 0
  @client_side_validation = true
  @ssl_verify = true
  @ssl_verify_mode = nil
  @ssl_ca_file = nil
  @ssl_client_cert = nil
  @ssl_client_key = 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

#api_key ⇒ String

Defines API key used with API Key authentications.



43
44
45
 
# File 'lib/transferzero-sdk/configuration.rb', line 43

def api_key
  @api_key
end

#api_secret ⇒ String

Defines API secret used with API Key authentications.



50
51
52
 
# File 'lib/transferzero-sdk/configuration.rb', line 50

def api_secret
  @api_secret
end

#base_path ⇒ Object

Defines url base path



24
25
26
 
# File 'lib/transferzero-sdk/configuration.rb', line 24

def base_path
  @base_path
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.



79
80
81
 
# File 'lib/transferzero-sdk/configuration.rb', line 79

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.



57
58
59
 
# File 'lib/transferzero-sdk/configuration.rb', line 57

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



120
121
122
 
# File 'lib/transferzero-sdk/configuration.rb', line 120

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



21
22
23
 
# File 'lib/transferzero-sdk/configuration.rb', line 21

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



118
119
120
 
# File 'lib/transferzero-sdk/configuration.rb', line 118

def inject_format
  @inject_format
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.



63
64
65
 
# File 'lib/transferzero-sdk/configuration.rb', line 63

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:


116
117
118
 
# File 'lib/transferzero-sdk/configuration.rb', line 116

def params_encoding
  @params_encoding
end

#scheme ⇒ Object

Defines url scheme



18
19
20
 
# File 'lib/transferzero-sdk/configuration.rb', line 18

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



27
28
29
 
# File 'lib/transferzero-sdk/configuration.rb', line 27

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



30
31
32
 
# File 'lib/transferzero-sdk/configuration.rb', line 30

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



36
37
38
 
# File 'lib/transferzero-sdk/configuration.rb', line 36

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



33
34
35
 
# File 'lib/transferzero-sdk/configuration.rb', line 33

def server_variables
  @server_variables
end

#ssl_ca_file ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.



101
102
103
 
# File 'lib/transferzero-sdk/configuration.rb', line 101

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

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



105
106
107
 
# File 'lib/transferzero-sdk/configuration.rb', line 105

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

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



109
110
111
 
# File 'lib/transferzero-sdk/configuration.rb', line 109

def ssl_client_key
  @ssl_client_key
end

#ssl_verify ⇒ 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.



88
89
90
 
# File 'lib/transferzero-sdk/configuration.rb', line 88

def ssl_verify
  @ssl_verify
end

#ssl_verify_mode ⇒ Object

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Any ‘OpenSSL::SSL::` constant (see ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)



95
96
97
 
# File 'lib/transferzero-sdk/configuration.rb', line 95

def ssl_verify_mode
  @ssl_verify_mode
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.



70
71
72
 
# File 'lib/transferzero-sdk/configuration.rb', line 70

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

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



74
75
76
 
# File 'lib/transferzero-sdk/configuration.rb', line 74

def timeout
  @timeout
end

Class Method Details

.default ⇒ Object

The default Configuration object.



148
149
150
 
# File 'lib/transferzero-sdk/configuration.rb', line 148

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

Instance Method Details

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



184
185
186
187
 
# File 'lib/transferzero-sdk/configuration.rb', line 184

def auth_settings
  {
  }
end

#base_url(operation = nil) ⇒ Object 



172
173
174
175
176
177
 
# File 'lib/transferzero-sdk/configuration.rb', line 172

def base_url(operation = nil)
  index = server_operation_index.fetch(operation, server_index)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

  server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



179
180
181
 
# File 'lib/transferzero-sdk/configuration.rb', line 179

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

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

Yields:

  • (_self)

Yield Parameters:



152
153
154
 
# File 'lib/transferzero-sdk/configuration.rb', line 152

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



203
204
205
206
 
# File 'lib/transferzero-sdk/configuration.rb', line 203

def operation_server_settings
  {
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/transferzero-sdk/configuration.rb', line 190

def server_settings
  [
    {
      url: "https://api-sandbox.transferzero.com/v1",
      description: "No description provided",
    },
    {
      url: "https://api.transferzero.com/v1",
      description: "No description provided",
    }
  ]
end

#server_url(index, variables = {}, servers = nil) ⇒ Object

Returns URL based on server settings



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/transferzero-sdk/configuration.rb', line 212

def server_url(index, variables = {}, servers = nil)
  servers = server_settings if servers == nil

  # 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]

  return url unless server.key? :variables

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (!server[:variables][name].key?(:enum_values) || 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