Develop

README.md

@@ -14,4 +14,4 @@ API for registration, live-site
 
 ## How to use and contribute
 
-See documentation here: <https://hackerapi.mchacks.ca>
+See documentation here: <https://docs.mchacks.ca>

VERSION

@@ -1 +1 @@
-1.0.3
+1.1.1

app.js

@@ -42,7 +42,7 @@ if (!Services.env.isProduction()) {
 } else {
     // TODO: change this when necessary
     corsOptions = {
-        origin: [`https://${process.env.FRONTEND_ADDRESS_DEPLOY}`, `https://hackerapi.mchacks.ca`],
+        origin: [`https://${process.env.FRONTEND_ADDRESS_DEPLOY}`, `https://docs.mchacks.ca`],
         credentials: true
     };
 }

constants/general.constant.js

@@ -80,6 +80,9 @@ CREATE_ACC_EMAIL_SUBJECTS[SPONSOR] = `You've been invited to create a sponsor ac
 CREATE_ACC_EMAIL_SUBJECTS[VOLUNTEER] = `You've been invited to create a volunteer account for ${HACKATHON_NAME}`;
 CREATE_ACC_EMAIL_SUBJECTS[STAFF] = `You've been invited to create a staff account for ${HACKATHON_NAME}`;
 
+const CACHE_TIMEOUT_STATS = 5 * 60 * 1000;
+const CACHE_KEY_STATS = "hackerStats";
+
 module.exports = {
     HACKATHON_NAME: HACKATHON_NAME,
     DEVPOST_REGEX: DEVPOST_REGEX,
@@ -112,5 +115,7 @@ module.exports = {
     SPONSOR_T4: SPONSOR_T4,
     SPONSOR_T5: SPONSOR_T5,
     ROLE_CATEGORIES: ROLE_CATEGORIES,
-    POST_ROLES: POST_ROLES
+    POST_ROLES: POST_ROLES,
+    CACHE_TIMEOUT_STATS: CACHE_TIMEOUT_STATS,
+    CACHE_KEY_STATS: CACHE_KEY_STATS
 };

constants/role.constant.js

@@ -6,7 +6,7 @@ const Constants = {
 const mongoose = require("mongoose");
 
 const accountRole = {
-    "_id": mongoose.Types.ObjectId(0),
+    "_id": mongoose.Types.ObjectId("00000000e285ec4f6ec7e5c2"),
     "name": "account",
     "routes": [
         Constants.Routes.authRoutes.login,

constants/routes.constant.js

@@ -159,13 +159,29 @@ const volunteerRoutes = {
     },
 };
 
+const searchRoutes = {
+    "get": {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/search/"
+    }
+};
+
+const staffRoutes = {
+    "hackerStats": {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/hacker/stats",
+    }
+}
+
 const allRoutes = {
     "Auth": authRoutes,
     "Account": accountRoutes,
     "Hacker": hackerRoutes,
     "Sponsor": sponsorRoutes,
     "Team": teamRoutes,
     "Volunteer": volunteerRoutes,
+    "Search": searchRoutes,
+    "Staff": staffRoutes,
 };
 
 /**
@@ -201,6 +217,8 @@ module.exports = {
     sponsorRoutes: sponsorRoutes,
     teamRoutes: teamRoutes,
     volunteerRoutes: volunteerRoutes,
+    searchRoutes: searchRoutes,
+    staffRoutes: staffRoutes,
     allRoutes: allRoutes,
     listAllRoutes: listAllRoutes,
 };

constants/success.constant.js

@@ -0,0 +1,72 @@
+"use strict";
+
+const ACCOUNT_GET_BY_EMAIL = "Account found by user email.";
+const ACCOUNT_GET_BY_ID = "Account found by user id.";
+const ACCOUNT_CREATE = "Account creation successful.";
+const ACCOUNT_UPDATE = "Account update successful.";
+const ACCOUNT_INVITE = "Account invitation successful.";
+
+const AUTH_LOGIN = "Login successful.";
+const AUTH_LOGOUT = "Logout successful.";
+const AUTH_SEND_RESET_EMAIL = "Send reset email successful.";
+const AUTH_RESET_PASSWORD = "Reset password successful.";
+const AUTH_CONFIRM_ACCOUNT = "Confirm account successful.";
+const AUTH_GET_ROLE_BINDINGS = "Get role bindings successful.";
+const AUTH_GET_ROLES = "Get roles successful.";
+const AUTH_SEND_CONFIRMATION_EMAIL = "Send confirmation email successful.";
+
+const HACKER_GET_BY_ID = "Hacker found by id.";
+const HACKER_READ = "Hacker retrieval successful.";
+const HACKER_CREATE = "Hacker creation successful.";
+const HACKER_UPDATE = "Hacker update successful.";
+
+const RESUME_UPLOAD = "Resume upload successful.";
+const RESUME_DOWNLOAD = "Resume download 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.";
+
+const TEAM_GET_BY_ID = "Team found by id.";
+const TEAM_CREATE = "Team creation successful.";
+
+const VOLUNTEER_CREATE = "Volunteer creation successful.";
+
+module.exports = {
+    ACCOUNT_GET_BY_EMAIL: ACCOUNT_GET_BY_EMAIL,
+    ACCOUNT_GET_BY_ID: ACCOUNT_GET_BY_ID,
+    ACCOUNT_CREATE: ACCOUNT_CREATE,
+    ACCOUNT_UPDATE: ACCOUNT_UPDATE,
+    ACCOUNT_INVITE: ACCOUNT_INVITE,
+
+    AUTH_LOGIN: AUTH_LOGIN,
+    AUTH_LOGOUT: AUTH_LOGOUT,
+    AUTH_SEND_RESET_EMAIL: AUTH_SEND_RESET_EMAIL,
+    AUTH_RESET_PASSWORD: AUTH_RESET_PASSWORD,
+    AUTH_CONFIRM_ACCOUNT: AUTH_CONFIRM_ACCOUNT,
+    AUTH_GET_ROLE_BINDINGS: AUTH_GET_ROLE_BINDINGS,
+    AUTH_SEND_CONFIRMATION_EMAIL: AUTH_SEND_CONFIRMATION_EMAIL,
+    AUTH_GET_ROLES: AUTH_GET_ROLES,
+
+    HACKER_GET_BY_ID: HACKER_GET_BY_ID,
+    HACKER_READ: HACKER_READ,
+    HACKER_CREATE: HACKER_CREATE,
+    HACKER_UPDATE: HACKER_UPDATE,
+
+    RESUME_UPLOAD: RESUME_UPLOAD,
+    RESUME_DOWNLOAD: RESUME_DOWNLOAD,
+
+    SEARCH_QUERY: SEARCH_QUERY,
+    SEARCH_NO_RESULTS: SEARCH_NO_RESULTS,
+
+    SPONSOR_GET_BY_ID: SPONSOR_GET_BY_ID,
+    SPONSOR_CREATE: SPONSOR_CREATE,
+
+    TEAM_GET_BY_ID: TEAM_GET_BY_ID,
+    TEAM_CREATE: TEAM_CREATE,
+
+    VOLUNTEER_CREATE: VOLUNTEER_CREATE,
+};

controllers/account.controller.js

@@ -6,6 +6,7 @@ const Services = {
 const Util = require("../middlewares/util.middleware");
 const Constants = {
     Error: require("../constants/error.constant"),
+    Success: require("../constants/success.constant"),
 };
 
 
@@ -22,7 +23,7 @@ async function getUserByEmail(req, res) {
 
     if (acc) {
         return res.status(200).json({
-            message: "Account found by user email",
+            message: Constants.Success.ACCOUNT_GET_BY_EMAIL,
             data: acc.toStrippedJSON()
         });
     } else {
@@ -47,7 +48,7 @@ async function getUserById(req, res) {
 
     if (acc) {
         return res.status(200).json({
-            message: "Account found by user id",
+            message: Constants.Success.ACCOUNT_GET_BY_ID,
             data: acc.toStrippedJSON()
         });
     } else {
@@ -69,7 +70,7 @@ async function getUserById(req, res) {
 async function addUser(req, res) {
     const acc = req.body.account;
     return res.status(200).json({
-        message: "Account creation successful",
+        message: Constants.Success.ACCOUNT_CREATE,
         data: acc.toStrippedJSON()
     });
 }
@@ -87,14 +88,14 @@ async function addUser(req, res) {
  */
 function updatedAccount(req, res) {
     return res.status(200).json({
-        message: "Changed account information",
+        message: Constants.Success.ACCOUNT_UPDATE,
         data: req.body
     });
 }
 
 function invitedAccount(req, res) {
     return res.status(200).json({
-        message: "Successfully invited user",
+        message: Constants.Success.ACCOUNT_INVITE,
         data: {}
     });
 }

controllers/auth.controller.js

@@ -1,52 +1,54 @@
 "use strict";
 
+const Success = require("../constants/success.constant");
+
 module.exports = {
     onSuccessfulLogin: function (req, res) {
         return res.status(200).json({
-            message: "Successfully logged in",
+            message: Success.LOGIN,
             data: {}
         });
     },
     logout: function (req, res) {
         req.logout();
         return res.status(200).json({
-            message: "Successfully logged out",
+            message: Success.LOGOUT,
             data: {}
         });
     },
     sentResetEmail: function (req, res) {
         return res.status(200).json({
-            message: "Sent reset email",
+            message: Success.AUTH_SEND_RESET_EMAIL,
             data: {}
         });
     },
     resetPassword: function (req, res) {
         return res.status(200).json({
-            message: "Successfully reset password",
+            message: Success.AUTH_RESET_PASSWORD,
             data: {}
         });
     },
     confirmAccount: function (req, res) {
         return res.status(200).json({
-            message: "Successfully confirmed account",
+            message: Success.AUTH_CONFIRM_ACCOUNT,
             data: {}
         });
     },
     retrieveRoleBindings: function (req, res) {
         return res.status(200).json({
-            message: "Successfully retrieved role bindings",
+            message: Success.AUTH_GET_ROLE_BINDINGS,
             data: req.roleBindings.toJSON()
         });
     },
     sentConfirmationEmail: function (req, res) {
         return res.status(200).json({
-            message: "Successfully resent account email",
+            message: Success.AUTH_SEND_CONFIRMATION_EMAIL,
             data: {}
         })
     },
     retrievedRoles: function (req, res) {
         return res.status(200).json({
-            message: "Successfully retrieved all roles",
+            message: Success.AUTH_GET_ROLES,
             data: req.roles
         })
     }

controllers/hacker.controller.js

@@ -5,6 +5,7 @@ const Services = {
 };
 const Util = require("../middlewares/util.middleware");
 const Constants = {
+    Success: require("../constants/success.constant"),
     Error: require("../constants/error.constant"),
 };
 
@@ -21,7 +22,7 @@ async function findById(req, res) {
 
     if (hacker) {
         return res.status(200).json({
-            message: "Successfully retrieved hacker information",
+            message: Constants.Success.HACKER_GET_BY_ID,
             data: hacker.toJSON()
         });
     } else {
@@ -41,7 +42,7 @@ async function findById(req, res) {
  */
 function showHacker(req, res) {
     return res.status(200).json({
-        message: "Hacker retrieval successful",
+        message: Constants.Success.HACKER_READ,
         data: req.body.hacker.toJSON()
     });
 }
@@ -55,7 +56,7 @@ function showHacker(req, res) {
  */
 function createdHacker(req, res) {
     return res.status(200).json({
-        message: "Hacker creation successful",
+        message: Constants.Success.HACKER_CREATE,
         data: req.body.hacker.toJSON()
     });
 }
@@ -73,14 +74,14 @@ function createdHacker(req, res) {
  */
 function updatedHacker(req, res) {
     return res.status(200).json({
-        message: "Changed hacker information",
+        message: Constants.Success.HACKER_UPDATE,
         data: req.body
     });
 }
 
 function uploadedResume(req, res) {
     return res.status(200).json({
-        message: "Uploaded resume",
+        message: Constants.Success.RESUME_UPLOAD,
         data: {
             filename: req.body.gcfilename
         }
@@ -89,19 +90,30 @@ function uploadedResume(req, res) {
 
 function downloadedResume(req, res) {
     return res.status(200).json({
-        message: "Downloaded resume",
+        message: Constants.Success.RESUME_DOWNLOAD,
         data: {
             id: req.body.id,
             resume: req.body.resume
         }
     });
 }
 
+function gotStats(req, res) {
+    return res.status(200).json({
+        message: "Retrieved stats",
+        data: {
+            stats: req.body.stats,
+        }
+    });
+
+}
+
 module.exports = {
     updatedHacker: updatedHacker,
     findById: Util.asyncMiddleware(findById),
     createdHacker: createdHacker,
     uploadedResume: uploadedResume,
     downloadedResume: downloadedResume,
     showHacker: showHacker,
+    gotStats: gotStats,
 };

controllers/search.controller.js

@@ -4,16 +4,16 @@ const Services = {
     Logger: require("../services/logger.service")
 };
 const Util = require("../middlewares/util.middleware");
+const Success = require("../constants/success.constant");
 
 async function searchResults(req, res) {
     let results = req.body.results;
     let message;
-    if(results.length < 1){
-        message = "No results found."
-        results = {}
-    }
-    else{
-        message = "Successfully executed query, returning all results"
+    if (results.length < 1) {
+        message = Success.SEARCH_NO_RESULTS;
+        results = {};
+    } else {
+        message = Success.SEARCH_QUERY;
     }
     return res.status(200).json({
         message: message,
@@ -23,4 +23,4 @@ async function searchResults(req, res) {
 
 module.exports = {
     searchResults: Util.asyncMiddleware(searchResults)
-}
+};