Update to latest version of SDK

Author: gnongsie

Logging.md

@@ -0,0 +1,59 @@
+[![Generic badge](https://img.shields.io/badge/LOGGING-NEW-GREEN.svg)](https://shields.io/)
+
+# Logging in CyberSource REST Client SDK (Ruby)
+
+Since v0.0.38, a new logging framework has been introduced in the SDK. This new logging framework makes use of Ruby's logger package, and standardizes the logging so that it can be integrated with the logging in the client application.
+
+## Ruby's logger package Configuration
+
+In order to leverage the new logging framework, the following configuration settings may be added to the merchant configuration as part of **`LogConfiguration`**:
+
+* enableLog
+* loggingLevel
+* logDirectory
+* logFilename
+* maxLogSize
+* maxLogFiles
+* enableMasking
+
+In our [sample Configuration.py](https://github.com/CyberSource/cybersource-rest-samples-ruby/blob/master/data/Configuration.rb) file, the following lines have been added to support this new framework:
+
+```ruby
+    enableLog=true
+    loggingLevel='DEBUG'
+    logDirectory='log'
+    logFilename='cybs'
+    maxLogSize=10485760
+    maxLogFiles=5
+    enableMasking=true
+    ...
+    log_config = {}
+    log_config['enableLog'] = enableLog
+    log_config['loggingLevel'] = loggingLevel
+    log_config['logDirectory'] = logDirectory
+    log_config['logFilename'] = logFilename
+    log_config['maxLogSize'] = maxLogSize
+    log_config['maxLogFiles'] = maxLogFiles
+    log_config['enableMasking'] = enableMasking
+    configurationDictionary['logConfiguration'] = log_config
+```
+
+### Important Notes
+
+The variable `enableMasking` needs to be set to `true` if sensitive data in the request/response should be hidden/masked.
+
+Sensitive data fields are listed below:
+
+  * Card Security Code
+  * Card Number
+  * Any field with `number` in the name
+  * Card Expiration Month
+  * Card Expiration Year
+  * Account
+  * Routing Number
+  * Email
+  * First Name & Last Name
+  * Phone Number
+  * Type
+  * Token
+  * Signature

README.md

@@ -136,3 +136,11 @@ with the following code:
 ## API Reference
 
 The [API Reference Guide](http://developer.cybersource.com/api/reference) provides examples of what information is needed for a particular request and how that information would be formatted. Using those examples, you can easily determine what methods would be necessary to include that information in a request using this SDK.
+
+### Logging
+
+[![Generic badge](https://img.shields.io/badge/LOGGING-NEW-GREEN.svg)](https://shields.io/)
+
+Since v0.0.38, a new logging framework has been introduced in the SDK. This new logging framework makes use of Ruby's logger package, and standardizes the logging so that it can be integrated with the logging in the client application.
+
+More information about this new logging framework can be found in this file : [Logging.md](Logging.md)

Samples/Authentication/data/Configuration.rb

@@ -5,10 +5,7 @@ def merchantConfigProp()
     runEnvironment='apitest.cybersource.com'
     timeout=1000 #In Milliseconds
     authenticationType='JWT' #'HTTP_Signature'
-    logDirectory='./log'
     jsonFilePath='./resource/request.json'
-    logSize=5000
-    enableLog=true
     #proxyAddress='userproxy.visa.com'
     #proxyPort=443
     # HTTP Parameters
@@ -23,17 +20,30 @@ def merchantConfigProp()
     # MetaKey Params
     useMetaKey = false
     portfolioID = ''
-    
+
+    enableLog=true
+    loggingLevel = 'DEBUG'
+    logDirectory='./log'
     logFilename='Cybs'
+    maxLogSize=5000
+    maxLogFiles=5
+    enableMasking=true
+
+    logConfiguration={}
+    logConfiguration['enableLog']=enableLog
+    logConfiguration['loggingLevel']=loggingLevel
+    logConfiguration['logDirectory']=logDirectory
+    logConfiguration['logFilename']=logFilename
+    logConfiguration['maxLogSize']=maxLogSize
+    logConfiguration['maxLogFiles']=maxLogFiles
+    logConfiguration['enableMasking']=enableMasking
+
     configurationDictionary={}
     configurationDictionary['merchantID']=merchantId
     configurationDictionary['runEnvironment']=runEnvironment
     configurationDictionary['timeout']=timeout
     configurationDictionary['authenticationType']=authenticationType
-    configurationDictionary['logDirectory']=logDirectory
     configurationDictionary['jsonFilePath']=jsonFilePath
-    configurationDictionary['logSize']=logSize
-    configurationDictionary['enableLog']=enableLog
     # configurationDictionary['proxyPort']=proxyPort
     configurationDictionary['merchantsecretKey']=merchantSecretKey
     configurationDictionary['merchantKeyId']=merchantKeyId
@@ -43,7 +53,7 @@ def merchantConfigProp()
     configurationDictionary['useMetaKey'] = useMetaKey
     configurationDictionary['portfolioID'] = portfolioID
     configurationDictionary['keyFilename'] = keyFilename
-    configurationDictionary['logFilename'] = logFilename
+    configurationDictionary['logConfiguration']=logConfiguration
     return configurationDictionary
   end
 end

Samples/Authentication/resource/cybs.yml

@@ -18,14 +18,14 @@
     #EBC portal Values
     merchantKeyId : "08c94330-f618-42a3-b09d-e1e43be5efda"
     merchantsecretKey : "yBJxy6LjM2TmcPGu+GaJrHtkke25fPpUX+UY6/L/1tE="
-    #Logging to be enabled or not [true/false].
-    enableLog : true
-    #Log directory Path
-    logDirectory : F:/Desktop/Log
-    #Enter only file name, do not enter the extension type like .log, .txt etc.
-    logFilename : "Cybs"
-    #Log file size in KB "5K" or MB as "5M".
-    logSize : 10485760
     #Proxy Setup
     # proxyAddress : "userproxy.visa.com"
-    # proxyPort : 
+    # proxyPort :
+    logConfiguration:
+       enableLog: true
+       loggingLevel: 'DEBUG'
+       logDirectory: './log'
+       logFilename: 'Cybs'
+       maxLogSize: 10425760
+       maxLogFiles: 5
+       enableMasking: true

Samples/Authentication/src/DeleteGenerateHeaders.rb

@@ -20,7 +20,7 @@ def main()
       merchantConfigObj = Merchantconfig.new cybsPropertyobj
 
       # creating Logger Object
-      logObj = Log.new merchantConfigObj.logDirectory,merchantConfigObj.logFilename,merchantConfigObj.logSize,merchantConfigObj.enableLog
+      logObj = Log.new merchantConfigObj.log_config, "DeleteGenerateHeaders"
 
       #setting requestType,requestTarget,requestUrl
       merchantConfigObj.requestType = @@request_type
@@ -50,15 +50,15 @@ def main()
         logObj.logger.info("Date  : " + gmtDateTime)
         puts "Date  : " + gmtDateTime
 
-        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime,logObj)
+        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime)
         logObj.logger.info("Host  : " + merchantConfigObj.requestHost)
         puts "Host  : " + merchantConfigObj.requestHost
 
         logObj.logger.info("Signature Header  : " + tempSig)
         puts "Signature Header  : " + tempSig
       else
         #JWT Token
-        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime,logObj)
+        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime)
         puts "Authorization,Bearer  : " + tempSig
         logObj.logger.info("Authorization,Bearer  : " + tempSig)
       end

Samples/Authentication/src/DeleteMethod.rb

@@ -19,7 +19,7 @@ def main
     # creating MerchantConfig Object
     merchantconfig_obj = Merchantconfig.new(cybsproperty_obj)
 
-    logObj = Log.new merchantconfig_obj.logDirectory,merchantconfig_obj.logFilename,merchantconfig_obj.logSize,merchantconfig_obj.enableLog
+    logObj = Log.new merchantconfig_obj.log_config, 'DeleteMethod'
     # setting requestTarget,requestUrl,requestType to merchantConfig Object
     merchantconfig_obj.requestTarget = @@request_target
     # Give the url path to where the data needs to be authenticated.
@@ -28,7 +28,7 @@ def main
     merchantconfig_obj.requestType = @@request_type
 
     # Calling APISDK, ApiController
-    response_code, response_body, vc_correlationid = APIController.new.payment_delete(merchantconfig_obj, logObj)
+    response_code, response_body, vc_correlationid = APIController.new.payment_delete(merchantconfig_obj)
     puts 'v-c-correlation-id:' + vc_correlationid
     puts 'Response Code:' + response_code
     puts 'Response Body:' + response_body

Samples/Authentication/src/GetGenerateHeaders.rb

@@ -24,7 +24,7 @@ def main()
       merchantConfigObj = Merchantconfig.new cybsPropertyobj
 
       # creating Logger Object
-      logObj = Log.new merchantConfigObj.logDirectory,merchantConfigObj.logFilename,merchantConfigObj.logSize,merchantConfigObj.enableLog
+      logObj = Log.new merchantConfigObj.log_config, 'GetGenerateHeaders'
 
       #setting requestType,requestTarget,requestUrl
       merchantConfigObj.requestType = @@request_type
@@ -55,15 +55,15 @@ def main()
         logObj.logger.info("Date  : " + gmtDateTime)
         puts "Date  : " + gmtDateTime
 
-        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime,logObj)
+        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime)
         logObj.logger.info("Host  : " + merchantConfigObj.requestHost)
         puts "Host  : " + merchantConfigObj.requestHost
 
         logObj.logger.info("Signature Header  : " + tempSig)
         puts "Signature Header  : " + tempSig
       else
         #JWT Token
