cybersource_rest_client 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b7625049670ddc6fe04c3b815f64d1b40395f2dc8b4474020a1603ae3e183be
+  data.tar.gz: 3ddadd409732bac2bd32f1f3015765c76fd40c2d383c469914e68f0ee4cff80f
+SHA512:
+  metadata.gz: 6285f04237f5f844c5056f2544a46b8975754e517f087af59acd024bbdece0ca22721739d677eb928692e9aa08775e9b0c70fa2a38ea9e269a659aeb05bfa8df
+  data.tar.gz: d9b33a02f50e1c79e53938f75d34fdb0cb86cf09874099d25a17992c730ee3d02d3233d4bb1da464f7b22fe5adc334f2749318ada4ef699af9d65096561854e2

data/AuthenticationSDK/Cybersource.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = "AuthenticationSDK"
+  s.version = "0.0.1"
+  s.platform = Gem::Platform::RUBY
+  s.date = "2018-07-17"
+  s.summary = "Cybersource Payments REST API Ruby Gem"
+  s.description = "Move your business forward with the Cybersource Payments REST API"
+  s.authors = ["cybersource"]
+  s.email = ""
+  s.files = Dir.glob("{lib}/**/*")
+  
+  s.required_ruby_version     = '>= 2.2.2'
+  s.required_rubygems_version = '>= 1.3.6'
+
+  s.add_runtime_dependency 'activesupport', '~> 5.2', '>= 5.2.0'
+  s.add_runtime_dependency 'json', '~> 2.1.0', '>= 1.8.1'
+  s.add_runtime_dependency 'interface','~> 1.0', '>= 1.0.4'
+  s.add_runtime_dependency 'jwt', '~> 2.1.0'
+  
+  s.add_development_dependency 'rspec', '~> 2.1'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rubocop', '~> 0.57.2'
+end

data/AuthenticationSDK/authentication/http/GetSignatureParameter.rb

@@ -0,0 +1,62 @@
+require_relative '../../util/Constants.rb'
+require_relative '.././payloadDigest/digest.rb'
+require 'openssl'
+# This function returns value for paramter Signature which is then passed to Signature header
+# paramter 'Signature' is calucated based on below key values and then signed with SECRET KEY -
+# host: Sandbox (apitest.cybersource.com) or Production (api.cybersource.com) hostname
+# date: "HTTP-date" format as defined by RFC7231.
+# (request-target): Should be in format of httpMethod: path
+# Example: "post /pts/v2/payments"
+# Digest: Only needed for POST calls.
+# digestString = BASE64( HMAC-SHA256 ( Payload ));
+# Digest: “SHA-256=“ + digestString;
+# v-c-merchant-id: set value to Cybersource Merchant ID
+# This ID can be found on EBC portal*/
+class SignatureParameter
+  def generateSignatureParameter(merchantconfig_obj, gmtdatetime, log_obj)
+    request_type = merchantconfig_obj.requestType.upcase
+    merchantSecretKey = merchantconfig_obj.merchantSecretKey
+    signatureString = Constants::HOST + ': ' + merchantconfig_obj.requestHost
+    signatureString << "\n"+ Constants::DATE + ': ' + gmtdatetime
+    signatureString << "\n(request-target): "
+    if request_type == Constants::GET_REQUEST_TYPE || request_type == Constants::DELETE_REQUEST_TYPE
+      targetUrl=gettargetUrlForGetDelete(request_type,merchantconfig_obj)
+      signatureString << targetUrl + "\n"
+    elsif request_type == Constants::POST_REQUEST_TYPE || request_type == Constants::PUT_REQUEST_TYPE
+      targetUrl=gettargetUrlForPutPost(request_type,merchantconfig_obj)
+      signatureString << targetUrl + "\n"
+      payload = merchantconfig_obj.requestJsonData
+      digest = DigestGeneration.new.generateDigest(payload, log_obj)
+      digest_payload = Constants::SHA256 + digest
+      signatureString << Constants::DIGEST + ': ' + digest_payload + "\n"
+    end
+    signatureString << Constants::V_C_MERCHANT_ID + ': ' + merchantconfig_obj.merchantId
+    encodedSignatureString = signatureString.force_encoding(Encoding::UTF_8)
+    decodedKey = Base64.decode64(merchantSecretKey)
+    base64EncodedSignature = Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', decodedKey, encodedSignatureString))
+    return base64EncodedSignature
+  rescue StandardError => err
+    log_obj.logger.error(err.message)
+    log_obj.logger.error(err.backtrace)
+    puts 'Check log for more details.'
+    exit!
+  end
+  def gettargetUrlForGetDelete(request_type, merchantconfig_obj)
+    targetUrlForGetDelete = ''
+    if request_type == Constants::DELETE_REQUEST_TYPE
+      targetUrlForGetDelete = Constants::DELETE_REQUEST_TYPE_LOWER + ' ' + merchantconfig_obj.requestTarget
+    elsif request_type == Constants::GET_REQUEST_TYPE
+      targetUrlForGetDelete = Constants::GET_REQUEST_TYPE_LOWER + ' ' + merchantconfig_obj.requestTarget
+    end
+    return targetUrlForGetDelete
+  end
+  def gettargetUrlForPutPost(request_type, merchantconfig_obj)
+    targetUrlForPutPost = ''
+    if request_type == Constants::POST_REQUEST_TYPE
+      targetUrlForPutPost = Constants::POST_REQUEST_TYPE_LOWER + ' ' + merchantconfig_obj.requestTarget
+    elsif request_type == Constants::PUT_REQUEST_TYPE
+      targetUrlForPutPost = Constants::PUT_REQUEST_TYPE_LOWER + ' ' + merchantconfig_obj.requestTarget
+    end
+    return targetUrlForPutPost
+  end
+end

