Merge pull request #49 from aydrian/ISSUE-48

aydrian · aydrian · commit 7ed788fcb5c7 · 2015-05-12T07:46:52.000-07:00
Issue 48 Add Grunt Bump
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -17,7 +17,7 @@ module.exports = function(grunt) {
   // Configure existing grunt tasks and create custom ones
   grunt.initConfig({
     config: config,
-
+    pkg: grunt.file.readJSON('package.json'),
     jshint: {
       files: [
         'index.js',
@@ -29,7 +29,21 @@ module.exports = function(grunt) {
         jshintrc: './.jshintrc'
       }
     },
-
+    bump: {
+      options: {
+        files: [ 'package.json' ]
+        , updateConfigs: [ 'pkg' ]
+        , commit: true
+        , commitMessage: 'Release %VERSION%'
+        , commitFiles: [ 'package.json', 'README.md' ]
+        , createTag: true
+        , tagName: '%VERSION%'
+        , tagMessage: '%VERSION%'
+        , push: true
+        , pushTo: 'upstream'
+        , gitDescribeOptions: '--tags --always --abbrev=1 --dirty=-d'
+      }
+    },
     shell: {
       test: {
         command : '<%= config.binPath %>/istanbul cover --report lcov --dir test/reports/ <%= config.binPath %>/_mocha test/spec -- --reporter ' + reporter,
diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ Click on the desired API to see usage and more information
 * [Sending Domains](/docs/resources/sendingDomains.md) - `client.sendingDomains` ([examples](/examples/sendingDomains))
 * [Suppression List](/docs/resources/suppressionList.md) - `client.suppressionList` ([examples](/examples/suppressionList))
 * [Templates](/docs/resources/templates.md) - `client.templates` ([examples](/examples/templates))
-* [Transmissions](/docs/apis/transmission.md) - `client.transmission` ([examples](/examples/transmission))
+* [Transmissions](/docs/apis/transmissions.md) - `client.transmission` ([examples](/examples/transmissions))
 * [Webhooks](/docs/resources/webhooks.md) - `client.webhooks` ([examples](/examples/webhooks))
 
 
diff --git a/docs/resources/transmissions.md b/docs/resources/transmissions.md
@@ -39,7 +39,7 @@ trans.substitutionData = {name: 'YOUR FIRST NAME'};
 trans.recipients = [{ address: { name: 'YOUR FULL NAME', email: 'YOUR EMAIL ADDRESS' } }];
 
 // Send it off into the world!
-client.transmission.send(trans, function(err, res) {
+client.transmissions.send(trans, function(err, res) {
   if (err) {
     console.log('Whoops! Something went wrong');
     console.log(err);
diff --git a/examples/transmissions/get_all_transmissions.js b/examples/transmissions/get_all_transmissions.js
@@ -4,7 +4,7 @@ var key = 'YOURAPIKEY'
   , SparkPost = require('sparkpost')
   , client = new SparkPost(key);
 
-client.transmission.all(function(err, res) {
+client.transmissions.all(function(err, res) {
   if (err) {
     console.log(err);
   } else {
diff --git a/examples/transmissions/get_transmission.js b/examples/transmissions/get_transmission.js
@@ -4,7 +4,7 @@ var key = 'YOURAPIKEY'
   , SparkPost = require('sparkpost')
   , client = new SparkPost(key);
 
-client.transmission.find('YOUR-TRANSMISSION-KEY', function(err, res) {
+client.transmissions.find('YOUR-TRANSMISSION-KEY', function(err, res) {
   if (err) {
     console.log(err);
   } else {
diff --git a/examples/transmissions/mime_parts.js b/examples/transmissions/mime_parts.js
@@ -14,7 +14,7 @@ var trans = {
   trackClicks: true
 };
 
-client.transmission.send(trans, function(err, res) {
+client.transmissions.send(trans, function(err, res) {
   if (err) {
     console.log(err);
   } else {
diff --git a/examples/transmissions/rfc822.js b/examples/transmissions/rfc822.js
@@ -11,7 +11,7 @@ var trans = {
   subject: 'Example Email for RFC-822 Content'
 };
 
-client.transmission.send(trans, function(err, res) {
+client.transmissions.send(trans, function(err, res) {
   if (err) {
     console.log(err);
   } else {
diff --git a/examples/transmissions/send_transmission_all_fields.js b/examples/transmissions/send_transmission_all_fields.js
@@ -35,7 +35,7 @@ var trans = {
   ]
 };
 
-client.transmission.send(trans, function(err, res) {
+client.transmissions.send(trans, function(err, res) {
   if (err) {
     console.log(err);
   } else {
diff --git a/examples/transmissions/stored_recipients_inline_content.js b/examples/transmissions/stored_recipients_inline_content.js
@@ -12,7 +12,7 @@ var trans = {
   text: 'Hello World!'
 };
 
-client.transmission.send(trans, function(err, res) {
+client.transmissions.send(trans, function(err, res) {
   if (err) {
     console.log(err);
   } else {
diff --git a/examples/transmissions/stored_recipients_stored_content.js b/examples/transmissions/stored_recipients_stored_content.js
@@ -12,7 +12,7 @@ var trans = {
   recipients: [{ address: { email: 'john.doe@example.com' } }]
 };
 
-client.transmission.send(trans, function(err, res) {
+client.transmissions.send(trans, function(err, res) {
   if (err) {
     console.log(err);
   } else {
diff --git a/examples/transmissions/stored_template_send.js b/examples/transmissions/stored_template_send.js
@@ -11,7 +11,7 @@ var trans = {
   recipients: [{ address: { email: 'john.doe@example.com' } }]
 };
 
-client.transmission.send(trans, function(err, res) {
+client.transmissions.send(trans, function(err, res) {
   if (err) {
     console.log(err);
   } else {
diff --git a/lib/SendGridCompatibility/index.js b/lib/SendGridCompatibility/index.js
@@ -119,7 +119,7 @@ var translatePayload = function(payload) {
  */
 sendgrid.prototype.send = function(payload, callback) {
   var translated = translatePayload(payload);
-  this.client.transmission.send(translated, callback);
+  this.client.transmissions.send(translated, callback);
 };
 
 sendgrid.prototype.Email = require('./Email');
diff --git a/lib/sparkpost.js b/lib/sparkpost.js
@@ -59,7 +59,7 @@ var SparkPost = function(apiKey, options) {
   this.sendingDomains = require('./sendingDomains')(this);
   this.suppressionList = require('./suppressionList')(this);
   this.templates = require('./templates')(this);
-  this.transmission = require('./transmission')(this);
+  this.transmissions = require('./transmissions')(this);
   this.webhooks = require('./webhooks')(this);
 };
 
diff --git a/lib/transmissions.js b/lib/transmissions.js
diff --git a/package.json b/package.json
@@ -19,6 +19,7 @@
   "devDependencies": {
     "chai": "1.9.1",
     "grunt": "0.4.5",
+    "grunt-bump": "^0.3.1",
     "grunt-contrib-jshint": "0.10.0",
     "grunt-shell": "1.1.1",
     "istanbul": "0.3.2",
diff --git a/test/spec/SendGridCompatibility/index.spec.js b/test/spec/SendGridCompatibility/index.spec.js
@@ -9,7 +9,7 @@ chai.use(sinonChai);
 
 describe('SendGrid Compatibility', function() {
   var sendgrid = new sendGridCompatibility('asdf', 'asdf')
-    , transmission = sendgrid.client.transmission
+    , transmissions = sendgrid.client.transmissions
     , payload = {
       to:       ['fake@email.org', 'real@notreally.net'],
       toname:   ['Fakey Fakerson', 'Realy Realerson'],
@@ -77,14 +77,14 @@ describe('SendGrid Compatibility', function() {
     var sendSpy, scope;
 
     beforeEach(function() {
-      sendSpy = sinon.spy(transmission, 'send');
+      sendSpy = sinon.spy(transmissions, 'send');
       scope = nock('https://api.sparkpost.com')
         .post('/api/v1/transmissions')
         .reply(200, { ok: true });
     });
 
     afterEach(function() {
-      transmission.send.restore(); // restoring function
+      transmissions.send.restore(); // restoring function
     });
 
     it('should handle an absence of toname', function(done) {
diff --git a/test/spec/transmissions.spec.js b/test/spec/transmissions.spec.js
@@ -14,7 +14,7 @@ describe('Transmissions Library', function() {
       post: sinon.stub().yields()
     };
 
-    transmission = require('../../lib/transmission')(client);
+    transmission = require('../../lib/transmissions')(client);
   });
 
   describe('all Method', function() {

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ var trans = {`
`35`	`35`	`]`
`36`	`36`	`};`
`37`	`37`
`38`		`-client.transmission.send(trans, function(err, res) {`
	`38`	`+client.transmissions.send(trans, function(err, res) {`
`39`	`39`	`if (err) {`
`40`	`40`	`console.log(err);`
`41`	`41`	`} else {`