Merge pull request #365 from ademarCardoso/feature/list-spaces

Feature/list spaces

Author: emanuelgsouza

README.md

@@ -145,6 +145,14 @@ $ storyblok run-migration --space <SPACE_ID> --component <COMPONENT_NAME> --fiel
 * `field`: name of field
 * `dryrun`: when passed as an argument, does not perform the migration
 
+### spaces
+
+List all spaces of the logged account
+
+```sh
+$ storyblok spaces
+```
+
 ### Help
 
 For global help

src/cli.js

@@ -283,6 +283,23 @@ program
     }
   })
 
+// list spaces
+program
+  .command('spaces')
+  .description('List all spaces of the logged account')
+  .action(async () => {
+    try {
+      if (!api.isAuthorized()) {
+        await api.processLogin()
+      }
+
+      await tasks.listSpaces(api)
+    } catch (e) {
+      console.log(chalk.red('X') + ' An error ocurred to listing sapces : ' + e.message)
+      process.exit(1)
+    }
+  })
+
 program.parse(process.argv)
 
 if (program.rawArgs.length <= 2) {

src/tasks/index.js

@@ -5,5 +5,6 @@ module.exports = {
   pullComponents: require('./pull-components'),
   pushComponents: require('./push-components'),
   generateMigration: require('./migrations/generate'),
-  runMigration: require('./migrations/run')
+  runMigration: require('./migrations/run'),
+  listSpaces: require('./list-spaces')
 }

src/tasks/list-spaces.js

@@ -0,0 +1,35 @@
+const chalk = require('chalk')
+
+/**
+ * @method listSpaces
+ * @param api - Pass the api instance as a parameter
+ * @return {Promise}
+ */
+
+const listSpaces = async (api) => {
+  console.log()
+  console.log(chalk.green('✓') + ' Loading spaces...')
+  console.log()
+
+  if (!api) {
+    console.log(chalk.red('X') + 'Api instance is required to make the request')
+    return []
+  }
+
+  const spaces = await api.getAllSpaces()
+    .then(res => res)
+    .catch(err => Promise.reject(err))
+
+  if (!spaces) {
+    console.log(chalk.red('X') + ' No spaces were found for this user ')
+    return []
+  }
+
+  spaces.map(space => {
+    console.log(`${space.name} (id: ${space.id})`)
+  })
+
+  return spaces
+}
+
+module.exports = listSpaces

src/utils/api.js

@@ -189,5 +189,12 @@ module.exports = {
     const _path = this.getPath(path)
 
     return client[method](_path, props)
+  },
+
+  async getAllSpaces () {
+    return await this.getClient()
+      .get('spaces/', {})
+      .then(res => res.data.spaces || [])
+      .catch(err => Promise.reject(err))
   }
 }

tests/constants.js

@@ -126,10 +126,34 @@ const FAKE_STORIES = () => [
   }
 ]
 
+const FAKE_SPACES = () => [
+  {
+    name: 'Example Space',
+    domain: 'https://example.storyblok.com',
+    uniq_domain: null,
+    plan: 'starter',
+    plan_level: 0,
+    limits: {},
+    created_at: '2018-11-10T15:33:18.402Z',
+    id: 0
+  },
+  {
+    name: 'Example Space Two',
+    domain: 'https://example-two.storyblok.com',
+    uniq_domain: null,
+    plan: 'starter',
+    plan_level: 0,
+    limits: {},
+    created_at: '2018-11-10T15:33:18.402Z',
+    id: 1
+  }
+]
+
 module.exports = {
   EMAIL_TEST,
   TOKEN_TEST,
   FAKE_STORIES,
   PASSWORD_TEST,
-  FAKE_COMPONENTS
+  FAKE_COMPONENTS,
+  FAKE_SPACES
 }

tests/units/list-spaces.spec.js

@@ -0,0 +1,22 @@
+const { listSpaces } = require('../../src/tasks/')
+const { FAKE_SPACES } = require('../constants')
+
+describe('Test spaces method', () => {
+  it('Testing list-spaces funtion without api instance', async () => {
+    try {
+      const spaces = await listSpaces()
+      expect(spaces).toStrictEqual([])
+    } catch (e) {
+      console.error(e)
+    }
+  })
+  it('Testing list-spaces funtion with api instance', async () => {
+    const FAKE_API = {
+      getAllSpaces: jest.fn(() => Promise.resolve(FAKE_SPACES()))
+    }
+    expect(
+      await listSpaces(FAKE_API)
+    ).toEqual(FAKE_SPACES())
+    expect(FAKE_API.getAllSpaces).toHaveBeenCalled()
+  })
+})