create volunteer get route (#285)

YiFeiZhang2 · pierreTklein · commit 9a7f742f552b · 2019-01-09T22:06:03.000-05:00
* create volunteer get route

* docs
diff --git a/constants/error.constant.js b/constants/error.constant.js
@@ -5,6 +5,7 @@ const HACKER_404_MESSAGE = "Hacker not found";
 const TEAM_404_MESSAGE = "Team not found";
 const RESUME_404_MESSAGE = "Resume not found";
 const SPONSOR_404_MESSAGE = "Sponsor not found";
+const VOLUNTEER_404_MESSAGE = "Volunteer not found";
 
 const ACCOUNT_TYPE_409_MESSAGE = "Wrong account type";
 const SPONSOR_ID_409_MESSAGE = "Conflict with sponsor accountId link";
@@ -75,4 +76,5 @@ module.exports = {
     TEAM_NAME_409_MESSAGE: TEAM_NAME_409_MESSAGE,
     TEAM_JOIN_SAME_409_MESSAGE: TEAM_JOIN_SAME_409_MESSAGE,
     TEAM_READ_500_MESSAGE: TEAM_READ_500_MESSAGE,
+    VOLUNTEER_404_MESSAGE: VOLUNTEER_404_MESSAGE,
 };
diff --git a/constants/role.constant.js b/constants/role.constant.js
@@ -52,6 +52,7 @@ const volunteerRole = {
     "_id": mongoose.Types.ObjectId.createFromTime(3),
     "name": Constants.General.VOLUNTEER,
     "routes": [
+        Constants.Routes.volunteerRoutes.getSelfById,
         Constants.Routes.volunteerRoutes.post,
 
         Constants.Routes.hackerRoutes.patchAnyCheckInById,
diff --git a/constants/routes.constant.js b/constants/routes.constant.js
@@ -161,6 +161,14 @@ const teamRoutes = {
 };
 
 const volunteerRoutes = {
+    "getSelfById": {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/volunteer/" + Constants.ROLE_CATEGORIES.SELF,
+    },
+    "getAnyById": {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/volunteer/" + Constants.ROLE_CATEGORIES.ALL,
+    },
     "post": {
         requestType: Constants.REQUEST_TYPES.POST,
         uri: "/api/volunteer/",
diff --git a/constants/success.constant.js b/constants/success.constant.js
@@ -41,6 +41,7 @@ const TEAM_UPDATE = "Team update successful.";
 const TEAM_READ = "Team retrieval successful.";
 const TEAM_HACKER_LEAVE = "Removal from team successful.";
 
+const VOLUNTEER_GET_BY_ID = "Volunteer found by id";
 const VOLUNTEER_CREATE = "Volunteer creation successful.";
 
 module.exports = {
@@ -84,5 +85,6 @@ module.exports = {
     TEAM_READ: TEAM_READ,
     TEAM_HACKER_LEAVE: TEAM_HACKER_LEAVE,
 
+    VOLUNTEER_GET_BY_ID: VOLUNTEER_GET_BY_ID,
     VOLUNTEER_CREATE: VOLUNTEER_CREATE,
 };
diff --git a/controllers/volunteer.controller.js b/controllers/volunteer.controller.js
@@ -10,21 +10,35 @@ const Constants = {
 }
 
 /**
- * @async
  * @function createdVolunteer
  * @param {{body: {volunteer: {_id: ObjectId, accountId: ObjectId}}}} req
  * @param {*} res
- * @return {JSON} Success or error status
+ * @return {JSON} Success status
  * @description Show the success message and the created volunteer
  */
-async function createdVolunteer(req, res) {
-
+function createdVolunteer(req, res) {
     return res.status(200).json({
         message: Constants.Success.VOLUNTEER_CREATE,
         data: req.body.volunteer
     });
 }
 
+/**
+ * @function showVolunteer
+ * @param {{body: {volunteer: {_id: ObjectId, accountId: ObjectId}}}} req
+ * @param {*} res
+ * @return {JSON} Success status
+ * @description Show the success message and retrieved volunteer
+ */
+function showVolunteer(req, res) {
+    return res.status(200).json({
+        message: Constants.Success.VOLUNTEER_GET_BY_ID,
+        data: req.body.volunteer.toJSON()
+    });
+}
+
+
 module.exports = {
     createdVolunteer: createdVolunteer,
+    showVolunteer: showVolunteer,
 };
diff --git a/docs/api/api_data.js b/docs/api/api_data.js
@@ -2425,6 +2425,7 @@ define({
       "name": "patchTeam",
       "group": "Team",
       "version": "0.0.8",
+      "description": "<p>We use hackerId instead of teamId because authorization requires a one-to-one mapping from param id to accountId, but we are not able to have that from teamId to accountId due to multiple members in a team. Instead, we use hackerId, as there is a 1 to 1 link between hackerId to teamId, and a 1 to 1 link between hackerId and accountId</p>",
       "parameter": {
         "fields": {
           "param": [{
@@ -2561,6 +2562,78 @@ define({
       "sampleRequest": [{
         "url": "https://api.mchacks.ca/api/volunteer/"
       }]
+    },
+    {
+      "type": "get",
+      "url": "/volunteer/:id",
+      "title": "get a volunteer's information",
+      "name": "getVolunteer",
+      "group": "Volunteer",
+      "version": "1.3.0",
+      "parameter": {
+        "fields": {
+          "param": [{
+            "group": "param",
+            "type": "ObjectId",
+            "optional": false,
+            "field": "id",
+            "description": "<p>a volunteer's unique mongoID</p>"
+          }]
+        }
+      },
+      "success": {
+        "fields": {
+          "Success 200": [{
+              "group": "Success 200",
+              "type": "String",
+              "optional": false,
+              "field": "message",
+              "description": "<p>Success message</p>"
+            },
+            {
+              "group": "Success 200",
+              "type": "Object",
+              "optional": false,
+              "field": "data",
+              "description": "<p>Volunteer object</p>"
+            }
+          ]
+        },
+        "examples": [{
+          "title": "Success-Response: ",
+          "content": "{\n               \"message\": \"Successfully retrieved volunteer information\", \n               \"data\": {...}\n           }",
+          "type": "object"
+        }]
+      },
+      "error": {
+        "fields": {
+          "Error 4xx": [{
+              "group": "Error 4xx",
+              "type": "String",
+              "optional": false,
+              "field": "message",
+              "description": "<p>Error message</p>"
+            },
+            {
+              "group": "Error 4xx",
+              "type": "Object",
+              "optional": false,
+              "field": "data",
+              "description": "<p>empty</p>"
+            }
+          ]
+        },
+        "examples": [{
+          "title": "Error-Response: ",
+          "content": "{\"message\": \"Volunteer not found\", \"data\": {}}",
+          "type": "object"
+        }]
+      },
+      "filename": "routes/api/volunteer.js",
+      "groupTitle": "Volunteer",
+      "sampleRequest": [{
+        "url": "https://api.mchacks.ca/api/volunteer/:id"
+      }]
     }
   ]
 });
diff --git a/docs/api/api_data.json b/docs/api/api_data.json
@@ -2424,6 +2424,7 @@
     "name": "patchTeam",
     "group": "Team",
     "version": "0.0.8",
+    "description": "<p>We use hackerId instead of teamId because authorization requires a one-to-one mapping from param id to accountId, but we are not able to have that from teamId to accountId due to multiple members in a team. Instead, we use hackerId, as there is a 1 to 1 link between hackerId to teamId, and a 1 to 1 link between hackerId and accountId</p>",
     "parameter": {
       "fields": {
         "param": [{
@@ -2560,5 +2561,77 @@
     "sampleRequest": [{
       "url": "https://api.mchacks.ca/api/volunteer/"
     }]
+  },
+  {
+    "type": "get",
+    "url": "/volunteer/:id",
+    "title": "get a volunteer's information",
+    "name": "getVolunteer",
+    "group": "Volunteer",
+    "version": "1.3.0",
+    "parameter": {
+      "fields": {
+        "param": [{
+          "group": "param",
+          "type": "ObjectId",
+          "optional": false,
+          "field": "id",
+          "description": "<p>a volunteer's unique mongoID</p>"
+        }]
+      }
+    },
+    "success": {
+      "fields": {
+        "Success 200": [{
+            "group": "Success 200",
+            "type": "String",
+            "optional": false,
+            "field": "message",
+            "description": "<p>Success message</p>"
+          },
+          {
+            "group": "Success 200",
+            "type": "Object",
+            "optional": false,
+            "field": "data",
+            "description": "<p>Volunteer object</p>"
+          }
+        ]
+      },
+      "examples": [{
+        "title": "Success-Response: ",
+        "content": "{\n               \"message\": \"Successfully retrieved volunteer information\", \n               \"data\": {...}\n           }",
+        "type": "object"
+      }]
+    },
+    "error": {
+      "fields": {
+        "Error 4xx": [{
+            "group": "Error 4xx",
+            "type": "String",
+            "optional": false,
+            "field": "message",
+            "description": "<p>Error message</p>"
+          },
+          {
+            "group": "Error 4xx",
+            "type": "Object",
+            "optional": false,
+            "field": "data",
+            "description": "<p>empty</p>"
+          }
+        ]
+      },
+      "examples": [{
+        "title": "Error-Response: ",
+        "content": "{\"message\": \"Volunteer not found\", \"data\": {}}",
+        "type": "object"
+      }]
+    },
+    "filename": "routes/api/volunteer.js",
+    "groupTitle": "Volunteer",
+    "sampleRequest": [{
+      "url": "https://api.mchacks.ca/api/volunteer/:id"
+    }]
   }
 ]
diff --git a/docs/api/api_project.js b/docs/api/api_project.js
@@ -9,7 +9,7 @@ define({
   "apidoc": "0.3.0",
   "generator": {
     "name": "apidoc",
-    "time": "2019-01-08T22:07:07.661Z",
+    "time": "2019-01-10T02:53:36.684Z",
     "url": "http://apidocjs.com",
     "version": "0.17.7"
   }
diff --git a/docs/api/api_project.json b/docs/api/api_project.json
@@ -9,7 +9,7 @@
   "apidoc": "0.3.0",
   "generator": {
     "name": "apidoc",
-    "time": "2019-01-08T22:07:07.661Z",
+    "time": "2019-01-10T02:53:36.684Z",
     "url": "http://apidocjs.com",
     "version": "0.17.7"
   }
diff --git a/middlewares/volunteer.middleware.js b/middlewares/volunteer.middleware.js
@@ -109,9 +109,34 @@ async function validateConfirmedStatus(req, res, next) {
     }
 }
 
+/**
+ * @async
+ * @function findById
+ * @param {{body: {id: ObjectId}}} req
+ * @param {*} res
+ * @description Retrieves a volunteer's information via req.body.id, moving result to req.body.volunteer if succesful.
+ */
+async function findById(req, res, next) {
+    const volunteer = await Services.Volunteer.findById(req.body.id);
+
+    if (!volunteer) {
+        return next({
+            status: 404,
+            message: Constants.Error.VOLUNTEER_404_MESSAGE,
+            data: {
+                id: req.body.id,
+            }
+        });
+    }
+
+    req.body.volunteer = volunteer;
+    next();
+}
+
 module.exports = {
     parseVolunteer: parseVolunteer,
     createVolunteer: Middleware.Util.asyncMiddleware(createVolunteer),
     checkDuplicateAccountLinks: Middleware.Util.asyncMiddleware(checkDuplicateAccountLinks),
     validateConfirmedStatus: Middleware.Util.asyncMiddleware(validateConfirmedStatus),
+    findById: Middleware.Util.asyncMiddleware(findById),
 };
diff --git a/routes/api/volunteer.js b/routes/api/volunteer.js
@@ -7,7 +7,8 @@ const Controllers = {
 const Middleware = {
     Validator: {
         /* Insert the require statement to the validator file here */
-        Volunteer: require("../../middlewares/validators/volunteer.validator")
+        Volunteer: require("../../middlewares/validators/volunteer.validator"),
+        RouteParam: require("../../middlewares/validators/routeParam.validator"),
     },
     /* Insert all of ther middleware require statements here */
     parseBody: require("../../middlewares/parse-body.middleware"),
@@ -24,6 +25,38 @@ module.exports = {
     activate: function (apiRouter) {
         const volunteerRouter = express.Router();
 
+        /**
+         * @api {get} /volunteer/:id get a volunteer's information
+         * @apiName getVolunteer
+         * @apiGroup Volunteer
+         * @apiVersion 1.3.0
+         * 
+         * @apiParam (param) {ObjectId} id a volunteer's unique mongoID
+         * 
+         * @apiSuccess {String} message Success message
+         * @apiSuccess {Object} data Volunteer object
+         * @apiSuccessExample {object} Success-Response: 
+         *      {
+                    "message": "Successfully retrieved volunteer information", 
+                    "data": {...}
+                }
+
+         * @apiError {String} message Error message
+         * @apiError {Object} data empty
+         * @apiErrorExample {object} Error-Response: 
+         *      {"message": "Volunteer not found", "data": {}}
+         */
+        volunteerRouter.route("/:id").get(
+            Middleware.Auth.ensureAuthenticated(),
+            Middleware.Auth.ensureAuthorized([Services.Volunteer.findById]),
+
+            Middleware.Validator.RouteParam.idValidator,
+            Middleware.parseBody.middleware,
+
+            Middleware.Volunteer.findById,
+            Controllers.Volunteer.showVolunteer
+        );
+
         /**
          * @api {post} /volunteer/ create a new volunteer
          * @apiName createVolunteer
diff --git a/services/volunteer.service.js b/services/volunteer.service.js
@@ -40,7 +40,7 @@ function findByAccountId(accountId) {
         accountId: accountId
     };
 
-    return Volunteer.findOne(query, logger.updateCallbackFactory(TAG, "hacker"));
+    return Volunteer.findOne(query, logger.updateCallbackFactory(TAG, "volunteer"));
 }
 
 module.exports = {
diff --git a/tests/volunteer.test.js b/tests/volunteer.test.js

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ define({`
`9`	`9`	`"apidoc": "0.3.0",`
`10`	`10`	`"generator": {`
`11`	`11`	`"name": "apidoc",`
`12`		`- "time": "2019-01-08T22:07:07.661Z",`
	`12`	`+ "time": "2019-01-10T02:53:36.684Z",`
`13`	`13`	`"url": "http://apidocjs.com",`
`14`	`14`	`"version": "0.17.7"`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`"apidoc": "0.3.0",`
`10`	`10`	`"generator": {`
`11`	`11`	`"name": "apidoc",`
`12`		`- "time": "2019-01-08T22:07:07.661Z",`
	`12`	`+ "time": "2019-01-10T02:53:36.684Z",`
`13`	`13`	`"url": "http://apidocjs.com",`
`14`	`14`	`"version": "0.17.7"`
`15`	`15`	`}`