Merge pull request #163 from developmentseed/feature/organizations-api

Feature/organizations api

Author: kamicut

app/lib/organization.js

@@ -165,6 +165,7 @@ async function createOrgTeam (organizationId, data, osmId) {
   return conn.transaction(async trx => {
     const record = await team.create(data, osmId, trx)
     await trx('organization_team').insert({ team_id: record.id, organization_id: organizationId })
+    return record
   })
 }
 

app/lib/team.js

@@ -332,6 +332,20 @@ async function isPublic (teamId) {
   return (privacy === 'public')
 }
 
+/**
+ * associatedOrg
+ *
+ * If the team is part of an org, return its associated org
+ * @param teamId - team id
+ * @returns {int} organization id or null
+ */
+async function associatedOrg (teamId) {
+  if (!teamId) throw new Error('team id is required as first argument')
+
+  const conn = await db()
+  return unpack(conn('organization_team').where('team_id', teamId).returning('organization_id'))
+}
+
 module.exports = {
   get,
   list,
@@ -349,5 +363,6 @@ module.exports = {
   isModerator,
   isMember,
   isPublic,
-  resolveMemberNames
+  resolveMemberNames,
+  associatedOrg
 }

app/manage/index.js

@@ -21,6 +21,19 @@ const {
   updateTeam
 } = require('./teams')
 
+const {
+  createOrg,
+  getOrg,
+  updateOrg,
+  destroyOrg,
+  addOwner,
+  removeOwner,
+  addManager,
+  removeManager,
+  createOrgTeam,
+  getOrgTeams
+} = require('./organizations')
+
 /**
  * The manageRouter handles all routes related to the first party
  * management client
@@ -62,16 +75,33 @@ function manageRouter (nextApp) {
    */
   router.get('/api/teams', listTeams)
   router.get('/api/my/teams', can('public:authenticated'), listMyTeams)
-  router.post('/api/teams', can('team:create'), createTeam)
+  router.post('/api/teams', can('public:authenticated'), createTeam)
   router.get('/api/teams/:id', can('team:view'), getTeam)
-  router.put('/api/teams/:id', can('team:update'), updateTeam)
-  router.delete('/api/teams/:id', can('team:delete'), destroyTeam)
-  router.put('/api/teams/add/:id/:osmId', can('team:update'), addMember)
-  router.put('/api/teams/remove/:id/:osmId', can('team:update'), removeMember)
-  router.patch('/api/teams/:id/members', can('team:update'), updateMembers)
+  router.put('/api/teams/:id', can('team:edit'), updateTeam)
+  router.delete('/api/teams/:id', can('team:edit'), destroyTeam)
+  router.put('/api/teams/add/:id/:osmId', can('team:edit'), addMember)
+  router.put('/api/teams/remove/:id/:osmId', can('team:edit'), removeMember)
+  router.patch('/api/teams/:id/members', can('team:edit'), updateMembers)
   router.put('/api/teams/:id/join', can('team:join'), joinTeam)
-  router.put('/api/teams/:id/assignModerator/:osmId', can('team:update'), assignModerator)
-  router.put('/api/teams/:id/removeModerator/:osmId', can('team:update'), removeModerator)
+  router.put('/api/teams/:id/assignModerator/:osmId', can('team:edit'), assignModerator)
+  router.put('/api/teams/:id/removeModerator/:osmId', can('team:edit'), removeModerator)
+
+  /**
+   * List, Create, Read, Update, Delete operations on orgs
+   */
+  router.post('/api/organizations', can('public:authenticated'), createOrg)
+  router.get('/api/organizations/:id', can('public:authenticated'), getOrg) // TODO handle private organizations
+  router.put('/api/organizations/:id', can('organization:edit'), updateOrg)
+  router.delete('/api/organizations/:id', can('organization:edit'), destroyOrg)
+
+  router.put('/api/organizations/:id/addOwner/:osmId', can('organization:edit'), addOwner)
+  router.put('/api/organizations/:id/removeOwner/:osmId', can('organization:edit'), removeOwner)
+
+  router.put('/api/organizations/:id/addManager/:osmId', can('organization:edit'), addManager)
+  router.put('/api/organizations/:id/removeManager/:osmId', can('organization:edit'), removeManager)
+
+  router.post('/api/organizations/:id/teams', can('organization:create-team'), createOrgTeam)
+  router.get('/api/organizations/:id/teams', getOrgTeams)
 
   /**
    * Page renders

app/manage/organizations.js

@@ -0,0 +1,221 @@
+const organization = require('../lib/organization')
+const team = require('../lib/team')
+
+/**
+ * Create an organization
+ * Uses the user id in the request and the body to forward
+ * to the organization model
+ */
+async function createOrg (req, reply) {
+  const { body } = req
+  const { user_id } = reply.locals
+
+  try {
+    const data = await organization.create(body, user_id)
+    reply.send(data)
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+/**
+ * Get an organization
+ * Requires id of organization
+ */
+async function getOrg (req, reply) {
+  const { id } = req.params
+
+  if (!id) {
+    return reply.boom.badRequest('organization id is required')
+  }
+
+  try {
+    const [data, owners, managers] = await Promise.all([
+      organization.get(id),
+      organization.getOwners(id),
+      organization.getManagers(id)
+    ])
+
+    reply.send({ ...data, owners, managers })
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+/**
+ * Update an organization
+ * Requires the id of the organization to modify
+ */
+async function updateOrg (req, reply) {
+  const { id } = req.params
+  const { body } = req
+
+  if (!id) {
+    return reply.boom.badRequest('organization id is required')
+  }
+
+  try {
+    const data = await organization.update(id, body)
+    reply.send(data)
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+/**
+ * Destroy an organization
+ */
+async function destroyOrg (req, reply) {
+  const { id } = req.params
+
+  if (!id) {
+    return reply.boom.badRequest('organization id is required')
+  }
+
+  try {
+    await organization.destroy(id)
+    reply.sendStatus(200)
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+/**
+ * Add owner
+ */
+async function addOwner (req, reply) {
+  const { id, osmId } = req.params
+
+  if (!id) {
+    return reply.boom.badRequest('organization id is required')
+  }
+
+  if (!osmId) {
+    return reply.boom.badRequest('osmId to add is required')
+  }
+
+  try {
+    await organization.addOwner(id, Number(osmId))
+    reply.sendStatus(200)
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+/**
+ * Remove owner
+ */
+async function removeOwner (req, reply) {
+  const { id, osmId } = req.params
+
+  if (!id) {
+    return reply.boom.badRequest('organization id is required')
+  }
+
+  if (!osmId) {
+    return reply.boom.badRequest('osmId to add is required')
+  }
+
+  try {
+    await organization.removeOwner(id, Number(osmId))
+    reply.sendStatus(200)
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+/**
+ * Add manager
+ */
+async function addManager (req, reply) {
+  const { id, osmId } = req.params
+
+  if (!id) {
+    return reply.boom.badRequest('organization id is required')
+  }
+
+  if (!osmId) {
+    return reply.boom.badRequest('osmId to add is required')
+  }
+
+  try {
+    await organization.addManager(id, Number(osmId))
+    reply.sendStatus(200)
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+/**
+ * Remove manager
+ */
+async function removeManager (req, reply) {
+  const { id, osmId } = req.params
+
+  if (!id) {
+    return reply.boom.badRequest('organization id is required')
+  }
+
+  if (!osmId) {
+    return reply.boom.badRequest('osmId to add is required')
+  }
+
+  try {
+    await organization.removeManager(id, Number(osmId))
+    reply.sendStatus(200)
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+/**
+ * Create org team
+ */
+async function createOrgTeam (req, reply) {
+  const { id } = req.params
+  const { body } = req
+  const { user_id } = reply.locals
+
+  try {
+    const data = await organization.createOrgTeam(id, body, user_id)
+    reply.send(data)
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+/**
+ * List org teams
+ */
+async function getOrgTeams (req, reply) {
+  const { id } = req.params
+  try {
+    const data = await team.list({ organizationId: id })
+    reply.send(data)
+  } catch (err) {
+    console.log(err)
+    return reply.boom.badRequest(err.message)
+  }
+}
+
+module.exports = {
+  createOrg,
+  getOrg,
+  updateOrg,
+  destroyOrg,
+  addOwner,
+  removeOwner,
+  addManager,
+  removeManager,
+  createOrgTeam,
+  getOrgTeams
+}

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

@@ -0,0 +1,18 @@
+const { isOwner, isManager } = require('../../lib/organization')
+
+/**
+ * organization:create-team
+ *
+ * To create a team within an organization, you have to be
+ * a manager of the organization
+ *
+ * @param {int} uid - user id
+ * @param {Object} params - request parameters
+ * @param {int} params.id - organization id
+ * @returns {Promise<boolean>}
+ */
+async function createOrgTeam (uid, { id }) {
+  return (await isOwner(id, uid)) || isManager(id, uid)
+}
+
+module.exports = createOrgTeam

app/manage/permissions/create-team.js

@@ -0,0 +1,18 @@
+const { isOwner } = require('../../lib/organization')
+
+/**
+ * organization:edit
+ *
+ * To edit an organization or delete it, the authenticated user needs
+ * to be an owner in the organization
+ *
+ * @param {int} uid - user id
+ * @param {Object} params - request parameters
+ * @param {int} params.id - organization id
+ * @returns {Promise<boolean>}
+ */
+async function editOrg (uid, { id }) {
+  return isOwner(id, uid)
+}
+
+module.exports = editOrg