data/AuthenticationSDK/authentication/http/HttpSignatureHeader.rb

@@ -0,0 +1,50 @@
+require 'base64'
+require_relative '../../core/ITokenGeneration.rb'
+require_relative '../../util/Constants.rb'
+require_relative '../../util/ApiException.rb'
+require_relative '.././payloadDigest/digest.rb'
+require_relative '.././http/GetSignatureParameter.rb'
+public
+#  SignatureHeader return SignatureHeader Value that contains following paramters
+#  * keyid     -- Merchant ID obtained from EBC portal
+#  * algorithm -- Should have value as "HmacSHA256"
+#  * headers   -- List of all header name passed in the Signature paramter below
+#                 String getHeaders = "host date (request-target)" + " " + "v-c-merchant-id";
+#                 String postHeaders = "host date (request-target) digest v-c-merchant-id";
+#                 Note: Digest is not passed for GET calls
+#  * signature -- Signature header has paramter called signature
+#                 Paramter 'Signature' must contain all the paramters mentioned in header above in given order
+class GenerateHttpSignature
+  # Generates Signature based on the requestType
+  def getToken(merchantconfig_obj, gmtdatetime, log_obj)
+    request_type = merchantconfig_obj.requestType.upcase
+    signatureHeaderValue =''
+    signatureHeaderValue << Constants::KEY_ID + merchantconfig_obj.merchantKeyId + "\""
+    # Algorithm should be always HmacSHA256 for http signature
+    signatureHeaderValue << ', ' + Constants::ALGORITHM + Constants::SIGNATURE_ALGORITHM + "\""
+    # Headers - list is choosen based on HTTP method
+    signatureheader=getsignatureHeader(request_type)
+    signatureHeaderValue << ', ' + Constants::HEADERS_PARAM + signatureheader + "\""
+    # Get Value for parameter 'Signature' to be passed to Signature Header
+    signature_value = SignatureParameter.new.generateSignatureParameter(merchantconfig_obj, gmtdatetime, log_obj)
+    signatureHeaderValue << ', ' + Constants::SIGNATURE_PARAM + signature_value + "\""
+    return signatureHeaderValue
+  rescue StandardError => err
+    ApiException.new.apiexception(err,log_obj)
+    exit!
+  end
+  def getsignatureHeader(request_type)
+    headers = ''
+    if request_type == Constants::POST_REQUEST_TYPE
+      headers = 'host date (request-target) digest ' + Constants::V_C_MERCHANT_ID
+    elsif request_type == Constants::GET_REQUEST_TYPE || request_type == Constants::DELETE_REQUEST_TYPE
+      headers = 'host date (request-target)' + ' ' + Constants::V_C_MERCHANT_ID
+    elsif request_type == Constants::PUT_REQUEST_TYPE
+      headers = 'host date (request-target) digest ' + Constants::V_C_MERCHANT_ID
+     else
+      raise StandardError.new(Constants::ERROR_PREFIX + Constants::INVALID_REQUEST_TYPE_METHOD)
+    end
+    return headers
+  end
+  implements TokenInterface
+end

