Merge pull request #1 from vultuk/error-handling

Error handling

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-tide",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "A Node module to assist with connections to the Tide business banking API",
   "author": "Simon Skinner <simon@sisk-ltd.co.uk>",
   "repository": {

src/errors/badRequest.ts

@@ -0,0 +1,20 @@
+import * as Interfaces from "../interfaces";
+
+export class BadRequestError extends Error implements Interfaces.ErrorMessage {
+
+    /**
+     * Holds a basic message about this error
+     */
+    message: string = "Invalid Input";
+
+    /**
+     * Holds the HTTP error code associated with the error
+     */
+    httpErrorCode: number = 400;
+
+    /**
+     * Holds a more desciptive message about the error
+     */
+    description: string = "An input was expected but it was not there. Therefore we could not perform the API request.";
+
+}

src/errors/forbidden.ts

@@ -0,0 +1,20 @@
+import * as Interfaces from "../interfaces";
+
+export class ForbiddenError extends Error implements Interfaces.ErrorMessage {
+
+    /**
+     * Holds a basic message about this error
+     */
+    message: string = "Forbidden";
+
+    /**
+     * Holds the HTTP error code associated with the error
+     */
+    httpErrorCode: number = 403;
+
+    /**
+     * Holds a more desciptive message about the error
+     */
+    description: string = "You do not have the required permissions to access the requested resource.";
+
+}

src/errors/index.ts

@@ -0,0 +1,9 @@
+export { BadRequestError } from "./badRequest";
+export { ForbiddenError } from "./forbidden";
+export { InternalServerError } from "./internalServerError";
+export { NotAcceptableError } from "./notAcceptable";
+export { NotAllowedError } from "./notAllowed";
+export { NotFoundError } from "./notFound";
+export { TooManyRequestsError } from "./tooManyRequests";
+export { UnauthorisedError } from "./unauthorised";
+export { UnavailableError } from "./unavailable";

src/errors/internalServerError.ts

@@ -0,0 +1,20 @@
+import * as Interfaces from "../interfaces";
+
+export class InternalServerError extends Error implements Interfaces.ErrorMessage {
+
+    /**
+     * Holds a basic message about this error
+     */
+    message: string = "Internal Server Error";
+
+    /**
+     * Holds the HTTP error code associated with the error
+     */
+    httpErrorCode: number = 500;
+
+    /**
+     * Holds a more desciptive message about the error
+     */
+    description: string = "An error has occurred in either Tide's service or the Node-Tide module. Please inspect this error further for full details.";
+
+}

src/errors/notAcceptable.ts

@@ -0,0 +1,20 @@
+import * as Interfaces from "../interfaces";
+
+export class NotAcceptableError extends Error implements Interfaces.ErrorMessage {
+
+    /**
+     * Holds a basic message about this error
+     */
+    message: string = "Not Acceptable";
+
+    /**
+     * Holds the HTTP error code associated with the error
+     */
+    httpErrorCode: number = 406;
+
+    /**
+     * Holds a more desciptive message about the error
+     */
+    description: string = "You requested a format that isn’t JSON.";
+
+}

src/errors/notAllowed.ts

@@ -0,0 +1,20 @@
+import * as Interfaces from "../interfaces";
+
+export class NotAllowedError extends Error implements Interfaces.ErrorMessage {
+
+    /**
+     * Holds a basic message about this error
+     */
+    message: string = "Not Allowed";
+
+    /**
+     * Holds the HTTP error code associated with the error
+     */
+    httpErrorCode: number = 405;
+
+    /**
+     * Holds a more desciptive message about the error
+     */
+    description: string = "You tried to access a resource with an invalid method.";
+
+}

src/errors/notFound.ts

@@ -0,0 +1,20 @@
+import * as Interfaces from "../interfaces";
+
+export class NotFoundError extends Error implements Interfaces.ErrorMessage {
+
+    /**
+     * Holds a basic message about this error
+     */
+    message: string = "Not Found";
+
+    /**
+     * Holds the HTTP error code associated with the error
+     */
+    httpErrorCode: number = 404;
+
+    /**
+     * Holds a more desciptive message about the error
+     */
+    description: string = "The requested resource was not found.";
+
+}

src/errors/tooManyRequests.ts

@@ -0,0 +1,20 @@
+import * as Interfaces from "../interfaces";
+
+export class TooManyRequestsError extends Error implements Interfaces.ErrorMessage {
+
+    /**
+     * Holds a basic message about this error
+     */
+    message: string = "Too Many Requests";
+
+    /**
+     * Holds the HTTP error code associated with the error
+     */
+    httpErrorCode: number = 429;
+
+    /**
+     * Holds a more desciptive message about the error
+     */
+    description: string = "There have been too many requests to this resource this hour, please ensure you stay within appropriate rate limiting.";
+
+}

src/errors/unauthorised.ts

@@ -0,0 +1,20 @@
+import * as Interfaces from "../interfaces";
+
+export class UnauthorisedError extends Error implements Interfaces.ErrorMessage {
+
+    /**
+     * Holds a basic message about this error
+     */
+    message: string = "Unauthorised";
+
+    /**
+     * Holds the HTTP error code associated with the error
+     */
+    httpErrorCode: number = 401;
+
+    /**
+     * Holds a more desciptive message about the error
+     */
+    description: string = "It has not been possible to access the Tide API as no valid access token was provided.";
+
+}

src/errors/unavailable.ts

@@ -0,0 +1,20 @@
+import * as Interfaces from "../interfaces";
+
+export class UnavailableError extends Error implements Interfaces.ErrorMessage {
+
+    /**
+     * Holds a basic message about this error
+     */
+    message: string = "Unavailable";
+
+    /**
+     * Holds the HTTP error code associated with the error
+     */
+    httpErrorCode: number = 503;
+
+    /**
+     * Holds a more desciptive message about the error
+     */
+    description: string = "Tide's API service is currently undergoing maintainance. Please try again later.";
+
+}

src/index.ts

@@ -1,5 +1,6 @@
 export * from "./services";
 export * from "./interfaces";
+export * from "./errors";
 
 import * as Services from "./services";
 

src/interfaces/errorMessage.ts

@@ -0,0 +1,18 @@
+export interface ErrorMessage {
+
+  /**
+   * Holds a basic message about this error
+   */
+  message: string;
+
+  /**
+   * Holds the HTTP error code associated with the error
+   */
+  httpErrorCode: number;
+
+  /**
+   * Holds a more desciptive message about the error
+   */
+  description: string;
+
+}

src/interfaces/index.ts

@@ -7,3 +7,4 @@ export { Credentials } from "./credentials";
 export { Service } from "./service";
 export { Factory } from "./factory";
 export { RequiresService } from "./requiresService";
+export { ErrorMessage } from "./errorMessage";

src/services/accounts.ts

@@ -12,7 +12,7 @@ export class Accounts extends RequiresService {
    */
   public all(companyId: number): Promise<Entities.Account[]> {
     return this.service.getRequest(`/external/companies/${companyId}/accounts`, {})
-      .then(response => (new Factories.Account).items(response))
+      .then(response => (new Factories.Account).items(response));
   }
 
 }

src/services/tideService.ts

@@ -1,3 +1,4 @@
+import * as Errors from "../errors";
 import * as Interfaces from "../interfaces";
 import * as request from "request-promise-native";
 
@@ -65,7 +66,47 @@ export class TideService implements Interfaces.Service {
         },
         body: data,
         json: true
-      }));
+      }))
+      .catch(err => {
+        throw this.returnError(err.statusCode, err);
+      });
+  }
+
+  /**
+   * Find the appropriate error required to be thrown for this hrrp request
+   * @param  {number}                  code The error code thrown by the API
+   * @param  {Error}                   err  The original Error
+   * @return {Interfaces.ErrorMessage}      The node-tide error message
+   */
+  private returnError(code: number, err: Error): Interfaces.ErrorMessage {
+    switch(code) {
+      case 400:
+        return new Errors.BadRequestError();
+      case 401:
+        return new Errors.UnauthorisedError();
+      case 403:
+        return new Errors.ForbiddenError();
+      case 404:
+        return new Errors.NotFoundError();
+      case 405:
+        return new Errors.NotAllowedError();
+      case 406:
+        return new Errors.NotAcceptableError();
+      case 429:
+        return new Errors.TooManyRequestsError();
+      case 500:
+        return new Errors.InternalServerError();
+      case 503:
+        return new Errors.UnavailableError();
+      default:
+        let newError: Interfaces.ErrorMessage = new Errors.InternalServerError();
+
+        newError.message = err.message;
+        newError.description = err.message;
+        newError.httpErrorCode = 500;
+
+        return newError;
+    }
   }
 
 }