-        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime,logObj)
+        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime)
         puts "Authorization,Bearer  : " + tempSig
         logObj.logger.info("Authorization,Bearer  : " + tempSig)
       end

Samples/Authentication/src/GetMethod.rb

@@ -18,7 +18,7 @@ def main
     cybsproperty_obj = PropertiesUtil.new.getCybsProp('resource/cybs.yml')
     merchantconfig_obj = Merchantconfig.new(cybsproperty_obj)
 
-    logObj = Log.new merchantconfig_obj.logDirectory,merchantconfig_obj.logFilename,merchantconfig_obj.logSize,merchantconfig_obj.enableLog
+    logObj = Log.new merchantconfig_obj.log_config, 'GetMethod'
     # Set Request Type into the merchant config object.
     merchantconfig_obj.requestType = @@request_type
     # Set Request Target into the merchant config object.
@@ -28,7 +28,7 @@ def main
     # Set URL into the merchant config object.
     merchantconfig_obj.requestUrl = url
     # Calling APISDK, Apisdk.controller.
-    response_code, response_body, vc_correlationid = APIController.new.payment_get(merchantconfig_obj, logObj)
+    response_code, response_body, vc_correlationid = APIController.new.payment_get(merchantconfig_obj)
     # Display response message and Headers in console.
     puts 'v-c-correlation-id:' + vc_correlationid
     puts 'Response Code:' + response_code