data/AuthenticationSDK/authentication/jwt/JwtToken.rb

@@ -0,0 +1,62 @@
+require 'base64'
+require 'openssl'
+require 'jwt'
+require 'json'
+require 'active_support'
+require_relative '../../core/ITokenGeneration.rb'
+require_relative '../../util/Constants.rb'
+require_relative '../../util/ApiException.rb'
+require_relative '../../util/Cache.rb'
+require_relative '../../authentication/payloadDigest/digest.rb'
+public
+#JWT Token-generated based  on the Request type
+class GenerateJwtToken
+  def getToken(merchantconfig_obj,gmtDatetime,log_obj)
+    jwtBody = ''
+    request_type = merchantconfig_obj.requestType.upcase
+    filePath = merchantconfig_obj.keysDirectory + '/' + merchantconfig_obj.keyFilename + '.p12'
+    if (!File.exist?(filePath))
+      raise Constants::ERROR_PREFIX + Constants::FILE_NOT_FOUND + filePath
+    end
+    p12File = File.binread(filePath)
+    jwtBody=getJwtBody(request_type, gmtDatetime, merchantconfig_obj, log_obj)
+    claimSet = JSON.parse(jwtBody)
+    p12FilePath = OpenSSL::PKCS12.new(p12File, merchantconfig_obj.keyPass)
+    # Generating certificate.
+    cacheObj = ActiveSupport::Cache::MemoryStore.new
+    x5Cert = Cache.new.fetchCachedCertificate(filePath, p12File, merchantconfig_obj.keyPass, cacheObj)
+    # Generating Public key.
+    publicKey = OpenSSL::PKey::RSA.new(p12FilePath.key.public_key)
+    #Generating Private Key
+    privateKey = OpenSSL::PKey::RSA.new(p12FilePath.key)
+    # JWT token-Generates using RS256 algorithm only
+    x5clist = [x5Cert]
+    customHeaders = {}
+    customHeaders['v-c-merchant-id'] = merchantconfig_obj.keyAlias
+    customHeaders['x5c'] = x5clist
+    # Generating JWT token
+    token = JWT.encode(claimSet, privateKey, 'RS256', customHeaders)
+    return token
+  rescue StandardError => err
+    if err.message.include? 'PKCS12_parse: mac verify failure'
+      ApiException.new.customerror(Constants::ERROR_PREFIX + Constants::INCORRECT_KEY_PASS,log_obj)
+      exit!
+    else
+      ApiException.new.apiexception(err,log_obj)
+      exit!
+    end
+  end
+  def getJwtBody(request_type, gmtDatetime, merchantconfig_obj,log_obj)
+    if request_type == Constants::POST_REQUEST_TYPE || request_type == Constants::PUT_REQUEST_TYPE
+      payload = merchantconfig_obj.requestJsonData
+      # Note: Digest is not passed for GET calls
+      digest = DigestGeneration.new.generateDigest(payload, log_obj)
+      jwtBody = "{\n      \"digest\":\"" + digest + "\", \"digestAlgorithm\":\"SHA-256\", \"iat\":\"" + gmtDatetime + "\"}"
+    elsif request_type == Constants::GET_REQUEST_TYPE || request_type == Constants::DELETE_REQUEST_TYPE
+      jwtBody = "{\n \"iat\":\"" + gmtDatetime + "\"\n} \n\n"
+    else 
+      raise StandardError.new(Constants::ERROR_PREFIX + Constants::INVALID_REQUEST_TYPE_METHOD)
+    end
+  end
+  implements TokenInterface
+end

