feat(Error): Add specific 402 errors

- IdpcBalanceDepletedError - catches balance depleted
- IdpcLimitReachedError - catches daily ip and daily key limit reached
errors

Author: cblanc

README.md

@@ -468,6 +468,8 @@ IdealPostcodesError < Error
    |- IdpcBadRequestError          # 400 Errors
    |- IdpcUnauthorisedError        # 401 Errors
    |- IdpcRequestFailedError       # 402 Errors
+   |  |- IdpcBalanceDepletedError
+   |  |- IdpcLimitReachedError
    |
    |- IdpcResourceNotFoundError    # 404 Errors
    |  |- IdpcPostcodeNotFoundError

lib/error.ts

@@ -123,6 +123,23 @@ export class IdpcInvalidKeyError extends IdpcUnauthorisedError {}
  */
 export class IdpcRequestFailedError extends IdpcApiError {}
 
+/**
+ * IdpcBalanceDepleted
+ *
+ * Balance on key has been depleted
+ */
+export class IdpcBalanceDepletedError extends IdpcRequestFailedError {}
+
+/**
+ * IdpcLimitReachedError
+ *
+ * Limit reached. One of your lookup limits has been breached for today. This
+ * could either be your total daily limit on your key or the individual IP
+ * limit. You can either wait for for the limit to reset (after a day) or
+ * manually disable or increase your limit.
+ */
+export class IdpcLimitReachedError extends IdpcRequestFailedError {}
+
 /**
  * IdpcResourceNotFoundError
  *
@@ -185,6 +202,8 @@ const INVALID_KEY = 4010;
 
 // 402 Responses
 const PAYMENT_REQUIRED = 402;
+const BALANCE_DEPLETED = 4020;
+const LIMIT_REACHED = 4021;
 
 // 404 Responses
 const NOT_FOUND = 404;
@@ -236,6 +255,9 @@ export const parse = (response: HttpResponse): Error | void => {
     if (code === KEY_NOT_FOUND) return new IdpcKeyNotFoundError(response);
     if (code === UDPRN_NOT_FOUND) return new IdpcUdprnNotFoundError(response);
     if (code === UMPRN_NOT_FOUND) return new IdpcUmprnNotFoundError(response);
+    if (code === BALANCE_DEPLETED)
+      return new IdpcBalanceDepletedError(response);
+    if (code === LIMIT_REACHED) return new IdpcLimitReachedError(response);
 
     // If no API errors of interest detected, fall back to http status code
     if (httpStatus === NOT_FOUND)

test/addresses.resource.ts

@@ -1,5 +1,5 @@
 import * as sinon from "sinon";
-import { IdpcRequestFailedError } from "../lib/error";
+import { IdpcRequestFailedError, IdpcBalanceDepletedError } from "../lib/error";
 import { addresses, errors } from "@ideal-postcodes/api-fixtures";
 import { create, AddressResource } from "../lib/resources/addresses";
 import { HttpVerb } from "../lib/agent";
@@ -76,7 +76,8 @@ describe("AddressesResource", () => {
       .list({ query })
       .then(() => done(new Error("Promise should be rejected")))
       .catch(error => {
-        assert.instanceOf(error, IdpcRequestFailedError);
+        assert.isTrue(error instanceof IdpcRequestFailedError);
+        assert.instanceOf(error, IdpcBalanceDepletedError);
         done();
       });
   });

test/autocomplete.resource.ts

@@ -1,5 +1,5 @@
 import * as sinon from "sinon";
-import { IdpcRequestFailedError } from "../lib/error";
+import { IdpcRequestFailedError, IdpcBalanceDepletedError } from "../lib/error";
 import { errors, autocomplete } from "@ideal-postcodes/api-fixtures";
 import { create, AutocompleteResource } from "../lib/resources/autocomplete";
 import { HttpVerb } from "../lib/agent";
@@ -76,7 +76,8 @@ describe("AutocompleteResource", () => {
       .list({ query })
       .then(() => done(new Error("Promise should be rejected")))
       .catch(error => {
-        assert.instanceOf(error, IdpcRequestFailedError);
+        assert.instanceOf(error, IdpcBalanceDepletedError);
+        assert.isTrue(error instanceof IdpcRequestFailedError);
         done();
       });
   });

test/error.ts

@@ -76,6 +76,7 @@ describe("Error", () => {
       assert.deepEqual(error.response, httpResponse);
       assert.equal(error.message, httpResponse.body.message);
       assert.equal(error.httpStatus, httpResponse.httpStatus);
+      assert.deepEqual(error.metadata, {});
       assert.equal(error.name, "Ideal Postcodes Error");
     });
 
@@ -192,6 +193,33 @@ describe("Error", () => {
     });
   });
 
+  describe("IdpcBalanceDepletedError", () => {
+    describe("instantiation", () => {
+      idpcApiErrorSuite({
+        httpResponse: toResponse(errors.balanceDepleted),
+        ErrorKlass: IdpcRequestFailedError,
+      });
+    });
+  });
+
+  describe("IdpcLimitReachedError", () => {
+    describe("instantiation", () => {
+      idpcApiErrorSuite({
+        httpResponse: toResponse(errors.dailyIpRateLimitReached),
+        ErrorKlass: IdpcRequestFailedError,
+      });
+    });
+  });
+
+  describe("IdpcLimitReachedError", () => {
+    describe("instantiation", () => {
+      idpcApiErrorSuite({
+        httpResponse: toResponse(errors.dailyLimitReached),
+        ErrorKlass: IdpcRequestFailedError,
+      });
+    });
+  });
+
   describe("IdpcServerError", () => {
     describe("instantiation", () => {
       const httpResponse = {