Feature/sponsor patch (#304)

* Create /self route for sponsor

* docs and add a authentication test

* Fix PR comments

* Add roles in post_roles to respect the tiers of sponsors

* Add success and error for sponsor patch

* Add sponsor patch routes and roles, remove account roles from hacker

* create updatedSponsor controller with comments

* Create sponsor patch middleware

* create update sponsor validator

* Create sponsor service

* Create sponsor patch route and update docs

* sponsor test

* Fix merge issue

* PR comments

Author: YiFeiZhang2

constants/error.constant.js

@@ -34,6 +34,7 @@ const HACKER_UPDATE_500_MESSAGE = "Error while updating hacker";
 const ACCOUNT_UPDATE_500_MESSAGE = "Error while updating account";
 const HACKER_CREATE_500_MESSAGE = "Error while creating hacker";
 const SPONSOR_CREATE_500_MESSAGE = "Error while creating sponsor";
+const SPONSOR_UPDATE_500_MESSAGE = "Error while updating sponsor";
 const TEAM_CREATE_500_MESSAGE = "Error while creating team";
 const VOLUNTEER_CREATE_500_MESSAGE = "Error while creating volunteer";
 const EMAIL_500_MESSAGE = "Error while generating email";
@@ -77,4 +78,5 @@ module.exports = {
     TEAM_JOIN_SAME_409_MESSAGE: TEAM_JOIN_SAME_409_MESSAGE,
     TEAM_READ_500_MESSAGE: TEAM_READ_500_MESSAGE,
     VOLUNTEER_404_MESSAGE: VOLUNTEER_404_MESSAGE,
+    SPONSOR_UPDATE_500_MESSAGE: SPONSOR_UPDATE_500_MESSAGE,
 };

constants/role.constant.js

@@ -29,10 +29,6 @@ const hackerRole = {
     "_id": mongoose.Types.ObjectId.createFromTime(2),
     "name": Constants.General.HACKER,
     "routes": [
-        Constants.Routes.accountRoutes.getSelf,
-        Constants.Routes.accountRoutes.getSelfById,
-        Constants.Routes.accountRoutes.patchSelfById,
-
         Constants.Routes.hackerRoutes.post,
         Constants.Routes.hackerRoutes.getSelfById,
         Constants.Routes.hackerRoutes.getSelfByEmail,
@@ -70,6 +66,7 @@ const sponsorT1Role = {
         Constants.Routes.sponsorRoutes.post,
         Constants.Routes.sponsorRoutes.getSelfById,
         Constants.Routes.sponsorRoutes.getSelf,
+        Constants.Routes.sponsorRoutes.patchSelfById,
     ]
 };
 
@@ -80,6 +77,7 @@ const sponsorT2Role = {
         Constants.Routes.sponsorRoutes.post,
         Constants.Routes.sponsorRoutes.getSelfById,
         Constants.Routes.sponsorRoutes.getSelf,
+        Constants.Routes.sponsorRoutes.patchSelfById,
     ]
 };
 
@@ -90,6 +88,7 @@ const sponsorT3Role = {
         Constants.Routes.sponsorRoutes.post,
         Constants.Routes.sponsorRoutes.getSelfById,
         Constants.Routes.sponsorRoutes.getSelf,
+        Constants.Routes.sponsorRoutes.patchSelfById,
     ]
 };
 
@@ -100,6 +99,7 @@ const sponsorT4Role = {
         Constants.Routes.sponsorRoutes.post,
         Constants.Routes.sponsorRoutes.getSelfById,
         Constants.Routes.sponsorRoutes.getSelf,
+        Constants.Routes.sponsorRoutes.patchSelfById,
     ]
 };
 
@@ -110,6 +110,7 @@ const sponsorT5Role = {
         Constants.Routes.sponsorRoutes.post,
         Constants.Routes.sponsorRoutes.getSelfById,
         Constants.Routes.sponsorRoutes.getSelf,
+        Constants.Routes.sponsorRoutes.patchSelfById,
     ]
 };
 

constants/routes.constant.js

@@ -143,6 +143,14 @@ const sponsorRoutes = {
         requestType: Constants.REQUEST_TYPES.POST,
         uri: "/api/sponsor/",
     },