data/AuthenticationSDK/authentication/payloadDigest/digest.rb

@@ -0,0 +1,10 @@
+require 'digest'
+public
+# This method return Digest value which is SHA-256 
+# hash of payload that is BASE64 encoded
+class DigestGeneration
+  def generateDigest(payload, log_obj)
+    digest = Digest::SHA256.base64digest(payload)
+    return digest
+  end
+end

data/AuthenticationSDK/core/Authorization.rb

@@ -0,0 +1,24 @@
+require_relative '../authentication/http/HttpSignatureHeader.rb'
+require_relative '../authentication/jwt/JwtToken.rb'
+require_relative '../util/Constants.rb'
+require_relative '../util/ApiException.rb'
+public
+# This function calls for the generation of Signature message depending on the authentication type.
+class Authorization
+  def getToken(merchantconfig_obj, gmtdatetime, log_obj)
+    authenticationType = merchantconfig_obj.authenticationType.upcase
+    if merchantconfig_obj.requestType.to_s.empty?
+      raise StandardError.new(Constants::ERROR_PREFIX + Constants::REQUEST_TYPE_EMPTY)
+    end
+    if authenticationType == Constants::AUTH_TYPE_HTTP
+      token = GenerateHttpSignature.new.getToken(merchantconfig_obj, gmtdatetime, log_obj)
+    elsif authenticationType == Constants::AUTH_TYPE_JWT
+      token = GenerateJwtToken.new.getToken(merchantconfig_obj, gmtdatetime, log_obj)
+    elsif authenticationType != Constants::AUTH_TYPE_HTTP || authenticationType != Constants::AUTH_TYPE_JWT
+      raise StandardError.ner(Constants::ERROR_PREFIX + Constants::AUTH_ERROR)
+    end
+  rescue StandardError => err
+    ApiException.new.apiexception(err,log_obj)
+    exit!
+  end
+end

data/AuthenticationSDK/core/ITokenGeneration.rb

@@ -0,0 +1,4 @@
+require 'interface'
+TokenInterface = interface {
+  required_methods :getToken
+}

data/AuthenticationSDK/core/Logger.rb

@@ -0,0 +1,26 @@
+require_relative '../util/ApiException.rb'
+require 'logger'
+public 
+# Logger Class
+class Log
+  def initialize(logDirectory, logFilename, logSize, enableLog)
+    #log
+    if enableLog == true
+      filename = logDirectory + '/' + logFilename + '.log'
+      datetime = DateTime.now
+      if File.exist?(filename) && File.size(filename) >= logSize
+        updatedFileName = logDirectory + '/' + logFilename + '_' + datetime.strftime('%Y%m%d%H%M%S') + '.log'
+        File.rename(filename, updatedFileName)
+      end
+      @logger = Logger.new(STDOUT)
+      @logger = Logger.new(filename, logSize)
+      @logger.datetime_format = datetime.strftime('%Y-%m-%d %H:%M:%S')
+    else
+      @logger = Logger.new(false)
+    end
+  rescue StandardError => err
+    puts err
+    exit!
+  end
+  attr_accessor :logger
+end

data/AuthenticationSDK/core/MerchantConfig.rb

