hackmcgill
diff --git a/‎VERSION‎
Lines changed: 1 addition & 1 deletion b/‎VERSION‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎assets/email/statusEmail/Accepted.hbs‎
Lines changed: 3 additions & 3 deletions b/‎assets/email/statusEmail/Accepted.hbs‎
Lines changed: 3 additions & 3 deletions
diff --git a/‎constants/error.constant.js‎
Lines changed: 2 additions & 0 deletions b/‎constants/error.constant.js‎
Lines changed: 2 additions & 0 deletions
diff --git a/‎constants/role.constant.js‎
Lines changed: 2 additions & 0 deletions b/‎constants/role.constant.js‎
Lines changed: 2 additions & 0 deletions
diff --git a/‎constants/routes.constant.js‎
Lines changed: 16 additions & 0 deletions b/‎constants/routes.constant.js‎
Lines changed: 16 additions & 0 deletions
diff --git a/‎constants/success.constant.js‎
Lines changed: 2 additions & 0 deletions b/‎constants/success.constant.js‎
Lines changed: 2 additions & 0 deletions
diff --git a/‎controllers/volunteer.controller.js‎
Lines changed: 18 additions & 4 deletions b/‎controllers/volunteer.controller.js‎
Lines changed: 18 additions & 4 deletions
diff --git a/‎docs/api/api_data.js‎
Lines changed: 146 additions & 1 deletion b/‎docs/api/api_data.js‎
Lines changed: 146 additions & 1 deletion
@@ -1 +1 @@
-1.3.0
+1.3.0
@@ -381,8 +381,8 @@
                                                 Here are your next steps:
                                                 <br><br>
                                                 <li style="-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%;color:#4D4D4D;" >Confirm your attendance on our hacker dashboard no later than
-                                                    (date)</li>
-                                                <li style="-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%;color:#4D4D4D;" >Join our FB group to mingle with other hackers coming to McHacks 6</li>
+                                                    Friday, January 18.</li>
+                                                <li style="-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%;color:#4D4D4D;" >Join our <a href="https://www.facebook.com/groups/mchacks6" style="-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%;color:#F2463A;text-decoration:none;" >FB group</a> to mingle with other hackers coming to McHacks 6!</li>
                                                 <br><br>
                                                 We've received an overwhelming number of applicants this year for only
                                                 600 spots. If you can no longer attend McHacks 6, please let us know by
@@ -443,4 +443,4 @@
     </center>
 </body>
 
-</html>
+</html>
@@ -5,6 +5,7 @@ const HACKER_404_MESSAGE = "Hacker not found";
 const TEAM_404_MESSAGE = "Team not found";
 const RESUME_404_MESSAGE = "Resume not found";
 const SPONSOR_404_MESSAGE = "Sponsor not found";
+const VOLUNTEER_404_MESSAGE = "Volunteer not found";
 
 const ACCOUNT_TYPE_409_MESSAGE = "Wrong account type";
 const SPONSOR_ID_409_MESSAGE = "Conflict with sponsor accountId link";
@@ -75,4 +76,5 @@ module.exports = {
     TEAM_NAME_409_MESSAGE: TEAM_NAME_409_MESSAGE,
     TEAM_JOIN_SAME_409_MESSAGE: TEAM_JOIN_SAME_409_MESSAGE,
     TEAM_READ_500_MESSAGE: TEAM_READ_500_MESSAGE,
+    VOLUNTEER_404_MESSAGE: VOLUNTEER_404_MESSAGE,
 };
