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
", "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": "a volunteer's unique mongoID
" + }] + } + }, + "success": { + "fields": { + "Success 200": [{ + "group": "Success 200", + "type": "String", + "optional": false, + "field": "message", + "description": "Success message
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "Volunteer object
" + } + ] + }, + "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": "Error message
" + }, + { + "group": "Error 4xx", + "type": "Object", + "optional": false, + "field": "data", + "description": "empty
" + } + ] + }, + "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" + }] } ] }); \ No newline at end of file diff --git a/docs/api/api_data.json b/docs/api/api_data.json index 03cc58e8..200690d7 100644 --- 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": "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
", "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": "a volunteer's unique mongoID
" + }] + } + }, + "success": { + "fields": { + "Success 200": [{ + "group": "Success 200", + "type": "String", + "optional": false, + "field": "message", + "description": "Success message
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "Volunteer object
" + } + ] + }, + "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": "Error message
" + }, + { + "group": "Error 4xx", + "type": "Object", + "optional": false, + "field": "data", + "description": "empty
" + } + ] + }, + "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" + }] } ] \ No newline at end of file diff --git a/docs/api/api_project.js b/docs/api/api_project.js index 22cdc45c..049ebd48 100644 --- 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 index 543c38d6..bc9db6de 100644 --- 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 index f1376c79..225f1361 100644 --- 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), }; \ No newline at end of file diff --git a/routes/api/volunteer.js b/routes/api/volunteer.js index 4749493a..c8ee237c 100644 --- 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 index debe80ee..dfd65056 100644 --- 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 index 8f324e36..dcb2a39f 100644 --- a/tests/volunteer.test.js +++ b/tests/volunteer.test.js @@ -26,6 +26,115 @@ const duplicateVolunteer = util.volunteer.duplicateVolunteer1; const hackerAccount = util.account.Account1; +describe("GET volunteer", function () { + it("should FAIL to get volunteer due to lack of authentication", function (done) { + chai.request(server.app) + .get(`/api/volunteer/${util.volunteer.Volunteer1._id}`) + .end(function (err, res) { + res.should.have.status(401); + res.should.be.json; + res.body.should.have.property("message"); + res.body.message.should.equal(Constants.Error.AUTH_401_MESSAGE); + res.body.should.have.property("data"); + + done(); + }); + }); + + it("should Fail to GET volunteer due inappropriate authorization", function (done) { + util.auth.login(agent, util.account.Hacker5, (error) => { + if (error) { + agent.close(); + return done(error); + } + return agent + .get(`/api/volunteer/${util.volunteer.Volunteer1._id}`) + .end(function (err, res) { + res.should.have.status(403); + res.should.be.json; + res.body.should.have.property("message"); + res.body.message.should.equal(Constants.Error.AUTH_403_MESSAGE); + res.body.should.have.property("data"); + + done(); + }); + }); + }); + + it("should Fail to GET volunteer due to non existant volunteer id", function (done) { + util.auth.login(agent, util.account.Admin1, (error) => { + if (error) { + agent.close(); + return done(error); + } + return agent + .get(`/api/volunteer/${util.account.Admin1._id}`) + .end(function (err, res) { + res.should.have.status(404); + res.should.be.json; + res.body.should.have.property("message"); + res.body.message.should.equal(Constants.Error.VOLUNTEER_404_MESSAGE); + res.body.should.have.property("data"); + + done(); + }); + }); + }); + + // success case + it("should GET volunteer info by id with admin credentials", function (done) { + util.auth.login(agent, util.account.Admin1, (error) => { + if (error) { + agent.close(); + return done(error); + } + return agent + .get(`/api/volunteer/${util.volunteer.Volunteer1._id}`) + .end(function (err, res) { + if (err) { + return done(err); + } + res.should.have.status(200); + res.should.be.json; + res.body.should.have.property("message"); + res.body.message.should.equal(Constants.Success.VOLUNTEER_GET_BY_ID); + res.body.should.have.property("data"); + + let volunteer = new Volunteer(util.volunteer.Volunteer1); + chai.assert.equal(JSON.stringify(res.body.data), JSON.stringify(volunteer.toJSON())); + done(); + }); + }); + }); + + // success case + it("should GET the user's volunteer info by id", function (done) { + util.auth.login(agent, util.account.Account4, (error) => { + if (error) { + agent.close(); + return done(error); + } + return agent + .get(`/api/volunteer/${util.volunteer.Volunteer1._id}`) + .end(function (err, res) { + if (err) { + return done(err); + } + res.should.have.status(200); + res.should.be.json; + res.body.should.have.property("message"); + res.body.message.should.equal(Constants.Success.VOLUNTEER_GET_BY_ID); + res.body.should.have.property("data"); + + let volunteer = new Volunteer(util.volunteer.Volunteer1); + chai.assert.equal(JSON.stringify(res.body.data), JSON.stringify(volunteer.toJSON())); + done(); + }); + }); + }); + +}); + describe("POST create volunteer", function () { it("should fail to create a new volunteer due to lack of authentication", function (done) { chai.request(server.app)