+    "patchSelfById": {
+        requestType: Constants.REQUEST_TYPES.PATCH,
+        uri: "/api/sponsor/" + Constants.ROLE_CATEGORIES.SELF,
+    },
+    "patchAnyById": {
+        requestType: Constants.REQUEST_TYPES.PATCH,
+        uri: "/api/sponsor/" + Constants.ROLE_CATEGORIES.ALL,
+    }
 };
 
 const teamRoutes = {

constants/success.constant.js

@@ -33,6 +33,7 @@ const SEARCH_NO_RESULTS = "Query search successful. No results found.";
 const SPONSOR_GET_BY_ID = "Sponsor found by id.";
 const SPONSOR_READ = "Sponsor retrieval successful.";
 const SPONSOR_CREATE = "Sponsor creation successful.";
+const SPONSOR_UPDATE = "Sponsor update successful.";
 
 const TEAM_GET_BY_ID = "Team found by id.";
 const TEAM_CREATE = "Team creation successful.";
@@ -77,6 +78,7 @@ module.exports = {
     SPONSOR_GET_BY_ID: SPONSOR_GET_BY_ID,
     SPONSOR_CREATE: SPONSOR_CREATE,
     SPONSOR_READ: SPONSOR_READ,
+    SPONSOR_UPDATE: SPONSOR_UPDATE,
 
     TEAM_GET_BY_ID: TEAM_GET_BY_ID,
     TEAM_CREATE: TEAM_CREATE,

controllers/sponsor.controller.js

@@ -24,20 +24,35 @@ function showSponsor(req, res) {
 }
 
 /**
- * @function createdHacker
+ * @function createdSponsor
  * @param {{body: {sponsor: {_id: ObjectId, accountId: ObjectId, tier: number, company: string, contractURL: string, nominees: ObjectId[]}}}} req
  * @param {*} res
  * @return {JSON} Success status
  * @description returns success message
  */
-async function createdSponsor(req, res) {
+function createdSponsor(req, res) {
     return res.status(200).json({
         message: Constants.Success.SPONSOR_CREATE,
         data: req.body.sponsor.toJSON()
     });
 }
 
+/**
+ * @function updatedSponsor
+ * @param {{body: {sponsor: {_id: ObjectId, accountId: ObjectId, tier: number, company: string, contractURL: string, nominees: ObjectId[]}}}} req
+ * @param {*} res
+ * @return {JSON} Success status
+ * @description returns success message
+ */
+function updatedSponsor(req, res) {
+    return res.status(200).json({
+        message: Constants.Success.SPONSOR_UPDATE,
+        data: req.body.sponsor.toJSON()
+    });
+}
+
 module.exports = {
     createdSponsor: createdSponsor,
     showSponsor: showSponsor,
+    updatedSponsor: updatedSponsor,
 };

docs/api/api_data.js

@@ -1824,7 +1824,7 @@ define({
         },
         "examples": [{
           "title": "Success-Response: ",
-          "content": "{\n               \"message\": \"Successfully retrieved sponsor information\", \n               \"data\": {...}\n           }",
+          "content": "{\n               \"message\": \"Successfully retrieved sponsor information\", \n               \"data\": {\n                   \"id\": \"5bff4d736f86be0a41badb91\",\n                   \"accountId\": \"5bff4d736f86be0a41badb99\",\n                   \"tier\": 3,\n                   \"company\": \"companyName\",\n                   \"contractURL\": \"https://www.contractHere.com\",\n                   \"nominees\": [\"5bff4d736f86be0a41badb93\",\"5bff4d736f86be0a41badb94\"]\n               }\n           }",
           "type": "object"
         }]
       },
@@ -1852,6 +1852,9 @@ define({
           "type": "object"
         }]
       },
+      "permission": [{
+        "name": ": Sponsor"
+      }],
       "filename": "routes/api/sponsor.js",
       "groupTitle": "Hacker",
       "sampleRequest": [{
@@ -2314,6 +2317,100 @@ define({
         "url": "https://api.mchacks.ca/api/sponsor/:id"
       }]
     },
+    {
+      "type": "patch",
+      "url": "/sponsor/",
+      "title": "update a sponsor",
+      "name": "patchSponsor",
+      "group": "Sponsor",
+      "version": "1.3.0",
+      "parameter": {
+        "fields": {
+          "param": [{
+            "group": "param",
+            "type": "ObjectId",
+            "optional": false,
+            "field": "id",
+            "description": "<p>ObjectID of the sponsor</p>"
+          }],
+          "body": [{
+              "group": "body",
+              "type": "String",
+              "optional": false,
+              "field": "company",
+              "description": "<p>Name of the company.</p>"
+            },
+            {
+              "group": "body",
+              "type": "String",
+              "optional": false,
+              "field": "contractURL",
+              "description": "<p>URL link to the contract with the company.</p>"
+            },
+            {
+              "group": "body",
+              "type": "ObjectId[]",
+              "optional": false,
+              "field": "nominees",
+              "description": "<p>Array of accounts that the company wish to nominate as hackers.</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>Sponsor object</p>"
+            }
+          ]
+        },
+        "examples": [{
+          "title": "Success-Response: ",
+          "content": "{\n               \"message\": \"Sponsor update successful\", \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\": \"Error while updating sponsor\", \"data\": {}}",
+          "type": "object"
+        }]
+      },
+      "filename": "routes/api/sponsor.js",
+      "groupTitle": "Sponsor",
+      "sampleRequest": [{
+        "url": "https://api.mchacks.ca/api/sponsor/"
+      }]
+    },
     {
       "type": "post",
       "url": "/team/",

docs/api/api_data.json

@@ -1823,8 +1823,7 @@
       },
       "examples": [{
         "title": "Success-Response: ",
-        "content": "{\n               \"message\": \"Successfully retrieved sponsor information\", \n               \"data\": {...}\n           }",
-        "type": "object"
+        "content": "{\n               \"message\": \"Successfully retrieved sponsor information\", \n               \"data\": {\n                   \"id\": \"5bff4d736f86be0a41badb91\",\n                   \"accountId\": \"5bff4d736f86be0a41badb99\",\n                   \"tier\": 3,\n                   \"company\": \"companyName\",\n                   \"contractURL\": \"https://www.contractHere.com\",\n                   \"nominees\": [\"5bff4d736f86be0a41badb93\",\"5bff4d736f86be0a41badb94\"]\n               }\n           }"
       }]
     },
     "error": {
@@ -1851,6 +1850,9 @@
         "type": "object"
       }]
     },
