Merge pull request #495 from EasyPost/error_alternative_format

test: alternative error format

Author: Justintime50

test/cassettes/Error-Service_386538342/pulls-out-error-properties-of-an-API-error-when-using-the-alternative-format_650479431/recording.har

@@ -33,18 +33,34 @@ describe('Address Service', function () {
   it('creates an address with verify param', async function () {
     const addressData = Fixture.incorrectAddress();
 
-    // Creating normally (without specifying "verify") will make the address, perform no verifications
+    // Creating normally (without specifying "verify") will make the address and perform no verifications
     let address = await client.Address.create(addressData);
 
     expect(address).to.be.an.instanceOf(Address);
     expect(address.verifications.delivery).to.be.undefined;
 
-    // Creating with verify = true will make the address, perform verifications
+    // Creating with verify = true will make the address and perform verifications
     addressData.verify = true;
     address = await client.Address.create(addressData);
 
     expect(address).to.be.an.instanceOf(Address);
+
+    // Delivery verification assertions
     expect(address.verifications.delivery.success).to.be.false;
+    // TODO: details is not deserializing correctly, related to the larger "double EasyPostObject" wrapping issue
+    // expect(address.verifications.delivery.details).to.equal({});
+    expect(address.verifications.delivery.errors[0].code).to.equal('E.ADDRESS.NOT_FOUND');
+    expect(address.verifications.delivery.errors[0].field).to.equal('address');
+    expect(address.verifications.delivery.errors[0].suggestion).to.be.null;
+    expect(address.verifications.delivery.errors[0].message).to.equal('Address not found');
+
+    // Zip4 verification assertions
+    expect(address.verifications.zip4.success).to.be.false;
+    expect(address.verifications.zip4.details).to.be.null;
+    expect(address.verifications.zip4.errors[0].code).to.equal('E.ADDRESS.NOT_FOUND');
+    expect(address.verifications.zip4.errors[0].field).to.equal('address');
+    expect(address.verifications.zip4.errors[0].suggestion).to.be.null;
+    expect(address.verifications.zip4.errors[0].message).to.equal('Address not found');
   });
 
   it('creates an address with verify_strict param', async function () {

test/services/address.test.js

@@ -15,6 +15,7 @@ import TimeoutError from '../../src/errors/api/timeout_error';
 import UnauthorizedError from '../../src/errors/api/unauthorized_error';
 import UnknownApiError from '../../src/errors/api/unknown_api_error';
 import ErrorHandler from '../../src/errors/error_handler';
+import Fixture from '../helpers/fixture';
 import * as setupPolly from '../helpers/setup_polly';
 
 describe('Error Service', function () {
@@ -39,6 +40,17 @@ describe('Error Service', function () {
     });
   });
 
+  it('pulls out error properties of an API error when using the alternative format', async function () {
+    const claimData = Fixture.basicClaim();
+    claimData.tracking_code = '123'; // Intentionally pass a bad tracking code
+    await client.Claim.create(claimData).catch((error) => {
+      expect(error.statusCode).to.equal(404);
+      expect(error.code).to.equal('NOT_FOUND');
+      expect(error.message).to.equal('The requested resource could not be found.');
+      assert.deepEqual(error.errors[0], 'No eligible insurance found with provided tracking code.');
+    });
+  });
+
   it('test error array parsing', () => {
     const fakeErrorResponse = {
       statusCode: 404,