Samples/Authentication/src/GetObjectMethod.rb

@@ -20,7 +20,7 @@ def main
     cybsPropertyobj = Configuration.new.merchantConfigProp
     merchantconfig_obj = Merchantconfig.new cybsPropertyobj
 
-    logObj = Log.new merchantconfig_obj.logDirectory,merchantconfig_obj.logFilename,merchantconfig_obj.logSize,merchantconfig_obj.enableLog
+    logObj = Log.new merchantconfig_obj.log_config, 'GetObjectMethod'
     # Set Request Type into the merchant config object.
     merchantconfig_obj.requestType = @@request_type
     # Set Request Target into the merchant config object.
@@ -30,7 +30,7 @@ def main
     # Set URL into the merchant config object.
     merchantconfig_obj.requestUrl = url
     # Calling APISDK, Apisdk.controller.
-    response_code, response_body, vc_correlationid = APIController.new.payment_get(merchantconfig_obj, logObj)
+    response_code, response_body, vc_correlationid = APIController.new.payment_get(merchantconfig_obj)
     # Display response message and Headers in console.
     puts 'v-c-correlation-id:' + vc_correlationid
     puts 'Response Code:' + response_code

Samples/Authentication/src/PostGenerateHeaders.rb

@@ -23,7 +23,7 @@ def main()
       merchantConfigObj = Merchantconfig.new cybsPropertyobj
 
       # creating Logger Object
