Added setting debug in initialization (#188)

* Added setting debug to initialization

* Added note for debug about exposing api key

* Added note about no support for older nodejs versions

Author: aydrian

README.md

@@ -21,6 +21,8 @@ Before using this library, you must have:
 npm install sparkpost
 ```
 
+*Note: Node.js versions 0.10 and 0.12 are no longer supported. For versions < 4, please continue using [sparkpost v1.3.8](https://github.com/SparkPost/node-sparkpost/tree/1.3.8)* 
+
 ## Initialization
 **new SparkPost(apiKey[, options])** - Initialization
 
@@ -40,24 +42,25 @@ npm install sparkpost
     * Required: no
     * Type: `Object`
     * set headers that apply to all requests
+* `options.debug`
+    * Required: no
+    * Type: `Boolean`
+    * Default: `false`
+    * appends full response from request client as `debug` when `true` for debugging purposes<br/>
+    *Note: This will expose your api key to the client-side. Do not use in production.*
 
 ## Methods
-* **request(options[, callback]) &rarr; `{Promise}`**
+
+*Note: All methods return promises and accept an optional last argument callback. [Read about how we handle callbacks and promises](/docs/async.md).*
+
+* **request(options[, callback])**
     * `options` - [see request modules options](https://github.com/mikeal/request#requestoptions-callback)
     * `options.uri` - can either be a full url or a path that is appended to `options.origin` used at initialization ([url.resolve](http://nodejs.org/api/url.html#url_url_resolve_from_to))
     * `options.debug` - setting to `true` includes full response from request client for debugging purposes
-    * `callback` - executed after task is completed if provided*
-      * standard `callback(err, data)`
-      * `err` - any error that occurred
-      * `data` - results from API call
-      * `data.debug` - full response from request client when `options.debug` is `true`
-* **get | post | put | delete(options[, callback]) &rarr; `{Promise}`**
+* **get | post | put | delete(options[, callback])**
     * `options` - see request options
-    * `callback` - see request options
     * Request method will be overwritten and set to the same value as the name of these methods.
 
-*callback is optional because all methods return a Promise.
-
 ## Creating a SparkPost Client
 
 Passing in an API key

docs/async.md

@@ -11,9 +11,7 @@ let client = new SparkPost(key);
 
 client.templates.get(id)
   .then((data) => {
-    // this is either:
-    // a) the `results` key of the API response body, or
-    // b) the full API response body
+    // this the full API response body
   })
   .catch((err) => {
     // handle the sad error
@@ -33,8 +31,6 @@ client.templates.get(id, (err, data) => {
     return;
   }
 
-  // this is either:
-  // a) the `results` key of the API response body, or
-  // b) the full API response body
+  // this is the full API response body
 });
 ```

lib/sparkpost.js

@@ -10,7 +10,8 @@ var version = require('../package.json').version
 //REST API Config Defaults
 defaults = {
   origin: 'https://api.sparkpost.com:443',
-  apiVersion: 'v1'
+  apiVersion: 'v1',
+  debug: false
 };
 
 resolveUri = function(origin, uri) {
@@ -66,6 +67,7 @@ SparkPost = function(apiKey, options) {
   //Optional client config
   this.origin = options.origin;
   this.apiVersion = options.apiVersion || defaults.apiVersion;
+  this.debug = (typeof options.debug === 'boolean') ? options.debug : defaults.debug;
 
   this.inboundDomains = require('./inboundDomains')(this);
   this.messageEvents = require('./messageEvents')(this);
@@ -106,6 +108,9 @@ SparkPost.prototype.request = function(options, callback) {
     options.gzip = true;
   }
 
+  // set debug
+  options.debug = (typeof options.debug === 'boolean') ? options.debug : this.debug;
+
   return new Promise(function(resolve, reject) {
     request(options, function(err, res, body) {
       var invalidCodeRegex = /(5|4)[0-9]{2}/

test/spec/sparkpost.spec.js

@@ -1,12 +1,13 @@
+'use strict';
+
 var chai = require('chai')
   , expect = chai.expect
   , sinon = require('sinon')
-  , sinonChai = require('sinon-chai')
   , zlib = require('zlib')
   , nock = require('nock')
   , SparkPost = require('../../lib/sparkpost');
 
-chai.use(sinonChai);
+chai.use(require('sinon-chai'));
 
 describe('SparkPost Library', function() {
 
@@ -65,6 +66,21 @@ describe('SparkPost Library', function() {
     expect(client.origin).to.equal('https://dev.sparkpost.com');
   });
 
+  it('should allow debug to be set in options', function() {
+    const key = '12345678901234567890';
+    let options = {}
+      , client;
+
+    // testing default initialization
+    client = new SparkPost(key, options);
+    expect(client.debug).to.equal(false);
+
+    // testing setting flag
+    options.debug = true;
+    client = new SparkPost(key, options);
+    expect(client.debug).to.equal(true);
+  });
+
   describe('request method', function() {
     var client;