Create travel api

.github/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+- Added travel model
+- Added route to create travel
+- Added routes to look up travel by id, email or self
+- Added routes to status or offer of an existing travel
+
 ## [2.2.0](https://github.com/hackmcgill/hackerapi/tree/2.2.0) - 2020-01-12
 
 ### Added

app.js

@@ -25,6 +25,7 @@ const accountRouter = require("./routes/api/account");
 const authRouter = require("./routes/api/auth");
 const hackerRouter = require("./routes/api/hacker");
 const teamRouter = require("./routes/api/team");
+const travelRouter = require("./routes/api/travel");
 const sponsorRouter = require("./routes/api/sponsor");
 const searchRouter = require("./routes/api/search");
 const settingsRouter = require("./routes/api/settings");
@@ -87,6 +88,8 @@ hackerRouter.activate(apiRouter);
 Services.log.info("Hacker router activated");
 teamRouter.activate(apiRouter);
 Services.log.info("Team router activated");
+travelRouter.activate(apiRouter);
+Services.log.info("Travel router activated")
 sponsorRouter.activate(apiRouter);
 Services.log.info("Sponsor router activated");
 volunteerRouter.activate(apiRouter);

constants/error.constant.js

@@ -7,6 +7,7 @@ const RESUME_404_MESSAGE = "Resume not found";
 const SPONSOR_404_MESSAGE = "Sponsor not found";
 const VOLUNTEER_404_MESSAGE = "Volunteer not found";
 const SETTINGS_404_MESSAGE = "Settings not found";
+const TRAVEL_404_MESSAGE = "Travel not found";
 
 const ACCOUNT_TYPE_409_MESSAGE = "Wrong account type";
 const ACCOUNT_EMAIL_409_MESSAGE = "Email already in use";
