Class: CyberSource::ApiClient

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api_client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = Configuration.default) ⇒ ApiClient

Initializes the ApiClient

Parameters:

  • config (Hash) (defaults to: Configuration.default) —

    a customizable set of options

Options Hash (config):

  • Configuration (Configuration) —

    for initializing the object, default to Configuration.default



38
39
40
41
42
43
44
45
46
 
# File 'lib/cybersource_rest_client/api_client.rb', line 38

def initialize(config = Configuration.default)
  @config = config
  @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
  @default_headers = {
    'User-Agent' => @user_agent
  }

  @client_id = 'cybs-rest-sdk-ruby-' + Gem.loaded_specs["cybersource_rest_client"].version.to_s
end

Instance Attribute Details

#accept_header ⇒ Object

Defines the user-defined Accept Header Type



34
35
36
 
# File 'lib/cybersource_rest_client/api_client.rb', line 34

def accept_header
  @accept_header
end

#client_id ⇒ Object

Defines the client ID for the SDK



31
32
33
 
# File 'lib/cybersource_rest_client/api_client.rb', line 31

def client_id
  @client_id
end

#config ⇒ Object

The Configuration object holding settings to be used in the API client.



23
24
25
 
# File 'lib/cybersource_rest_client/api_client.rb', line 23

def config
  @config
end

#default_headers ⇒ Hash

Defines the headers to be used in HTTP requests of all API calls by default.

Returns:

  • (Hash) 


28
29
30
 
# File 'lib/cybersource_rest_client/api_client.rb', line 28

def default_headers
  @default_headers
end

Class Method Details

.default ⇒ Object 



52
53
54
 
# File 'lib/cybersource_rest_client/api_client.rb', line 52

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

Instance Method Details

#build_collection_param(param, collection_format) ⇒ Object

Build parameter value according to the given collection format.

Parameters:

  • collection_format (String) —

    one of :csv, :ssv, :tsv, :pipes and :multi



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/cybersource_rest_client/api_client.rb', line 488

def build_collection_param(param, collection_format)
  case collection_format
  when :csv
    param.join(',')
  when :ssv
    param.join(' ')
  when :tsv
    param.join("\t")
  when :pipes
    param.join('|')
  when :multi
    # return the array directly as typhoeus will handle it as expected
    param
  else
    fail "unknown collection format: #{collection_format.inspect}"
  end
end

#build_request(http_method, path, opts = {}) ⇒ Typhoeus::Request

Builds the HTTP request

Parameters:

  • http_method (String) —

    HTTP method/verb (e.g. POST)

  • path (String) —

    URL path (e.g. /account/new)

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :header_params (Hash) —

    Header parameters

  • :query_params (Hash) —

    Query parameters

  • :form_params (Hash) —

    Query parameters

  • :body (Object) —

    HTTP body (JSON/XML)

Returns:

  • (Typhoeus::Request) —

    A Typhoeus Request



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/cybersource_rest_client/api_client.rb', line 110

def build_request(http_method, path, opts = {})
  url = build_request_url(path)
  body_params = opts[:body] || {}
  query_params = opts[:query_params] || {}
  if !query_params.empty?
    query_params = Addressable::URI.form_encode(query_params)
  end

  headers = opts[:header_params]
  if $merchantconfig_obj.authenticationType.upcase != Constants::AUTH_TYPE_MUTUAL_AUTH
    headers = CallAuthenticationHeader(http_method, path, body_params, headers, query_params)
  end
  http_method = http_method.to_sym.downcase
  header_params = headers.merge(@default_headers)
  form_params = opts[:form_params] || {}


  # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
  _verify_ssl_host = @config.verify_ssl_host ? 2 : 0

  # client cert
  if $merchantconfig_obj.enableClientCert
    @config.cert_file = File.join($merchantconfig_obj.clientCertDirectory, $merchantconfig_obj.sslClientCert)
    @config.key_file = File.join($merchantconfig_obj.clientCertDirectory, $merchantconfig_obj.privateKey)
  end

  req_opts = {
    :method => http_method,
    :headers => header_params,
    :params => query_params,
    :params_encoding => @config.params_encoding,
    :timeout => @config.timeout,
    :ssl_verifypeer => @config.verify_ssl,
    :ssl_verifyhost => _verify_ssl_host,
    :sslcert => @config.cert_file,
    :sslkeypasswd => $merchantconfig_obj.sslKeyPassword || "",
    :sslkey => @config.key_file,
    :verbose => @config.debugging
  }

  # set custom cert, if provided
  req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert

  if [:post, :patch, :put, :delete].include?(http_method)
    req_body = build_request_body(header_params, form_params, opts[:body])
    req_opts.update :body => req_body
    if @config.debugging
        begin
        raise
            @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
        rescue
            puts 'Cannot write to log'
        end
    end
  end

  request = Typhoeus::Request.new(url, req_opts)
  download_file(request) if opts[:return_type] == 'File'
  request
