MA-1057 #time 6h Tests for email object

Author: Tim Noel

lib/SendGridCompatibility/Email.js

@@ -1,12 +1,20 @@
+'use strict';
+
 function Email(options){
-  self = options;
+  for (var option in options) {
+    this[option] = options[option];
+  }
 }
 
 Email.prototype.addTo = function (address){
-  if (typeof this.to === 'string'){
+  if (this.to === undefined){
+    this.to = address;
+  } else if (typeof this.to === 'string'){
     this.to = [this.to];
+    this.to.push(address);
+  } else {
+    this.to.push(address);
   }
-  this.to.push(address);
 };
 Email.prototype.setFrom = function (address){
   this.from = address;
@@ -21,12 +29,18 @@ Email.prototype.setHtml = function (html){
   this.html = html;
 };
 Email.prototype.addHeader = function (key, value){
+  if (this.headers === undefined){
+    this.headers = {};
+  }
   this.headers[key] = value;
 };
 Email.prototype.setHeaders = function (headers){
   this.headers = headers;
 };
 Email.prototype.addSubstitution = function (key, value){
+  if (this.sub === undefined){
+    this.sub = {};
+  }
   if (typeof value === 'string'){
     this.sub[key] = [value];
   } else {
@@ -37,30 +51,33 @@ Email.prototype.setSubstitutions = function (substitutions){
   this.sub = substitutions;
 };
 Email.prototype.addSection = function (key, value){
+  if (this.section === undefined){
+    this.section = {};
+  }
   this.section[key] = value;
 };
 Email.prototype.setSections = function (sections){
   this.section = sections;
 };
-Email.prototype.addUniqueArg = function (arg){
+Email.prototype.addUniqueArg = function (){
   throw new Error('Unique Argument compatibility is not supported.');
 };
-Email.prototype.setUniqueArgs = function (args){
+Email.prototype.setUniqueArgs = function (){
   throw new Error('Unique Argument compatibility is not supported.');
 };
-Email.prototype.addCategory = function (category){
+Email.prototype.addCategory = function (){
   throw new Error('Category compatibility is not supported.');
 };
-Email.prototype.setCategories = function (categories){
+Email.prototype.setCategories = function (){
   throw new Error('Category compatibility is not supported.');
 };
-Email.prototype.addFilter = function (filter){
+Email.prototype.addFilter = function (){
   throw new Error('Filter compatibility is not supported.');
 };
-Email.prototype.setFilters = function (filters){
+Email.prototype.setFilters = function (){
   throw new Error('Filter compatibility is not supported.');
 };
-Email.prototype.addFile = function (file){
+Email.prototype.addFile = function (){
   throw new Error('File compatibility is not supported.');
 };
 

lib/SendGridCompatibility/index.js

@@ -3,27 +3,55 @@
 var transmission = require('../transmission');
 var configuration = require('../configuration');
 
-var sendgrid = function(username, key, options) {
+var sendgrid = function(username, apiKey, options) {
   var configOptions = options;
   if (configOptions === undefined) {
-    configOptions = {'key': key};
+    configOptions = {key: apiKey};
   } else {
-    configOptions['key'] = key;
+    configOptions.key = apiKey;
   }
   configuration.setConfig(configOptions);
 };
 
+var mergeObjects = function(obj1, obj2){
+  var merged = {};
+  for (var key1 in obj1) {
+    merged[key1] = obj1[key1];
+  }
+  for (var key2 in obj2) {
+    merged[key2] = obj2[key2];
+  }
+  return merged;
+};
+
+var consolidateSubstitutionData = function(payload) {
+  var substitutionData = {};
+  if (payload.sub !== undefined && payload.section !== undefined){
+    substitutionData = mergeObjects(payload.sub, payload.section);
+  } else if (payload.sub !== undefined){
+    substitutionData = payload.sub;
+  } else if (payload.section !== undefined){
+    substitutionData = payload.section;
+  }
+  return substitutionData;
+};
+
 var translatePayload = function(payload) {
-  var input = {
+  var sub = consolidateSubstitutionData(payload)
+    , input = {
     recipients: [],
     from: '',
     html: '',
     text: '',
     subject: ''
-  }
+  };
 
   for (var i = 0; payload.to.length > i; i++){
-    var to = { address: { email: payload.to[i] } };
+    var to = {
+      address: {
+        email: payload.to[i]
+      }
+    };
     if (payload.toname !== undefined && payload.toname[i] !== undefined){
       to.address.name = payload.toname;
     }
@@ -38,19 +66,7 @@ var translatePayload = function(payload) {
   input.html = payload.html;
   input.replyTo = payload.replyto;
   input.customHeaders = payload.headers;
-  if (payload.sub !== undefined && payload.section !== undefined){
-    input.substitutionData = {};
-    for (var key in payload.sub) {
-      input.substitutionData[key] = payload.sub[key];
-    }
-    for (var key in payload.section) {
-      input.substitutionData[key] = payload.section[key];
-    }
-  } else if (payload.sub !== undefined){
-    input.substitutionData = payload.sub;
-  } else if (payload.section !== undefined){
-    input.substitutionData = payload.section;
-  }
+  input.substitutionData = (sub !== {}) ? sub : undefined;
   console.log(input);
 
   return input;
@@ -59,13 +75,15 @@ var translatePayload = function(payload) {
 sendgrid.prototype.send = function(payload, callback) {
   var translated = translatePayload(payload);
   transmission.send(translated, function (err, res){
-    if(err){
-      console.log(err);
+    if (err) {
+      callback(err);
+    } else {
+      callback(null, res);
     }
   });
 };
 
 sendgrid.prototype.Email = require('./Email');
-module.exports.Email = require('./Email');
+//module.exports.Email = require('./Email');
 
 module.exports = sendgrid;

test/mocha.opts

@@ -0,0 +1,3 @@
+--recursive
+--reporter spec
+--timeout 20000

test/spec/SendGridCompatibility/Email.js

@@ -0,0 +1,154 @@
+var chai = require('chai')
+  , expect = chai.expect
+  , sinon = require('sinon')
+  , sinonChai = require('sinon-chai')
+  , email = require('../../../lib/SendGridCompatibility/Email');
+
+chai.use(sinonChai);
+
+describe('SendGrid Email Object', function() {
+  var tmpEmail
+    , payload = {
+      to:       ['[email protected]', '[email protected]'],
+      toname:   ['Fakey Fakerson', 'Realy Realerson'],
+      from:     '[email protected]',
+      fromname: 'A. Sender',
+      subject:  'Sale',
+      text:     'Look at this sale!',
+      html:     '<h1>Look </h1><h5>at this sale!</h5>',
+      bcc:      ['[email protected]', '[email protected]'],
+      replyto:  '[email protected]',
+      date:     new Date(),
+      files: [
+        {
+          filename:     'name.txt',
+          path:         '../../../../../../',
+          url:          'www.google.com',
+          content:      '?'
+        }
+      ],
+      file_data:  {asdf: 'asdf'},
+      headers: {asdfasdf: 'asdfasdf'}
+    };
+
+  describe('instantiation', function() {
+    it('should handle empty input', function() {
+      tmpEmail = new email();
+      expect(Object.keys(tmpEmail).length).to.equal(0);
+    });
+    it('should handle a payload', function() {
+      tmpEmail = new email(payload);
+      for (var index in tmpEmail) {
+        if(typeof tmpEmail[index] !== 'function'){
+          expect(tmpEmail[index]).to.deep.equal(payload[index]);
+        }
+      }
+    });
+  });
+
+  describe('compatibility functions: ', function() {
+    beforeEach(function() {
+      tmpEmail = new email(payload);
+    });
+    it('addTo', function() {
+      tmpEmail.to = undefined;
+      tmpEmail.addTo('[email protected]');
+      tmpEmail.addTo('[email protected]');
+      tmpEmail.addTo('[email protected]');
+      expect(tmpEmail.to).to.deep.equal(['[email protected]','[email protected]','[email protected]']);
+    });
+    it('setFrom', function(){
+      tmpEmail.setFrom('[email protected]');
+      expect(tmpEmail.from).to.equal('[email protected]');
+    });
+    it('setSubject', function(){
+      tmpEmail.setSubject('new subject');
+      expect(tmpEmail.subject).to.equal('new subject');
+    });
+    it('setText', function(){
+      tmpEmail.setText('new text');
+      expect(tmpEmail.text).to.equal('new text');
+    });
+    it('setHtml', function(){
+      tmpEmail.setHtml('<p>new html</p>');
+      expect(tmpEmail.html).to.equal('<p>new html</p>');
+    });
+    it('addHeader', function(){
+      tmpEmail.headers = undefined;
+      tmpEmail.addHeader('abcd', 'efgh');
+      tmpEmail.addHeader('1234', '5678');
+      expect(tmpEmail.headers).to.deep.equal({abcd: 'efgh', 1234: '5678'});
+    });
+    it('setHeaders', function(){
+      tmpEmail.setHeaders({oldish: 'new'});
+      expect(tmpEmail.headers).to.deep.equal({oldish: 'new'});
+    });
+    it('addSubstitution', function(){
+      tmpEmail.addSubstitution('key', 'value');
+      tmpEmail.addSubstitution('attributeName', ['attribute1', 'attribute2']);
+      expect(tmpEmail.sub).to.deep.equal({key: ['value'], attributeName: ['attribute1', 'attribute2']});
+    });
+    it('setSubstitutions', function(){
+      tmpEmail.setSubstitutions({index: ['element']});
+      expect(tmpEmail.sub).to.deep.equal({index: ['element']});
+    });
+    it('addSection', function(){
+      tmpEmail.addSection('key', 'value');
+      tmpEmail.addSection('attributeName', 'attribute1');
+      expect(tmpEmail.section).to.deep.equal({key: 'value', attributeName: 'attribute1'});
+    });
+    it('setSections', function(){
+      tmpEmail.setSections({index: 'element'});
+      expect(tmpEmail.section).to.deep.equal({index: 'element'});
+    });
+    it('addUniqueArg', function(){
+      try {
+        tmpEmail.addUniqueArg();
+      } catch (err) {
+        expect(err).to.deep.equal(new Error('Unique Argument compatibility is not supported.'));
+      }
+    });
+    it('setUniqueArgs', function(){
+      try {
+        tmpEmail.setUniqueArgs();
+      } catch (err) {
+        expect(err).to.deep.equal(new Error('Unique Argument compatibility is not supported.'));
+      }
+    });
+    it('addCategory', function(){
+      try {
+        tmpEmail.addCategory();
+      } catch (err) {
+        expect(err).to.deep.equal(new Error('Category compatibility is not supported.'));
+      }
+    });
+    it('setCategories', function(){
+      try {
+        tmpEmail.setCategories();
+      } catch (err) {
+        expect(err).to.deep.equal(new Error('Category compatibility is not supported.'));
+      }
+    });
+    it('addFilter', function(){
+      try {
+        tmpEmail.addFilter();
+      } catch (err) {
+        expect(err).to.deep.equal(new Error('Filter compatibility is not supported.'));
+      }
+    });
+    it('setFilters', function(){
+      try {
+        tmpEmail.setFilters();
+      } catch (err) {
+        expect(err).to.deep.equal(new Error('Filter compatibility is not supported.'));
+      }
+    });
+    it('addFile', function(){
+      try {
+        tmpEmail.addFile();
+      } catch (err) {
+        expect(err).to.deep.equal(new Error('File compatibility is not supported.'));
+      }
+    });
+  });
+});

test/spec/SendGridCompatibility/index.spec.js

@@ -0,0 +1,49 @@
+var chai = require('chai')
+  , expect = chai.expect
+  , proxyquire = require('proxyquire')
+  , sinon = require('sinon')
+  , sinonChai = require('sinon-chai')
+  , configuration = require('../../../lib/configuration')
+  , MockRequest = require('../../mocks/request.js');
+
+chai.use(sinonChai);
+
+describe('SendGrid Compatibility', function() {
+  var sendgrid;
+
+  beforeEach(function() {
+    sendgrid = proxyquire('../../../lib/SendGridCompatibility', {
+      'request': MockRequest
+    });
+ });
+
+  describe('Instantiation', function() {
+    it('should expose a send function', function() {
+      expect(transmission.send).to.be.a.function;
+    });
+  });
+
+  describe('translatePayload Helper Method', function() {
+    var sendSpy;
+
+    beforeEach(function() {
+      sendSpy = sinon.spy(MockRequest, 'post');
+    });
+
+    afterEach(function() {
+      sendSpy.restore();
+    });
+
+    it('should default the return path for sparkpost users', function() {
+      sparkpost.send({}, function(err, res) {
+        expect(sendSpy.args[0][0].json.return_path).to.equal('[email protected]');
+      });
+    });
+
+    it('should allow on prem users to override the return path', function() {
+      transmission.send({returnPath: '[email protected]'}, function(err, res) {
+        expect(sendSpy.args[0][0].json.return_path).to.equal('[email protected]');
+      });
+    });
+  });
+});