Add the ability for mailmason to generate and upload/update templates.

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .idea
-secrets.json
+config.json
+secrets.json

Gruntfile.js

@@ -3,35 +3,62 @@
  * 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',
+        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',
+        from: "<%= config.postmark.from %>",
+        to: "<%= config.postmark.to %>",
+        subject: "<%= config.postmark.subject %>",
         src: ['test/*.html']
       }
-    }
+    },
+
+    // you can either specify the template configuration here, or in templates.json
+    'postmark-templates-upload': config.templates && config.templates
+      ? config.templates.output_file || config.templates.file
+      : {
+        test_email: {
+          name: 'testing-postmark-templates-js1-' + new Date().valueOf(),
+          subject: 'Testing grunt-postmark-templates',
+          htmlBody: 'test/email.html',
+          textBody: 'test/email.txt',
+        },
+        test_email_again: {
+          name: 'testing-postmark-templates-js2-' + new Date().valueOf(),
+          subject: 'Testing grunt-postmark-templates',
+          htmlBody: 'test/email.html',
+          textBody: 'test/email.txt',
+        }
+      },
 
+    'postmark-templates-output': {
+      options: {
+        outputFile: '<%= config.templates.output_file || config.templates.file %>',
+        cleanOutput: '<%= config.templates.clean_output %>'
+      }
+    }
   });
 
   grunt.loadTasks('tasks');
 
-  grunt.registerTask('default', ['postmark']);
+  grunt.registerTask('default', ['postmark', 'postmark-templates']);
 
 };

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._
 

example_config.json

@@ -0,0 +1,17 @@
+// 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
+//
+// 3. Visit the following page for details:
+//    https://github.com/wildbit/mailmason/wiki/Getting-Started#configjson
+{
+  "postmark": {
+    "from": "[email protected]",
+    "to": "[email protected]",
+    "subject": "Test Email"
+  },
+  "templates": {
+    "file": "templates.json"
+  }
+}

example_secrets.json

@@ -0,0 +1,12 @@
+// 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
+//
+// 3. Visit the following page for details:
+//    https://github.com/wildbit/mailmason/wiki/Getting-Started#secretsjson
+{
+  "postmark": {
+    "server_token": "YOUR_POSTMARK_SERVER_TOKEN_HERE"
+  }
+}

tasks/grunt-postmark-templates.js

@@ -0,0 +1,118 @@
+/*
+ * grunt-postmark-templates
+ * push templates to a Postmark server for use with SendTemplatedEmail
+ *
+ * https://github.com/wildbit/grunt-postmark.git
+ */
+
+module.exports = function (grunt) {
+  grunt.registerMultiTask('postmark-templates-upload', 'Create or update Postmark templates', function () {
+    var done = this.async();
+    var options = this.options();
+    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) {
+      grunt.log.error('Missing template property "HtmlBody" \n');
+    }
+
+    if (!template.TextBody) {
+      grunt.log.error('Missing template property "TextBody" \n');
+    }
+
+    var postmark = require('postmark');
+    var client = new postmark.Client(serverToken);
+
+    // read the referenced files, but hold on to the original filenames
+    var expanded = Object.assign({}, template);
+
+    if (template.TemplateId) {
+      client.editTemplate(template.TemplateId, expanded, function (err, response) {
+        if (err && err.code === 1101) {
+          grunt.log.warn('Template ' + template.TemplateId + ' not found, so attempting create');
+          delete template.TemplateId;
+          delete expanded.TemplateId;
+          client.createTemplate(expanded, function (err, response) {
+            grunt.log.writeln('Template ' + template.Name + ' created: ' + JSON.stringify(response.TemplateId));
+            handleResponse(err, response, done, template);
+          });
+        } else {
+          grunt.log.writeln('Template ' + template.Name + ' updated: ' + JSON.stringify(response.TemplateId));
+          handleResponse(err, response, done, template);
+        }
+      });
+    } else {
+      client.createTemplate(expanded, function (err, response) {
+        grunt.log.writeln('Template ' + template.Name + ' created: ' + JSON.stringify(response.TemplateId));
+        handleResponse(err, response, done, template);
+      });
+    }
+
+  });
+
+  function handleResponse(err, response, done, template) {
+    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('updatedTemplates') || {};
+      updatedTemplates[template.Name] = template;
+      grunt.config.set('updatedTemplates', 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: false
+    });
+    var updatedTemplates = grunt.config('updatedTemplates');
+    var oldTemplates = grunt.file.read(options.outputFile);
+
+    Object.keys(updatedTemplates).forEach(function (updatedTemplateKey) {
+      updatedTemplates[updatedTemplateKey] = Object.assign(
+        oldTemplates[updatedTemplateKey] || {},
+        updatedTemplates[updatedTemplateKey]
+      );
+
+      if (options.cleanOutput) {
+        delete updatedTemplates[updatedTemplateKey].HtmlBody;
+        delete updatedTemplates[updatedTemplateKey].TextBody;
+      }
+    });
+
+    grunt.file.write(options.outputFile, JSON.stringify(updatedTemplates, null, 2));
+    grunt.log.writeln("Updated template information written to " + options.outputFile);
+
+  });
+
+  // you can also get a JSON report of uploaded templates
+  grunt.registerTask('postmark-templates', ['postmark-templates-upload', 'postmark-templates-output']);
+};

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();
   }
 

test/email.txt

@@ -0,0 +1 @@
+Hello from grunt-postmark-templates