end

#build_request_body(header_params, form_params, body) ⇒ String

Builds the HTTP request body

Parameters:

  • header_params (Hash) —

    Header parameters

  • form_params (Hash) —

    Query parameters

  • body (Object) —

    HTTP body (JSON/XML)

Returns:

  • (String) —

    HTTP body data in the form of string



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/cybersource_rest_client/api_client.rb', line 384

def build_request_body(header_params, form_params, body)
  # http form
  if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
      header_params['Content-Type'] == 'multipart/form-data'
    data = {}
    form_params.each do |key, value|
      case value
      when ::File, ::Array, nil
        # let typhoeus handle File, Array and nil parameters
        data[key] = value
      else
        data[key] = value.to_s
      end
    end
    JSON.parse(body).each do |key, value|
      case value
      when ::File, ::Array, nil
        # let typhoeus handle File, Array and nil parameters
        data[key] = value
      else
        data[key] = value.to_s
      end
    end
  elsif body
    data = body.is_a?(String) ? body : body.to_json
  else
    data = nil
  end
  data
end

#build_request_url(path) ⇒ Object 



372
373
374
375
376
 
# File 'lib/cybersource_rest_client/api_client.rb', line 372

def build_request_url(path)
  # Add leading and trailing slashes to path
  path = "/#{path}".gsub(/\/+/, '/')
  Addressable::URI.encode(@config.base_url + path)
end

#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Call an API with given options.

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    an array of 3 elements: the data deserialized from response body (could be nil), response status code and response headers.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/cybersource_rest_client/api_client.rb', line 60

def call_api(http_method, path, opts = {})
  unless @accept_header.nil? || @accept_header.empty?
    default_accept_header = ',' + (opts[:header_params])['Accept']
    default_accept_header = @accept_header + default_accept_header.sub(',' + @accept_header, '')
    opts[:header_params]['Accept'] = default_accept_header
  end

  request = build_request(http_method, path, opts)
  response = request.run

  if @config.debugging
    begin
    raise
        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
    rescue
        puts 'Cannot write to log'
    end
  end

  unless response.success?
    if response.timed_out?
      fail ApiError.new('Connection timed out')
    elsif response.code == 0
      # Errors from libcurl will be made visible here
      fail ApiError.new(:code => 0,
                        :message => response.return_message)
    else
      fail ApiError.new(:code => response.code,
                        :response_headers => response.headers,
                        :response_body => response.body)
    end
  end

  if opts[:return_type]
    data = deserialize(response, opts[:return_type])
  else
    data = nil
  end
  return response.body, response.code, response.headers
end

#CallAuthenticationHeader(http_method, path, body_params, header_params, query_params) ⇒ Object

Calling Authentication



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/cybersource_rest_client/api_client.rb', line 177

def CallAuthenticationHeader(http_method, path, body_params, header_params, query_params)
  require_relative '../AuthenticationSDK/core/Authorization.rb'
  require_relative '../AuthenticationSDK/authentication/payloadDigest/digest.rb'
  request_target = get_query_param(path, query_params)
  # Request Type. [Non-Editable]
  request_type = http_method.to_s
  log_obj = Log.new $merchantconfig_obj.log_config, "ApiClient"
  # Set Request Type into the merchant config object.
  $merchantconfig_obj.requestType = request_type
  # Set Request Target into the merchant config object.
  $merchantconfig_obj.requestTarget = request_target
  # Construct the URL.
  url = Constants::HTTPS_URI_PREFIX + $merchantconfig_obj.requestHost + $merchantconfig_obj.requestTarget
  # set Request Json to Merchant config object
  $merchantconfig_obj.requestJsonData = body_params
  # Set URL into the merchant config object.
  $merchantconfig_obj.requestUrl = url
  # Calling APISDK, Apisdk.controller.
  gmtDateTime = DateTime.now.httpdate
  token = Authorization.new.getToken($merchantconfig_obj, gmtDateTime)

  # Adding client ID header
  header_params['v-c-client-id'] = @client_id

  # Adding solution ID header
  # header_params['v-c-solution-id'] = $merchantconfig_obj.solutionId if !$merchantconfig_obj.solutionId.nil? && !$merchantconfig_obj.solutionId.empty?
  # HTTP header 'Accept' (if needed)
  if $merchantconfig_obj.authenticationType.upcase == Constants::AUTH_TYPE_HTTP
    # Appending headers for Get Connection
    header_params['v-c-merchant-id'] = $merchantconfig_obj.merchantId
    header_params['Date'] = gmtDateTime
    header_params['Host'] = $merchantconfig_obj.requestHost
    header_params['Signature'] = token
    if request_type == Constants::POST_REQUEST_TYPE || request_type == Constants::PUT_REQUEST_TYPE || request_type == Constants::PATCH_REQUEST_TYPE
      digest = DigestGeneration.new.generateDigest(body_params)
      digest_payload = Constants::SHA256 + digest
      header_params['Digest'] = digest_payload
    end
  end
  if $merchantconfig_obj.authenticationType.upcase == Constants::AUTH_TYPE_JWT
    token = "Bearer " + token
    header_params['Authorization'] = token
  end
  if $merchantconfig_obj.authenticationType.upcase == Constants::AUTH_TYPE_OAUTH
    token = "Bearer " + token
    header_params['Authorization'] = token
  end
  # header_params.each do |key, value|
  #  log_obj.logger.info("#{key} : #{value}")
  # end
  return header_params
