Use a shared struct for address proofing results

app/services/proofing/address_result.rb

@@ -0,0 +1,41 @@
+module Proofing
+  class AddressResult
+    attr_reader :success, :errors, :exception, :vendor_name, :transaction_id, :reference
+
+    def initialize(
+      success:,
+      errors:,
+      exception:,
+      vendor_name:,
+      transaction_id: '',
+      reference: ''
+    )
+      @success = success
+      @errors = errors
+      @exception = exception
+      @vendor_name = vendor_name
+      @transaction_id = transaction_id
+      @reference = reference
+    end
+
+    def success?
+      success
+    end
+
+    def timed_out?
+      exception.is_a?(Proofing::TimeoutError)
+    end
+
+    def to_h
+      {
+        exception: exception,
+        errors: errors,
+        success: success?,
+        timed_out: timed_out?,
+        transaction_id: transaction_id,
+        reference: reference,
+        vendor_name: vendor_name,
+      }
+    end
+  end
+end

app/services/proofing/lexis_nexis/phone_finder/proofer.rb

@@ -10,10 +10,36 @@ def initialize(config)
 
         def proof(applicant)
           response = VerificationRequest.new(config: config, applicant: applicant).send
-          return Proofing::LexisNexis::PhoneFinder::Result.new(response)
+          return build_result_from_response(response)
         rescue => exception
           NewRelic::Agent.notice_error(exception)
-          ResultWithException.new(exception, vendor_name: 'lexisnexis:phone_finder')
+          AddressResult.new(
+            success: false,
+            errors: {},
+            exception: exception,
+            vendor_name: 'lexisnexis:phone_finder',
+          )
+        end
+
+        private
+
+        def build_result_from_response(verification_response)
+          AddressResult.new(
+            success: verification_response.verification_status == 'passed',
+            errors: parse_verification_errors(verification_response),
+            exception: nil,
+            vendor_name: 'lexisnexis:phone_finder',
+            transaction_id: verification_response.conversation_id,
+            reference: verification_response.reference,
+          )
+        end
+
+        def parse_verification_errors(verification_response)
+          errors = Hash.new { |h, k| h[k] = [] }
+          verification_response.verification_errors.each do |key, value|
+            errors[key] << value
+          end
+          errors
         end
       end
     end

app/services/proofing/mock/address_mock_client.rb

@@ -6,27 +6,6 @@ class AddressMockClient
       FAILED_TO_CONTACT_PHONE_NUMBER = '7035555999'
       TRANSACTION_ID = 'address-mock-transaction-id-123'
 
-      AddressMockClientResult = Struct.new(:success, :errors, :exception, keyword_init: true) do
-        def success?
-          success
-        end
-
-        def transaction_id
-          TRANSACTION_ID
-        end
-
-        def to_h
-          {
-            exception: exception,
-            errors: errors,
-            success: success,
-            timed_out: exception.is_a?(Proofing::TimeoutError),
-            transaction_id: transaction_id,
-            vendor_name: 'AddressMock',
-          }
-        end
-      end
-
       def proof(applicant)
         plain_phone = applicant[:phone].gsub(/\D/, '').delete_prefix('1')
         if plain_phone == UNVERIFIABLE_PHONE_NUMBER
@@ -36,35 +15,45 @@ def proof(applicant)
         elsif plain_phone == PROOFER_TIMEOUT_PHONE_NUMBER
           timeout_result
         else
-          AddressMockClientResult.new(success: true, errors: {}, exception: nil)
+          address_result(success: true, errors: {}, exception: nil)
         end
       end
 
       private
 
       def unverifiable_phone_result