+    "permission": [{
+      "name": ": Sponsor"
+    }],
     "filename": "routes/api/sponsor.js",
     "groupTitle": "Hacker",
     "sampleRequest": [{
@@ -2313,6 +2315,100 @@
       "url": "https://api.mchacks.ca/api/sponsor/:id"
     }]
   },
+  {
+    "type": "patch",
+    "url": "/sponsor/",
+    "title": "update a sponsor",
+    "name": "patchSponsor",
+    "group": "Sponsor",
+    "version": "1.3.0",
+    "parameter": {
+      "fields": {
+        "param": [{
+          "group": "param",
+          "type": "ObjectId",
+          "optional": false,
+          "field": "id",
+          "description": "<p>ObjectID of the sponsor</p>"
+        }],
+        "body": [{
+            "group": "body",
+            "type": "String",
+            "optional": false,
+            "field": "company",
+            "description": "<p>Name of the company.</p>"
+          },
+          {
+            "group": "body",
+            "type": "String",
+            "optional": false,
+            "field": "contractURL",
+            "description": "<p>URL link to the contract with the company.</p>"
+          },
+          {
+            "group": "body",
+            "type": "ObjectId[]",
+            "optional": false,
+            "field": "nominees",
+            "description": "<p>Array of accounts that the company wish to nominate as hackers.</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>Sponsor object</p>"
+          }
+        ]
+      },
+      "examples": [{
+        "title": "Success-Response: ",
+        "content": "{\n               \"message\": \"Sponsor update successful\", \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\": \"Error while updating sponsor\", \"data\": {}}",
+        "type": "object"
+      }]
+    },
+    "filename": "routes/api/sponsor.js",
+    "groupTitle": "Sponsor",
+    "sampleRequest": [{
+      "url": "https://api.mchacks.ca/api/sponsor/"
+    }]
+  },
   {
     "type": "post",
     "url": "/team/",