end

#convert_to_type(data, return_type) ⇒ Mixed

Convert data to the given return type.

Parameters:

  • data (Object) —

    Data to be converted

  • return_type (String) —

    Return type

Returns:

  • (Mixed) —

    Data in a particular type



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/cybersource_rest_client/api_client.rb', line 289

def convert_to_type(data, return_type)
  return nil if data.nil?
  case return_type
  when 'String'
    data.to_s
  when 'Integer'
    data.to_i
  when 'Float'
    data.to_f
  when 'BOOLEAN'
    data == true
  when 'DateTime'
    # parse date time (expecting ISO 8601 format)
    DateTime.parse data
  when 'Date'
    # parse date time (expecting ISO 8601 format)
    Date.parse data
  when 'Object'
    # generic object (usually a Hash), return directly
    data
  when /\AArray<(.+)>\z/
    # e.g. Array<Pet>
    sub_type = $1
    data.map { |item| convert_to_type(item, sub_type) }
  when /\AHash\<String, (.+)\>\z/
    # e.g. Hash<String, Integer>
    sub_type = $1
    {}.tap do |hash|
      data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
    end
  else
    # models, e.g. Pet
    CyberSource.const_get(return_type).new.tap do |model|
      model.build_from_hash data
    end
  end
end

#deserialize(response, return_type) ⇒ Object

Deserialize the response to the given return type.

Parameters:

  • response (Response) —

    HTTP response

  • return_type (String) —

    some examples: “User”, “Array”, “Hash”



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/cybersource_rest_client/api_client.rb', line 255

def deserialize(response, return_type)
  body = response.body

  # handle file downloading - return the File instance processed in request callbacks
  # note that response body is empty when the file is written in chunks in request on_body callback
  return @tempfile if return_type == 'File'

  return nil if body.nil? || body.empty?

  # return response body directly for String return type
  return body if return_type == 'String'

  # ensuring a default content type
  content_type = response.headers['Content-Type'] || 'application/json'

  fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)

  begin
    data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
  rescue JSON::ParserError => e
    if %w(String Date DateTime).include?(return_type)
      data = body
    else
      raise e
    end
  end

  convert_to_type data, return_type
end

#download_file(request) ⇒ Object

Save response body into a file in (the defined) temporary folder, using the filename from the “Content-Disposition” header if provided, otherwise a random filename. The response body is written to the file in chunks in order to handle files which size is larger than maximum Ruby String or even larger than the maximum memory a Ruby process can use.

See Also:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/cybersource_rest_client/api_client.rb', line 334

def download_file(request)
  tempfile = nil
  encoding = nil
  request.on_headers do |response|
    content_disposition = response.headers['Content-Disposition']
    if content_disposition && content_disposition =~ /filename=/i
      filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
      prefix = sanitize_filename(filename)
    else
      prefix = 'download-'
    end
    prefix = prefix + '-' unless prefix.end_with?('-')
    encoding = response.body.encoding
    tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
    @tempfile = tempfile
  end
  request.on_body do |chunk|
    chunk.force_encoding(encoding)
    tempfile.write(chunk)
  end
  request.on_complete do |response|
    tempfile.close
    @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
                        "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
                        "will be deleted automatically with GC. It's also recommended to delete the temp file "\
                        "explicitly with `tempfile.delete`"
  end
end

#get_query_param(path, query_params) ⇒ Object 



229
230
231
232
233
234
235
236
237
 
# File 'lib/cybersource_rest_client/api_client.rb', line 229

