Updated logging framework

Author: gnongsie

README.md

@@ -12,7 +12,7 @@ The CyberSource Ruby client provides convenient access to the [CyberSource REST
 * Ruby 2.5.0 or higher
 * [CyberSource Account](https://developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration.html)
 * [CyberSource API Keys](https://prod.developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration/createCertSharedKey.html)
- 
+
 ## Dependencies
 
 * activesupport 6.0.3.2
@@ -37,9 +37,9 @@ Be sure to always use HTTPS rubygems source in your gemfile and include the cybe
 
 Use of this SDK and the CyberSource APIs requires having an account on our system. You can find details of getting a test account and creating your keys [here](https://developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration.html)
 
-Once you have your keys, simply load them into the appropriate variables in your code, as per the below sample code dealing with the authentication part of the API request. 
+Once you have your keys, simply load them into the appropriate variables in your code, as per the below sample code dealing with the authentication part of the API request.
 
-Remember this SDK is for use in server-side Ruby applications that access the CyberSource REST API and credentials should always be securely stored and accessed appropriately. 
+Remember this SDK is for use in server-side Ruby applications that access the CyberSource REST API and credentials should always be securely stored and accessed appropriately.
 
 ## SDK Usage Examples and Sample Code
 

cybersource_rest_client.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.summary     = "CyberSource Ruby SDK Gem"
   s.description = "Simple REST API for the CyberSource Global Payments Platform"
   s.license     = "CyberSource"
-  s.files       = Dir.glob("{lib}/{cybersource_rest_client}/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/authentication/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/core/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/util/**/*") + Dir.glob("{lib}/cybersource_rest_client.rb")
+  s.files       = Dir.glob("{lib}/{cybersource_rest_client}/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/authentication/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/core/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/util/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/logging/**/*") + Dir.glob("{lib}/cybersource_rest_client.rb")
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'

generator/cybersource-ruby-config.json

@@ -1,4 +1,4 @@
 {
    "moduleName" : "CyberSource",
-   "gemName"  : "cybersource_rest_client"   
+   "gemName"  : "cybersource_rest_client"
 }

generator/cybersource-ruby-template/api.mustache

@@ -11,7 +11,7 @@ module {{moduleName}}
 
     def initialize(api_client = ApiClient.default, config)
       @api_client = api_client
-	  @api_client.set_configuration(config)
+      @api_client.set_configuration(config)
     end
 {{#operation}}
     {{#summary}}
@@ -40,14 +40,14 @@ module {{moduleName}}
 {{#allParams}}{{^required}}    # @option opts [{{{dataType}}}] :{{paramName}} {{description}}
 {{/required}}{{/allParams}}    # @return [Array<({{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}nil{{/returnType}}, Fixnum, Hash)>] {{#returnType}}{{{returnType}}} data{{/returnType}}{{^returnType}}nil{{/returnType}}, response status code and response headers
     def {{operationId}}_with_http_info({{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}opts = {})
-      
-	  if @api_client.config.debugging
-	  	begin
-			raise
-				@api_client.config.logger.debug 'Calling API: {{classname}}.{{operationId}} ...'
-			rescue
-				puts 'Cannot write to log'
-			end
+
+      if @api_client.config.debugging
+          begin
+            raise
+                @api_client.config.logger.debug 'Calling API: {{classname}}.{{operationId}} ...'
+            rescue
+                puts 'Cannot write to log'
+            end
       end
       {{#allParams}}
       {{#required}}
@@ -189,13 +189,13 @@ module {{moduleName}}
         :auth_names => auth_names{{#returnType}},
         :return_type => '{{{returnType}}}'{{/returnType}})
       if @api_client.config.debugging
-		begin
-		raise
-			@api_client.config.logger.debug "API called: {{classname}}#{{operationId}}\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-		rescue
-			puts 'Cannot write to log'
-		end
-	  end
+        begin
+        raise
+            @api_client.config.logger.debug "API called: {{classname}}#{{operationId}}\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        rescue
+            puts 'Cannot write to log'
+        end
+      end
       return data, status_code, headers
     end
 {{/operation}}

generator/cybersource-ruby-template/api_client.mustache

@@ -20,7 +20,7 @@ module {{moduleName}}
     attr_accessor :default_headers
 
     # Defines the client ID for the SDK
-    attr_accessor :client_id   
+    attr_accessor :client_id
 
     # Defines the user-defined Accept Header Type
     attr_accessor :accept_header
@@ -64,7 +64,7 @@ module {{moduleName}}
         raise
             @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
         rescue
-            puts 'Cannot write to log'            
+            puts 'Cannot write to log'
         end
       end
 
@@ -162,7 +162,7 @@ module {{moduleName}}
       download_file(request) if opts[:return_type] == 'File'
       request
     end
-    # set merchantConfig 
+    # set merchantConfig
     def set_configuration(config)
        require_relative '../AuthenticationSDK/core/MerchantConfig.rb'
        $merchantconfig_obj = Merchantconfig.new(config)
@@ -175,7 +175,7 @@ module {{moduleName}}
       request_target = get_query_param(path, query_params)
       # Request Type. [Non-Editable]
       request_type = http_method.to_s
-      log_obj = Log.new $merchantconfig_obj.logDirectory, $merchantconfig_obj.logFilename, $merchantconfig_obj.logSize, $merchantconfig_obj.enableLog
+      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.
@@ -188,14 +188,13 @@ module {{moduleName}}
       $merchantconfig_obj.requestUrl = url
       # Calling APISDK, Apisdk.controller.
       gmtDateTime = DateTime.now.httpdate
-      token = Authorization.new.getToken($merchantconfig_obj, gmtDateTime, log_obj)
+      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
@@ -204,7 +203,7 @@ module {{moduleName}}
         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, log_obj)
+          digest = DigestGeneration.new.generateDigest(body_params)
           digest_payload = Constants::SHA256 + digest
           header_params['Digest'] = digest_payload
         end
@@ -231,7 +230,7 @@ module {{moduleName}}
       end
       request_target
     end
-    
+
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json

generator/cybersource-ruby-template/gem.mustache

@@ -7,11 +7,12 @@ require 'AuthenticationSDK/util/Utility.rb'
 require 'AuthenticationSDK/util/PropertiesUtil.rb'
 require 'AuthenticationSDK/util/Constants.rb'
 require 'AuthenticationSDK/util/Cache.rb'
-require 'AuthenticationSDK/util/ApiException.rb'
+require 'AuthenticationSDK/util/ExceptionHandler.rb'
 require 'AuthenticationSDK/core/MerchantConfig.rb'
-require 'AuthenticationSDK/core/Logger.rb'
 require 'AuthenticationSDK/core/ITokenGeneration.rb'
 require 'AuthenticationSDK/core/Authorization.rb'
+require 'AuthenticationSDK/logging/log_configuration.rb'
+require 'AuthenticationSDK/logging/log_factory.rb'
 require 'AuthenticationSDK/authentication/payloadDigest/digest.rb'
 require 'AuthenticationSDK/authentication/jwt/JwtToken.rb'
 require 'AuthenticationSDK/authentication/http/HttpSignatureHeader.rb'

generator/cybersource_ruby_sdk_gen.bat

@@ -1,4 +1,4 @@
-@echo off 
+@echo off
 
 cd %~dp0
 
@@ -11,8 +11,8 @@ rd /s /q ..\spec
 del ..\lib\cybersource_rest_client.rb
 
 REM Command to generate SDK
- 
-java -jar swagger-codegen-cli-2.2.3.jar generate -t cybersource-ruby-template -i cybersource-rest-spec.json -l ruby -o ../ -c %~dp0cybersource-ruby-config.json 
+
+java -jar swagger-codegen-cli-2.2.3.jar generate -t cybersource-ruby-template -i cybersource-rest-spec.json -l ruby -o ../ -c %~dp0cybersource-ruby-config.json
 
 powershell -Command "(Get-Content ..\lib\cybersource_rest_client\api\secure_file_share_api.rb) | ForEach-Object { $_ -replace 'select_header_content_type\(\[''application/json;charset=utf-8', 'select_header_content_type([''*/*' } | Set-Content ..\lib\cybersource_rest_client\api\secure_file_share_api.rb"
 

lib/AuthenticationSDK/authentication/http/GetSignatureParameter.rb

@@ -1,5 +1,6 @@
 require_relative '../../util/Constants.rb'
 require_relative '.././payloadDigest/digest.rb'
+require_relative '../../logging/log_factory.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 -
@@ -13,20 +14,25 @@
 # 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)
+    @log_obj
+    def generateSignatureParameter(merchantconfig_obj, gmtdatetime)
+      @log_obj = Log.new merchantconfig_obj.log_config, "GetSignatureParameter"
+
       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 || request_type == Constants::PATCH_REQUEST_TYPE
         targetUrl=gettargetUrlForPutPost(request_type,merchantconfig_obj)
         signatureString << targetUrl + "\n"
         payload = merchantconfig_obj.requestJsonData
-        digest = DigestGeneration.new.generateDigest(payload, log_obj)
+        digest = DigestGeneration.new.generateDigest(payload)
         digest_payload = Constants::SHA256 + digest
         signatureString << Constants::DIGEST + ': ' + digest_payload + "\n"
       end
@@ -40,10 +46,11 @@ def generateSignatureParameter(merchantconfig_obj, gmtdatetime, log_obj)
       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!
+      @log_obj.logger.error(err.message)
+      @log_obj.logger.error(err.backtrace)
+      raise err
+      # puts 'Check log for more details.'
+      # exit!
     end
     def gettargetUrlForGetDelete(request_type, merchantconfig_obj)
       targetUrlForGetDelete = ''

lib/AuthenticationSDK/authentication/http/HttpSignatureHeader.rb

@@ -1,9 +1,10 @@
 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'
+require_relative '../../logging/log_factory.rb'
+require_relative '../../util/ExceptionHandler.rb'
 public
 #  SignatureHeader return SignatureHeader Value that contains following paramters
 #  * keyid     -- Merchant ID obtained from EBC portal
@@ -15,23 +16,30 @@
 #  * signature -- Signature header has paramter called signature
 #                 Paramter 'Signature' must contain all the paramters mentioned in header above in given order
   class GenerateHttpSignature
+    @log_obj
     # Generates Signature based on the requestType
-    def getToken(merchantconfig_obj, gmtdatetime, log_obj)
+    def getToken(merchantconfig_obj, gmtdatetime)
+      @log_obj = Log.new merchantconfig_obj.log_config, "GenerateHttpSignature"
+
       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)
+      signature_value = SignatureParameter.new.generateSignatureParameter(merchantconfig_obj, gmtdatetime)
       signatureHeaderValue << ', ' + Constants::SIGNATURE_PARAM + signature_value + "\""
       return signatureHeaderValue
     rescue StandardError => err
-      ApiException.new.apiexception(err,log_obj)
-      exit!
+      @log_obj.logger.error(ExceptionHandler.new.new_api_exception err)
+      raise err
+      # exit!
     end
     def getsignatureHeader(request_type)
       headers = ''

lib/AuthenticationSDK/authentication/jwt/JwtToken.rb

@@ -5,56 +5,71 @@
 require 'active_support'
 require_relative '../../core/ITokenGeneration.rb'
 require_relative '../../util/Constants.rb'
-require_relative '../../util/ApiException.rb'
+require_relative '../../util/ExceptionHandler.rb'
 require_relative '../../util/Cache.rb'
 require_relative '../../authentication/payloadDigest/digest.rb'
+require_relative '../../logging/log_factory.rb'
 public
-#JWT Token-generated based  on the Request type
   class GenerateJwtToken
-    def getToken(merchantconfig_obj,gmtDatetime,log_obj)
+    @log_obj
+
+    #JWT Token-generated based  on the Request type
+    def getToken(merchantconfig_obj,gmtDatetime)
+      @log_obj = Log.new merchantconfig_obj.log_config, "JwtToken"
+
       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 + File.expand_path(filePath)
       end
+
       p12File = File.binread(filePath)
-      jwtBody=getJwtBody(request_type, gmtDatetime, merchantconfig_obj, log_obj)
+      jwtBody=getJwtBody(request_type, gmtDatetime, merchantconfig_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!
+        @log_obj.logger.error(ExceptionHandler.new.new_custom_error Constants::ERROR_PREFIX + Constants::INCORRECT_KEY_PASS)
+        # exit!
       else
-        ApiException.new.apiexception(err,log_obj)
-        exit!
+        @log_obj.logger.error(ExceptionHandler.new.new_api_exception err)
+        # exit!
       end
+      raise err
     end
-    def getJwtBody(request_type, gmtDatetime, merchantconfig_obj,log_obj)
+
+    def getJwtBody(request_type, gmtDatetime, merchantconfig_obj)
       if request_type == Constants::POST_REQUEST_TYPE || request_type == Constants::PUT_REQUEST_TYPE || request_type == Constants::PATCH_REQUEST_TYPE
         payload = merchantconfig_obj.requestJsonData
+
         # Note: Digest is not passed for GET calls
-        digest = DigestGeneration.new.generateDigest(payload, log_obj)
+        digest = DigestGeneration.new.generateDigest(payload)
         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 
+      else
         raise StandardError.new(Constants::ERROR_PREFIX + Constants::INVALID_REQUEST_TYPE_METHOD)
       end
     end