feat: Add locale instance methods

Author: trodrigues

lib/create-space-api.js

@@ -321,7 +321,7 @@ export default function createSpaceApi ({
    */
   function getLocale (id) {
     return http.get('locales/' + id)
-    .then((response) => wrapLocale(response.data), errorHandler)
+    .then((response) => wrapLocale(http, response.data), errorHandler)
   }
 
   /**
@@ -334,7 +334,7 @@ export default function createSpaceApi ({
    */
   function getLocales () {
     return http.get('locales')
-    .then((response) => wrapLocaleCollection(response.data), errorHandler)
+    .then((response) => wrapLocaleCollection(http, response.data), errorHandler)
   }
 
   /**
@@ -344,7 +344,7 @@ export default function createSpaceApi ({
    * @param {object} data - Object representation of the Locale to be created
    * @return {Promise<Entities.Locale>} Promise for the newly created Locale
    * @example
-   * space.createLocale({fields: {}})
+   * space.createLocale({name: 'German (Germany)', code: 'de-DE'})
    * .then(e => console.log(e))
    */
   function createLocale (data) {

lib/entities/entry.js

@@ -89,7 +89,7 @@ function createEntryApi (http) {
      * @func update
      * @return {Promise<Entry>} Object returned from the server with updated changes.
      * @example
-     * contentType.fields.name['en-US'] = 'Blog Post'
+     * entry.fields.name['en-US'] = 'Blog Post'
      * entry.update()
      * .then(entry => console.log(entry.fields.name['en-US']))
      */

lib/entities/locale.js

@@ -2,10 +2,10 @@ import {cloneDeep} from 'lodash/lang'
 import freezeSys from 'contentful-sdk-core/freeze-sys'
 import enhanceWithMethods from '../enhance-with-methods'
 import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
-
-// Methods to add:
-// - update
-// - delete
+import {
+  createUpdateEntity,
+  createDeleteEntity
+} from '../instance-actions'
 
 /**
  * @memberof Entities
@@ -20,7 +20,44 @@ import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
  */
 
 function createLocaleApi (http) {
-  return {}
+  return {
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @memberof Locale
+     * @func update
+     * @return {Promise<Locale>} Object returned from the server with updated changes.
+     * @example
+     * locale.name = 'English'
+     * locale.update()
+     * .then(locale => console.log(locale.name))
+     */
+    update: function () {
+      // delete some properties which are returned by the server but shouldn't
+      // be sent back.
+      const locale = this
+      delete locale.default
+      delete locale.fallback_code
+      return createUpdateEntity({
+        http: http,
+        entityPath: 'locales',
+        wrapperMethod: wrapLocale
+      }).call(locale)
+    },
+
+    /**
+     * Deletes this object on the server.
+     * @memberof Locale
+     * @func delete
+     * @return {Promise} Promise for the deletion. It contains no data, but the Promise error case should be handled.
+     * @example
+     * locale.delete()
+     * .catch(err => console.log(err))
+     */
+    delete: createDeleteEntity({
+      http: http,
+      entityPath: 'locales'
+    })
+  }
 }
 
 /**
@@ -31,6 +68,7 @@ function createLocaleApi (http) {
  */
 export function wrapLocale (http, data) {
   const locale = mixinToPlainObject(cloneDeep(data))
+  delete locale.internal_code
   enhanceWithMethods(locale, createLocaleApi(http))
   return freezeSys(locale)
 }

test/integration/locale.js

@@ -0,0 +1,35 @@
+export default function localeTests (t, space) {
+  t.test('Gets locales', (t) => {
+    t.plan(2)
+    return space.getLocales()
+    .then((response) => {
+      t.ok(response.items[0].name, 'English')
+      t.ok(response.items[0].code, 'en-US')
+    })
+  })
+
+  t.test('Creates, gets, updates and deletes a locale', (t) => {
+    t.plan(3)
+    return space.createLocale({
+      name: 'German (Austria)',
+      code: 'de-AT'
+    })
+    .then((response) => {
+      t.equals(response.code, 'de-AT', 'locale code after creation')
+      return new Promise((resolve) => {
+        setTimeout(() => {
+          resolve(space.getLocale(response.sys.id)
+          .then((locale) => {
+            t.equals(locale.code, 'de-AT', 'locale code after getting')
+            locale.name = 'Deutsch (Österreich)'
+            return locale.update()
+            .then((updatedLocale) => {
+              t.equals(updatedLocale.name, 'Deutsch (Österreich)', 'locale name after update')
+              return updatedLocale.delete()
+            })
+          }))
+        }, 3000)
+      })
+    })
+  })
+}

test/integration/tests.js

@@ -1,4 +1,5 @@
 import test from 'blue-tape'
+import localeTests from './locale'
 import contentTypeTests from './content-type'
 import entryTests from './entry'
 import assetTests from './asset'
@@ -72,6 +73,7 @@ test.only('Gets space with entities', (t) => {
   // in case someone forgets to comment this line again.
   // client.getSpace("wolk5fnyla9z")
   .then((space) => {
+    localeTests(t, space)
     contentTypeTests(t, space)
     entryTests(t, space)
     assetTests(t, space)

test/unit/entities/locale-test.js

@@ -1,25 +1,57 @@
 import test from 'tape'
-import {localeMock, mockCollection} from '../mocks/entities'
+import {cloneMock} from '../mocks/entities'
 import setupHttpMock from '../mocks/http'
 import {wrapLocale, wrapLocaleCollection} from '../../../lib/entities/locale'
+import {
+  entityWrappedTest,
+  entityCollectionWrappedTest,
+  entityUpdateTest,
+  entityDeleteTest,
+  failingActionTest,
+  failingVersionActionTest
+} from '../test-creators/instance-entity-methods'
 
-function setup () {
+function setup (promise) {
   return {
-    httpMock: setupHttpMock()
+    httpMock: setupHttpMock(promise),
+    entityMock: cloneMock('locale')
   }
 }
 
 test('Locale is wrapped', (t) => {
-  const {httpMock} = setup()
-  const wrappedLocale = wrapLocale(httpMock, localeMock)
-  t.looseEqual(wrappedLocale.toPlainObject(), localeMock)
-  t.end()
+  entityWrappedTest(t, setup, {
+    wrapperMethod: wrapLocale
+  })
 })
 
 test('Locale collection is wrapped', (t) => {
-  const {httpMock} = setup()
-  const localeCollection = mockCollection(localeMock)
-  const wrappedLocale = wrapLocaleCollection(httpMock, localeCollection)
-  t.looseEqual(wrappedLocale.toPlainObject(), localeCollection)
-  t.end()
+  return entityCollectionWrappedTest(t, setup, {
+    wrapperMethod: wrapLocaleCollection
+  })
+})
+
+test('Locale update', (t) => {
+  return entityUpdateTest(t, setup, {
+    wrapperMethod: wrapLocale
+  })
+})
+
+test('Locale update fails', (t) => {
+  return failingVersionActionTest(t, setup, {
+    wrapperMethod: wrapLocale,
+    actionMethod: 'update'
+  })
+})
+
+test('Locale delete', (t) => {
+  return entityDeleteTest(t, setup, {
+    wrapperMethod: wrapLocale
+  })
+})
+
+test('Locale delete fails', (t) => {
+  return failingActionTest(t, setup, {
+    wrapperMethod: wrapLocale,
+    actionMethod: 'delete'
+  })
 })