-      logObj = Log.new merchantConfigObj.logDirectory,merchantConfigObj.logFilename,merchantConfigObj.logSize,merchantConfigObj.enableLog
+      logObj = Log.new merchantConfigObj.log_config, 'PostGenerateHeaders'
 
       #setting requestType,requestTarget,requestUrl
       merchantConfigObj.requestType = @@request_type
@@ -55,20 +55,20 @@ def main()
         maskedRequestBody = Masking.new.maskPayload(merchantConfigObj.requestJsonData)
         logObj.logger.info("Request Body: " + JSON.generate(maskedRequestBody))
 
-        digest = DigestGeneration.new.generateDigest(merchantConfigObj.requestJsonData,logObj)
+        digest = DigestGeneration.new.generateDigest(merchantConfigObj.requestJsonData)
         digest = Constants::SHA256 + digest
         logObj.logger.info("Digest : " + digest)
         puts "Digest  : " + digest 
 
-        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime,logObj)
+        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime)
         logObj.logger.info("Host  : " + merchantConfigObj.requestHost)
         puts "Host  : " + merchantConfigObj.requestHost
 
         logObj.logger.info("Signature Header  : " + tempSig)
         puts "Signature Header  : " + tempSig
       else
         #JWT Token
-        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime,logObj)
+        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime)
         puts "Authorization,Bearer  : " + tempSig
         logObj.logger.info("Authorization,Bearer  : " + tempSig)
       end

Samples/Authentication/src/PostMethod.rb

@@ -18,7 +18,7 @@ def main
     cybsproperty_obj = PropertiesUtil.new.getCybsProp('resource/cybs.yml')
     merchantconfig_obj = Merchantconfig.new(cybsproperty_obj)
 
-    logObj = Log.new merchantconfig_obj.logDirectory,merchantconfig_obj.logFilename,merchantconfig_obj.logSize,merchantconfig_obj.enableLog
+    logObj = Log.new merchantconfig_obj.log_config, 'PostMethod'
     # Set Request Type into the merchant config object.
     merchantconfig_obj.requestType = @@request_type
     # Set Request Target into the merchant config object.
@@ -30,7 +30,7 @@ def main
     # SetrequestJsonDataURL into the merchant config object.
     merchantconfig_obj.requestJsonData = RequestData.new.jsonFileData(@@requestJsonPath)
     # Calling APISDK, Apisdk.Controller
-    response_code, response_body, vc_correlationid = APIController.new.payment_post(merchantconfig_obj, logObj)
+    response_code, response_body, vc_correlationid = APIController.new.payment_post(merchantconfig_obj)
     # Display response message and Headers in console.
     puts 'v-c-correlation-id:' + vc_correlationid
     puts 'Response Code:' + response_code

Samples/Authentication/src/PostObjectMethod.rb

@@ -20,7 +20,7 @@ def main()
       cybsPropertyobj = Configuration.new.merchantConfigProp
       merchantConfigObj = Merchantconfig.new cybsPropertyobj
 
