feat(commands): Add organization list command

Added the organization list command, requested in #29

docs/README.md

@@ -8,5 +8,6 @@
 * [guide](./guide) - Getting started with Contentful
 * [config](./config) - Config related commands
 * [space](./space) - Space related commands
+* [organization](./organization) - Organization related commands
 * [content-type](./content-type) - Content Type related commands
 * [extension](./extension) - UI Extension related commands

docs/organization/README.md

@@ -0,0 +1,5 @@
+# Contentful CLI - Organization command
+
+## Available subcommands:
+
+* [list](./list) - List all Organizations you have access to

docs/organization/list/README.md

@@ -0,0 +1,8 @@
+# Contentful CLI - `space list` command
+
+Lists all Organizations you have access to.
+
+## Example
+```sh
+contentful organization list
+```

lib/cmds/organization.js

@@ -0,0 +1,10 @@
+export const command = 'organization'
+
+export const desc = 'Manage and list your organizations'
+
+export const builder = function (yargs) {
+  return yargs
+    .usage('')
+    .commandDir('organization_cmds')
+    .demandCommand(4, 'Please specify a sub command.')
+}

lib/cmds/organization_cmds/list.js

@@ -0,0 +1,54 @@
+import Table from 'cli-table3'
+
+import { handleAsyncError as handle } from '../../utils/async'
+import { createManagementClient } from '../../utils/contentful-clients'
+import { log } from '../../utils/log'
+import paginate from '../../utils/pagination'
+
+export const command = 'list'
+
+export const desc = 'List your organizations'
+
+export const builder = yargs => {
+  return yargs
+    .usage('Usage: contentful organization list')
+    .option('management-token', {
+      alias: 'mt',
+      describe: 'Contentful management API token',
+      type: 'string'
+    })
+    .epilog(
+      [
+        'See more at:',
+        'https://github.com/contentful/contentful-cli/tree/master/docs/organization/list',
+        'Copyright 2018 Contentful, this is a BETA release'
+      ].join('\n')
+    )
+}
+
+export const aliases = ['ls']
+
+export async function organizationList ({ context }) {
+  const { managementToken } = context
+
+  const client = await createManagementClient({
+    accessToken: managementToken,
+    feature: 'organization-list'
+  })
+
+  const result = await paginate({ client, method: 'getOrganizations' })
+
+  const organizations = result.items.sort((a, b) => a.name.localeCompare(b.name))
+
+  const table = new Table({
+    head: ['Organization name', 'Organization id']
+  })
+
+  organizations.forEach(({ sys, name }) => {
+    table.push([name, sys.id])
+  })
+
+  log(table.toString())
+}
+
+export const handler = handle(organizationList)

lib/config.js

@@ -18,6 +18,7 @@ export default {
     'config list',
     'config remove',
     'space create',
-    'space list'
+    'space list',
+    'organization list'
   ]
 }

test/e2e/__snapshots__/basics.test.js.snap

@@ -12,6 +12,7 @@ Commands:
   guide         A guide introducing basic concepts of working with Contentful
   login         Login to Contentful
   logout        Logout from Contentful
+  organization  Manage and list your organizations
   space         Manage and list your spaces
 
 Options:
@@ -33,6 +34,7 @@ Commands:
   guide         A guide introducing basic concepts of working with Contentful
   login         Login to Contentful
   logout        Logout from Contentful
+  organization  Manage and list your organizations
   space         Manage and list your spaces
 
 Options:
@@ -54,6 +56,7 @@ Commands:
   guide         A guide introducing basic concepts of working with Contentful
   login         Login to Contentful
   logout        Logout from Contentful
+  organization  Manage and list your organizations
   space         Manage and list your spaces
 
 Options:
@@ -77,6 +80,7 @@ Commands:
   guide         A guide introducing basic concepts of working with Contentful
   login         Login to Contentful
   logout        Logout from Contentful
+  organization  Manage and list your organizations
   space         Manage and list your spaces
 
 Options:

test/integration/cmds/__snapshots__/main.test.js.snap

@@ -11,6 +11,7 @@ Commands:
   guide         A guide introducing basic concepts of working with Contentful
   login         Login to Contentful
   logout        Logout from Contentful
+  organization  Manage and list your organizations
   space         Manage and list your spaces
 
 Options:
@@ -31,6 +32,7 @@ Commands:
   guide         A guide introducing basic concepts of working with Contentful
   login         Login to Contentful
   logout        Logout from Contentful
+  organization  Manage and list your organizations
   space         Manage and list your spaces
 
 Options:
@@ -52,6 +54,7 @@ Commands:
   guide         A guide introducing basic concepts of working with Contentful
   login         Login to Contentful
   logout        Logout from Contentful
+  organization  Manage and list your organizations
   space         Manage and list your spaces
 
 Options:
@@ -72,6 +75,7 @@ Commands:
   guide         A guide introducing basic concepts of working with Contentful
   login         Login to Contentful
   logout        Logout from Contentful
+  organization  Manage and list your organizations
   space         Manage and list your spaces
 
 Options:

test/integration/cmds/organization/__snapshots__/list.test.js.snap

@@ -0,0 +1,13 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`should print help message: help data is incorrect 1`] = `
+"Usage: contentful organization list
+
+Options:
+  -h, --help                Show help                                  [boolean]
+  --management-token, --mt  Contentful management API token             [string]
+
+See more at:
+https://github.com/contentful/contentful-cli/tree/master/docs/organization/list
+Copyright 2018 Contentful, this is a BETA release"
+`;

test/integration/cmds/organization/list.test.js

@@ -0,0 +1,38 @@
+import nixt from 'nixt'
+import { join } from 'path'
+import { initConfig } from '../../util'
+
+const bin = join(__dirname, './../../../../', 'bin')
+const org = process.env.CLI_E2E_ORG_ID
+
+const app = () => {
+  return nixt({ newlines: true })
+    .cwd(bin)
+    .base('./contentful.js ')
+    .clone()
+}
+
+beforeAll(() => {
+  return initConfig()
+})
+
+test('should print help message', done => {
+  app()
+    .run('organization list --help')
+    .code(0)
+    .expect(result => {
+      const resultText = result.stdout.trim()
+      expect(resultText).toMatchSnapshot('help data is incorrect')
+    })
+    .end(done)
+})
+
+test('should list organizations', done => {
+  app()
+    .run('organization list')
+    .code(0)
+    .stdout(/(Organization name)|(Organization id)/)
+    .stdout(RegExp(org))
+    .stdout(/Contentful CLI Test Org/)
+    .end(done)
+})

test/integration/cmds/organization/snapshots/list.test.js.md

@@ -0,0 +1,19 @@
+# Snapshot report for `test/integration/cmds/organization/list.test.js`
+
+The actual snapshot is saved in `list.test.js.snap`.
+
+Generated by [AVA](https://ava.li).
+
+## should print help message
+
+> help data is incorrect
+
+    `Usage: contentful organization list␊
+    ␊
+    Options:␊
+      -h, --help          Show help                                        [boolean]␊
+      --management-token  Contentful management API token                   [string]␊
+    ␊
+    See more at:␊
+    https://github.com/contentful/contentful-cli/tree/master/docs/organization/list␊
+    Copyright 2018 Contentful, this is a BETA release`

test/unit/cmds/organization_cmds/list.test.js

@@ -0,0 +1,58 @@
+import { organizationList } from '../../../../lib/cmds/organization_cmds/list'
+import { createManagementClient } from '../../../../lib/utils/contentful-clients'
+import { log } from '../../../../lib/utils/log'
+
+jest.mock('../../../../lib/context')
+jest.mock('../../../../lib/utils/contentful-clients')
+jest.mock('../../../../lib/utils/log')
+
+const organizationData = {
+  items: [
+    {
+      sys: {
+        type: 'Organization',
+        id: '0D9ZC8rLWiw6x5qizZGiRs',
+        version: '1',
+        createdAt: '2015-05-18T11:29:46.809Z',
+        updatedAt: '2015-05-18T11:29:46.809Z'
+      },
+      name: 'My organization'
+    },
+    {
+      sys: {
+        type: 'Organization 2',
+        id: 'ewr1k12341lk4123332131',
+        version: '1',
+        createdAt: '2015-05-18T11:29:46.809Z',
+        updatedAt: '2015-05-18T11:29:46.809Z'
+      },
+      name: 'My second organization'
+    }
+  ]
+}
+
+const fakeClient = {
+  getOrganizations: async () => organizationData
+}
+createManagementClient.mockResolvedValue(fakeClient)
+
+afterEach(() => {
+  createManagementClient.mockClear()
+  log.mockClear()
+})
+
+test('list organizations', async () => {
+  await organizationList({
+    context: {
+      managementToken: 'managementToken'
+    }
+  })
+
+  expect(createManagementClient).toHaveBeenCalledTimes(1)
+  const [result] = log.mock.calls[0]
+  const [org1, org2] = organizationData.items
+  expect(result).toContain(org1.name)
+  expect(result).toContain(org1.sys.id)
+  expect(result).toContain(org2.name)
+  expect(result).toContain(org2.sys.id)
+})