@@ -0,0 +1,181 @@
+require_relative './Logger.rb'
+require_relative '../util/Constants.rb'
+require_relative '../Util/ApiException.rb'
+public
+# This fuction has all the merchantConfig properties getters and setters methods
+class Merchantconfig
+  def initialize(cybsPropertyObj)
+  # Common Parameters
+  @merchantId = cybsPropertyObj['merchantID']
+  @runEnvironment = cybsPropertyObj['runEnvironment']
+  @authenticationType = cybsPropertyObj['authenticationType']
+  @logDirectory = cybsPropertyObj['logDirectory']
+  @logSize = cybsPropertyObj['logSize']
+  @enableLog = cybsPropertyObj['enableLog']
+  @proxyAddress = cybsPropertyObj['proxyAddress']
+  @proxyPort = cybsPropertyObj['proxyPort']
+  @getId = ''
+  @requestHost = ''
+  @requestTarget = ''
+  @requestJsonData = ''
+  # HTTP Parameters
+  @merchantSecretKey = cybsPropertyObj['merchantsecretKey']
+  @merchantKeyId = cybsPropertyObj['merchantKeyId']
+  # JWT Parameters
+  @keysDirectory = cybsPropertyObj['keysDirectory']
+  @keyAlias = cybsPropertyObj['keyAlias']
+  @keyPass = cybsPropertyObj['keyPass']
+  @keyFilename = cybsPropertyObj['keyFilename']
+  @logFilename = cybsPropertyObj['logFilename']
+  validateMerchantDetails()
+  logAllProperties(cybsPropertyObj)
+  end
+  #fall back logic
+  def validateMerchantDetails()
+    logmessage=''
+    if @enableLog.to_s.empty?
+      @enableLog = true
+    elsif @enableLog.instance_of? Fixnum
+      @enableLog = @enableLog.to_s
+    end
+    if @logSize.to_s.empty?
+      @logSize = Constants::DEFAULT_LOG_SIZE
+    elsif !@logSize.instance_of? Fixnum
+      @logSize=@logSize.to_i
+    end
+    if @logDirectory.to_s.empty? || !Dir.exist?(@logDirectory)
+      @logDirectory = Constants::DEFAULT_LOG_DIRECTORY
+      unless Dir.exist?(@logDirectory)
+        Dir.mkdir(Constants::DEFAULT_LOG_DIRECTORY)
+      end
+      logmessage = Constants::WARNING_PREFIX + Constants::INVALID_LOG_DIRECTORY + File.expand_path(@logDirectory)
+    end
+    if @logFilename.to_s.empty?
+      @logFilename = Constants::DEFAULT_LOGFILE_NAME
+    elsif !@logFilename.instance_of? String
+      @logFilename=@logFilename.to_s
+    end
+    @log_obj = Log.new @logDirectory,@logFilename,@logSize,@enableLog
+    @log_obj.logger.info('START> =======================================')
+    if !logmessage.to_s.empty?
+      ApiException.new.apiwarning(logmessage,log_obj)
+    end
+    if @merchantId.to_s.empty?
+      err = raise StandardError.new(Constants::ERROR_PREFIX + Constants::MERCHANT_ID_NULL)
+      ApiException.new.apiexception(err,log_obj)
+    elsif !@merchantId.instance_of? String
+      @merchantId=@merchantId.to_s
+    end
+    if @authenticationType.to_s.empty?
+      err = raise StandardError.new(Constants::ERROR_PREFIX + Constants::AUTH_TYPE_MANDATORY)
+      ApiException.new.apiexception(err,log_obj) 
+    end
+    if !@authenticationType.instance_of? String 
+      err = raise StandardError.new(Constants::ERROR_PREFIX+ Constants::AUTH_ERROR)
+      ApiException.new.apiexception(err,log_obj)
+    end
+    if !@runEnvironment.to_s.empty?
+      if !@runEnvironment.instance_of? String
+        @requestHost = @runEnvironment.to_s
+      elsif @runEnvironment.upcase == Constants::RUN_ENV_PROD
+        @requestHost = Constants::PRODUCTION_URL
+      elsif @runEnvironment.upcase == Constants::RUN_ENV_SANDBOX
+        @requestHost = Constants::SANDBOX_URL
+      else
+        @requestHost = @runEnvironment
+      end
+    elsif @runEnvironment.to_s.empty?
+      err = raise StandardError.new(Constants::ERROR_PREFIX + Constants::RUN_ENVIRONMENT)
+      ApiException.new.apiexception(err,log_obj)
+    end
+    if @authenticationType.upcase == Constants::AUTH_TYPE_JWT
+      if @keyAlias.to_s.empty?
+        @keyAlias = @merchantId
+        ApiException.new.apiwarning(Constants::WARNING_PREFIX + Constants::KEY_ALIAS_NULL_EMPTY, log_obj)
+      elsif !@keyAlias.instance_of? String
+        @keyAlias=@keyAlias.to_s
+      elsif @keyAlias != @merchantId
+        @keyAlias = @merchantId
+        ApiException.new.apiwarning(Constants::WARNING_PREFIX + Constants::INCORRECT_KEY_ALIAS, log_obj)
+      end
+      if @keyPass.to_s.empty?
+        @keyPass = @merchantId
+        ApiException.new.apiwarning(Constants::WARNING_PREFIX + Constants::KEY_PASS_NULL, log_obj)
+      elsif !@keyPass.instance_of? String
+        @keyPass=@keyPass.to_s
+      end
+      if @keysDirectory.to_s.empty?
+        @keysDirectory = Constants::DEFAULT_KEY_DIRECTORY
+        ApiException.new.apiwarning(Constants::WARNING_PREFIX + Constants::KEY_DIRECTORY_EMPTY + @keysDirectory, log_obj)
+      elsif !@keysDirectory.instance_of? String
+        @keysDirectory=@keysDirectory.to_s
+      end
+      if @keyFilename.to_s.empty?
+        @keyFilename = @merchantId
+        ApiException.new.apiwarning(Constants::WARNING_PREFIX + Constants::KEY_FILE_NAME_NULL_EMPTY, log_obj)
+      elsif !@keyFilename.instance_of? String
+        @keyFilename=@keyFilename.to_s
+      end
+    end
+    if @authenticationType.upcase == Constants::AUTH_TYPE_HTTP
+      if @merchantKeyId.to_s.empty?
+        err = raise StandardError.new(Constants::ERROR_PREFIX+ Constants::MERCHANT_KEY_ID_MANDATORY)
+        ApiException.new.apiexception(err,log_obj)
+      elsif !@merchantKeyId.instance_of? String
+        @merchantKeyId=@merchantKeyId.to_s
+      end
+      if @merchantSecretKey.to_s.empty?
+        err = raise StandardError.new(Constants::ERROR_PREFIX+ Constants::MERCHANT_SECRET_KEY_MANDATORY) 
+        ApiException.new.apiexception(err,log_obj)
+      elsif !@merchantSecretKey.instance_of? String
+        @merchantSecretKey=@merchantSecretKey.to_s
+      end
+    end
+    if !@proxyAddress.instance_of? String
+      @proxyAddress=@proxyAddress.to_s
+    end
+    if !@proxyPort.instance_of? String
+      @proxyPort=@proxyPort.to_s
+    end
+  end
+  def logAllProperties(propertyObj)
+    merchantConfig = ''
+    hiddenProperties = (Constants::HIDDEN_MERCHANT_PROPERTIES).split(',')
+    hiddenPropArray = Array.new
+    hiddenProperties.each do |value|
+      hiddenPropArray << value.strip
+    end
+    hiddenPropArray.each do |prop|
+      propertyObj.each do |key, value|
+        if key == prop
+          propertyObj.delete(key)
+        end
+      end
+    end
+    @log_obj.logger.info('MERCHCFG >' + propertyObj.to_s)
+  end
+   
+  # getter and setter methods
+  attr_accessor :merchantId
+  attr_accessor :merchantSecretKey
+  attr_accessor :merchantKeyId
+  attr_accessor :authenticationType
+  attr_accessor :keysDirectory
+  attr_accessor :requestHost
+  attr_accessor :keyAlias
+  attr_accessor :keyPass
+  attr_accessor :keyFilename
+  attr_accessor :requestJsonData
+  attr_accessor :requestUrl
+  attr_accessor :requestType
+  attr_accessor :getId
+  attr_accessor :logDirectory
+  attr_accessor :logFilename
+  attr_accessor :enableLog
+  attr_accessor :logSize
+  attr_accessor :logger
+  attr_accessor :proxyAddress
+  attr_accessor :proxyPort
+  attr_accessor :requestTarget
+  attr_accessor :log_obj
+end