def get_query_param(path, query_params)
  request_target = ''
  if !query_params.empty?
    request_target = @config.base_path + path + '?' + query_params
  else
    request_target = @config.base_path + path
  end
  request_target
end

#json_mime?(mime) ⇒ Boolean

Check if the given MIME is a JSON MIME. JSON MIME examples:

application/json
application/json; charset=UTF8
APPLICATION/JSON
*/*

Parameters:

  • mime (String) —

    MIME

Returns:

  • (Boolean) —

    True if the MIME is application/json



247
248
249
 
# File 'lib/cybersource_rest_client/api_client.rb', line 247

def json_mime?(mime)
  (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
end

#object_to_hash(obj) ⇒ String

Convert object(non-array) to hash.

Parameters:

  • obj (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



478
479
480
481
482
483
484
 
# File 'lib/cybersource_rest_client/api_client.rb', line 478

def object_to_hash(obj)
  if obj.respond_to?(:to_hash)
    obj.to_hash
  else
    obj
  end
end

#object_to_http_body(model) ⇒ String

Convert object (array, hash, object, etc) to JSON string.

Parameters:

  • model (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



464
465
466
467
468
469
470
471
472
473
 
# File 'lib/cybersource_rest_client/api_client.rb', line 464

def object_to_http_body(model)
  return model if model.nil? || model.is_a?(String)
  local_body = nil
  if model.is_a?(Array)
    local_body = model.map { |m| object_to_hash(m) }
  else
    local_body = object_to_hash(model)
  end
  local_body.to_json
end

#sanitize_filename(filename) ⇒ String

Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif

Parameters:

  • filename (String) —

    the filename to be sanitized

Returns:

  • (String) —

    the sanitized filename



368
369
370
 
# File 'lib/cybersource_rest_client/api_client.rb', line 368

def sanitize_filename(filename)
  filename.gsub(/.*[\/\\]/, '')
end

#select_header_accept(accepts) ⇒ String

Return Accept header based on an array of accepts provided.

Parameters:

  • accepts (Array) —

    array for Accept

Returns:

  • (String) —

    the Accept header (e.g. application/json)



443
444
445
446
447
448
 
# File 'lib/cybersource_rest_client/api_client.rb', line 443

def select_header_accept(accepts)
  return nil if accepts.nil? || accepts.empty?
  # use JSON when present, otherwise use all of the provided
  json_accept = accepts.find { |s| json_mime?(s) }
  json_accept || accepts.join(',')
end

#select_header_content_type(content_types) ⇒ String

Return Content-Type header based on an array of content types provided.

Parameters:

  • content_types (Array) —

    array for Content-Type

Returns:

  • (String) —

    the Content-Type header (e.g. application/json)



453
454
455
456
457
458
459
 
# File 'lib/cybersource_rest_client/api_client.rb', line 453

def select_header_content_type(content_types)
  # use application/json by default
  return 'application/json' if content_types.nil? || content_types.empty?
  # use JSON when present, otherwise use the first one
  json_content_type = content_types.find { |s| json_mime?(s) }
  json_content_type || content_types.first
end

#set_configuration(config) ⇒ Object

set merchantConfig



171
172
173
174
175
 
# File 'lib/cybersource_rest_client/api_client.rb', line 171

def set_configuration(config)
   require_relative '../AuthenticationSDK/core/MerchantConfig.rb'
   $merchantconfig_obj = Merchantconfig.new(config)
   @config.host = $merchantconfig_obj.requestHost
end

#set_user_defined_accept_header(accept_type) ⇒ Object 



48
49
50
 
# File 'lib/cybersource_rest_client/api_client.rb', line 48

def set_user_defined_accept_header(accept_type)
  @accept_header = accept_type
end

#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object

Update hearder and query params based on authentication settings.

Parameters:

  • header_params (Hash) —

    Header parameters

  • query_params (Hash) —

    Query parameters

  • auth_names (String) —

    Authentication scheme name



420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/cybersource_rest_client/api_client.rb', line 420

def update_params_for_auth!(header_params, query_params, auth_names)
  Array(auth_names).each do |auth_name|
    auth_setting = @config.auth_settings[auth_name]
    next unless auth_setting
    case auth_setting[:in]
    when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
    when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
    else fail ArgumentError, 'Authentication token must be in `query` of `header`'
    end
  end
end

#user_agent=(user_agent) ⇒ Object

Sets user agent in HTTP header

Parameters:

  • user_agent (String) —

    User agent (e.g. swagger-codegen/ruby/1.0.0)



435
436
437
438
 
# File 'lib/cybersource_rest_client/api_client.rb', line 435

def user_agent=(user_agent)
  @user_agent = user_agent
  @default_headers['User-Agent'] = @user_agent
end