Refine payload generation with a #generateResource method

There aren't many details in Drip's documentation on the required schema. Discovering the correct structure has been trial and error. This new method ensures payloads are structured correctly and paves the way for passing simpler payload objects to the client

Author: samudary

lib/campaigns.js

@@ -59,6 +59,6 @@ module.exports = {
    * @returns {promise}
    */
   subscribeToCampaign(campaignId, payload, callback) {
-    return this.post(`v2/${this.accountId}/campaigns/${campaignId}/subscribers`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/campaigns/${campaignId}/subscribers`, this.generateResource('subscribers', payload), callback);
   }
 };

lib/events.js

@@ -7,7 +7,7 @@ module.exports = {
    * @returns {promise}
    */
   recordEvent(payload, callback) {
-    return this.post(`v2/${this.accountId}/events`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/events`, this.generateResource('events', payload), callback);
   },
   /**
    * Record a batch of events
@@ -17,7 +17,7 @@ module.exports = {
    * @returns {promise}
    */
   recordBatchEvents(payload, callback) {
-    return this.post(`v2/${this.accountId}/events/batches`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/events/batches`, this.generateResource('events', payload), callback);
   },
   /**
    * Fetch a list of all event actions

lib/helpers.js

@@ -6,7 +6,7 @@ module.exports = {
     return encodeURIComponent(string);
   },
   checkRequiredFields(payload, requiredFields, personRequest = false) {
-    if (!requiredFields.every(prop => prop in payload)) {
+    if (!requiredFields.every((prop) => prop in payload)) {
       throw new MissingAttributeError(`Fields: ${requiredFields} should all be present`);
     }
 

lib/index.js

@@ -1,5 +1,6 @@
 const requestPromise = require('request-promise');
 
+// Resources
 const Accounts = require('./accounts');
 const Broadcasts = require('./broadcasts');
 const Campaigns = require('./campaigns');
@@ -14,8 +15,8 @@ const Subscriptions = require('./subscriptions');
 const Tags = require('./tags');
 const Triggers = require('./workflow_triggers');
 const Users = require('./users');
-const Workflows = require('./workflows');
 const Webhooks = require('./webhooks');
+const Workflows = require('./workflows');
 
 // Utilities
 const helper = require('./helpers');
@@ -34,13 +35,11 @@ class Client {
   }
 
   requestHeaders() {
-    const headers = {
+    return {
       'Content-Type': 'application/json',
       authorization: `${this.tokenType} ${this.token}`,
       'User-Agent': `Drip NodeJS Wrapper ${VERSION}`
     };
-
-    return headers;
   }
 
   request(requestOptions, callback) {
@@ -55,12 +54,15 @@ class Client {
     return requestPromise(requestOptions);
   }
 
+  generateResource(key, ...args) {
+    return { [key]: args };
+  }
+
   get(url, data, callback) {
     return this.request({
       method: 'GET',
       headers: this.requestHeaders(),
       uri: helper.baseUrl + url,
-      body: data.payload,
       qs: data.qs,
       json: true,
       resolveWithFullResponse: true
@@ -72,7 +74,7 @@ class Client {
       method: 'POST',
       headers: this.requestHeaders(),
       uri: helper.baseUrl + url,
-      body: data.payload,
+      body: data,
       qs: data.qs,
       json: true,
       resolveWithFullResponse: true
@@ -94,7 +96,7 @@ class Client {
       method: 'PUT',
       headers: this.requestHeaders(),
       uri: helper.baseUrl + url,
-      body: data.payload,
+      body: data,
       qs: data.qs,
       json: true,
       resolveWithFullResponse: true

lib/orders.js

@@ -8,18 +8,18 @@ module.exports = {
    * @returns {promise}
    */
   createUpdateOrder(payload, callback) {
-    return this.post(`v2/${this.accountId}/orders`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/orders`, this.generateResource('orders', payload), callback);
   },
   /**
    * Record a batch of orders
    * Docs: http://developer.drip.com/#create-or-update-a-batch-of-orders
    *
-   * @param {object} payload - An object of an array of multiple orders
+   * @param {object} payload - An array of multiple order objects
    * @param {callback} callback - An optional callback
    * @returns {promise}
    */
   createUpdateBatchOrders(payload, callback) {
-    return this.post(`v2/${this.accountId}/orders/batches`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/orders/batches`, this.generateResource('batches', { orders: payload }), callback);
   },
   /**
    * Record a refund for an order
@@ -30,6 +30,6 @@ module.exports = {
    * @returns {promise}
    */
   createUpdateRefund(payload, callback) {
-    return this.post(`v2/${this.accountId}/refunds`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/refunds`, this.generateResource('refunds', payload), callback);
   }
 };

lib/shopper_activity.js

@@ -13,7 +13,7 @@ module.exports = {
     const requiredFields = ['provider', 'action', 'cart_id', 'cart_url'];
     helpers.checkRequiredFields(payload, requiredFields, true);
 
-    return this.post(`v3/${this.accountId}/shopper_activity/cart`, { payload }, callback);
+    return this.post(`v3/${this.accountId}/shopper_activity/cart`, payload, callback);
   },
   /**
    * Create or update an order for a customer
@@ -27,7 +27,7 @@ module.exports = {
     const requiredFields = ['provider', 'action', 'order_id'];
     helpers.checkRequiredFields(payload, requiredFields);
 
-    return this.post(`v3/${this.accountId}/shopper_activity/order`, { payload }, callback);
+    return this.post(`v3/${this.accountId}/shopper_activity/order`, payload, callback);
   },
   /**
    * Create or update a product
@@ -41,6 +41,6 @@ module.exports = {
     const requiredFields = ['provider', 'action', 'product_id', 'name', 'price', 'product_variant_id'];
     helpers.checkRequiredFields(payload, requiredFields);
 
-    return this.post(`v3/${this.accountId}/shopper_activity/product`, { payload }, callback);
+    return this.post(`v3/${this.accountId}/shopper_activity/product`, payload, callback);
   }
 };

lib/subscribers.js

@@ -20,7 +20,7 @@ module.exports = {
    * @returns {promise}
    */
   createUpdateSubscriber(payload, callback) {
-    return this.post(`v2/${this.accountId}/subscribers`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/subscribers`, this.generateResource('subscribers', payload), callback);
   },
   /**
    * Fetch a subscriber
@@ -53,7 +53,7 @@ module.exports = {
    * @returns {promise}
    */
   unsubscribeBatchSubscribers(payload, callback) {
-    return this.post(`v2/${this.accountId}/unsubscribes/batches`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/unsubscribes/batches`, this.generateResource('batches', { subscribers: payload }), callback);
   },
   /**
    * Unsubscribe a subscriber from all mailings

lib/tags.js

@@ -18,7 +18,7 @@ module.exports = {
    * @returns {promise}
    */
   tagSubscriber(payload, callback) {
-    return this.post(`v2/${this.accountId}/tags`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/tags`, this.generateResource('tags', payload), callback);
   },
   /**
    * Remove a tag from a subscriber

lib/version.js

@@ -1 +1 @@
-module.exports = '2.1.3';
+module.exports = '3.0.0';

lib/webhooks.js

@@ -27,7 +27,7 @@ module.exports = {
    * @returns {promise}
    */
   createWebhook(payload, callback) {
-    return this.post(`v2/${this.accountId}/webhooks`, { payload }, callback);
+    return this.post(`v2/${this.accountId}/webhooks`, this.generateResource('webhooks', payload), callback);
   },
   /**
    * Destroy a webhook