feat: make phone numbers optional (#673)

* feat: make phone numbers optional

* docs: make phone number optional

* docs: rebuild doc changes

Author: jamesxu123

docs/api/api_data.js

@@ -1 +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": "2020-07-31T04:35:04.323Z",    "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": "2020-10-31T17:54:03.433Z",
+    "url": "http://apidocjs.com",
+    "version": "0.17.7"
+  }
+});

docs/api/api_data.json

@@ -1 +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": "2020-07-31T04:35:04.323Z",    "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-10-31T17:54:03.433Z",
+    "url": "http://apidocjs.com",
+    "version": "0.17.7"
+  }
+}

docs/api/api_project.js

@@ -19,7 +19,7 @@ module.exports = {
             true
         ),
         VALIDATOR.dateValidator("body", "birthDate", false),
-        VALIDATOR.phoneNumberValidator("body", "phoneNumber", false)
+        VALIDATOR.phoneNumberValidator("body", "phoneNumber", true)
     ],
     updateAccountValidator: [
         VALIDATOR.stringValidator("body", "firstName", true),

docs/api/api_project.json

@@ -51,8 +51,7 @@ const AccountSchema = new mongoose.Schema({
         required: true
     },
     phoneNumber: {
-        type: Number,
-        required: true
+        type: Number
     }
 });
 

middlewares/validators/account.validator.js

@@ -73,7 +73,7 @@ module.exports = {
          * @apiParam (body) {String[]} dietaryRestrictions Any dietary restrictions for the user. 'None' if there are no restrictions
          * @apiParam (body) {String} password The password of the account.
          * @apiParam (body) {String} birthDate a Date parsable string.
-         * @apiParam (body) {Number} phoneNumber the user's phone number, represented as a string.
+         * @apiParam (body) {Number} [phoneNumber] the user's phone number, represented as a string.
          * @apiParam (header) {JWT} [token] the user's invite token.
          * 
          * @apiParamExample {json} Request-Example:

models/account.model.js

@@ -38,6 +38,9 @@ const storedAccount3 = util.account.NonConfirmedAccount3;
 
 const newAccount0 = util.account.unlinkedAccounts.new[0];
 
+//This account should NOT have a phone number
+const noPhoneAccount = util.account.NoPhoneHackerAccount0;
+
 describe("GET user account", function() {
     // fail on authentication
     it("should FAIL to list the user's account on /api/account/self GET due to authentication", function(done) {
@@ -239,6 +242,31 @@ describe("POST create account", function() {
                 done();
             });
     });
+
+    it("should SUCCEED and create a new account without a phone number", function(done) {
+        chai.request(server.app)
+            .post('/api/account')
+            .type('application/json')
+            .send(noPhoneAccount)
+            .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.ACCOUNT_CREATE);
+
+                // use acc.toStrippedJSON to deal with hidden passwords and convert _id to id
+                const acc = new Account(noPhoneAccount).toStrippedJSON();
+                // delete id as those are generated
+                delete acc.id;
+                delete res.body.data.id;
+
+                chai.assert.equal(
+                    JSON.stringify(res.body.data),
+                    JSON.stringify(acc)
+                );
+                done();
+            })
+    })
 });
 
 describe("POST confirm account", function() {

routes/api/account.js

@@ -304,6 +304,21 @@ const NonConfirmedAccount3 = createAccount({
     email: "notconfirmed3@blahblah.com"
 });
 
+const NoPhoneHackerAccount0 = {
+    _id: mongoose.Types.ObjectId(),
+    firstName: "LMAO",
+    lastName: "ROFL",
+    pronoun: "Ey/Em",
+    gender: "Female",
+    email: "noPhone0@blahblah.com",
+    password: "probsShouldBeHashed5",
+    dietaryRestrictions: ["something1", "something2"],
+    gender: "Male",
+    confirmed: false,
+    birthDate: "1980-07-30",
+    accountType: Constants.HACKER
+}
+
 const extraAccounts = [
     waitlistedHacker0,
     NonConfirmedAccount1,
@@ -326,6 +341,7 @@ module.exports = {
     NonConfirmedAccount1: NonConfirmedAccount1,
     NonConfirmedAccount2: NonConfirmedAccount2,
     NonConfirmedAccount3: NonConfirmedAccount3,
+    NoPhoneHackerAccount0: NoPhoneHackerAccount0,
 
     extraAccounts: extraAccounts,