ActiveCampaign · derekrushforth · Jan 13, 2018 · Dec 14, 2016 · Dec 14, 2016 · Dec 14, 2016
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 node_modules
 .idea
-secrets.json
+config.json
+secrets.json
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -3,35 +3,69 @@
  * https://github.com/wildbit/grunt-postmark.git
  */
 
-module.exports = function(grunt) {
+module.exports = function (grunt) {
+  var secret = grunt.file.readJSON('secrets.json');
+  var config = grunt.file.readJSON('config.json');
 
   grunt.initConfig({
-    secrets: grunt.file.readJSON('secrets.json'),
+    secret: secret,
+    config: config,
 
     /* Postmark
-    ------------------------------------------------- */
+     ------------------------------------------------- */
     postmark: {
       options: {
-        serverToken: '<%= secrets.serverToken %>'
+        serverToken: "<%= secret.postmark.server_token %>"
       },
       email: {
-        from: '[email protected]',
-        to: '[email protected]',
-        subject: 'Yo',
-        src: ['test/email.html']
+        from: "<%= config.postmark.from %>",
+        to: "<%= config.postmark.to %>",
+        subject: "<%= config.postmark.subject %>",
+        src: ["test/email.html"]
       },
       bulk: {
-        from: '[email protected]',
-        to: '[email protected]',
-        subject: 'Hey',
-        src: ['test/*.html']
+        from: "<%= config.postmark.from %>",
+        to: "<%= config.postmark.to %>",
+        subject: "<%= config.postmark.subject %>",
+        src: ["test/*.html"]
       }
-    }
+    },
+
+    "postmark-templates-upload": {
+      options: {
+        ephemeralUploadResultsProperty: "<%= config.templates && config.templates.ephemeralUploadResultsProperty %>"
+      },
+      test_email: {
+        name: "testing-postmark-templates-js1-" + new Date().valueOf(),
+        subject: "Testing grunt-postmark-templates",
+        htmlSrc: "test/email.html",
+        textSrc: "test/email.txt"
+      },
+      test_email_again: {
+        name: "testing-postmark-templates-js2-" + new Date().valueOf(),
+        subject: "Testing grunt-postmark-templates (again)",
+        htmlSrc: "test/email.html",
+        textSrc: "test/email.txt"
+      },
+      test_email_inline_body: {
+        name: "testing-postmark-templates-js3-" + new Date().valueOf(),
+        subject: "Testing grunt-postmark-templates (inline body)",
+        htmlBody: "<html><body><h1>Another email test</h1></body></html>",
+        textBody: "Hello from grunt-postmark-templates\n"
+      }
+    },
 
+    "postmark-templates-output": {
+      options: {
+        cleanOutput: "<%= config.templates && config.templates.cleanOutput %>",
+        outputFile: "<%= config.templates && config.templates.outputFile %>",
+        ephemeralUploadResultsProperty: "<%= config.templates && config.templates.ephemeralUploadResultsProperty %>"
+      },
+    }
   });
 
-  grunt.loadTasks('tasks');
+  grunt.loadTasks("tasks");
 
-  grunt.registerTask('default', ['postmark']);
+  grunt.registerTask("default", ["postmark", "postmark-templates"]);
 
 };
