feat(contributors): remove contributor

Author: Jérémie Parker

cli.js

@@ -13,6 +13,7 @@ const {
   viewProject,
   listContributors,
   addContributor,
+  removeContributor,
 } = require('./gitpo')
 
 const {
@@ -23,7 +24,7 @@ const {
   CONTRIBUTORS,
   CONTRIBUTORS_LIST,
   CONTRIBUTORS_ADD,
-  CONTRIBUTORS_DELETE,
+  CONTRIBUTORS_REMOVE,
 } = require('./utils/konstants')
 
 let languages = []
@@ -33,7 +34,7 @@ inquirer
     {
       type: 'list',
       name: 'action',
-      message: 'What would you like to do',
+      message: 'What would you like to do:',
       choices: [
         { name: 'View Project Details', value: PROJECT_VIEW },
         { name: 'Update Code (POEditor → GitHub)', value: PROJECT_UPDATE },
@@ -46,61 +47,61 @@ inquirer
       when: ({ action }) => action === CONTRIBUTORS,
       type: 'list',
       name: 'action',
-      message: 'What would you like to do',
+      message: 'What would you like to do:',
       choices: [
         { name: 'List collaborators', value: CONTRIBUTORS_LIST },
         { name: 'Add collaborator', value: CONTRIBUTORS_ADD },
-        { name: 'Delete collaborator', value: CONTRIBUTORS_DELETE },
+        { name: 'Remove collaborator', value: CONTRIBUTORS_REMOVE },
       ],
     },
     {
       when: ({ action }) => action === CONTRIBUTORS_ADD,
       type: 'input',
+      name: 'fullname',
+      message: 'Full Name:',
+    },
+    {
+      when: ({ action }) => [CONTRIBUTORS_ADD, CONTRIBUTORS_REMOVE].includes(action),
+      type: 'input',
       name: 'email',
       message: 'Email:',
     },
     {
-      when: ({ action }) => action === CONTRIBUTORS_ADD,
-      type: 'input',
-      name: 'fullname',
-      message: 'Full Name:',
+      when: ({ action }) => [CONTRIBUTORS_ADD, CONTRIBUTORS_REMOVE].includes(action),
+      type: 'checkbox',
+      name: 'projects',
+      message: 'Select project(s):',
+      choices: async () => {
+        const projects = await listProjects()
+        return projects.map(({ name, id: value }) => ({ name, value }))
+      },
     },
     {
       when: ({ action }) => action === PROJECT_CLEAN,
       type: 'input',
       name: 'file',
-      message: 'Where is the file to work on ?',
+      message: 'Where is the file to work on?',
     },
     {
       when: ({ action }) => action === PROJECT_CLEAN,
       type: 'confirm',
       name: 'override',
-      message: 'Override existing file ? (if not, a file will be created next to the existing one)',
+      message: 'Override existing file? (if not, a file will be created next to the existing one)',
       default: false,
     },
     {
-      when: ({ action }) => action !== PROJECT_CLEAN && action !== CONTRIBUTORS_LIST && action !== CONTRIBUTORS_ADD,
+      when: ({ action }) => [PROJECT_VIEW, PROJECT_UPDATE, PROJECT_TERMS].includes(action),
       type: 'list',
       name: 'project',
-      message: 'Select a project',
-      choices: async () => {
-        const projects = await listProjects()
-        return projects.map(({ name, id: value }) => ({ name, value }))
-      },
-    },
-    {
-      when: ({ action }) => action === CONTRIBUTORS_ADD,
-      type: 'checkbox',
-      name: 'projects',
-      message: 'Select project(s)',
+      message: 'Select a project:',
       choices: async () => {
         const projects = await listProjects()
         return projects.map(({ name, id: value }) => ({ name, value }))
       },
     },
     {
       when: async ({ action, project, projects }) => {
-        if ([PROJECT_UPDATE, CONTRIBUTORS_ADD].includes(action)) {
+        if ([PROJECT_UPDATE, CONTRIBUTORS_ADD, CONTRIBUTORS_REMOVE].includes(action)) {
           if (projects && !project) {
             project = projects[0] // NOTE: assuming all projects have the same language set here
           }
@@ -111,7 +112,7 @@ inquirer
       },
       type: 'checkbox',
       name: 'languages',
-      message: 'Select Language(s)',
+      message: 'Select Language(s):',
       choices: async () => languages.map(({ name, code }) => ({ name, value: code })),
     },
     {
@@ -152,6 +153,9 @@ inquirer
       case CONTRIBUTORS_ADD:
         addContributor(email, fullname, projects, languages).then(() => console.log('Contributor added'))
         break
+      case CONTRIBUTORS_REMOVE:
+        removeContributor(email, projects, languages).then(() => console.log('Contributor removed'))
+        break
       default:
         console.log('Sorry, I did not get what it is that you want...')
     }

gitpo.js

@@ -1,22 +1,24 @@
 const conf = require('./config')
+const addContributor = require('./lib/addContributor')(conf)
 const cleanTranslationJSON = require('./lib/cleanTranslationJSON')
 const importNewTerms = require('./lib/importNewTerms')(conf)
+const listContributors = require('./lib/listContributors')(conf)
 const listProjectLanguages = require('./lib/listProjectLanguages')(conf)
 const listProjects = require('./lib/listProjects')(conf)
+const removeContributor = require('./lib/removeContributor')(conf)
 const synchronizeTerms = require('./lib/synchronizeTerms')(conf)
 const updateTranslations = require('./lib/updateTranslations')(conf)
 const viewProject = require('./lib/viewProject')(conf)
-const listContributors = require('./lib/listContributors')(conf)
-const addContributor = require('./lib/addContributor')(conf)
 
 module.exports = {
+  addContributor,
   cleanTranslationJSON,
   importNewTerms,
+  listContributors,
   listProjectLanguages,
   listProjects,
+  removeContributor,
   synchronizeTerms,
   updateTranslations,
   viewProject,
-  listContributors,
-  addContributor,
 }

lib/removeContributor.js

@@ -0,0 +1,27 @@
+const rp = require('request-promise')
+
+// NOTE: An assumption is made here that may require some changes to support a more general use case:
+// All projects have all the same languages OR poeditor API will ignore deletion to non existing languages for a given project
+// this cases where not tested
+module.exports = ({ API_TOKEN }) => (email, projects, languages) =>
+  Promise.all(
+    projects.map(async (id) =>
+      Promise.all(
+        languages.map(async (language) =>
+          rp({
+            method: 'POST',
+            url: 'https://api.poeditor.com/v2/contributors/remove',
+            headers: {
+              'content-type': 'application/x-www-form-urlencoded',
+            },
+            form: {
+              api_token: API_TOKEN,
+              id,
+              email,
+              language,
+            },
+          })
+        )
+      )
+    )
+  )

utils/konstants.js

@@ -6,5 +6,5 @@ module.exports = {
   CONTRIBUTORS: 'CONTRIBUTORS',
   CONTRIBUTORS_LIST: 'CONTRIBUTORS_LIST',
   CONTRIBUTORS_ADD: 'CONTRIBUTORS_ADD',
-  CONTRIBUTORS_DELETE: 'CONTRIBUTORS_DELETE',
+  CONTRIBUTORS_REMOVE: 'CONTRIBUTORS_REMOVE',
 }