Feature/team get (#270)

YiFeiZhang2 · pierreTklein · commit 433a103cb2a1 · 2019-01-07T14:29:53.000-05:00
* Add routes and roles

* add showTeam with member names

* create tests

* Create middleware to display member names and add auth

* documentation and function commenting

* add some more test details

* docs and typo

* Change findMemberNames to use Mongoose.populate

* Change documentation to so param type is ObjectId

* Move id for get to be in req.param

* Fix documentation, make test cases more detailed
diff --git a/constants/role.constant.js b/constants/role.constant.js
@@ -41,6 +41,7 @@ const hackerRole = {
         Constants.Routes.hackerRoutes.getSelf,
 
         Constants.Routes.teamRoutes.join,
+        Constants.Routes.teamRoutes.get
     ]
 };
 
@@ -52,6 +53,8 @@ const volunteerRole = {
 
         Constants.Routes.hackerRoutes.patchAnyCheckInById,
         Constants.Routes.hackerRoutes.patchSelfCheckInById,
+
+        Constants.Routes.teamRoutes.get
     ]
 };
 
diff --git a/constants/routes.constant.js b/constants/routes.constant.js
@@ -134,11 +134,7 @@ const sponsorRoutes = {
 };
 
 const teamRoutes = {
-    "getSelfById": {
-        requestType: Constants.REQUEST_TYPES.GET,
-        uri: "/api/team/" + Constants.ROLE_CATEGORIES.SELF,
-    },
-    "getAnyById": {
+    "get": {
         requestType: Constants.REQUEST_TYPES.GET,
         uri: "/api/team/" + Constants.ROLE_CATEGORIES.ALL,
     },
diff --git a/controllers/team.controller.js b/controllers/team.controller.js
@@ -19,9 +19,27 @@ const Constants = {
  * @description Returns the JSON of team object located in req.body.team
  */
 function showTeam(req, res) {
+    const teamData = req.body.team.toJSON();
+    delete teamData.members;
+
+    const memberNames = [];
+    for (const member of req.body.teamMembers) {
+        const strippedMemberJSON = member.toStrippedJSON();
+
+        const memberName = {
+            "firstName": strippedMemberJSON.firstName,
+            "lastName": strippedMemberJSON.lastName,
+        };
+
+        memberNames.push(memberName);
+    }
+
     return res.status(200).json({
         message: Constants.Success.TEAM_READ,
-        data: req.body.team.toJSON()
+        data: {
+            team: teamData,
+            members: memberNames,
+        }
     });
 }
 
diff --git a/docs/api/api_data.js b/docs/api/api_data.js
@@ -1779,7 +1779,7 @@ define({
     {
       "type": "post",
       "url": "/api/role/",
-      "title": "create a new hacker",
+      "title": "create a new role",
       "name": "createRole",
       "group": "Role",
       "version": "1.1.1",
@@ -2263,7 +2263,7 @@ define({
             "type": "ObjectId",
             "optional": false,
             "field": "id",
-            "description": "<p>a team's unique mongoId</p>"
+            "description": "<p>MongoId of the team</p>"
           }]
         }
       },
diff --git a/docs/api/api_data.json b/docs/api/api_data.json
@@ -1778,7 +1778,7 @@
   {
     "type": "post",
     "url": "/api/role/",
-    "title": "create a new hacker",
+    "title": "create a new role",
     "name": "createRole",
     "group": "Role",
     "version": "1.1.1",
@@ -2262,7 +2262,7 @@
           "type": "ObjectId",
           "optional": false,
           "field": "id",
-          "description": "<p>a team's unique mongoId</p>"
+          "description": "<p>MongoId of the team</p>"
         }]
       }
     },
diff --git a/docs/api/api_project.js b/docs/api/api_project.js
@@ -1,16 +1,16 @@
-define({
-  "name": "hackerAPI",
-  "version": "0.0.8",
-  "description": "Documentation for the API used for mchacks",
-  "defaultVersion": "0.0.8",
-  "title": "hackerAPI documentation",
-  "url": "https://api.mchacks.ca/api",
-  "sampleUrl": "https://api.mchacks.ca/api",
-  "apidoc": "0.3.0",
-  "generator": {
-    "name": "apidoc",
-    "time": "2019-01-04T19:05:11.619Z",
-    "url": "http://apidocjs.com",
-    "version": "0.17.7"
-  }
+define({
+  "name": "hackerAPI",
+  "version": "0.0.8",
+  "description": "Documentation for the API used for mchacks",
+  "defaultVersion": "0.0.8",
+  "title": "hackerAPI documentation",
+  "url": "https://api.mchacks.ca/api",
+  "sampleUrl": "https://api.mchacks.ca/api",
+  "apidoc": "0.3.0",
+  "generator": {
+    "name": "apidoc",
+    "time": "2019-01-07T19:14:21.760Z",
+    "url": "http://apidocjs.com",
+    "version": "0.17.7"
+  }
 });
diff --git a/docs/api/api_project.json b/docs/api/api_project.json
@@ -1,16 +1,16 @@
-{
-  "name": "hackerAPI",
-  "version": "0.0.8",
-  "description": "Documentation for the API used for mchacks",
-  "defaultVersion": "0.0.8",
-  "title": "hackerAPI documentation",
-  "url": "https://api.mchacks.ca/api",
-  "sampleUrl": "https://api.mchacks.ca/api",
-  "apidoc": "0.3.0",
-  "generator": {
-    "name": "apidoc",
-    "time": "2019-01-04T19:05:11.619Z",
-    "url": "http://apidocjs.com",
-    "version": "0.17.7"
-  }
+{
+  "name": "hackerAPI",
+  "version": "0.0.8",
+  "description": "Documentation for the API used for mchacks",
+  "defaultVersion": "0.0.8",
+  "title": "hackerAPI documentation",
+  "url": "https://api.mchacks.ca/api",
+  "sampleUrl": "https://api.mchacks.ca/api",
+  "apidoc": "0.3.0",
+  "generator": {
+    "name": "apidoc",
+    "time": "2019-01-07T19:14:21.760Z",
+    "url": "http://apidocjs.com",
+    "version": "0.17.7"
+  }
 }
diff --git a/middlewares/team.middleware.js b/middlewares/team.middleware.js
@@ -5,7 +5,8 @@ const mongoose = require("mongoose");
 const Services = {
     Logger: require("../services/logger.service"),
     Team: require("../services/team.service"),
-    Hacker: require("../services/hacker.service")
+    Hacker: require("../services/hacker.service"),
+    Account: require("../services/account.service"),
 };
 const Util = require("./util.middleware");
 const Constants = {
@@ -192,6 +193,42 @@ async function findById(req, res, next) {
     next();
 }
 
+/**
+ * @async
+ * @function populateMemberAccountsById
+ * @param {{body: {id: ObjectId}}} req 
+ * @param {*} res 
+ * @return {JSON} Success or error status
+ * @description 
+ * Find the team by id and populates the accounts of the members.
+ * The team information is stored in req.body.team, and the member information is stored in req.body.teamMembers
+ */
+async function populateMemberAccountsById(req, res, next) {
+    const team = await Services.Team.findById(req.body.id).populate({
+        path: "members",
+        populate: {
+            path: "accountId"
+        }
+    });
+
+    if (!team) {
+        return res.status(404).json({
+            message: Constants.Error.TEAM_404_MESSAGE,
+            data: {}
+        });
+    }
+
+    let teamMembers = [];
+
+    for (const member of team.members) {
+        teamMembers.push(member.accountId);
+    }
+
+    req.body.team = team;
+    req.body.teamMembers = teamMembers;
+    return next();
+}
+
 /**
  * @function parseTeam
  * @param {{body: {name: string, members: Object[], devpostURL: string, projectName: string}}} req
@@ -228,4 +265,5 @@ module.exports = {
     ensureUniqueHackerId: Util.asyncMiddleware(ensureUniqueHackerId),
     ensureSpace: Util.asyncMiddleware(ensureSpace),
     updateHackerTeam: Util.asyncMiddleware(updateHackerTeam),
+    populateMemberAccountsById: Util.asyncMiddleware(populateMemberAccountsById),
 };
diff --git a/middlewares/validators/team.validator.js b/middlewares/validators/team.validator.js
@@ -13,5 +13,5 @@ module.exports = {
 
     joinTeamValidator: [
         VALIDATOR.asciiValidator("body", "name", false),
-    ]
+    ],
 };
diff --git a/routes/api/role.js b/routes/api/role.js
@@ -18,7 +18,7 @@ module.exports = {
         const roleRouter = express.Router();
 
         /**
-         * @api {post} /api/role/ create a new hacker
+         * @api {post} /api/role/ create a new role
          * @apiName createRole
          * @apiGroup Role
          * @apiVersion 1.1.1
diff --git a/routes/api/team.js b/routes/api/team.js
@@ -98,7 +98,7 @@ module.exports = {
          * @apiGroup Team
          * @apiVersion 0.0.8
          * 
-         * @apiParam (param) {ObjectId} id a team's unique mongoId
+         * @apiParam (param) {ObjectId} id MongoId of the team
          * 
          * @apiSuccess {String} message Success message
          * @apiSuccess {Object} data Sponsor object
@@ -114,10 +114,21 @@ module.exports = {
          *      {"message": "Team not found", "data": {}}
          */
         teamRouter.route("/:id").get(
+            Middleware.Auth.ensureAuthenticated(),
+            // get is available for all teams, or no teams. No authorization is done on the :id parameter.
+            // However, a function is needed, so the identity function is put here. In reality, the route
+            // is /api/team/:all, so the id is not checked. The returned object places the id inside accountId
+            // to be consistent with other findById functions
+            Middleware.Auth.ensureAuthorized([(id) => {
+                return {
+                    accountId: id
+                };
+            }]),
+
             Middleware.Validator.RouteParam.idValidator,
             Middleware.parseBody.middleware,
 
-            Middleware.Team.findById,
+            Middleware.Team.populateMemberAccountsById,
             Controllers.Team.showTeam
         );
 
diff --git a/tests/team.test.js b/tests/team.test.js
@@ -21,21 +21,70 @@ const Constants = {
 const agent = chai.request.agent(server.app);
 
 describe("GET team", function () {
-    it("should SUCCEED and list a team's information from /api/team/:id GET", function (done) {
+    it("should FAIL to list a team's information due to lack of authentication", function (done) {
         chai.request(server.app)
-            .get(`/api/team/` + util.team.Team1._id)
+            .get(`/api/team/${util.team.Team3._id}`)
             .end(function (err, res) {
-                res.should.have.status(200);
+                res.should.have.status(401);
                 res.should.be.json;
                 res.body.should.have.property("message");
-                res.body.message.should.equal(Constants.Success.TEAM_READ);
+                res.body.message.should.equal(Constants.Error.AUTH_401_MESSAGE);
                 res.body.should.have.property("data");
 
-                let team = new Team(util.team.Team1);
-                chai.assert.equal(JSON.stringify(res.body.data), JSON.stringify(team.toJSON()));
                 done();
             });
     });
+
+    it("should Fail and list a team's information from /api/team/ GET due to non existant team id", function (done) {
+        util.auth.login(agent, util.account.Hacker4, (error) => {
+            if (error) {
+                agent.close();
+                return done(error);
+            }
+            return agent
+                .get(`/api/team/${util.team.newTeam1._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.TEAM_404_MESSAGE);
+                    res.body.should.have.property("data");
+
+                    done();
+                });
+        });
+    });
+
+    it("should SUCCEED and list a team's information from /api/team/ GET", function (done) {
+        util.auth.login(agent, util.account.Hacker3, (error) => {
+            if (error) {
+                agent.close();
+                return done(error);
+            }
+            return agent
+                .get(`/api/team/${util.team.Team3._id}`)
+                .end(function (err, res) {
+                    res.should.have.status(200);
+                    res.should.be.json;
+                    res.body.should.have.property("message");
+                    res.body.message.should.equal(Constants.Success.TEAM_READ);
+                    res.body.should.have.property("data");
+                    res.body.data.should.have.property("team");
+                    res.body.data.team.name.should.equal("FullTeam");
+                    res.body.data.should.have.property("members");
+                    res.body.data.members[0].firstName.should.equal("abcd");
+                    res.body.data.members[0].lastName.should.equal("defg4");
+                    res.body.data.members[1].firstName.should.equal("abcd");
+                    res.body.data.members[1].lastName.should.equal("defg5");
+                    res.body.data.members[2].firstName.should.equal("abcd");
+                    res.body.data.members[2].lastName.should.equal("defg6");
+                    res.body.data.members[3].firstName.should.equal("abcd");
+                    res.body.data.members[3].lastName.should.equal("defg7");
+
+                    done();
+                });
+        });
+    });
 });
 
 describe("POST create team", function () {
diff --git a/tests/util/account.test.util.js b/tests/util/account.test.util.js
@@ -152,7 +152,7 @@ const NonConfirmedAccount2 = {
 const Hacker3 = {
     "_id": mongoose.Types.ObjectId(),
     "firstName": "abcd",
-    "lastName": "defg",
+    "lastName": "defg3",
     "pronoun": "They/Them",
     "email": "abc.def7@blahblah.com",
     "password": "probsShouldBeHashed2",
@@ -167,7 +167,7 @@ const Hacker3 = {
 const Hacker4 = {
     "_id": mongoose.Types.ObjectId(),
     "firstName": "abcd",
-    "lastName": "defg",
+    "lastName": "defg4",
     "pronoun": "They/Them",
     "email": "abc.def.hacker4@blahblah.com",
     "password": "probsShouldBeHashed2",
@@ -181,7 +181,7 @@ const Hacker4 = {
 const Hacker5 = {
     "_id": mongoose.Types.ObjectId(),
     "firstName": "abcd",
-    "lastName": "defg",
+    "lastName": "defg5",
     "pronoun": "They/Them",
     "email": "abc.def.hacker5@blahblah.com",
     "password": "probsShouldBeHashed2",
@@ -195,7 +195,7 @@ const Hacker5 = {
 const Hacker6 = {
     "_id": mongoose.Types.ObjectId(),
     "firstName": "abcd",
-    "lastName": "defg",
+    "lastName": "defg6",
     "pronoun": "They/Them",
     "email": "abc.def.hacker6@blahblah.com",
     "password": "probsShouldBeHashed2",
@@ -209,7 +209,7 @@ const Hacker6 = {
 const Hacker7 = {
     "_id": mongoose.Types.ObjectId(),
     "firstName": "abcd",
-    "lastName": "defg",
+    "lastName": "defg7",
     "pronoun": "They/Them",
     "email": "abc.def.hacker7@blahblah.com",
     "password": "probsShouldBeHashed2",
diff --git a/tests/util/team.test.util.js b/tests/util/team.test.util.js
@@ -7,6 +7,7 @@ const mongoose = require("mongoose");
 const logger = require("../../services/logger.service");
 
 const newTeam1 = {
+    "_id": mongoose.Types.ObjectId(),
     "name": "BronzeTeam",
     "members": [Util.Hacker.HackerB._id],
     "projectName": "YetAnotherProject"

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ const hackerRole = {`
`41`	`41`	`Constants.Routes.hackerRoutes.getSelf,`
`42`	`42`
`43`	`43`	`Constants.Routes.teamRoutes.join,`
	`44`	`+ Constants.Routes.teamRoutes.get`
`44`	`45`	`]`
`45`	`46`	`};`
`46`	`47`
`@@ -52,6 +53,8 @@ const volunteerRole = {`
`52`	`53`
`53`	`54`	`Constants.Routes.hackerRoutes.patchAnyCheckInById,`
`54`	`55`	`Constants.Routes.hackerRoutes.patchSelfCheckInById,`
	`56`	`+`
	`57`	`+ Constants.Routes.teamRoutes.get`
`55`	`58`	`]`
`56`	`59`	`};`
`57`	`60`