feat: add isRemote boolean variable to the SETTINGS schema, wire in validation, and add tests (#675)

* feat: add isRemote boolean variable to the SETTINGS schema, wire in validation, and add tests

* feat: update API docs

Author: pierreTklein

docs/api/api_data.js

@@ -1,16 +1 @@
-{
-  "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": "2020-10-31T17:54:03.433Z",
-    "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": "2020-11-01T22:01:33.009Z",    "url": "http://apidocjs.com",    "version": "0.17.7"  }}

docs/api/api_data.json

@@ -57,7 +57,7 @@ async function updateSettings(req, res, next) {
 
 /**
  * @function confirmValidPatch
- * @param {{body:{settingsDetails:{openTime:Date, closeTime:Date, confirmTime:Date}}}} req
+ * @param {{body:{settingsDetails:{openTime:Date, closeTime:Date, confirmTime:Date, isRemote: Boolean}}}} req
  * @param {*} res
  * @param {*} next
  * @return {void}

docs/api/api_project.js

@@ -5,6 +5,7 @@ module.exports = {
     createSettingsValidator: [
         VALIDATOR.dateValidator("body", "openTime", true),
         VALIDATOR.dateValidator("body", "closeTime", true),
-        VALIDATOR.dateValidator("body", "confirmTime", true)
+        VALIDATOR.dateValidator("body", "confirmTime", true),
+        VALIDATOR.booleanValidator("body", "isRemote", true)
     ]
 };

docs/api/api_project.json

@@ -13,6 +13,10 @@ const settings = new mongoose.Schema({
     confirmTime: {
         type: Date,
         default: Date.now() + 31104000000 + 2628000000 // 1 year and 1 month from now.
+    },
+    isRemote: {
+        type: Boolean,
+        default: false
     }
 });
 

middlewares/settings.middleware.js

@@ -34,7 +34,8 @@ module.exports = {
          *              "settings": {
          *                  openTime: "Wed Feb 06 2019 00:00:00 GMT-0500 (GMT-05:00)",
          *                  closeTime: "Sat Feb 01 2020 00:00:00 GMT-0500 (GMT-05:00)",
-         *                  confirmTime: "Sat Feb 20 2020 00:00:00 GMT-0500 (GMT-05:00)"
+         *                  confirmTime: "Sat Feb 20 2020 00:00:00 GMT-0500 (GMT-05:00)",
+         *                  isRemote: false
          *              }
          *          }
          *      }
@@ -55,6 +56,7 @@ module.exports = {
          * @apiParam (body) {Date} [openTime] The opening time for the hackathon.
          * @apiParam (body) {Date} [closeTime] The closing time for the hackathon.
          * @apiParam (body) {Date} [confirmTime] The deadline for confirmation for the hackathon.
+         * @apiParam (body) {Boolean} [isRemote] Whether this hackathon is remote or not.
          *
          * @apiSuccess {string} message Success message
          * @apiSuccess {object} data Settings Object
@@ -65,7 +67,8 @@ module.exports = {
          *              "settings": {
          *                  openTime: "Wed Feb 06 2019 00:00:00 GMT-0500 (GMT-05:00)",
          *                  closeTime: "Sat Feb 01 2020 00:00:00 GMT-0500 (GMT-05:00)",
-         *                  confirmTime: "Sat Feb 20 2020 00:00:00 GMT-0500 (GMT-05:00)"
+         *                  confirmTime: "Sat Feb 20 2020 00:00:00 GMT-0500 (GMT-05:00)",
+         *                  isRemote: true
          *              }
          *          }
          *      }

middlewares/validators/settings.validator.js

@@ -99,4 +99,28 @@ describe("PATCH settings", function() {
             );
         });
     });
+    it("should succeed to make the hackathon remote", function(done) {
+        util.auth.login(agent, Admin, (error) => {
+            if (error) {
+                agent.close();
+                return done(error);
+            }
+            return (
+                agent
+                    .patch(`/api/settings/`)
+                    .type("application/json")
+                    .send(util.settings.settingRemoteHackathon)
+                    // does not have password because of to stripped json
+                    .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.SETTINGS_PATCH
+                        );
+                        done();
+                    })
+            );
+        });
+    });
 });

models/settings.model.js

@@ -25,6 +25,13 @@ const settingConfirmClosed = {
     confirmTime: new Date(Date.now() - 100)
 };
 
+const settingRemoteHackathon = {
+    openTime: new Date(Date.now() - 100),
+    closeTime: new Date(Date.now() + 10000000000),
+    confirmTime: new Date(Date.now() + 100000000000000),
+    isRemote: true
+};
+
 async function storeAll() {
     const toStore = new Settings(settingApplicationOpen);
     Settings.collection.insertOne(toStore);
@@ -61,5 +68,6 @@ module.exports = {
     settingApplicationNotYetOpen: settingApplicationNotYetOpen,
     settingApplicationOpen: settingApplicationOpen,
     settingApplicationClosed: settingApplicationClosed,
-    settingConfirmClosed: settingConfirmClosed
+    settingConfirmClosed: settingConfirmClosed,
+    settingRemoteHackathon: settingRemoteHackathon
 };