diff --git a/README.md b/README.md
@@ -20,6 +20,8 @@ After the plugin is installed, it can be enabled in your Gruntfile:
 grunt.loadNpmTasks('grunt-postmark');
 ```
 
+You'll need to add a [`config.json`](https://github.com/wildbit/mailmason/wiki/Getting-Started#create-configjson-required) and a [`secrets.json`](https://github.com/wildbit/mailmason/wiki/Getting-Started#create-secretsjson-optional) per the `mailmason` configuration.
+
 ## Postmark task
 _Run this task with the `grunt postmark` command._
 

diff --git a/example_config.json b/example_config.json
@@ -0,0 +1,16 @@
+// 1. Copy this file to "config.json" for your own version that won't be
+//    tracked in source control.
+//
+// 2. Delete these comments from the configuration so Grunt doesn't get confused
+{
+  "postmark": {
+    "from": "[email protected]",
+    "to": "[email protected]",
+    "subject": "Test Email"
+  },
+  "templates": {
+    "ephemeralUploadResultsProperty": "postmark-templates-upload-results",
+    "cleanOutput": true,
+    "outputFile": "templates.json"
+  }
+}
diff --git a/example_secrets.json b/example_secrets.json
@@ -0,0 +1,9 @@
+// 1. Copy this file to "secrets.json" for your own version that won't be
+//    tracked in source control.
+//
+// 2. Delete these comments from the configuration so Grunt doesn't get confused
+{
+  "postmark": {
+    "server_token": "YOUR_POSTMARK_SERVER_TOKEN_HERE"
+  }
+}
diff --git a/secrets_example.json b/secrets_example.json
diff --git a/tasks/grunt-postmark-templates.js b/tasks/grunt-postmark-templates.js
@@ -0,0 +1,138 @@
+/*
+ * grunt-postmark-templates
+ * push templates to a Postmark server for use with SendTemplatedEmail
+ *
+ * https://github.com/wildbit/grunt-postmark.git
+ */
+
+module.exports = function (grunt) {
+  var DEFAULT_EPHEMERAL_UPLOAD_RESULTS_PROPERTY = 'postmark-templates-upload-results';
+  var DEFAULT_OUTPUT_FILE_NAME = 'templates.json';
+  var DEFAULT_CLEAN_OUTPUT = false;
+
+  grunt.registerMultiTask('postmark-templates-upload', 'Create or update Postmark templates', function () {
+    var done = this.async();
+    var options = this.options({
+      ephemeralUploadResultsProperty: DEFAULT_EPHEMERAL_UPLOAD_RESULTS_PROPERTY
+    });
+    var ephemeralUploadResultsProperty = options.ephemeralUploadResultsProperty || DEFAULT_EPHEMERAL_UPLOAD_RESULTS_PROPERTY;
+    var template = this.data;
+
+    var serverToken = options.serverToken || grunt.config('secret.postmark.server_token');
+
+    if (!serverToken) {
+      grunt.fail.warn('Missing Postmark server token \n');
+    }
+
+    if (!template.name) {
+      grunt.fail.warn('Missing required template property "name" \n');
+    }
+
+    if (!template.subject) {
+      grunt.fail.warn('Missing required template property "subject" \n');
+    }
+
+    if (!template.htmlBody && !template.htmlSrc) {
+      grunt.log.error('Missing template property "htmlBody" or "htmlSrc"\n');
+    }
+
+    if (!template.textBody && !template.textSrc) {
+      grunt.log.error('Missing template property "textBody" or "textSrc"\n');
+    }
+
+    var postmark = require('postmark');
+    var client = new postmark.Client(serverToken);
+
+    // read the referenced files, but hold on to the original filenames
+    var expanded = {
+      Name: template.name,
+      Subject: template.subject,
+      HtmlBody: template.htmlBody || grunt.file.read(template.htmlSrc),
+      TextBody: template.textBody || grunt.file.read(template.textSrc),
+      TemplateId: template.templateId,
+    };
+
+    if (expanded.TemplateId) {
+      client.editTemplate(expanded.TemplateId, expanded, function (err, response) {
+        if (err && err.code === 1101) {
+          grunt.log.warn('Template ' + expanded.TemplateId + ' not found, so attempting create');
+          delete template.templateId;
+          delete expanded.TemplateId;
+          client.createTemplate(expanded.TemplateId, function (err, response) {
+            grunt.log.writeln('Template ' + expanded.Name + ' created: ' + JSON.stringify(response.TemplateId));
+            handleResponse(err, done, response, template, ephemeralUploadResultsProperty);
+          });
+        } else {
+          grunt.log.writeln('Template ' + expanded.Name + ' updated: ' + JSON.stringify(response.TemplateId));
+          handleResponse(err, done, response, template, ephemeralUploadResultsProperty);
+        }
+      });
+    } else {
+      client.createTemplate(expanded, function (err, response) {
+        grunt.log.writeln('Template ' + expanded.Name + ' created: ' + JSON.stringify(response.TemplateId));
+        handleResponse(err, done, response, template, ephemeralUploadResultsProperty);
+      });
+    }
+  });
+
+  function handleResponse(err, done, response, template, ephemeralUploadResultsProperty) {
+    if (err){
+      errorMessage(err);
+      done();
+    } else {
+      template.templateId = response.TemplateId;
+      // compile the templates for use by the `postmark-templates-output` task
+      var updatedTemplates = grunt.config.get(ephemeralUploadResultsProperty) || {};
+      updatedTemplates[template.name] = template;
+      grunt.config.set(ephemeralUploadResultsProperty, updatedTemplates);
+
+      done();
+    }
+  }
+
+  function errorMessage(err) {
+    if (err.message) {
+      grunt.log.warn('Error: ' + err.message);
+    } else {
+      grunt.log.warn('Error: ' + JSON.stringify(err));
+    }
+  }
+
+  // invoke this task after postmark-templates to get an output file containing the resulting template IDs
+  // this is in the same format as the postmark-templates config.
+
+  grunt.registerTask('postmark-templates-output', 'Write out the resulting template IDs', function () {
+    var options = this.options({
+      cleanOutput: DEFAULT_CLEAN_OUTPUT,
+      outputFile: DEFAULT_OUTPUT_FILE_NAME,
+      ephemeralUploadResultsProperty: DEFAULT_EPHEMERAL_UPLOAD_RESULTS_PROPERTY
+    });
+    var ephemeralUploadResultsProperty = options.ephemeralUploadResultsProperty || DEFAULT_EPHEMERAL_UPLOAD_RESULTS_PROPERTY;
+    var outputFile = options.outputFile || DEFAULT_OUTPUT_FILE_NAME;
+    var cleanOutput = options.cleanOutput || DEFAULT_CLEAN_OUTPUT;
+    var updatedTemplates = grunt.config(ephemeralUploadResultsProperty);
+    var oldTemplates = grunt.file.exists(outputFile)
+      ? grunt.file.read(outputFile)
+      : {};
+
+    Object.keys(updatedTemplates).forEach(function (updatedTemplateKey) {
+      updatedTemplates[updatedTemplateKey] = Object.assign(
+        oldTemplates[updatedTemplateKey] || {},
+        updatedTemplates[updatedTemplateKey]
+      );
+
+      if (cleanOutput) {
+        delete updatedTemplates[updatedTemplateKey].htmlBody;
+        delete updatedTemplates[updatedTemplateKey].textBody;
+        delete updatedTemplates[updatedTemplateKey].htmlSrc;
+        delete updatedTemplates[updatedTemplateKey].textSrc;
+      }
+    });
+
+    grunt.file.write(outputFile, JSON.stringify(updatedTemplates, null, 2));
+    grunt.log.writeln("Updated template information written to " + outputFile);
+  });
+
+  // you can also get a JSON report of uploaded templates
+  grunt.registerTask('postmark-templates', ['postmark-templates-upload', 'postmark-templates-output']);
+};
diff --git a/tasks/grunt-postmark.js b/tasks/grunt-postmark.js
@@ -3,18 +3,18 @@
  * https://github.com/wildbit/grunt-postmark.git
  */
 
-'use strict';
-
 module.exports = function(grunt) {
 
+  'use strict';
+
   grunt.registerMultiTask('postmark', 'Send emails through Postmark', function() {
 
     var done = this.async();
     var options = this.options();
     var _data = this.data;
 
     // Check for server token
-    if (!options.serverToken && !_data.serverToken) { 
+    if (!options.serverToken && !_data.serverToken) {
       grunt.fail.warn('Missing Postmark server token \n');
     }
 
@@ -25,8 +25,8 @@ module.exports = function(grunt) {
     if (this.files.length > 0) {
 
       var message = {
-        'From': _data.from || options.from, 
-        'To': _data.to || options.to, 
+        'From': _data.from || options.from,
+        'To': _data.to || options.to,
         'Subject': _data.subject || options.subject
       };
 
@@ -56,7 +56,7 @@ module.exports = function(grunt) {
           handleResponse(err, response, done);
         });
       }
-    
+
     } else {
       // Warn about no files being passed to task
       grunt.log.warn('No src file found \n');
@@ -66,7 +66,13 @@ module.exports = function(grunt) {
 
 
   function handleResponse(err, response, done) {
-    err ? errorMessage(err) : successMessage(response);
+    if (err) {
+      errorMessage(err);
+
+    } else {
+      successMessage(response);
+    }
+
     done();
   }
 

diff --git a/test/email.txt b/test/email.txt
@@ -0,0 +1 @@
+Hello from grunt-postmark-templates