leadconduit-batch 0.1.8 → 0.1.10

package/lib/delivery.js

@@ -1,14 +1,10 @@
 const flatten = require('flat').flatten;
 const _ = require('lodash');
-
+const baseUrl = require('@activeprospect/leadconduit-base-url');
 
 const encodeAuthentication = apiKey =>
   `Basic ${new Buffer(`API:${apiKey}`).toString('base64')}`;
 
-//
-// Request Function -------------------------------------------------------
-//
-
 const request = function(vars) {
 
   let key, value;
@@ -37,7 +33,7 @@ const request = function(vars) {
 
   return {
     method: 'POST',
-    url: `${getBaseUrl()}${vars.batch_id}/records`,
+    url: `${baseUrl('batch')}/batches/${vars.batch_id}/records`,
     headers: {
       Accept:        'application/json',
       Authorization:  encodeAuthentication(vars.activeprospect.api_key),
@@ -53,23 +49,12 @@ request.variables = function() {
     { name: 'batch.custom.*', type: 'wildcard', required: false }
   ];
 };
-
-//
-// Validate Function ------------------------------------------------------
-//
-
 const validate = function(vars) {
   if (_.isNil(vars.batch_id) || !vars.batch_id.match(/^[0-9a-fA-F]{24}$/)) {
     return 'must have a valid batch id';
   }
 };
 
-
-//
-// Response Function ------------------------------------------------------
-//
-
-
 const response = function(vars, req, res) {
   let event = {};
   switch (res.status) {
@@ -103,28 +88,6 @@ response.variables = function() {
   ];
 };
 
-//
-// Helpers ----------------------------------------------------------------
-//
-
-const getBaseUrl = function() {
-  switch (process.env.NODE_ENV) {
-    case 'production':
-    case 'test':
-      return 'https://batch.leadconduit.com/batches/';
-    case 'staging':
-      return 'https://batch.leadconduit-staging.com/batches/';
-    case 'development':
-      return 'https://batch.leadconduit-development.com/batches/';
-    default:
-      return 'http://batch.leadconduit.localhost/batches/';
-  }
-};
-
-//
-// Exports ----------------------------------------------------------------
-//
-
 module.exports = {
   validate,
   request,

package/package.json

@@ -1,30 +1,25 @@
 {
   "name": "leadconduit-batch",
   "description": "LeadConduit integration to send batch files",
-  "contributors": [
-    "Kelly Martin <kelly@activeprospect.com>",
-    "Jonathan Grayson <jonathan@activeprospect.com>"
-  ],
-  "version": "0.1.8",
+  "version": "0.1.10",
   "main": "index.js",
-  "license": "CC-BY-NC-ND-4.0",
+  "license": "UNLICENSED",
   "repository": {
     "type": "git",
     "url": "https://github.com/activeprospect/leadconduit-integration-batch"
   },
-  "engines": {
-    "node": ">=0.8.1"
-  },
   "scripts": {
-    "test": "NODE_ENV=test TZ=GMT ./node_modules/.bin/mocha --recursive --reporter spec --colors --timeout 10000 spec/"
+    "test": "mocha",
+    "fixlint": "eslint . --fix",
+    "lint": "eslint ."
   },
   "dependencies": {
-    "flat": "1.2.1",
+    "@activeprospect/leadconduit-base-url": "^1.0.0",
+    "flat": "^5.0.2",
     "lodash": "^4.17.4"
   },
   "devDependencies": {
-    "chai": ">= 1.9.0",
-    "leadconduit-integration": "^0.2.0",
-    "mocha": "^8.3.0"
+    "@activeprospect/integration-dev-dependencies": "^2.0.2",
+    "leadconduit-integration": "^0.6.3"
   }
 }

package/test/delivery-spec.js

@@ -0,0 +1,196 @@
+const assert = require('chai').assert;
+const integration = require('../lib/delivery');
+const parser = require('leadconduit-integration').test.types.parser(integration.request.variables());
+
+const withAPIKey = function(vars) {
+  vars.activeprospect = {
+    api_key: 'c9351ff49a8e38a23493c6b7328c7629'
+  };
+  return vars;
+};
+
+describe('Batch Request', function() {
+  beforeEach(function() {
+    this.vars = parser(
+      withAPIKey({
+        lead: {
+          email: 'foo@bar.com',
+          first_name: 'Joe',
+          state: null
+        },
+        batch_id: '57ed7d52d0c92f2077eaac1f',
+        foo: null,
+        batch: {
+          custom: {
+            email: 'bar@foo.com',
+            favorite_color: 'blue',
+            least_favorite_color: null
+          }
+        }
+      })
+    );
+    this.request = integration.request(this.vars);
+  });
+
+  afterEach(function() {
+    process.env.NODE_ENV = 'test';
+  });
+
+  it('should have url', function() {
+    assert.equal(this.request.url, 'https://batch.leadconduit.com/batches/57ed7d52d0c92f2077eaac1f/records');
+  });
+
+  it('uses the api_key in the auth header', function() {
+    assert.equal(this.request.headers.Authorization, 'Basic QVBJOmM5MzUxZmY0OWE4ZTM4YTIzNDkzYzZiNzMyOGM3NjI5');
+  });
+
+  it('should be POST', function() {
+    assert.equal(this.request.method, 'POST');
+  });
+
+  it('should set the content type to JSON', function() {
+    assert.equal(this.request.headers['Content-Type'], 'application/json');
+  });
+
+  it('should send the correct value of fields in lead', function() {
+    assert.equal(JSON.parse(this.request.body).first_name, 'Joe');
+  });
+
+  it('should send the correct value of custom fields', function() {
+    assert.equal(JSON.parse(this.request.body).favorite_color, 'blue');
+  });
+
+  it('should override lead values with batch.custom values of the same name', function() {
+    assert.equal(JSON.parse(this.request.body).email, 'bar@foo.com');
+  });
+
+  it('should not send null fields', function() {
+    assert.isUndefined(JSON.parse(this.request.body).state);
+    assert.isUndefined(JSON.parse(this.request.body).foo);
+    assert.isUndefined(JSON.parse(this.request.body).least_favorite_color);
+  });
+
+  it('should handle no custom fields', function() {
+    assert.isUndefined(JSON.parse(integration.request(withAPIKey({lead: {email: 'foo@bar.com'}, batch_id: '57ed7d52d0c92f2077eaac1f'})).body).favorite_color);
+  });
+
+  it('should delete batch_id from content', function() {
+    assert.isUndefined(JSON.parse(this.request.body).batch_id, 'batch_id is in body');
+  });
+
+  it('should set production url correctly', function() {
+    process.env.NODE_ENV = 'production';
+    assert.equal(integration.request(this.vars).url, 'https://batch.leadconduit.com/batches/57ed7d52d0c92f2077eaac1f/records');
+  });
+
+  it('should set staging url correctly', function() {
+    process.env.NODE_ENV = 'staging';
+    assert.equal(integration.request(this.vars).url, 'https://batch.leadconduit-staging.com/batches/57ed7d52d0c92f2077eaac1f/records');
+  });
+
+  it('should set development url correctly', function() {
+    process.env.NODE_ENV = 'development';
+    assert.equal(integration.request(this.vars).url, 'https://batch.leadconduit-development.com/batches/57ed7d52d0c92f2077eaac1f/records');
+  });
+
+  it('should set local url correctly', function() {
+    process.env.NODE_ENV = 'local';
+    assert.equal(integration.request(this.vars).url, 'http://batch.leadconduit.localhost/batches/57ed7d52d0c92f2077eaac1f/records');
+  });
+
+  describe('batch_id is set using custom wildcard', function() {
+
+    beforeEach(function() {
+      this.vars.batch.custom.batch_id = '457ed7d52d0c92f2077eaac1f';
+      this.request = integration.request(this.vars);
+    });
+
+    it('should set batch_id in content to the custom wildcard value', function() {
+      assert.equal(JSON.parse(this.request.body).batch_id, this.vars.batch.custom.batch_id);
+    });
+
+    it('should use base batch_id to set the url', function() {
+      assert.equal(this.request.url, 'https://batch.leadconduit.com/batches/57ed7d52d0c92f2077eaac1f/records');
+    });
+  });
+});
+
+describe('Validate Function', function() {
+
+  it('should not return valid when batch_id is missing', function() {
+    let vars = {
+      lead: { email: 'foo@bar.com' },
+      chair: 'Steelcase Leap'
+    };
+    assert.equal(integration.validate(vars), 'must have a valid batch id');
+  });
+
+  it('should not return valid when batch_id is an invalid format', function() {
+    let vars = { batch_id: '12345' };
+    assert.equal(integration.validate(vars), 'must have a valid batch id');
+  });
+
+  it('should not return valid when batch_id is an empty string', function() {
+    let vars = { batch_id: '' };
+    assert.equal(integration.validate(vars), 'must have a valid batch id');
+  });
+});
+
+describe('Response', function() {
+
+  describe('Success', function() {
+
+    it('should set a success outcome for a 200 status code', function() {
+      let res = { status: 200 };
+      let expected = { outcome: 'success' };
+      let response = integration.response({}, {}, res);
+      assert.deepEqual(expected, response);
+    });
+
+  });
+
+
+  describe('Error', function() {
+
+    it('should return invalid batch id error on 400 status code', function() {
+      let res = { status: 400 };
+      let expected = {
+        outcome: 'error',
+        reason: 'invalid batch id'
+      };
+      let response = integration.response({}, {}, res);
+      assert.deepEqual(expected, response);
+    });
+
+    it('should return unauthorized on 401 status code', function() {
+      let res = { status: 401 };
+      let expected = {
+        outcome: 'error',
+        reason: 'unauthorized'
+      };
+      let response = integration.response({}, {}, res);
+      assert.deepEqual(expected, response);
+    });
+
+    it('should return batch not found on 404 status code', function() {
+      let res = { status: 404 };
+      let expected = {
+        outcome: 'error',
+        reason: 'batch not found'
+      };
+      let response = integration.response({}, {}, res);
+      assert.deepEqual(expected, response);
+    });
+
+    it('should return unknown error on any status code other than 200 or 400', function() {
+      let res = { status: 500 };
+      let expected = {
+        outcome: 'error',
+        reason: 'unknown error: undefined'
+      };
+      let response = integration.response({}, {}, res);
+      assert.deepEqual(expected, response);
+    });
+  });
+
+});