@engage_so/core 1.3.4 → 1.4.1

package/index.js

@@ -1,7 +1,7 @@
 const fetch = require('cross-fetch')
 const Buffer = require('buffer/').Buffer
 const EngageError = require('./error')
-const root = 'https://api.engage.so'
+const root = 'https://api.engage.so/v1'
 if (typeof btoa === 'undefined') {
   global.btoa = function (str) {
     return Buffer.from(str).toString('base64')
@@ -15,6 +15,9 @@ const options = {
 
 async function _request (url, params, method) {
   try {
+    if (!params) {
+      params = {}
+    }
     const response = await fetch(url, {
       method,
       headers: {
@@ -46,7 +49,7 @@ const request = (url, params, method) => {
 
 const init = (o) => {
   if (!o) {
-    throw new EngageError('You need to pass in your API key')
+    throw new EngageError('You need to pass in your API key.')
   }
   if (typeof o === 'string') {
     options.key = o
@@ -54,7 +57,7 @@ const init = (o) => {
   }
 
   if (!o.key) {
-    throw new EngageError('`key` missing in object')
+    throw new EngageError('`key` missing in object.')
   }
   if (o.key) {
     options.key = `${o.key}`
@@ -74,50 +77,50 @@ const identify = async (o) => {
   if (o.email && !/^\S+@\S+$/.test(o.email)) {
     throw new EngageError('Email invalid.')
   }
-  const allowed = ['id', 'email', 'number', 'created_at', 'device_token', 'device_platform', 'first_name', 'last_name']
+  const allowed = ['id', 'is_group', 'email', 'number', 'created_at', 'device_token', 'device_platform', 'first_name', 'last_name']
   const params = {
     meta: {}
   }
-  Object.keys(o).map(k => {
-    if (allowed.indexOf(k) !== -1) {
+  for (const k in o) {
+    if (allowed.includes(k)) {
       params[k] = o[k]
     } else {
       params.meta[k] = o[k]
     }
-  })
+  }
 
   return _request(`${root}/users/${o.id}`, params, 'PUT')
 }
 
 const addAttribute = async (uid, data) => {
   if (!uid) {
-    throw new EngageError('User id missing')
+    throw new EngageError('User id missing.')
   }
   if (!data) {
-    throw new EngageError('Attributes missing')
+    throw new EngageError('Attributes missing.')
   }
   if (!Object.keys(data).length) {
-    throw new EngageError('Attributes missing')
+    throw new EngageError('Attributes missing.')
   }
-  const notMeta = ['created_at', 'number', 'device_token', 'device_platform', 'email', 'first_name', 'last_name']
+  const notMeta = ['created_at', 'is_group', 'number', 'device_token', 'device_platform', 'email', 'first_name', 'last_name']
   const params = { meta: {} }
-  Object.keys(data).map(k => {
-    if (notMeta.indexOf(k) === -1) {
-      params.meta[k] = data[k]
-    } else {
+  for (const k in data) {
+    if (notMeta.includes(k)) {
       params[k] = data[k]
+    } else {
+      params.meta[k] = data[k]
     }
-  })
+  }
 
   return _request(`${root}/users/${uid}`, params, 'PUT')
 }
 
 const track = async (uid, data) => {
   if (!uid) {
-    throw new EngageError('User id missing')
+    throw new EngageError('User id missing.')
   }
   if (!data) {
-    throw new EngageError('Attributes missing')
+    throw new EngageError('Attributes missing.')
   }
   if (typeof data === 'string') {
     data = {
@@ -126,17 +129,76 @@ const track = async (uid, data) => {
     }
   } else {
     if (!Object.keys(data).length) {
-      throw new EngageError('Attributes missing')
+      throw new EngageError('Attributes missing.')
     }
   }
 
   return _request(`${root}/users/${uid}/events`, data, 'POST')
 }
 
+const addToGroup = async (uid, gid, role) => {
+  if (!uid) {
+    throw new EngageError('User id missing.')
+  }
+  if (!gid) {
+    throw new EngageError('Group id missing.')
+  }
+  if (role && typeof role !== 'string') {
+    throw new EngageError('Role should be a text.')
+  }
+  const g = {
+    id: gid
+  }
+  if (role) {
+    g.role = role
+  }
+  return _request(`${root}/users/${uid}/groups`, { groups: [g] }, 'POST')
+}
+const removeFromGroup = async (uid, gid) => {
+  if (!uid) {
+    throw new EngageError('User id missing.')
+  }
+  if (!gid) {
+    throw new EngageError('Group id missing.')
+  }
+  return _request(`${root}/users/${uid}/groups/${gid}`, null, 'DELETE')
+}
+
+const changeGroupRole = async (uid, gid, role) => {
+  if (!uid) {
+    throw new EngageError('User id missing.')
+  }
+  if (!gid) {
+    throw new EngageError('Group id missing.')
+  }
+  if (!role) {
+    throw new EngageError('New role missing.')
+  }
+  return _request(`${root}/users/${uid}/groups/${gid}`, { role }, 'PUT')
+}
+
+const convertToUser = async (uid) => {
+  if (!uid) {
+    throw new EngageError('User id missing.')
+  }
+  return _request(`${root}/users/${uid}/convert`, { type: 'user' }, 'POST')
+}
+const convertToGroup = async (uid) => {
+  if (!uid) {
+    throw new EngageError('User id missing.')
+  }
+  return _request(`${root}/users/${uid}/convert`, { type: 'group' }, 'POST')
+}
+
 module.exports = {
   init,
   identify,
   addAttribute,
   track,
-  request
+  request,
+  addToGroup,
+  removeFromGroup,
+  changeGroupRole,
+  convertToUser,
+  convertToGroup
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@engage_so/core",
-  "version": "1.3.4",
+  "version": "1.4.1",
   "description": "Event driven customer segmentation and targeted engagement.",
   "main": "index.js",
   "scripts": {
@@ -18,5 +18,5 @@
   "devDependencies": {
     "jest": "^26.4.2"
   },
-  "gitHead": "b288998ee988a348358f0a39c3747d1049d37dbd"
+  "gitHead": "7fc22abf94ef02987964ecfb6c3871314e42f922"
 }

package/test/index.test.js

@@ -1,120 +0,0 @@
-const Engage = require('../index')
-const id = '1234'
-
-describe('Init', () => {
-  test('should throw if no parameters sent', () => {
-    expect(() => {
-      Engage.init()
-    }).toThrowError('API')
-  })
-  test('should throw if parameter is empty object', () => {
-    expect(() => {
-      Engage.init({})
-    }).toThrowError('key')
-  })
-  test('should throw if empty key sent', () => {
-    expect(() => {
-      Engage.init('')
-    }).toThrowError()
-  })
-  test('should not throw if key is sent', () => {
-    expect(() => {
-      Engage.init(process.env.KEY)
-    }).not.toThrowError()
-  })
-  test('should not throw if key/secret is sent', () => {
-    expect(() => {
-      Engage.init({
-        key: process.env.KEY,
-        secret: process.env.SECRET
-      })
-    }).not.toThrowError()
-  })
-})
-
-describe('Identify', () => {
-  test('should throw if no parameter passed', async () => {
-    await expect(Engage.identify()).rejects.toThrowError('object')
-  })
-  test('should throw if empty string passed', async () => {
-    await expect(Engage.identify('')).rejects.toThrowError('id')
-  })
-  test('should throw if empty object passed', async () => {
-    await expect(Engage.identify({})).rejects.toThrowError(/id/i)
-  })
-  test('should throw if no email passed', async () => {
-    await expect(Engage.identify({ id })).rejects.toThrowError(/email/i)
-  })
-  test('should throw if invalid email passed', async () => {
-    await expect(Engage.identify({
-      id,
-      email: 'invalid'
-    })).rejects.toThrowError(/email/i)
-  })
-  test('should work if id and email passed', async () => {
-    await expect(Engage.identify({
-      id,
-      email: 'fickledreams@yahoo.com'
-    })).resolves.toMatchObject({
-      status: 'ok'
-    })
-  })
-})
-
-describe('Add attribute', () => {
-  test('should throw if no parameter passed', async () => {
-    await expect(Engage.addAttribute()).rejects.toThrowError('id')
-  })
-  test('should throw if no data attribute passed', async () => {
-    await expect(Engage.addAttribute(id)).rejects.toThrowError(/attributes/i)
-  })
-  test('should throw if empty object passed', async () => {
-    await expect(Engage.addAttribute(id, {})).rejects.toThrowError(/attributes/i)
-  })
-  test('should resolve if parameters passed', async () => {
-    await expect(Engage.addAttribute(id, {
-      first_name: 'Opeyemi',
-      active: true,
-      created_at: '2020-08-11'
-    })).resolves.toMatchObject({
-      status: 'ok'
-    })
-  })
-})
-
-describe('Track', () => {
-  test('should throw if no parameter passed', async () => {
-    await expect(Engage.track()).rejects.toThrowError('id')
-  })
-  test('should throw if no data attribute passed', async () => {
-    await expect(Engage.track(id)).rejects.toThrowError(/attributes/i)
-  })
-  test('should throw if empty object passed', async () => {
-    await expect(Engage.track(id, {})).rejects.toThrowError(/attributes/i)
-  })
-  test('should pass if string property passed', async () => {
-    await expect(Engage.track(id, 'loggedin')).resolves.toMatchObject({
-      status: 'ok'
-    })
-  })
-  test('should pass if right parameters passed', async () => {
-    await expect(Engage.track(id, {
-      event: 'played',
-      value: 'vid_133',
-      timestamp: '2020-05-30T09:30:10Z'
-    })).resolves.toMatchObject({
-      status: 'ok'
-    })
-  })
-  test('should resolve if other variant passed', async () => {
-    await expect(Engage.track(id, {
-      event: 'loggedin',
-      properties: {
-        ip: '127.0.0.1',
-        referral: 'localhost'
-      }
-    })).resolves.toMatchObject({
-      status: 'ok'
-    })
-  })
-})