Feature/role route

.vscode/launch.json

@@ -179,6 +179,22 @@
                 "${workspaceFolder}/tests/auth.test.js"
             ],
             "internalConsoleOptions": "openOnSessionStart"
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Mocha Tests - Role",
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "args": [
+                "-u",
+                "tdd",
+                "--timeout",
+                "999999",
+                "--colors",
+                "${workspaceFolder}/tests/setup.spec.js",
+                "${workspaceFolder}/tests/role.test.js"
+            ],
+            "internalConsoleOptions": "openOnSessionStart"
         }
     ]
 }

app.js

@@ -28,6 +28,7 @@ const teamRouter = require("./routes/api/team");
 const sponsorRouter = require("./routes/api/sponsor");
 const searchRouter = require("./routes/api/search");
 const volunteerRouter = require("./routes/api/volunteer");
+const roleRouter = require("./routes/api/role");
 
 const app = express();
 Services.db.connect(app);
@@ -83,6 +84,8 @@ volunteerRouter.activate(apiRouter);
 Services.log.info("Volunteer router activated");
 searchRouter.activate(apiRouter);
 Services.log.info("Search router activated");
+roleRouter.activate(apiRouter);
+Services.log.info("Role router activated");
 
 apiRouter.use("/", indexRouter);
 app.use("/", indexRouter);

constants/error.constant.js

@@ -16,6 +16,7 @@ const HACKER_STATUS_409_MESSAGE = "Conflict with hacker status";
 const TEAM_MEMBER_422_MESSAGE = "Duplicate team member in input";
 const VALIDATION_422_MESSAGE = "Validation failed";
 const ACCOUNT_DUPLICATE_422_MESSAGE = "Account already exists";
+const ROLE_DUPLICATE_422_MESSAGE = "Role already exists";
 
 const ACCOUNT_TOKEN_401_MESSAGE = "Invalid token for account";
 const AUTH_401_MESSAGE = "Invalid Authentication";
@@ -32,6 +33,7 @@ const VOLUNTEER_CREATE_500_MESSAGE = "Error while creating volunteer";
 const EMAIL_500_MESSAGE = "Error while generating email";
 const GENERIC_500_MESSAGE = "Internal error";
 const LOGIN_500_MESSAGE = "Error while logging in";
