Class: PostfinancecheckoutRubySdk::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(default_headers = {}) {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 146

def initialize(default_headers = {})
  @scheme = 'https'
  @host = 'checkout.postfinance.ch'
  @base_path = '/api/v2.0'
  @server_index = nil
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @client_side_validation = true
  @ssl_verify = true
  @ssl_verify_mode = nil
  @ssl_ca_file = nil
  @ssl_client_cert = nil
  @ssl_client_key = nil
  @middlewares = Hash.new { |h, k| h[k] = [] }
  @configure_connection_blocks = []
  @timeout = 25
  # return data as binary instead of file
  @return_binary_data = false
  @params_encoder = nil
  @debugging = false
  @ignore_operation_servers = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
  @default_headers = default_headers
  @user_id = ''
  @authentication_key = ''

  yield(self) if block_given?
end

Instance Attribute Details

#authentication_key ⇒ String

Defines the authentication_key used for request authentication.

Returns:

  • (String) 


54
55
56
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 54

def authentication_key
  @authentication_key
end

#base_path ⇒ Object

Defines url base path



32
33
34
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 32

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.

Returns:

  • (true, false) 


96
97
98
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 96

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) 


66
67
68
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 66

def debugging
  @debugging
end

#default_headers ⇒ Object

Returns the value of attribute default_headers.



144
145
146
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 144

def default_headers
  @default_headers
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



142
143
144
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 142

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



29
30
31
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 29

def host
  @host
end

#ignore_operation_servers ⇒ true, false

Set this to ignore operation servers for the API client. This is useful when you need to send requests to a different server than the one specified in the OpenAPI document. Will default to the base url defined in the spec but can be overridden by setting ‘scheme`, `host`, `base_path` directly. Default to false.

Returns:

  • (true, false) 


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

def ignore_operation_servers
  @ignore_operation_servers
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



140
141
142
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 140

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.

Returns:

  • (#debug) 


80
81
82
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 80

def logger
  @logger
end

#params_encoder ⇒ Object

Set this to customize parameters encoder of array parameter. Default to nil. Faraday uses NestedParamsEncoder when nil.

github.com/lostisland/faraday/tree/main/lib/faraday/encoders

See Also:

  • params_encoder option of Faraday. Related source code:


137
138
139
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 137

def params_encoder
  @params_encoder
end

#proxy ⇒ Object

Proxy setting HTTP Proxy settings



130
131
132
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 130

def proxy
  @proxy
end

#return_binary_data ⇒ Object

Set this to return data as binary instead of downloading a temp file. When enabled (set to true) HTTP responses with return type ‘File` will be returned as a stream of binary data. Default to false.



59
60
61
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 59

def return_binary_data
  @return_binary_data
end

#scheme ⇒ Object

Defines url scheme



26
27
28
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 26

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



35
36
37
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 35

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



38
39
40
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 38

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



44
45
46
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 44

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



41
42
43
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 41

def server_variables
  @server_variables
end

#ssl_ca_file ⇒ String

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

Returns:

  • (String) —

    the path to the certificate file



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

def ssl_ca_file
  @ssl_ca_file
end

#ssl_client_cert ⇒ Object

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



122
123
124
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 122

def ssl_client_cert
  @ssl_client_cert
end

#ssl_client_key ⇒ Object

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



126
127
128
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 126

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.

Returns:

  • (true, false) 


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

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)



