Added helper method for url construction and changed storedTemplate to template based on code review feedback

Author: Jessica Martin

README.md

@@ -61,15 +61,15 @@ sparkpost.transmission.send(trans, function(err, res) {
 | replyTo          | no          | Field for specifying the email address that should be used when a recipient hits the reply button                          | String           |
 | subject          | yes         | Field for setting the subject line of a given transmission                                                                 | String           |
 | from             | yes         | Field for setting the from line of a given transmission                                                                    | String or Object |
-| html             | yes**          | Field for setting the HTML content of a given transmission                                                                 | String           |
-| text             | yes**        | Field for setting the Plain Text content of a given transmission                                                           | String           |
-| rfc822           | no**          | Field for setting the RFC-822 encoded content of a given transmission                                                      | String           |
-| storedTemplate   | no**          | Field for specifying the Template ID of a stored template to be used when sending a given transmission                     | String           |
+| html             | yes**       | Field for setting the HTML content of a given transmission                                                                 | String           |
+| text             | yes**       | Field for setting the Plain Text content of a given transmission                                                           | String           |
+| rfc822           | no**        | Field for setting the RFC-822 encoded content of a given transmission                                                      | String           |
+| template         | no**        | Field for specifying the Template ID of a stored template to be used when sending a given transmission                     | String           |
 | customHeaders    | no          | Field for specifying additional headers to be applied to a given transmission (other than Subject, From, To, and Reply-To) | Object (Simple)  |
-| recipients       | yes**         | Field for specifying who a given transmission should be sent to                                                            | Array of Objects |
-| recipientList    | no**          | Field for specifying a stored recipient list ID to be used for a given transmission                                        | String           |
+| recipients       | yes**       | Field for specifying who a given transmission should be sent to                                                            | Array of Objects |
+| recipientList    | no**        | Field for specifying a stored recipient list ID to be used for a given transmission                                        | String           |
 
-** - If using inline content then html or text are required. If using RFC-822 Inline Content, then rfc822 is required. If using a stored recipient list, then recipientList is required. If using a stored template, then storedTemplate is required.
+** - If using inline content then html or text are required. If using RFC-822 Inline Content, then rfc822 is required. If using a stored recipient list, then recipientList is required. If using a stored template, then template is required.
 
 ## Tips and Tricks
 ### General

examples/transmission/stored_recipients_stored_content.js

@@ -7,7 +7,7 @@ var trans = {
   from: 'From Envelope <[email protected]>',
   subject: 'Example Email for Stored List and Template',
   recipientList: 'example-list',
-  storedTemplate: 'my-template',
+  template: 'my-template',
   recipients: [{ address: { email: '[email protected]' } }]
 };
 

examples/transmission/stored_template_send.js

@@ -4,10 +4,10 @@ var key = 'YOURAPIKEY'
   , sparkpost = require('sparkpost')({ key: key });
 
 var trans = {
-  storedTemplate: 'my-template',
+  template: 'my-template',
   from: 'From Envelope <[email protected]>',
   subject: 'Example Email for Stored Template',
-  recipients = [{ address: { email: '[email protected]' } }]
+  recipients: [{ address: { email: '[email protected]' } }]
 };
 
 sparkpost.transmission.send(trans, function(err, res) {

lib/transmission.js

@@ -17,7 +17,8 @@ var request = require('request')
 var toApiFormat = function(input) {
   var model = {
     content: {},
-    options: {}
+    options: {},
+    recipients: {}
   };
 
   model.description = input.description;
@@ -36,15 +37,24 @@ var toApiFormat = function(input) {
   model.content.html = input.html;
   model.content.text = input.text;
   model.content.email_rfc822 = input.rfc822;
-  model.content.template_id = input.storedTemplate;
+  model.content.template_id = input.template;
   model.content.headers = input.customHeaders;
 
-  model.recipients = input.recipients;
   model.recipients.list_id = input.recipientList;
+  model.recipients = input.recipients;
 
   return model;
 };
 
+/**
+ * Private Method for putting URL construction logic into one place
+ *
+ * @returns string Fully constructed URL for contacting the Transmissions API
+ */
+var constructURL = function () {
+  return config.options.protocol + '://' + config.options.host + (config.options.port ? ':' + config.options.port: '') + '/api/' + config.options.version + '/transmissions';
+};
+
 /**
  *  Private Method for issuing GET request to Transmissions API
  *
@@ -59,7 +69,7 @@ var toApiFormat = function(input) {
 var fetch = function(transmissionID, callback) {
   var cb = callback
     , options = {
-      url: config.options.protocol + '://' + config.options.host + (config.options.port ? ':' + config.options.port: '') + '/api/' + config.options.version + '/transmissions',
+      url: constructURL(),
       headers: {
         authorization: config.options.key
       },
@@ -100,7 +110,7 @@ module.exports = {
     var mappedInput = toApiFormat(transmissionBody);
 
     var options = {
-      url: config.options.protocol + '://' + config.options.host + (config.options.port ? ':' + config.options.port: '') + '/api/' + config.options.version + '/transmissions',
+      url: constructURL(),
       json: mappedInput,
       headers: {
         authorization: config.options.key