-        AddressMockClientResult.new(
+        address_result(
           success: false,
           errors: { phone: ['The phone number could not be verified.'] },
           exception: nil,
         )
       end
 
       def failed_to_contact_vendor_result
-        AddressMockClientResult.new(
+        address_result(
           success: false,
           errors: {},
           exception: RuntimeError.new('Failed to contact proofing vendor'),
         )
       end
 
       def timeout_result
-        AddressMockClientResult.new(
+        address_result(
           success: false,
           errors: {},
           exception: Proofing::TimeoutError.new('address mock timeout'),
         )
       end
+
+      def address_result(success:, errors:, exception:)
+        AddressResult.new(
+          success: success,
+          errors: errors,
+          exception: exception,
+          transaction_id: TRANSACTION_ID,
+          vendor_name: 'AddressMock',
+        )
+      end
     end
   end
 end

spec/controllers/idv/phone_controller_spec.rb

@@ -327,6 +327,7 @@
             exception: nil,
             timed_out: false,
             transaction_id: 'address-mock-transaction-id-123',
+            reference: '',
           },
         }
 
@@ -381,6 +382,7 @@
             exception: nil,
             timed_out: false,
             transaction_id: 'address-mock-transaction-id-123',
+            reference: '',
           },
         }
 

spec/features/idv/analytics_spec.rb

@@ -33,7 +33,7 @@
       'IdV: doc auth optional verify_wait submitted' => { success: true, errors: {}, address_edited: false, proofing_results: { exception: nil, transaction_id: 'resolution-mock-transaction-id-123', reference: 'aaa-bbb-ccc', timed_out: false, context: { should_proof_state_id: true, stages: { resolution: { client: 'ResolutionMock', errors: {}, exception: nil, success: true, timed_out: false, transaction_id: 'resolution-mock-transaction-id-123', reference: 'aaa-bbb-ccc' }, state_id: { client: 'StateIdMock', errors: {}, success: true, timed_out: false, exception: nil, transaction_id: 'state-id-mock-transaction-id-456', state: 'MT', state_id_jurisdiction: 'ND' } } } }, ssn_is_unique: true, step: 'verify_wait_step_show' },
       'IdV: phone of record visited' => {},
       'IdV: phone confirmation form' => { success: true, errors: {}, phone_type: :mobile, types: [:fixed_or_mobile], carrier: 'Test Mobile Carrier', country_code: 'US', area_code: '202' },
-      'IdV: phone confirmation vendor' => { success: true, errors: {}, vendor: { exception: nil, vendor_name: 'AddressMock', transaction_id: 'address-mock-transaction-id-123', timed_out: false }, new_phone_added: false },
+      'IdV: phone confirmation vendor' => { success: true, errors: {}, vendor: { exception: nil, vendor_name: 'AddressMock', transaction_id: 'address-mock-transaction-id-123', timed_out: false, reference: '' }, new_phone_added: false },
       'IdV: final resolution' => { success: true },
       'IdV: personal key visited' => {},
       'IdV: personal key submitted' => {},
@@ -101,7 +101,7 @@
       'IdV: in person proofing optional verify_wait submitted' => { success: true, step: 'verify_wait_step_show', address_edited: false, ssn_is_unique: true },
       'IdV: phone of record visited' => {},
       'IdV: phone confirmation form' => { success: true, errors: {}, phone_type: :mobile, types: [:fixed_or_mobile], carrier: 'Test Mobile Carrier', country_code: 'US', area_code: '202' },
-      'IdV: phone confirmation vendor' => { success: true, errors: {}, vendor: { exception: nil, vendor_name: 'AddressMock', transaction_id: 'address-mock-transaction-id-123', timed_out: false }, new_phone_added: false },
+      'IdV: phone confirmation vendor' => { success: true, errors: {}, vendor: { exception: nil, vendor_name: 'AddressMock', transaction_id: 'address-mock-transaction-id-123', timed_out: false, reference: '' }, new_phone_added: false },
       'IdV: Phone OTP delivery Selection Visited' => {},
       'IdV: Phone OTP Delivery Selection Submitted' => { success: true, otp_delivery_preference: 'sms' },
       'IdV: phone confirmation otp sent' => { success: true, otp_delivery_preference: :sms, country_code: 'US', area_code: '202' },

spec/services/idv/phone_step_spec.rb

@@ -59,6 +59,7 @@
           exception: nil,
           timed_out: false,
           transaction_id: 'address-mock-transaction-id-123',
+          reference: '',
         },
       }
 
@@ -92,6 +93,7 @@
           exception: nil,
           timed_out: false,
           transaction_id: 'address-mock-transaction-id-123',
+          reference: '',
         },
       }