refactor(src): implement to es6

src/http.router.js

@@ -0,0 +1,377 @@
+/**
+ * @apiDefine Priority Priority
+ *
+ * @apiDescription A representation an entity which provides a way
+ * to prioritize service and service request(issues)
+ * in order of their importance.
+ *
+ * @author Benson Maruchu <benmaruchu@gmail.com>
+ * @author lally elias <lallyelias87@gmail.com>
+ * @license MIT
+ * @since  0.1.0
+ * @version 1.0.0
+ * @public
+ */
+
+/**
+ * @apiDefine Priority
+ * @apiSuccess {String} _id Unique priority identifier
+ * @apiSuccess {String} [jurisdiction = undefined] jurisdiction under
+ * which priority belongs to
+ * @apiSuccess {Object} name
+ * @apiSuccess {String} name.en Unique Human readable name of
+ * the priority e.g High, Low, Medium.
+ * @apiSuccess {Number} weight Weight of the priority to help in ordering
+ * service request(issue) based on priority.
+ * @apiSuccess {String} color A color code used to differentiate a service
+ * request priority visually.
+ * @apiSuccess {Date} createdAt Date when priority was created
+ * @apiSuccess {Date} updatedAt Date when priority was last updated
+ */
+
+/**
+ * @apiDefine Priorities
+ * @apiSuccess {Object[]} data List of priorities
+ * @apiSuccess {String} data._id Unique priority identifier
+ * @apiSuccess {String} [data.jurisdiction = undefined] jurisdiction under
+ * which priority belongs to
+ * @apiSuccess {Object} data.name
+ * @apiSuccess {String} data.name.en Unique Human readable name of the
+ * priority e.g High, Low, Medium.
+ * @apiSuccess {Number} data.weight Weight of the priority to help in
+ * ordering service request(issue) based on priority.
+ * @apiSuccess {String} data.color A color code used to differentiate
+ * a service request priority visually.
+ * @apiSuccess {Date} data.createdAt Date when priority was created
+ * @apiSuccess {Date} data.updatedAt Date when priority was last updated
+ * @apiSuccess {Number} total Total number of priority
+ * @apiSuccess {Number} size Number of priority returned
+ * @apiSuccess {Number} limit Query limit used
+ * @apiSuccess {Number} skip Query skip/offset used
+ * @apiSuccess {Number} page Page number
+ * @apiSuccess {Number} pages Total number of pages
+ * @apiSuccess {Date} lastModified Date and time at which latest priority
+ * was last modified
+ *
+ */
+
+/**
+ * @apiDefine PrioritySuccessResponse
+ * @apiSuccessExample {json} Success-Response:
+ *   {
+ *       "_id": "592029e5e8dd8e00048c1816",
+ *       jurisdiction: {
+ *         _id: "5af36f7cdfbcfc17b0614933",
+ *         code: "43138529",
+ *         name: "Myanmar",
+ *         color: "#837AD6"
+ *       },
+ *       "name": {
+ *        "en": "Low"
+ *       },
+ *       "weight": 0,
+ *       "color": "#1B5E21",
+ *       "createdAt": "2017-05-20T11:35:01.059Z",
+ *       "updatedAt": "2017-05-20T11:35:01.059Z",
+ *    }
+ */
+
+/**
+ * @apiDefine PrioritiesSuccessResponse
+ * @apiSuccessExample {json} Success-Response:
+ * {
+ *      "data": [
+ *           {
+ *             "_id": "592029e5e8dd8e00048c1816",
+ *             jurisdiction: {
+ *               _id: "5af36f7cdfbcfc17b0614933",
+ *               code: "43138529",
+ *               name: "Myanmar",
+ *               color: "#837AD6"
+ *             },
+ *             "name": {
+ *              "en": Low"
+ *             },
+ *             "weight": 0,
+ *             "color": "#1B5E20",
+ *             "createdAt": "2017-05-20T11:35:01.586Z",
+ *             "updatedAt": "2017-05-20T11:35:01.586Z",
+ *         }
+ *      ],
+ *      "total": 5,
+ *      "size": 1,
+ *      "limit": 1,
+ *      "skip": 0,
+ *      "page": 1,
+ *      "pages": 5,
+ *      "lastModified": "Mon, 30 Apr 2018 12:33:58 GMT"
+ *   }
+ */
+
+/* dependencies */
+import _ from 'lodash';
+import { getString } from '@lykmapipo/env';
+import { Router } from '@lykmapipo/express-common';
+import Priority from './priority.model';
+
+/* local  constants */
+const API_VERSION = getString('API_VERSION', '1.0.0');
+const PATH_LIST = '/priorities';
+const PATH_SINGLE = '/priorities/:id';
+const PATH_JURISDICTION = '/jurisdictions/:jurisdiction/priorities';
+
+/* declarations */
+const router = new Router({
+  version: API_VERSION,
+});
+
+/**
+ * @api {get} /priorities List Priorities
+ * @apiGroup Priority
+ * @apiName GetPriorities
+ * @apiVersion 1.0.0
+ * @apiDescription Returns a list of priorities
+ * @apiUse RequestHeaders
+ * @apiUse Priorities
+ *
+ * @apiUse RequestHeadersExample
+ * @apiUse PrioritiesSuccessResponse
+ * @apiUse JWTError
+ * @apiUse JWTErrorExample
+ * @apiUse AuthorizationHeaderError
+ * @apiUse AuthorizationHeaderErrorExample
+ */
+router.get(PATH_LIST, function getPriorities(request, response, next) {
+  // obtain request options
+  const options = _.merge({}, request.mquery);
+
+  Priority.get(options, function onGetPriorities(error, results) {
+    // forward error
+    if (error) {
+      next(error);
+    }
+
+    // handle response
+    else {
+      response.status(200);
+      response.json(results);
+    }
+  });
+});
+
+/**
+ * @api {post} /priorities Create New Priority
+ * @apiGroup Priority
+ * @apiName PostPriority
+ * @apiVersion 1.0.0
+ * @apiDescription Create new Priority
+ * @apiUse RequestHeaders
+ * @apiUse Priority
+ *
+ * @apiUse RequestHeadersExample
+ * @apiUse PrioritySuccessResponse
+ * @apiUse JWTError
+ * @apiUse JWTErrorExample
+ * @apiUse AuthorizationHeaderError
+ * @apiUse AuthorizationHeaderErrorExample
+ */
+router.post(PATH_LIST, function postPriority(request, response, next) {
+  //   obtain request body
+  const body = _.merge({}, request.body);
+
+  Priority.post(body, function onPostPriority(error, created) {
+    // forward error
+    if (error) {
+      next(error);
+    }
+
+    // handle response
+    else {
+      response.status(201);
+      response.json(created);
+    }
+  });
+});
+
+/**
+ * @api {get} /priorities/:id Get Existing Priority
+ * @apiGroup Priority
+ * @apiName GetPriority
+ * @apiVersion 1.0.0
+ * @apiDescription Get existing priority
+ * @apiUse RequestHeaders
+ * @apiUse Priority
+ *
+ * @apiUse RequestHeadersExample
+ * @apiUse PrioritySuccessResponse
+ * @apiUse JWTErrorExample
+ * @apiUse AuthorizationHeaderError
+ * @apiUse AuthorizationHeaderErrorExample
+ */
+router.get(PATH_SINGLE, function getPriority(request, response, next) {
+  // obtain request options
+  const options = _.merge({}, request.mquery);
+
+  // obtain priority id
+  options._id = request.params.id; // eslint-disable-line no-underscore-dangle
+
+  Priority.getById(options, function onGetPriority(error, found) {
+    // forward error
+    if (error) {
+      next(error);
+    }
+
+    // handle response
+    else {
+      response.status(200);
+      response.json(found);
+    }
+  });
+});
+
+/**
+ * @api {patch} /priorities/:id Patch Existing Priority
+ * @apiGroup Priority
+ * @apiName  PatchPriority
+ * @apiVersion 1.0.0
+ * @apiDescription Patch existing priority
+ * @apiUse RequestHeaders
+ * @apiUse Priority
+ *
+ * @apiUse RequestHeadersExample
+ * @apiUse PrioritySuccessResponse
+ * @apiUse JWTError
+ * @apiUse JWTErrorExample
+ * @apiUse AuthorizationHeaderError
+ * @apiUse AuthorizationHeaderErrorExample
+ */
+router.patch(PATH_SINGLE, function patchPriority(request, response, next) {
+  // obtain priority id
+  const _id = request.params.id; // eslint-disable-line no-underscore-dangle
+
+  // obtain request body
+  const patches = _.merge({}, request.body);
+
+  Priority.patch(_id, patches, function onPatchPriority(error, patched) {
+    // forward error
+    if (error) {
+      next(error);
+    }
+
+    // handle response
+    else {
+      response.status(200);
+      response.json(patched);
+    }
+  });
+});
+
+/**
+ * @api {put} /priorities/:id Put Existing Priority
+ * @apiGroup Priority
+ * @apiName  PutPriority
+ * @apiVersion 1.0.0
+ * @apiDescription Put existing priority
+ * @apiUse RequestHeaders
+ * @apiUse Priority
+ *
+ * @apiUse RequestHeadersExample
+ * @apiUse PrioritySuccessResponse
+ * @apiUse JWTError
+ * @apiUse JWTErrorExample
+ * @apiUse AuthorizationHeaderError
+ * @apiUse AuthorizationHeaderErrorExample
+ */
+router.put(PATH_SINGLE, function putPriority(request, response, next) {
+  // obtain priority id
+  const _id = request.params.id; // eslint-disable-line no-underscore-dangle
+
+  // obtain request body
+  const updates = _.merge({}, request.body);
+
+  Priority.put(_id, updates, function onPutPriority(error, updated) {
+    // forward error
+    if (error) {
+      next(error);
+    }
+
+    // handle response
+    else {
+      response.status(200);
+      response.json(updated);
+    }
+  });
+});
+
+/**
+ * @api {delete} /priorities/:id Delete Priority
+ * @apiGroup Priority
+ * @apiName  DeletePriority
+ * @apiVersion 1.0.0
+ * @apiDescription Delete existing priority
+ * @apiUse RequestHeaders
+ * @apiUse Priority
+ *
+ * @apiUse RequestHeadersExample
+ * @apiUse PrioritySuccessResponse
+ * @apiUse JWTError
+ * @apiUse JWTErrorExample
+ * @apiUse AuthorizationHeaderError
+ * @apiUse AuthorizationHeaderErrorExample
+ */
+router.delete(PATH_SINGLE, function deletePriority(request, response, next) {
+  // obtain priority id
+  const _id = request.params.id; // eslint-disable-line no-underscore-dangle
+
+  Priority.del(_id, function onDeletePriority(error, deleted) {
+    // forward error
+    if (error) {
+      next(error);
+    }
+
+    // handle response
+    else {
+      response.status(200);
+      response.json(deleted);
+    }
+  });
+});
+
+/**
+ * @api {get} /jurisdictions/:jurisdiction/priorities List Jurisdiction Priorities
+ * @apiVersion 1.0.0
+ * @apiName GetJurisdictionPriorities
+ * @apiGroup Priority
+ * @apiDescription Returns a list of priorities of specified jurisdiction
+ * @apiUse RequestHeaders
+ * @apiUse Priorities
+ *
+ * @apiUse RequestHeadersExample
+ * @apiUse PrioritiesSuccessResponse
+ * @apiUse JWTError
+ * @apiUse JWTErrorExample
+ * @apiUse AuthorizationHeaderError
+ * @apiUse AuthorizationHeaderErrorExample
+ */
+router.get(PATH_JURISDICTION, function getPriorities(request, response, next) {
+  // obtain request options
+  const { jurisdiction } = request.params;
+  const filter = jurisdiction ? { filter: { jurisdiction } } : {}; // TODO support parent and no jurisdiction
+  const options = _.merge({}, filter, request.mquery);
+
+  Priority.get(options, function onGetPriorities(error, found) {
+    // forward error
+    if (error) {
+      next(error);
+    }
+
+    // handle response
+    else {
+      response.status(200);
+      response.json(found);
+    }
+  });
+});
+
+/* expose router */
+export default router;