LG-3280 Adding ConversationId and Reference to LexisNexis error loggi…

…ng… (#16)

LG-3280 Adding ConversationId and Reference to response class and error logging to allow easier follow up on proofing failures.

lib/lexisnexis/response.rb

@@ -25,6 +25,14 @@ def verification_status
       @verification_status ||= response_body.dig('Status', 'TransactionStatus')
     end
 
+    def conversation_id
+      @conversation_id ||= response_body.dig('Status', 'ConversationId')
+    end
+
+    def reference
+      @reference ||= response_body.dig('Status', 'Reference')
+    end
+
     # @api private
     def response_body
       @response_body ||= JSON.parse(response.body)
@@ -51,7 +59,9 @@ def handle_verification_transaction_error
 
       error_code = response_body.dig('Status', 'TransactionReasonCode', 'Code')
       error_information = response_body.fetch('Information', {}).to_json
-      message = "Response error with code '#{error_code}': #{error_information}"
+      tracking_ids = "(LN ConversationId: #{conversation_id}; Reference: #{reference}) "
+
+      message = "#{tracking_ids} Response error with code '#{error_code}': #{error_information}"
       raise VerificationTransactionError, message
     end
   end

lib/lexisnexis/verification_error_parser.rb

@@ -14,9 +14,13 @@ def parsed_errors
 
     def base_error_message
       error_code = body.dig('Status', 'TransactionReasonCode', 'Code')
-      return 'Verification failed without a reason code' if error_code.nil?
+      conversation_id = body.dig('Status', 'ConversationId')
+      reference = body.dig('Status', 'Reference')
+      tracking_ids = "(LN ConversationId: #{conversation_id}; Reference: #{reference}) "
 
-      "Verification failed with code: '#{error_code}'"
+      return "#{tracking_ids} Verification failed without a reason code" if error_code.nil?
+
+      "#{tracking_ids} Verification failed with code: '#{error_code}'"
     end
 
     def product_error_messages

lib/lexisnexis/version.rb

@@ -1,3 +1,3 @@
 module LexisNexis
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

spec/lib/response_spec.rb

@@ -49,9 +49,9 @@
                 end
 
         expect(error).to be_a(LexisNexis::Response::VerificationTransactionError)
-        expect(error.message).to include(
-          "Response error with code 'invalid_transaction_initiate'"
-        )
+        expect(error.message).to include("5556787618334595970")
+        expect(error.message).to include("1234-abcd")
+        expect(error.message).to include("invalid_transaction_initiate")
         expect(error.message).to include(JSON.parse(response_body)['Information'].to_json)
       end
     end

spec/lib/verification_error_parser_spec.rb

@@ -6,9 +6,10 @@
     it 'should return an array of errors from the response' do
       errors = subject.parsed_errors
 
-      expect(errors[:base]).to eq(
-        "Verification failed with code: 'total.scoring.model.verification.fail'"
-      )
+      expect(errors[:base]).to include("total.scoring.model.verification.fail")
+      expect(errors[:base]).to include("31000123456789")
+      expect(errors[:base]).to include("1234-abcd")
+
       expect(errors[:Discovery]).to eq(nil) # This should be absent since it passed
       expect(errors[:SomeOtherProduct]).to eq(response_body['Products'][1].to_json)
       expect(errors[:InstantVerify]).to eq(response_body['Products'][2].to_json)

spec/support/fixtures/instant_verify/error_response.json

@@ -6,6 +6,7 @@
     "TransactionReasonCode": {
       "Code": "invalid_transaction_initiate"
     },
+    "Reference": "1234-abcd",
     "ServerInfo": "ALANARABA01-W7D"
   },
   "Information": [

spec/support/fixtures/instant_verify/failed_response.json

@@ -1,5 +1,6 @@
 {
   "Status": {
+    "ConversationId": "31000123456789",
     "RequestId": "13936762",
     "TransactionStatus": "failed",
     "TransactionReasonCode": {