feat(organizations): implement new organizations endpoint

Author: axe312ger

lib/create-contentful-api.js

@@ -6,6 +6,7 @@ import entities from './entities'
  * @property {function(id: string): Promise<Space>} getSpace - Gets a space with the spcified id
  * @property {function(): Promise<SpaceCollection>} getSpaces - Gets a collection of spaces
  * @property {function(data: {name: string}): Promise<Space>} createSpace - Creates a space
+ * @property {function(): Promise<OrganizationCollection>} getOrganizations - Gets a collection of Organizations
  */
 
 /**
@@ -17,8 +18,9 @@ import entities from './entities'
  * @prop {Function} shouldLinksResolve - Link resolver preconfigured with global setting
  * @return {ClientAPI}
  */
-export default function createSpaceApi ({ http }) {
+export default function createClientApi ({ http }) {
   const {wrapSpace, wrapSpaceCollection} = entities.space
+  const {wrapOrganizationCollection} = entities.organization
 
   /**
    * Gets all spaces
@@ -64,9 +66,26 @@ export default function createSpaceApi ({ http }) {
     .then((response) => wrapSpace(http, response.data), errorHandler)
   }
 
+  /**
+   * Gets a collection of Organizations
+   * @memberof ClientAPI
+   * @return {Promise<OrganizationCollection>} Promise for a collection of Organizations
+   * @example
+   * space.getOrganizations()
+   * .then(result => console.log(result.items))
+   */
+  function getOrganizations () {
+    const baseURL = http.defaults.baseURL.replace('/spaces/', '/organizations/')
+    return http.get('', {
+      baseURL
+    })
+    .then((response) => wrapOrganizationCollection(http, response.data), errorHandler)
+  }
+
   return {
     getSpaces: getSpaces,
     getSpace: getSpace,
-    createSpace: createSpace
+    createSpace: createSpace,
+    getOrganizations: getOrganizations
   }
 }

lib/entities/index.js

@@ -9,6 +9,7 @@ import * as spaceMembership from './space-membership'
 import * as role from './role'
 import * as apiKey from './api-key'
 import * as upload from './upload'
+import * as organization from './organization'
 
 export default {
   space,
@@ -21,5 +22,6 @@ export default {
   spaceMembership,
   role,
   apiKey,
-  upload
+  upload,
+  organization
 }

lib/entities/organization.js

@@ -0,0 +1,14 @@
+import cloneDeep from 'lodash/cloneDeep'
+import { freezeSys, toPlainObject } from 'contentful-sdk-core'
+
+/**
+* This method normalizes each organization in a collection.
+ * @private
+ * @param {Object} http - HTTP client instance
+ * @param {Object} data - Raw organization collection data
+ * @return {OrganizationCollection} Normalized organization collection data
+ */
+export function wrapOrganizationCollection (http, data) {
+  const organizations = toPlainObject(cloneDeep(data))
+  return freezeSys(organizations)
+}

test/integration/integration-tests.js

@@ -32,6 +32,14 @@ test('Gets spaces', (t) => {
   })
 })
 
+test('Gets organizations', (t) => {
+  t.plan(1)
+  return client.getOrganizations()
+  .then((response) => {
+    t.ok(response.items.length >= 1, 'user must belong to at least one organization')
+  })
+})
+
 test('Gets space', (t) => {
   t.plan(2)
   return client.getSpace('cfexampleapi')

test/unit/create-contentful-api-test.js

@@ -1,7 +1,7 @@
 import test from 'blue-tape'
 import { Promise } from 'es6-promise'
 
-import {spaceMock, setupEntitiesMock} from './mocks/entities'
+import {spaceMock, setupEntitiesMock, organizationMock} from './mocks/entities'
 import setupHttpMock from './mocks/http'
 import createContentfulApi, {__RewireAPI__ as createContentfulApiRewireApi} from '../../lib/create-contentful-api'
 import {makeGetEntityTest, makeGetCollectionTest, makeEntityMethodFailingTest} from './test-creators/static-entity-methods'
@@ -49,6 +49,20 @@ test('API call getSpace fails', (t) => {
   })
 })
 
+test('API call getOrganizations', (t) => {
+  makeGetCollectionTest(t, setup, teardown, {
+    entityType: 'organization',
+    mockToReturn: organizationMock,
+    methodToTest: 'getOrganizations'
+  })
+})
+
+test('API call getOrganizations fails', (t) => {
+  makeEntityMethodFailingTest(t, setup, teardown, {
+    methodToTest: 'getOrganizations'
+  })
+})
+
 test('API call createSpace', (t) => {
   t.plan(3)
   const data = {

test/unit/entities/organization-test.js

@@ -0,0 +1,20 @@
+import test from 'tape'
+import { cloneMock } from '../mocks/entities'
+import setupHttpMock from '../mocks/http'
+import { wrapOrganizationCollection } from '../../../lib/entities/organization'
+import {
+  entityCollectionWrappedTest
+} from '../test-creators/instance-entity-methods'
+
+function setup (promise) {
+  return {
+    httpMock: setupHttpMock(promise),
+    entityMock: cloneMock('organization')
+  }
+}
+
+test('Organization collection is wrapped', (t) => {
+  entityCollectionWrappedTest(t, setup, {
+    wrapperMethod: wrapOrganizationCollection
+  })
+})

test/unit/mocks/entities.js

@@ -150,6 +150,12 @@ const apiKeyMock = {
   })
 }
 
+const organizationMock = {
+  sys: assign(cloneDeep(sysMock), {
+    type: 'Organization'
+  })
+}
+
 const errorMock = {
   config: {
     url: 'requesturl',
@@ -175,7 +181,8 @@ const mocks = {
   role: roleMock,
   apiKey: apiKeyMock,
   error: errorMock,
-  upload: uploadMock
+  upload: uploadMock,
+  organization: organizationMock
 }
 
 function cloneMock (name) {
@@ -234,6 +241,9 @@ function setupEntitiesMock (rewiredModuleApi) {
     },
     upload: {
       wrapUpload: sinon.stub()
+    },
+    organization: {
+      wrapOrganizationCollection: sinon.stub()
     }
   }
   rewiredModuleApi.__Rewire__('entities', entitiesMock)
@@ -259,5 +269,6 @@ export {
   cloneMock,
   mockCollection,
   setupEntitiesMock,
-  uploadMock
+  uploadMock,
+  organizationMock
 }

test/unit/mocks/http.js

@@ -6,6 +6,9 @@ export default function setupHttpMock (promise = Promise.resolve({data: {}})) {
     get: sinon.stub().returns(promise),
     post: sinon.stub().returns(promise),
     put: sinon.stub().returns(promise),
-    delete: sinon.stub().returns(promise)
+    delete: sinon.stub().returns(promise),
+    defaults: {
+      baseURL: 'https://api.contentful.com/spaces/'
+    }
   }
 }