-      logObj = Log.new merchantConfigObj.logDirectory,merchantConfigObj.logFilename,merchantConfigObj.logSize,merchantConfigObj.enableLog
+      logObj = Log.new merchantConfigObj.log_config, 'PostObjectMethod'
       # setting requestTarget to merchant
       merchantConfigObj.requestTarget = @@request_target
       merchantConfigObj.requestJsonData = RequestData.new.samplePaymentsData()
@@ -29,7 +29,7 @@ def main()
       merchantConfigObj.requestType = @@request_type
       merchantConfigObj.requestUrl = url
       # Calling APISDK, ApiController
-      responsecode,responseBody,v_c_correlationId =  APIController.new.payment_post(merchantConfigObj, logObj)
+      responsecode,responseBody,v_c_correlationId =  APIController.new.payment_post(merchantConfigObj)
       puts "v-c-correlation-id:"  + v_c_correlationId
       puts "Response Code:" + responsecode
       puts "Response Body:" + responseBody

Samples/Authentication/src/PutGenerateHeaders.rb

@@ -23,7 +23,7 @@ def main()
       merchantConfigObj = Merchantconfig.new cybsPropertyobj
 
       # creating Logger Object
-      logObj = Log.new merchantConfigObj.logDirectory,merchantConfigObj.logFilename,merchantConfigObj.logSize,merchantConfigObj.enableLog
+      logObj = Log.new merchantConfigObj.log_config, 'PutGenerateHeaders'
 
       #setting requestType,requestTarget,requestUrl
       merchantConfigObj.requestType = @@request_type
@@ -55,20 +55,20 @@ def main()
         maskedRequestBody = Masking.new.maskPayload(merchantConfigObj.requestJsonData)
         logObj.logger.info("Request Body: " + JSON.generate(maskedRequestBody))
 
-        digest = DigestGeneration.new.generateDigest(merchantConfigObj.requestJsonData,logObj)
+        digest = DigestGeneration.new.generateDigest(merchantConfigObj.requestJsonData)
         digest = Constants::SHA256 + digest
         logObj.logger.info("Digest : " + digest)
         puts "Digest  : " + digest 
 
-        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime,logObj)
+        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime)
         logObj.logger.info("Host  : " + merchantConfigObj.requestHost)
         puts "Host  : " + merchantConfigObj.requestHost
 
         logObj.logger.info("Signature Header  : " + tempSig)
         puts "Signature Header  : " + tempSig
       else
         #JWT Token
-        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime,logObj)
+        tempSig = Authorization.new.getToken(merchantConfigObj,gmtDateTime)
         puts "Authorization,Bearer  : " + tempSig
         logObj.logger.info("Authorization,Bearer  : " + tempSig)
       end

Samples/Authentication/src/PutMethod.rb

@@ -18,7 +18,7 @@ def main
     cybsproperty_obj = PropertiesUtil.new.getCybsProp('resource/cybs.yml')
     merchantconfig_obj = Merchantconfig.new(cybsproperty_obj)
 
-    logObj = Log.new merchantconfig_obj.logDirectory,merchantconfig_obj.logFilename,merchantconfig_obj.logSize,merchantconfig_obj.enableLog
+    logObj = Log.new merchantconfig_obj.log_config, 'PutMethod'
     # Set Request Type into the merchant config object.
     merchantconfig_obj.requestType = @@request_type
     # Set Request Target into the merchant config object.
@@ -30,7 +30,7 @@ def main
     # SetrequestJsonDataURL into the merchant config object.
     merchantconfig_obj.requestJsonData=RequestData.new.jsonFileData(@@requestJsonPath)
     # Calling APISDK, Apisdk.Controller
-    response_code, response_body, vc_correlationid = APIController.new.payment_put(merchantconfig_obj, logObj)
+    response_code, response_body, vc_correlationid = APIController.new.payment_put(merchantconfig_obj)
     # Display response message and Headers in console.
     puts 'v-c-correlation-id:' + vc_correlationid
     puts 'Response Code:' + response_code