Documentation changes

Author: kamicut

app/manage/permissions/create-org-team.js

@@ -9,7 +9,7 @@ const { isOwner, isManager } = require('../../lib/organization')
  * @param {int} uid - user id
  * @param {Object} params - request parameters
  * @param {int} params.id - organization id
- * @returns {boolean}
+ * @returns {Promise<boolean>}
  */
 async function createOrgTeam (uid, { id }) {
   return (await isOwner(id, uid)) || isManager(id, uid)

app/manage/permissions/edit-org.js

@@ -9,7 +9,7 @@ const { isOwner } = require('../../lib/organization')
  * @param {int} uid - user id
  * @param {Object} params - request parameters
  * @param {int} params.id - organization id
- * @returns {boolean}
+ * @returns {Promise<boolean>}
  */
 async function editOrg (uid, { id }) {
   return isOwner(id, uid)

app/manage/permissions/edit-team.js

@@ -10,7 +10,7 @@ const { isOwner } = require('../../lib/organization')
  *
  * @param {string} uid user id
  * @param {Object} params request parameters
- * @returns {boolean} can the request go through?
+ * @returns {Promise<boolean>} can the request go through?
  */
 async function updateTeam (uid, { id }) {
   // user has to be authenticated

app/tests/permissions/add-org-team.test.js

@@ -49,11 +49,11 @@ test('org owner can create a team', async t => {
 
   let res = await agent.post('/api/organizations')
     .send({ name: orgName })
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   let res2 = await agent.post(`/api/organizations/${res.body.id}/teams`)
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .send({ name: teamName })
 
   t.is(res2.status, 200)
@@ -71,16 +71,16 @@ test('org manager can create a team', async t => {
 
   let res = await agent.post('/api/organizations')
     .send({ name: orgName })
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   // We create a manager role for user 101
   await agent.put(`/api/organizations/${res.body.id}/addManager/101`)
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   let res2 = await agent.post(`/api/organizations/${res.body.id}/teams`)
-    .set('Authorization', `Bearer user101`)
+    .set('Authorization', 'Bearer user101')
     .send({ name: teamName })
 
   t.is(res2.status, 200)
@@ -98,11 +98,11 @@ test('non-org manager cannot create a team', async t => {
 
   let res = await agent.post('/api/organizations')
     .send({ name: orgName })
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   let res2 = await agent.post(`/api/organizations/${res.body.id}/teams`)
-    .set('Authorization', `Bearer user101`)
+    .set('Authorization', 'Bearer user101')
     .send({ name: teamName })
 
   t.is(res2.status, 401)

app/tests/permissions/join-team.test.js

@@ -44,28 +44,28 @@ test.after.always(async () => {
 test('a user can join a public team', async t => {
   const team = t.context.publicTeam
   let res = await agent.put(`/api/teams/${team.id}/join`)
-    .set('Authorization', `Bearer user101`)
+    .set('Authorization', 'Bearer user101')
   t.is(res.status, 200)
 })
 
 test('a user cannot join a private team', async t => {
   const team = t.context.privateTeam
   let res = await agent.put(`/api/teams/${team.id}/join`)
-    .set('Authorization', `Bearer user101`)
+    .set('Authorization', 'Bearer user101')
   t.is(res.status, 401)
 })
 
 test('a user cannot join a team they are already in', async t => {
   const team = t.context.publicTeam
   let res = await agent.put(`/api/teams/${team.id}/join`)
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
   t.is(res.status, 401)
 })
 
 test('a user must be authenticated to join a team', async t => {
   const team = t.context.publicTeam
   let invalidToken = await agent.put(`/api/teams/${team.id}/join`)
-    .set('Authorization', `Bearer invalidToken`)
+    .set('Authorization', 'Bearer invalidToken')
   t.is(invalidToken.status, 401)
   let unauthenticated = await agent.put(`/api/teams/${team.id}/join`)
   t.is(unauthenticated.status, 401)

app/tests/permissions/update-team.test.js

@@ -39,11 +39,11 @@ test.after.always(async () => {
 test('a team moderator can update a team', async t => {
   let res = await agent.post('/api/teams')
     .send({ name: 'road team 1' })
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   let res2 = await agent.put(`/api/teams/${res.body.id}`)
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .send({ name: 'building team 1' })
 
   t.is(res2.status, 200)
@@ -52,11 +52,11 @@ test('a team moderator can update a team', async t => {
 test('a non-team moderator cannot update a team', async t => {
   let res = await agent.post('/api/teams')
     .send({ name: 'road team 2' })
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   let res2 = await agent.put(`/api/teams/${res.body.id}`)
-    .set('Authorization', `Bearer user101`)
+    .set('Authorization', 'Bearer user101')
     .send({ name: 'building team 2' })
 
   t.is(res2.status, 401)
@@ -66,24 +66,24 @@ test('an org team can be updated by the the org manager', async t => {
   // Let's create an organization, user100 is the owner
   const res = await agent.post('/api/organizations')
     .send({ name: 'org manager can update team' })
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   // Let's set user101 to be a manager of this organization and create a
   // team in the organization
   await agent.put(`/api/organizations/${res.body.id}/addManager/101`)
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   const res2 = await agent.post(`/api/organizations/${res.body.id}/teams`)
     .send({ name: 'org team can be updated by manager - team' })
-    .set('Authorization', `Bearer user101`)
+    .set('Authorization', 'Bearer user101')
     .expect(200)
 
   // Use the manager to update the team
   const res3 = await agent.put(`/api/teams/${res2.body.id}`)
     .send({ name: 'org team can be updated by manager - team2' })
-    .set('Authorization', `Bearer user101`)
+    .set('Authorization', 'Bearer user101')
 
   t.is(res3.status, 200)
 })
@@ -92,25 +92,25 @@ test('an org team can be updated by the owner of the org', async t => {
   // Let's create an organization, user100 is the owner
   const res = await agent.post('/api/organizations')
     .send({ name: 'org owner can update team' })
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   // Let's set user101 to be a manager of this organization and create a
   // team in the organization
   await agent.put(`/api/organizations/${res.body.id}/addManager/101`)
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
     .expect(200)
 
   const res2 = await agent.post(`/api/organizations/${res.body.id}/teams`)
     .send({ name: 'org team can be updated by owner - team' })
-    .set('Authorization', `Bearer user101`)
+    .set('Authorization', 'Bearer user101')
     .expect(200)
 
   // user101 is the moderator and manager, but user100 should be able
   // to edit this team
   const res3 = await agent.put(`/api/teams/${res2.body.id}`)
     .send({ name: 'org team can be updated by owner - team2' })
-    .set('Authorization', `Bearer user100`)
+    .set('Authorization', 'Bearer user100')
 
   t.is(res3.status, 200)
 })