@@ -35,6 +35,7 @@ const hackerRole = {
 
         Constants.Routes.hackerRoutes.post,
         Constants.Routes.hackerRoutes.getSelfById,
+        Constants.Routes.hackerRoutes.getSelfByEmail,
         Constants.Routes.hackerRoutes.getSelfResumeById,
         Constants.Routes.hackerRoutes.patchSelfById,
         Constants.Routes.hackerRoutes.patchSelfConfirmationById,
@@ -52,6 +53,7 @@ const volunteerRole = {
     "_id": mongoose.Types.ObjectId.createFromTime(3),
     "name": Constants.General.VOLUNTEER,
     "routes": [
+        Constants.Routes.volunteerRoutes.getSelfById,
         Constants.Routes.volunteerRoutes.post,
 
         Constants.Routes.hackerRoutes.patchAnyCheckInById,
 
@@ -68,6 +68,14 @@ const hackerRoutes = {
         requestType: Constants.REQUEST_TYPES.GET,
         uri: "/api/hacker/" + Constants.ROLE_CATEGORIES.ALL,
     },
+    "getSelfByEmail": {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/hacker/email/" + Constants.ROLE_CATEGORIES.SELF,
+    },
+    "getAnyByEmail": {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/hacker/email/" + Constants.ROLE_CATEGORIES.ALL,
+    },
     "getSelfResumeById": {
         requestType: Constants.REQUEST_TYPES.GET,
         uri: "/api/hacker/resume/" + Constants.ROLE_CATEGORIES.SELF,
@@ -161,6 +169,14 @@ const teamRoutes = {
 };
 
 const volunteerRoutes = {
+    "getSelfById": {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/volunteer/" + Constants.ROLE_CATEGORIES.SELF,
+    },
+    "getAnyById": {
+        requestType: Constants.REQUEST_TYPES.GET,
+        uri: "/api/volunteer/" + Constants.ROLE_CATEGORIES.ALL,
+    },
     "post": {
         requestType: Constants.REQUEST_TYPES.POST,
         uri: "/api/volunteer/",
 
@@ -41,6 +41,7 @@ const TEAM_UPDATE = "Team update successful.";
 const TEAM_READ = "Team retrieval successful.";
 const TEAM_HACKER_LEAVE = "Removal from team successful.";
 
+const VOLUNTEER_GET_BY_ID = "Volunteer found by id";
 const VOLUNTEER_CREATE = "Volunteer creation successful.";
 
 module.exports = {
@@ -84,5 +85,6 @@ module.exports = {
     TEAM_READ: TEAM_READ,
     TEAM_HACKER_LEAVE: TEAM_HACKER_LEAVE,
 
+    VOLUNTEER_GET_BY_ID: VOLUNTEER_GET_BY_ID,
     VOLUNTEER_CREATE: VOLUNTEER_CREATE,
 };
@@ -10,21 +10,35 @@ const Constants = {
 }
 
 /**
- * @async
  * @function createdVolunteer
  * @param {{body: {volunteer: {_id: ObjectId, accountId: ObjectId}}}} req
  * @param {*} res
- * @return {JSON} Success or error status
+ * @return {JSON} Success status
  * @description Show the success message and the created volunteer
  */
-async function createdVolunteer(req, res) {
-
+function createdVolunteer(req, res) {
     return res.status(200).json({
         message: Constants.Success.VOLUNTEER_CREATE,
         data: req.body.volunteer
     });
 }
 
+/**
+ * @function showVolunteer
+ * @param {{body: {volunteer: {_id: ObjectId, accountId: ObjectId}}}} req
+ * @param {*} res
+ * @return {JSON} Success status
+ * @description Show the success message and retrieved volunteer
+ */
+function showVolunteer(req, res) {
+    return res.status(200).json({
+        message: Constants.Success.VOLUNTEER_GET_BY_ID,
+        data: req.body.volunteer.toJSON()
+    });
+}
+
+
 module.exports = {
     createdVolunteer: createdVolunteer,
+    showVolunteer: showVolunteer,
 };
@@ -1248,6 +1248,78 @@ define({
         "url": "https://api.mchacks.ca/api/hacker/"
       }]
     },
+    {
+      "type": "get",
+      "url": "/hacker/email/:email",
+      "title": "get a hacker's information",
+      "name": "getHacker",
+      "group": "Hacker",
+      "version": "0.0.8",
+      "parameter": {
+        "fields": {
+          "param": [{
+            "group": "param",
+            "type": "String",
+            "optional": false,
+            "field": "email",
+            "description": "<p>a hacker's unique email</p>"
+          }]
+        }
+      },
+      "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>Hacker object</p>"
+            }
+          ]
+        },
+        "examples": [{
+          "title": "Success-Response: ",
+          "content": "{\n               \"message\": \"Successfully retrieved hacker information\", \n               \"data\": {\n                   \"id\":\"5bff4d736f86be0a41badb91\",\n                   \"application\":{\n                       \"portfolioURL\":{\n                           \"resume\":\"resumes/1543458163426-5bff4d736f86be0a41badb91\",\n                           \"github\":\"https://github.com/abcd\",\n                           \"dropler\":\"https://dribbble.com/abcd\",\n                           \"personal\":\"https://www.hi.com/\",\n                           \"linkedIn\":\"https://linkedin.com/in/abcd\",\n                           \"other\":\"https://github.com/hackmcgill/hackerAPI/issues/168\"\n                       },\n                       \"jobInterest\":\"Internship\",\n                       \"skills\":[\"Javascript\",\"Typescript\"],\n                       \"comments\":\"hi!\",\n                       \"essay\":\"Pls accept me\"\n                   },\n                   \"status\":\"Applied\",\n                   \"ethnicity\":[\"White or Caucasian\",\" Asian or Pacific Islander\"],\n                   \"accountId\":\"5bff2a35e533b0f6562b4998\",\n                   \"school\":\"McPherson College\",\n                   \"gender\":\"Female\",\n                   \"needsBus\":false,\n                   \"major\":\"Accounting\",\n                   \"graduationYear\":2019,\n                   \"codeOfConduct\":true,\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\": \"Hacker not found\", \"data\": {}}",
+          "type": "object"
+        }]
+      },
+      "filename": "routes/api/hacker.js",
+      "groupTitle": "Hacker",
+      "sampleRequest": [{
+        "url": "https://api.mchacks.ca/api/hacker/email/:email"
+      }]
+    },
     {
       "type": "get",
       "url": "/hacker/:id",
@@ -1280,7 +1352,7 @@ define({
               "type": "Object",
               "optional": false,
               "field": "data",
-              "description": "<p>Sponsor object</p>"
+              "description": "<p>Hacker object</p>"
             }
           ]
         },
@@ -2425,6 +2497,7 @@ define({
       "name": "patchTeam",
       "group": "Team",
       "version": "0.0.8",
+      "description": "<p>We use hackerId instead of teamId because authorization requires a one-to-one mapping from param id to accountId, but we are not able to have that from teamId to accountId due to multiple members in a team. Instead, we use hackerId, as there is a 1 to 1 link between hackerId to teamId, and a 1 to 1 link between hackerId and accountId</p>",
       "parameter": {
         "fields": {
           "param": [{
@@ -2561,6 +2634,78 @@ define({
       "sampleRequest": [{
         "url": "https://api.mchacks.ca/api/volunteer/"
       }]
+    },
+    {
+      "type": "get",
+      "url": "/volunteer/:id",
+      "title": "get a volunteer's information",
+      "name": "getVolunteer",
+      "group": "Volunteer",
+      "version": "1.3.0",
+      "parameter": {
+        "fields": {
+          "param": [{
+            "group": "param",
+            "type": "ObjectId",
+            "optional": false,
+            "field": "id",
+            "description": "<p>a volunteer's unique mongoID</p>"
+          }]
+        }
+      },
+      "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>Volunteer object</p>"
+            }
+          ]
+        },
+        "examples": [{
+          "title": "Success-Response: ",
+          "content": "{\n               \"message\": \"Successfully retrieved volunteer information\", \n               \"data\": {...}\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\": \"Volunteer not found\", \"data\": {}}",
+          "type": "object"
+        }]
+      },
+      "filename": "routes/api/volunteer.js",
+      "groupTitle": "Volunteer",
+      "sampleRequest": [{
+        "url": "https://api.mchacks.ca/api/volunteer/:id"
+      }]
     }
   ]
 });