rejoiner 1.2.0 → 2.10.2

package/README.md

@@ -17,89 +17,138 @@ npm install rejoiner --save
 ````js
 var Rejoiner = require('rejoiner')
 
-var apiClient = new Rejoiner({
-  siteId: '527bcca942bd247ca1816847',
-  domain: '173.203.96.102',
-  apiKey: '63cab4a5e1c44fcbbe260daa3f0bc55d',
-  apiSecret: 'cb015c09a3b54688a247470b462082b3',
+var client = new Rejoiner({
+  // Your Site ID
+  siteId: 'eXaMpLe',
+  // Your API key
+  apiKey: 'tHiSaPiKeYiSjUsTaNeXaMpLeAnDyOuCaNtUsEiT',
 })
 ````
 
-## Endpoints
+## Ping
 
-### Convert Lead
+The `ping` endpoint can be used to verify your credentials are working.
 
 ````js
-apiClient.lead.convert({
-  email: 'foo2@bar.com',
+client.verify.ping()
+  .then(...)
+  .catch(...)
+````
+
+## Customer Endpoints
+
+### Convert Customer
+
+````js
+client.customer.convert({
+  email: 'test@example.com',
   cart_data: {
-    cart_value: 79996,
+    cart_value: 20000,
     cart_item_count: 2,
+    promo: 'COUPON_CODE',
+    return_url: 'https://www.example.com/return_url',
+    ...
   },
-  cart_items: [{
-    'name': 'Item Name',
-    'product_id': 'ITM1',
-    'price': 19999,
-    'product_url': 'http://yoursite.com/productpage',
-    'category': ['televisions', 'smart_tv'],
-    'item_qty': 2,
-    'qty_price': 39998,
-    'image_url': 'http://yoursite.com/path/to/image.jpg'
-  }, {
-    'name': 'Item Name2',
-    'product_id': 'ITM2',
-    'price': 19999,
-    'product_url': 'http://yoursite.com/productpage2',
-    'category': ['televisions'],
-    'item_qty': 2,
-    'qty_price': 39998,
-    'image_url': 'http://yoursite.com/path/to/image2.jpg'
-  }],
+  cart_items: [
+    {
+      product_id: 'example',
+      name: 'Example Product',
+      price: 10000,
+      description: 'Information about Example Product.',
+      category: [
+        'Example Category 1',
+        'Example Category 2',
+      ],
+      item_qty: 1,
+      qty_price: 10000,
+      product_url: 'https://www.example.com/products/example',
+      image_url: 'https://www.example.com/products/example/images/example.jpg',
+      ...
+    },
+    {
+      product_id: 'example2',
+      name: 'Example Product 2',
+      price: 10000,
+      description: 'Information about Example Product 2.',
+      category: [
+        'Example Category 2',
+        'Example Category 3',
+      ],
+      item_qty: 1,
+      qty_price: 10000,
+      product_url: 'https://www.example.com/products/example2',
+      image_url: 'https://www.example.com/products/example2/images/example.jpg',
+      ...
+    },
+    ...
+  ],
 })
   .then(...)
   .catch(...)
 ````
 
-### Cancellation
+### Journey Cancellation
 
 ````js
-apiClient.lead.cancel('foo@bar.com')
+client.customer.cancel('test@example.com')
   .then(...)
   .catch(...)
 ````
 
-### Adding Contact to List
+### Customer Unsubscribe
 
 ````js
-apiClient.contact.add({
-  email: 'foo@bar.com',
-  list_id: '5706374ae6ec520d3370e368',
-  first_name: 'Tom',
-})
+client.customer.unsubscribe('test@example.com')
+  .then(...)
+  .catch(...)
+````
+
+### Record Explicit Customer Consent
+
+````js
+client.customer.optIn('test@example.com')
+  .then(...)
+  .catch(...)
+````
+
+## Email List Endpoints
+
+### Email Lists
+
+````js
+client.lists.get()
+  .then(...)
+  .catch(...)
+````
+
+### Retrieving Listing of Contacts
+
+````js
+client.lists.contacts('eXaMpLeLiStId').get()
   .then(...)
   .catch(...)
 ````
 
-### Unsubscribe Contact
+#### With optional page number for pagination
 
 ````js
-apiClient.lead.unsubscribe('foo@bar.com')
+client.lists.contacts('eXaMpLeLiStId').get(2)
   .then(...)
   .catch(...)
 ````
 
-### Retrieve Lists
+### Add Customer to List
 
 ````js
-apiClient.lists.get()
+client.lists.contacts('eXaMpLeLiStId').add('test@example.com')
   .then(...)
   .catch(...)
 ````
 
-### Record Contact Opt In
+### Remove Customer From List
 
 ````js
-apiClient.lead.optIn('foo@bar.com')
+client.lists.contacts('eXaMpLeLiStId').remove('test@example.com')
   .then(...)
   .catch(...)
 ````

package/lib/config.js

@@ -1,10 +1,14 @@
 const VERSION = require('../package.json').version
 
-const { REJOINER_API_KEY, REJOINER_API_SECRET, REJOINER_SITE_ID } = process.env
+const { REJOINER_API_KEY, REJOINER_SITE_ID, REJOINER_WEBHOOK_SECRET } = process.env
+
+const DEFAULT_BASE_URL = 'https://rj2.rejoiner.com/api/v1'
+const REJOINER_BASE_URL = process.env.REJOINER_BASE_URL || DEFAULT_BASE_URL
 
 module.exports = {
   VERSION,
   REJOINER_API_KEY,
-  REJOINER_API_SECRET,
   REJOINER_SITE_ID,
+  REJOINER_WEBHOOK_SECRET,
+  REJOINER_BASE_URL,
 }

package/lib/endpoints/customer.js

@@ -0,0 +1,22 @@
+const { withClient } = require('../helpers')
+
+const customerEndpoint = (client) => {
+  const endpoint = 'customer'
+
+  const { dispatchReturnData, postEmail, putEmail } = withClient(client)
+
+  return {
+    path: endpoint,
+    convert: (data, always) => {
+      if (always) return dispatchReturnData('post')(`${endpoint}/always_convert/`, data)
+      return dispatchReturnData('post')(`${endpoint}/convert/`, data)
+    },
+    cancel: email => postEmail(`${endpoint}/cancel/`, email),
+    unsubscribe: email => postEmail(`${endpoint}/unsubscribe/`, email),
+    optIn: email => postEmail(`${endpoint}/opt_in/`, email),
+    get: email => dispatchReturnData('get')(`customers/${email}/`),
+    update: data => putEmail(`customers/${data.email}/`, data),
+  }
+}
+
+module.exports = customerEndpoint

package/lib/endpoints/journeys.js

@@ -0,0 +1,39 @@
+const { withClient } = require('../helpers')
+
+const path = 'journeys'
+
+const journeysEndpoint = (client) => {
+  const { dispatchReturnData } = withClient(client)
+
+  const endpoint = journeyId => ({
+    nodes: nodeId => ({
+      webhook: (email) => {
+        const requestPath = `${path}/${journeyId}/nodes/${nodeId}/webhook_event_wait/`
+
+        if (typeof email === 'string') {
+          return dispatchReturnData('post')(requestPath, {
+            email: email.toLowerCase(),
+            customer_data: {},
+            session_data: {},
+          })
+        }
+
+        if (typeof email === 'object' && typeof email.email === 'string') {
+          return dispatchReturnData('post')(requestPath, Object.assign(
+            { customer_data: {}, session_data: {} },
+            email,
+            { email: email.email.toLowerCase() },
+          ))
+        }
+
+        return Promise.reject(new Error('Request is missing required email parameter.'))
+      },
+    }),
+  })
+
+  endpoint.path = path
+
+  return endpoint
+}
+
+module.exports = journeysEndpoint

package/lib/endpoints/lists.js

@@ -1,10 +1,28 @@
+const { withClient } = require('../helpers')
+
 const listsEndpoint = (client) => {
   const endpoint = 'lists'
 
+  const { dispatchReturnData, postEmail } = withClient(client)
+
   return {
-    name: endpoint,
-    get: () => client.dispatch.get(endpoint)
-      .then(res => res.data),
+    path: endpoint,
+    get: () => dispatchReturnData('get')(`${endpoint}/`),
+    add: (name) => {
+      if (typeof name === 'string') {
+        return dispatchReturnData('post')(`${endpoint}/`, { name })
+      }
+
+      return dispatchReturnData('post')(`${endpoint}/`, name)
+    },
+    contacts: listId => ({
+      get: (page) => {
+        const pagination = page ? `?page=${page}` : ''
+        return dispatchReturnData('get')(`${endpoint}/${listId}/contacts/${pagination}`)
+      },
+      add: email => postEmail(`${endpoint}/${listId}/contacts/`, email),
+      remove: email => postEmail(`${endpoint}/${listId}/contacts/remove/`, email),
+    }),
   }
 }
 

package/lib/endpoints/ping.js

@@ -0,0 +1,11 @@
+const pingEndpoint = (client) => {
+  const endpoint = 'verify'
+
+  return {
+    path: endpoint,
+    ping: () => client.dispatch.get('/ping/')
+      .then(res => res.data),
+  }
+}
+
+module.exports = pingEndpoint

package/lib/endpoints/segments.js

@@ -0,0 +1,16 @@
+const { withClient } = require('../helpers')
+
+const segmentsEndpoint = (client) => {
+  const endpoint = 'segments'
+
+  const { dispatchReturnData } = withClient(client)
+
+  return {
+    path: endpoint,
+    customers: segmentId => ({
+      get: () => dispatchReturnData('get')(`${endpoint}/${segmentId}/customers/`),
+    }),
+  }
+}
+
+module.exports = segmentsEndpoint

package/lib/helpers.js

@@ -0,0 +1,31 @@
+const withClient = (client) => {
+  const dispatchReturnData = method => (...args) => client.dispatch[method](...args)
+    .then(res => res.data)
+
+  const withEmail = (method, path, email) => {
+    if (typeof email === 'string') {
+      return dispatchReturnData(method)(path, { email: email.toLowerCase() })
+    }
+
+    if (typeof email === 'object' && typeof email.email === 'string') {
+      return dispatchReturnData(method)(path, Object.assign(
+        {},
+        email,
+        { email: email.email.toLowerCase() },
+      ))
+    }
+
+    return Promise.reject(new Error('Request is missing required email parameter.'))
+  }
+
+  const postEmail = (path, email) => withEmail('post', path, email)
+  const putEmail = (path, email) => withEmail('put', path, email)
+
+  return {
+    dispatchReturnData,
+    postEmail,
+    putEmail,
+  }
+}
+
+module.exports = { withClient }

package/lib/rejoiner.js

@@ -2,57 +2,67 @@ const axios = require('axios')
 const crypto = require('crypto')
 const fs = require('graceful-fs')
 const path = require('path')
-const { merge } = require('lodash')
+const merge = require('lodash.merge')
 
 const {
   VERSION,
   REJOINER_API_KEY,
-  REJOINER_API_SECRET,
   REJOINER_SITE_ID,
+  REJOINER_WEBHOOK_SECRET,
+  REJOINER_BASE_URL,
 } = require('./config')
 
-function Rejoiner(options) {
+function Rejoiner2(options) {
   const opts = merge({}, options)
 
   this.siteId = opts.siteId || REJOINER_SITE_ID
   this.apiKey = opts.apiKey || REJOINER_API_KEY
-  this.apiSecret = opts.apiSecret || REJOINER_API_SECRET
+  this.webhookSecret = opts.webhookSecret || REJOINER_WEBHOOK_SECRET
+  this.baseURL = opts.baseURL || REJOINER_BASE_URL
 
-  this.sign = ({ httpVerb, requestPath, requestBody }) => {
-    const req = [httpVerb, requestPath, requestBody].join('\n')
-    return crypto.createHmac('sha1', this.apiSecret).update(req).digest('base64')
-  }
+  if (!this.siteId) throw new Error('Site ID must be configured')
+  if (!this.apiKey) throw new Error('API Key must be configured')
 
   this.dispatch = axios.create({
-    baseURL: `https://app.rejoiner.com/api/1.0/site/${this.siteId}`,
+    baseURL: `${this.baseURL}/${this.siteId}`,
     headers: {
-      'User-Agent': `rejoiner-node/v${VERSION}`,
+      Authorization: `Rejoiner ${this.apiKey}`,
+      'User-Agent': `rejoiner2-node/v${VERSION}`,
     },
   })
 
-  this.dispatch.interceptors.request.use((conf) => {
-    const signedReq = this.sign({
-      httpVerb: conf.method.toUpperCase(),
-      requestPath: conf.url.replace('https://app.rejoiner.com', ''),
-      requestBody: JSON.stringify(conf.data),
-    })
-
-    const withSignedReqHeader = merge({}, conf, {
-      headers: {
-        Authorization: `Rejoiner ${this.apiKey}:${signedReq}`,
-      },
-    })
-
-    return withSignedReqHeader
-  })
-
   fs.readdirSync(path.join(__dirname, 'endpoints'))
     .filter(file => file.indexOf('.') !== 0)
     .forEach((file) => {
       // eslint-disable-next-line global-require, import/no-dynamic-require
       const endpoint = require(path.join(__dirname, 'endpoints', file))(this)
-      this[endpoint.name] = endpoint
+      this[endpoint.path] = endpoint
     })
+
+  this.verifyWebhook = (signatureHeader, payload) => {
+    if (!this.webhookSecret) throw new Error('No webhook secret configured')
+
+    const { timestamp, hmac } = signatureHeader.split(',')
+      .reduce((signature, element) => {
+        const [key, value] = element.trim().split('=')
+        switch (key) {
+          case 't':
+            return { ...signature, timestamp: value }
+          case 'sha1':
+            return { ...signature, hmac: value }
+          default:
+            return signature
+        }
+      }, {})
+
+    const signedPayload = `${timestamp}.${payload}`
+
+    const digest = crypto.createHmac('sha1', this.webhookSecret)
+      .update(signedPayload)
+      .digest('hex')
+
+    return digest === hmac
+  }
 }
 
-module.exports = Rejoiner
+module.exports = Rejoiner2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rejoiner",
   "description": "Rejoiner REST API client wrapper for Node.js",
-  "version": "1.2.0",
+  "version": "2.10.2",
   "main": "lib/rejoiner.js",
   "author": "Sascha Bratton <sascha@brattonbratton.com>",
   "license": "MIT",
@@ -26,12 +26,15 @@
   "dependencies": {
     "axios": ">=0.18.1",
     "graceful-fs": "^4.1.11",
-    "lodash": "^4.17.13"
+    "lodash.merge": "^4.6.2"
   },
   "devDependencies": {
     "eslint": "^5.3.0",
     "eslint-config-airbnb-base": "^13.2.0",
     "eslint-plugin-import": "^2.17.2",
     "husky": "^0.14.3"
+  },
+  "engines": {
+    "node": ">=8.3.0"
   }
 }

package/lib/endpoints/contact.js

@@ -1,11 +0,0 @@
-const contactAddEndpoint = (client) => {
-  const endpoint = 'contact'
-
-  return {
-    name: endpoint,
-    add: data => client.dispatch.post(`${endpoint}_add`, data)
-      .then(res => res.data),
-  }
-}
-
-module.exports = contactAddEndpoint

package/lib/endpoints/lead.js

@@ -1,26 +0,0 @@
-const leadEndpoint = (client) => {
-  const endpoint = 'lead'
-
-  const postEmail = (path, email) => {
-    let data
-
-    if (typeof email === 'string') {
-      data = { email }
-    } else {
-      data = email
-    }
-
-    return client.dispatch.post(path, data).then(res => res.data)
-  }
-
-  return {
-    name: endpoint,
-    convert: data => client.dispatch.post(`${endpoint}/convert`, data)
-      .then(res => res.data),
-    cancel: email => postEmail(`${endpoint}/cancel`, email),
-    optIn: email => postEmail(`${endpoint}/opt_in`, email),
-    unsubscribe: email => postEmail(`${endpoint}/unsubscribe`, email),
-  }
-}
-
-module.exports = leadEndpoint