112
113
114
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 112

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`.

Returns:

  • (String) 


87
88
89
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 87

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to .



91
92
93
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 91

def timeout
  @timeout
end

#user_id ⇒ String

Defines the user_id used for request authentication.

Returns:

  • (String) 


49
50
51
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 49

def user_id
  @user_id
end

Class Method Details

.default ⇒ Object

The default Configuration object.



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

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

Instance Method Details

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



204
205
206
207
208
209
210
211
212
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 204

def base_url(operation = nil)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
  if operation_server_settings.key?(operation) then
    index = server_operation_index.fetch(operation, server_index)
    server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
  else
    server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
  end
end

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

Yields:

  • (_self)

Yield Parameters:



183
184
185
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 183

def configure
  yield(self) if block_given?
end

#configure_connection(conn) ⇒ Object 



283
284
285
286
287
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 283

def configure_connection(conn)
  @configure_connection_blocks.each do |block|
    block.call(conn)
  end
end

#configure_faraday_connection(&block) ⇒ Object

Configure Faraday connection directly.

“‘ c.configure_faraday_connection do |conn|

conn.use Faraday::HttpCache, shared_cache: false, logger: logger
conn.response :logger, nil, headers: true, bodies: true, log_level: :debug do |logger|
  logger.filter(/(Authorization: )(.*)/, '\1[REDACTED]')
end

end

c.configure_faraday_connection do |conn|

conn.adapter :typhoeus

end “‘

Parameters:

  • block (Proc) —

    ‘#call`able object that takes one arg, the connection



279
280
281
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 279

def configure_faraday_connection(&block)
  @configure_connection_blocks << block
end

#configure_middleware(connection) ⇒ Object

Set up middleware on the connection



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 326

def configure_middleware(connection)
  return if @middlewares.empty?

  [:request, :response, :use, :insert, :insert_before, :insert_after, :swap].each do |operation|
    next unless @middlewares.key?(operation)

    @middlewares[operation].each do |key, args, block|
      connection.builder.send(operation, key, *args, &block)
    end
  end

  if @middlewares.key?(:delete)
    @middlewares[:delete].each do |key, _args, _block|
      connection.builder.delete(key)
    end
  end
end

#operation_server_settings ⇒ Object 



224
225
226
227
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 224

def operation_server_settings
  {
  }
end

#request(*middleware) ⇒ Object

Adds request middleware to the stack



295
296
297
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 295

def request(*middleware)
  set_faraday_middleware(:request, *middleware)
end

#response(*middleware) ⇒ Object

Adds response middleware to the stack



300
301
302
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 300

def response(*middleware)
  set_faraday_middleware(:response, *middleware)
end

#server_settings ⇒ Object

Returns an array of Server setting



215
216
217
218
219
220
221
222
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 215

def server_settings
  [
    {
      url: "https://checkout.postfinance.ch/api/v2.0",
      description: "No description provided",
    }
  ]
end

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

Returns URL based on server settings

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 233

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

  # check array index out of bound
  if (index.nil? || index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and 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

#set_faraday_middleware(operation, key, *args, &block) ⇒ Object

Adds Faraday middleware setting information to the stack

Examples:

Use the ‘set_faraday_middleware` method to set middleware information

config.set_faraday_middleware(:request, :retry, max: 3, methods: [:get, :post], retry_statuses: [503])
config.set_faraday_middleware(:response, :logger, nil, { bodies: true, log_level: :debug })
config.set_faraday_middleware(:use, Faraday::HttpCache, store: Rails.cache, shared_cache: false)
config.set_faraday_middleware(:insert, 0, FaradayMiddleware::FollowRedirects, { standards_compliant: true, limit: 1 })
config.set_faraday_middleware(:swap, 0, Faraday::Response::Logger)
config.set_faraday_middleware(:delete, Faraday::Multipart::Middleware)

See Also:



315
316
317
318
319
320
321
322
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 315

def set_faraday_middleware(operation, key, *args, &block)
  unless [:request, :response, :use, :insert, :insert_before, :insert_after, :swap, :delete].include?(operation)
    fail ArgumentError, "Invalid faraday middleware operation #{operation}. Must be" \
                        " :request, :response, :use, :insert, :insert_before, :insert_after, :swap or :delete."
  end

  @middlewares[operation] << [key, args, block]
end

#use(*middleware) ⇒ Object

Adds middleware to the stack



290
291
292
 
# File 'lib/postfinancecheckout-ruby-sdk/configuration.rb', line 290

def use(*middleware)
  set_faraday_middleware(:use, *middleware)
end