@@ -44,6 +45,7 @@ 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";
+const TRAVEL_CREATE_500_MESSAGE = "Error while creating travel";
 
 module.exports = {
     ACCOUNT_404_MESSAGE: ACCOUNT_404_MESSAGE,
@@ -83,5 +85,7 @@ module.exports = {
     TEAM_READ_500_MESSAGE: TEAM_READ_500_MESSAGE,
     VOLUNTEER_404_MESSAGE: VOLUNTEER_404_MESSAGE,
     SPONSOR_UPDATE_500_MESSAGE: SPONSOR_UPDATE_500_MESSAGE,
-    SETTINGS_404_MESSAGE: SETTINGS_404_MESSAGE
+    SETTINGS_404_MESSAGE: SETTINGS_404_MESSAGE,
+    TRAVEL_404_MESSAGE: TRAVEL_404_MESSAGE,
+    TRAVEL_CREATE_500_MESSAGE: TRAVEL_CREATE_500_MESSAGE
 };

constants/general.constant.js

@@ -28,6 +28,23 @@ const HACKER_STATUSES = [
 // This date is Jan 6, 2020 00:00:00 GMT -0500
 const APPLICATION_CLOSE_TIME = 1578286800000;
 
+const TRAVEL_STATUS_NONE = "None"; // Hacker has not been offered compensation for travelling
+const TRAVEL_STATUS_BUS = "Bus"; // Hacker is taking bus to hackathon
+const TRAVEL_STATUS_POLICY = "Policy"; // Hacker has been offer some reimbursement, but we are waiting for hacker to accept travel policy first  
+const TRAVEL_STATUS_OFFERED = "Offered"; // Hacker has been offered some amount of compensation for travelling, but we have not verified their reciepts yet
+const TRAVEL_STATUS_VALID = "Valid"; // Hacker has been offered some amount of compensation for travelling and have uploaded reciepts which we have confirmed to be an approprate amount
+const TRAVEL_STATUS_INVALID = "Invalid"; // Hacker has been offered some amount of compensation for travelling but have uploaded reciepts which we have confirmed to be an inapproprate amount
+const TRAVEL_STATUS_CLAIMED = "Claimed"; // Hacker has been offered some amount of compensation and has recieved such the funds
+const TRAVEL_STATUSES = [
+    TRAVEL_STATUS_NONE,
+    TRAVEL_STATUS_BUS,
+    TRAVEL_STATUS_POLICY,
+    TRAVEL_STATUS_OFFERED,
+    TRAVEL_STATUS_VALID,
+    TRAVEL_STATUS_INVALID,
+    TRAVEL_STATUS_CLAIMED
+];
+
 const SAMPLE_DIET_RESTRICTIONS = [
     "None",
     "Vegan",
@@ -160,6 +177,14 @@ module.exports = {
     HACKER_STATUS_WITHDRAWN: HACKER_STATUS_WITHDRAWN,
     HACKER_STATUS_CHECKED_IN: HACKER_STATUS_CHECKED_IN,
     HACKER_STATUSES: HACKER_STATUSES,
+    TRAVEL_STATUS_NONE: TRAVEL_STATUS_NONE,
+    TRAVEL_STATUS_BUS: TRAVEL_STATUS_BUS,
+    TRAVEL_STATUS_POLICY: TRAVEL_STATUS_POLICY,
+    TRAVEL_STATUS_OFFERED: TRAVEL_STATUS_OFFERED,
+    TRAVEL_STATUS_VALID: TRAVEL_STATUS_VALID,
+    TRAVEL_STATUS_INVALID: TRAVEL_STATUS_INVALID,
+    TRAVEL_STATUS_CLAIMED: TRAVEL_STATUS_CLAIMED,
+    TRAVEL_STATUSES: TRAVEL_STATUSES,
     APPLICATION_CLOSE_TIME: APPLICATION_CLOSE_TIME,
     REQUEST_TYPES: REQUEST_TYPES,
     JOB_INTERESTS: JOB_INTERESTS,

constants/role.constant.js

@@ -38,6 +38,14 @@ const hackerRole = {
         Constants.Routes.hackerRoutes.patchSelfConfirmationById,
         Constants.Routes.hackerRoutes.getSelf,
 
+        Constants.Routes.travelRoutes.getSelf,
+        Constants.Routes.travelRoutes.getSelfById,
+        Constants.Routes.travelRoutes.getAnyById,
+        Constants.Routes.travelRoutes.getSelfByEmail,
+        Constants.Routes.travelRoutes.getAnyByEmail,
+        Constants.Routes.travelRoutes.patchAnyStatusById,
+        Constants.Routes.travelRoutes.patchAnyOfferById,
+
         Constants.Routes.teamRoutes.join,
         Constants.Routes.teamRoutes.patchSelfById,
         Constants.Routes.teamRoutes.post,

constants/routes.constant.js

@@ -150,6 +150,41 @@ const hackerRoutes = {
     }
 };
 
+const travelRoutes = {
+    getSelf: {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/travel/self/"
+    },
+    getSelfById: {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/travel/" + Constants.ROLE_CATEGORIES.SELF
+    },
+    getAnyById: {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/travel/" + Constants.ROLE_CATEGORIES.ALL
+    },
+    getSelfByEmail: {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/travel/email/" + Constants.ROLE_CATEGORIES.SELF
+    },
+    getAnyByEmail: {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/travel/email/" + Constants.ROLE_CATEGORIES.ALL
+    },
+    post: {
+        requestType: Constants.REQUEST_TYPES.POST,
+        uri: "/api/travel/"
+    },
+    patchAnyStatusById: {
+        requestType: Constants.REQUEST_TYPES.PATCH,
+        uri: "/api/travel/status/" + Constants.ROLE_CATEGORIES.ALL
+    },
+    patchAnyOfferById: {
+        requestType: Constants.REQUEST_TYPES.PATCH,
+        uri: "/api/travel/offer/" + Constants.ROLE_CATEGORIES.ALL
+    }
+}
+
 const sponsorRoutes = {
     getSelf: {
         requestType: Constants.REQUEST_TYPES.GET,
@@ -263,6 +298,7 @@ const allRoutes = {
     Auth: authRoutes,
     Account: accountRoutes,
     Hacker: hackerRoutes,
+    Travel: travelRoutes,
     Sponsor: sponsorRoutes,
     Team: teamRoutes,
     Volunteer: volunteerRoutes,
@@ -302,6 +338,7 @@ module.exports = {
     authRoutes: authRoutes,
     accountRoutes: accountRoutes,
     hackerRoutes: hackerRoutes,
+    travelRoutes: travelRoutes,
     sponsorRoutes: sponsorRoutes,
     teamRoutes: teamRoutes,
     volunteerRoutes: volunteerRoutes,

constants/success.constant.js

@@ -27,6 +27,10 @@ const HACKER_SENT_DAY_OF = "Hacker day-of email sent.";
 const RESUME_UPLOAD = "Resume upload successful.";
 const RESUME_DOWNLOAD = "Resume download successful.";
 
+const TRAVEL_READ = "Travel retrieval successful.";
+const TRAVEL_CREATE = "Travel creation successful.";
+const TRAVEL_UPDATE = "Travel update successful.";
+
 const ROLE_CREATE = "Role creation successful.";
 
 const SEARCH_QUERY = "Query search successful. Returning results.";
@@ -78,6 +82,10 @@ module.exports = {
     RESUME_UPLOAD: RESUME_UPLOAD,
     RESUME_DOWNLOAD: RESUME_DOWNLOAD,
 
+    TRAVEL_READ: TRAVEL_READ,
+    TRAVEL_CREATE: TRAVEL_CREATE,
+    TRAVE_UPDATE: TRAVEL_UPDATE,
+
     ROLE_CREATE: ROLE_CREATE,
 
     SEARCH_QUERY: SEARCH_QUERY,

controllers/travel.controller.js

@@ -0,0 +1,66 @@
+"use strict";
+const Constants = {
+    Success: require("../constants/success.constant"),
+    Error: require("../constants/error.constant")
+};
+
+function okay(req, res) {
+    return res.status(200).json({
+        message: "good"
+    });
+}
+
+/**
+ * @function showTravel
+ * @param {{body: {travel: Object}}} req
+ * @param {*} res
+ * @return {JSON} Success status and travel object
+ * @description Returns the JSON of travel object located in req.body.travel
+ */
+function showTravel(req, res) {
+    return res.status(200).json({
+        message: Constants.Success.TRAVEL_READ,
+        data: req.body.travel.toJSON()
+    });
+}
+
+/**
+ * @function createTravel
+ * @param {{body: {travel: {_id: ObjectId, accountId: ObjectId, hackerId: objectId, status: string, request: number, offer: number}}}} req
+ * @param {*} res
+ * @return {JSON} Success status
+ * @description
+ *      Create a travel's record based off information stored in req.body.travel
+ *      Returns a 200 status for the created travel.
+ */
+function createdTravel(req, res) {
+    return res.status(200).json({
+        message: Constants.Success.TRAVEL_CREATE,
+        data: req.body.travel.toJSON()
+    });
+}
+
+/**
+ * @function updatedTravel
+ * @param {{params: {id: ObjectId}, body: {Object}}} req
+ * @param {*} res
+ * @return {JSON} Success or error status
+ * @description
+ *      Change a travel's information based on the trave;'s mongoID specified in req.params.id.
+ *      The id is moved to req.body.id from req.params.id by validation.
+ *      Returns a 200 status for an updated travel.
+ *      The new information is located in req.body.
+ */
+function updatedTravel(req, res) {
+    return res.status(200).json({
+        message: Constants.Success.TRAVEL_UPDATE,
+        data: req.body
+    });
+}
+
+module.exports = {
+    okay: okay,
+    showTravel: showTravel,
+    updatedTravel: updatedTravel,
+    createdTravel: createdTravel
+};

middlewares/hacker.middleware.js

@@ -7,6 +7,7 @@ const Services = {
     Storage: require("../services/storage.service"),
     Email: require("../services/email.service"),
     Account: require("../services/account.service"),
+    Travel: require("../services/travel.service"),
     Env: require("../services/env.service")
 };
 const Middleware = {
@@ -158,9 +159,9 @@ async function validateConfirmedStatusFromHackerId(req, res, next) {
     const hacker = await Services.Hacker.findById(req.params.id);
     if (hacker == null) {
         return next({
-        status: 404,
-        message: Constants.Error.HACKER_404_MESSAGE,
-        data: req.body.hackerId
+            status: 404,
+            message: Constants.Error.HACKER_404_MESSAGE,
+            data: req.body.hackerId
         });
     }
     const account = await Services.Account.findById(hacker.accountId);
@@ -235,7 +236,7 @@ function ensureAccountLinkedToHacker(req, res, next) {
                 hacker &&
                 req.user &&
                 String.toString(hacker.accountId) ===
-                    String.toString(req.user.id)
+                String.toString(req.user.id)
             ) {
                 return next();
             } else {
@@ -545,6 +546,12 @@ async function updateHacker(req, res, next) {
             });
         }
         req.email = acct.email;
+
+        // If this hacker has a travel account associated with it, then update request to reflect amount wanted for travel
+        const travel = await Services.Travel.findByHackerId(hacker.id);
+        if (travel) {
+            await Services.Travel.updateOne(travel.id, { "request": hacker.application.accommodation.travel });
+        }
         return next();
     } else {
         return next({
@@ -617,7 +624,7 @@ function parseAcceptEmail(req, res, next) {
 
 
 /**
- * @function createhacker
+ * @function createHacker
  * @param {{body: {hackerDetails: object}}} req
  * @param {*} res
  * @param {(err?)=>void} next