+const ROLE_CREATE_500_MESSAGE = "Error while creating role";
 
 module.exports = {
     ACCOUNT_404_MESSAGE: ACCOUNT_404_MESSAGE,
@@ -61,4 +63,6 @@ module.exports = {
     ACCOUNT_DUPLICATE_422_MESSAGE: ACCOUNT_DUPLICATE_422_MESSAGE,
     LOGIN_500_MESSAGE: LOGIN_500_MESSAGE,
     HACKER_STATUS_409_MESSAGE: HACKER_STATUS_409_MESSAGE,
+    ROLE_DUPLICATE_422_MESSAGE: ROLE_DUPLICATE_422_MESSAGE,
+    ROLE_CREATE_500_MESSAGE: ROLE_CREATE_500_MESSAGE,
 };

constants/routes.constant.js

@@ -62,7 +62,7 @@ const accountRoutes = {
 const hackerRoutes = {
     "getSelf": {
         requestType: Constants.REQUEST_TYPES.GET,
-        uri: "/api/hacker/self/"
+        uri: "/api/hacker/self/",
     },
     "getSelfById": {
         requestType: Constants.REQUEST_TYPES.GET,
@@ -159,6 +159,13 @@ const volunteerRoutes = {
     },
 };
 
+const roleRoutes = {
+    "post": {
+        requestType: Constants.REQUEST_TYPES.POST,
+        uri: "/api/role/",
+    }
+};
+
 const searchRoutes = {
     "get": {
         requestType: Constants.REQUEST_TYPES.GET,
@@ -180,6 +187,7 @@ const allRoutes = {
     "Sponsor": sponsorRoutes,
     "Team": teamRoutes,
     "Volunteer": volunteerRoutes,
+    "Role": roleRoutes,
     "Search": searchRoutes,
     "Staff": staffRoutes,
 };
@@ -217,6 +225,7 @@ module.exports = {
     sponsorRoutes: sponsorRoutes,
     teamRoutes: teamRoutes,
     volunteerRoutes: volunteerRoutes,
+    roleRoutes: roleRoutes,
     searchRoutes: searchRoutes,
     staffRoutes: staffRoutes,
     allRoutes: allRoutes,

constants/success.constant.js

@@ -23,10 +23,11 @@ const HACKER_UPDATE = "Hacker update successful.";
 const RESUME_UPLOAD = "Resume upload successful.";
 const RESUME_DOWNLOAD = "Resume download successful.";
 
+const ROLE_CREATE = "Role creation successful.";
+
 const SEARCH_QUERY = "Query search successful. Returning results.";
 const SEARCH_NO_RESULTS = "Query search successful. No results found.";
 
-
 const SPONSOR_GET_BY_ID = "Sponsor found by id.";
 const SPONSOR_CREATE = "Sponsor creation successful.";
 
@@ -59,6 +60,8 @@ module.exports = {
     RESUME_UPLOAD: RESUME_UPLOAD,
     RESUME_DOWNLOAD: RESUME_DOWNLOAD,
 
+    ROLE_CREATE: ROLE_CREATE,
+
     SEARCH_QUERY: SEARCH_QUERY,
     SEARCH_NO_RESULTS: SEARCH_NO_RESULTS,
 

controllers/account.controller.js

@@ -60,14 +60,13 @@ async function getUserById(req, res) {
 }
 
 /**
- * @async
  * @function addUser
  * @param {{body: {accountDetails: {_id: ObjectId, firstName: string, lastName: string, email: string, password: string, dietaryRestrictions: string, shirtSize: string}}}} req
  * @param {*} res
  * @return {JSON} Success or error status
  * @description Adds a user from information in req.body.accountDetails
  */
-async function addUser(req, res) {
+function addUser(req, res) {
     const acc = req.body.account;
     return res.status(200).json({
         message: Constants.Success.ACCOUNT_CREATE,
@@ -106,7 +105,7 @@ module.exports = {
     getUserById: Util.asyncMiddleware(getUserById),
 
     // assumes all information in req.body
-    addUser: Util.asyncMiddleware(addUser),
+    addUser: addUser,
     updatedAccount: updatedAccount,
     invitedAccount: invitedAccount
 };

controllers/role.controller.js

@@ -0,0 +1,21 @@
+"use strict";
+
+const Success = require("../constants/success.constant");
+
+/**
+ * @function createdRole
+ * @param {{body: {role: Object}}} req
+ * @param {*} res
+ * @return {JSON} Success status and role object
+ * @description Returns the JSON of role object located in req.body.role
+ */
+function createdRole(req, res) {
+    return res.status(200).json({
+        message: Success.ROLE_CREATE,
+        data: req.body.role.toJSON(),
+    });
+}
+
+module.exports = {
+    createdRole: createdRole,
+};

docs/api/api_data.js

@@ -1734,6 +1734,91 @@ define({
         "url": "https://api.mchacks.ca/api/"
       }]
     },
+    {
+      "type": "post",
+      "url": "/api/role/",
+      "title": "create a new hacker",
+      "name": "createRole",
+      "group": "Role",
+      "version": "1.1.1",
+      "parameter": {
+        "fields": {
+          "body": [{
+              "group": "body",
+              "type": "String",
+              "optional": false,
+              "field": "name",
+              "description": "<p>Name of the route</p>"
+            },
+            {
+              "group": "body",
+              "type": "Route[]",
+              "optional": false,
+              "field": "routes",
+              "description": "<p>The routes that this role gives access to</p>"
+            }
+          ]
+        },
+        "examples": [{
+          "title": "application: ",
+          "content": "{\n               \"name\": \"routename\",\n               \"routes\": [\n                   {\n                       uri: \"/api/hacker/\"\n                       requestType: \"POST\"\n                   }\n               ]\n}",
+          "type": "Json"
+        }]
+      },
+      "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>Role object</p>"
+            }
+          ]
+        },
+        "examples": [{
+          "title": "Success-Response: ",
+          "content": "{\n    \"message\": \"Role creation successful\", \n    \"data\": {\n                   \"name\": \"routename\",\n                   \"routes\": [\n                       {\n                           uri: \"/api/hacker/\"\n                           requestType: \"POST\"\n                       }\n                   ]\n    }\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\": \"Error while creating role\", \"data\": {}}",
+          "type": "object"
+        }]
+      },
+      "filename": "routes/api/role.js",
+      "groupTitle": "Role",
+      "sampleRequest": [{
+        "url": "https://api.mchacks.ca/api/api/role/"
+      }]
+    },
     {
       "type": "get",
       "url": "/search/",

docs/api/api_data.json

@@ -1733,6 +1733,91 @@
       "url": "https://api.mchacks.ca/api/"
     }]
   },
+  {
+    "type": "post",
+    "url": "/api/role/",
+    "title": "create a new hacker",
+    "name": "createRole",
+    "group": "Role",
+    "version": "1.1.1",
+    "parameter": {
+      "fields": {
+        "body": [{
+            "group": "body",
+            "type": "String",
+            "optional": false,
+            "field": "name",
+            "description": "<p>Name of the route</p>"
+          },
+          {
+            "group": "body",
+            "type": "Route[]",
+            "optional": false,
+            "field": "routes",
+            "description": "<p>The routes that this role gives access to</p>"
+          }
+        ]
+      },
+      "examples": [{
+        "title": "application: ",
+        "content": "{\n               \"name\": \"routename\",\n               \"routes\": [\n                   {\n                       uri: \"/api/hacker/\"\n                       requestType: \"POST\"\n                   }\n               ]\n}",
+        "type": "Json"
+      }]
+    },
+    "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>Role object</p>"
+          }
+        ]
+      },
+      "examples": [{
+        "title": "Success-Response: ",
+        "content": "{\n    \"message\": \"Role creation successful\", \n    \"data\": {\n                   \"name\": \"routename\",\n                   \"routes\": [\n                       {\n                           uri: \"/api/hacker/\"\n                           requestType: \"POST\"\n                       }\n                   ]\n    }\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\": \"Error while creating role\", \"data\": {}}",
+        "type": "object"
+      }]
+    },
+    "filename": "routes/api/role.js",
+    "groupTitle": "Role",
+    "sampleRequest": [{
+      "url": "https://api.mchacks.ca/api/api/role/"
+    }]
+  },
   {
     "type": "get",
     "url": "/search/",

docs/api/api_project.js

@@ -9,7 +9,7 @@ define({
   "apidoc": "0.3.0",
   "generator": {
     "name": "apidoc",
-    "time": "2018-12-17T04:51:43.722Z",
+    "time": "2018-12-20T06:25:49.908Z",
     "url": "http://apidocjs.com",
     "version": "0.17.6"
   }

docs/api/api_project.json

@@ -9,7 +9,7 @@
   "apidoc": "0.3.0",
   "generator": {
     "name": "apidoc",
-    "time": "2018-12-17T04:51:43.722Z",
+    "time": "2018-12-20T06:25:49.908Z",
     "url": "http://apidocjs.com",
     "version": "0.17.6"
   }