Cleaner request object initialization; Ability to use http for testing

Author: thinkingserious

CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.1.0] - 2016-06-08
+### Added
+- Cleaner request object initialization
+- Ability to use http for testing
+
 ## [2.0.0] - 2016-06-06
 ### Changed
 - Made the Request and Response variables non-redundant. e.g. request.requestBody becomes request.body

README.md

@@ -19,8 +19,7 @@ npm install sendgrid-rest
 ```javascript
 var Client = require('sendgrid-rest').Client
 var client = new Client()
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = client.emptyRequest()
 var param = 'myparam'
 request.host = 'api.example.com'
 request.method = 'GET'
@@ -37,8 +36,7 @@ client.API(request, function (response) {
 ```javascript
 var Client = require('sendgrid-rest').Client
 var client = new Client()
-var emptyRequest = require('sendgrid-rest').request
-var request = JSON.parse(JSON.stringify(emptyRequest))
+var request = client.emptyRequest()
 request.host = 'api.example.com'
 request.headers['Authorization'] = 'Bearer XXXXXX'
 request.queryParams['limit'] = 100

examples/example.js

@@ -1,16 +1,15 @@
 var Client = require('../lib/client.js').Client
-var emptyRequest = require('../lib/client.js').request
 
 // These values persist across of subsequent calls, unless overidden.
-var globalRequest = JSON.parse(JSON.stringify(emptyRequest))
+var globalRequest = require('../lib/client.js').emptyRequest
 globalRequest.host = 'api.sendgrid.com';
 globalRequest.headers['Content-Type'] = 'application/json'
 // You must add your SendGrid API Key to your OS Environment
 globalRequest.headers['Authorization'] = 'Bearer '.concat(process.env.SENDGRID_API_KEY)
 var client = new Client(globalRequest)
 
 // GET Collection
-var requestGet = JSON.parse(JSON.stringify(emptyRequest))
+var requestGet = client.emptyRequest()
 requestGet.method = 'GET'
 requestGet.path = '/v3/api_keys'
 requestGet.queryParams['limit'] = 100
@@ -30,7 +29,7 @@ var requestBody = {
     'alerts.read'
   ]
 }
-var requestPost = JSON.parse(JSON.stringify(emptyRequest));
+var requestPost = client.emptyRequest()
 requestPost.method = 'POST'
 requestPost.path = '/v3/api_keys'
 requestPost.body = requestBody
@@ -49,7 +48,7 @@ createAPIKey(function (returnValue) { // This ensures we POST a new key first, t
   var api_key_id = '/'.concat(returnValue)
 
   // GET SINGLE
-  var requestGetSingle = JSON.parse(JSON.stringify(emptyRequest))
+  var requestGetSingle = client.emptyRequest()
   requestGetSingle.method = 'GET'
   requestGetSingle.path = '/v3/api_keys'.concat(api_key_id)
   client.API(requestGetSingle, function (response) {
@@ -62,7 +61,7 @@ createAPIKey(function (returnValue) { // This ensures we POST a new key first, t
   requestBody = {
     'name': 'A New Hope'
   }
-  var requestPatch = JSON.parse(JSON.stringify(emptyRequest))
+  var requestPatch = client.emptyRequest()
   requestPatch.method = 'PATCH'
   requestPatch.path = '/v3/api_keys'.concat(api_key_id)
   requestPatch.body = requestBody
@@ -80,7 +79,7 @@ createAPIKey(function (returnValue) { // This ensures we POST a new key first, t
       'user.profile.update'
     ]
   }
-  var requestPut = JSON.parse(JSON.stringify(emptyRequest))
+  var requestPut = client.emptyRequest()
   requestPut.method = 'PUT'
   requestPut.path = '/v3/api_keys'.concat(api_key_id)
   requestPut.body = requestBody
@@ -91,7 +90,7 @@ createAPIKey(function (returnValue) { // This ensures we POST a new key first, t
   })
 
   // DELETE
-  var requestDelete = JSON.parse(JSON.stringify(emptyRequest))
+  var requestDelete = client.emptyRequest()
   requestDelete.method = 'DELETE'
   requestDelete.path = '/v3/api_keys'.concat(api_key_id)
   client.API(requestDelete, function (response) {

lib/client.js

@@ -1,19 +1,23 @@
 'use strict'
 
-var http = require('https')
+var https = require('https')
+var http = require('http')
 var queryString = require('querystring')
 
-// request holds the request to an API Call, use this as an initializer
-// like so: JSON.parse(JSON.stringify(request))
+// request holds the request to an API Call
 var request = {
   host: '',
   method: '',
   path: '',
   headers: {},
   body: {},
-  queryParams: {}
+  queryParams: {},
+  test: false, // use this to allow for http calls
+  port: ''     // set the port for http calls
 }
 
+var emptyRequest = JSON.parse(JSON.stringify(request))
+
 // response holds the response from an API call, use this as an initializer
 // like so: JSON.parse(JSON.stringify(response))
 var response = {
@@ -27,6 +31,11 @@ function Client (globalRequest) {
   var emptyResponse = JSON.parse(JSON.stringify(response))
   var body = ''
 
+  // utility function to create an empty request object
+  this.emptyRequest = function () {
+    return JSON.parse(JSON.stringify(request))
+  }
+
   // utility function to detect empty objects
   function isEmpty (obj) {
     for (var key in obj) {
@@ -74,7 +83,14 @@ function Client (globalRequest) {
   this.API = function (endpointRequest, callback) {
     var request = buildRequest(globalRequest, endpointRequest)
 
-    var httpRequest = http.request(request, function (httpResponse) {
+    if ( endpointRequest.test == true ) {
+      var http_request = http
+      request.port = endpointRequest.port
+    } else {
+      var http_request = https
+    }
+
+    var httpRequest = http_request.request(request, function (httpResponse) {
       var responseBody = ''
 
       // cature the response from the API
@@ -110,5 +126,6 @@ function Client (globalRequest) {
 module.exports =
 {
   Client: Client,
-  request: request
+  request: request,
+  emptyRequest: emptyRequest
 }

package.json

@@ -5,7 +5,7 @@
   ],
   "name": "sendgrid-rest",
   "description": "HTTP REST client, simplified for Node.js.",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "homepage": "https://sendgrid.com",
   "repository": {
     "type": "git",

test/test.js

@@ -4,8 +4,7 @@ var nock = require('nock')
 var TEST_HOST = 'https://api.test.com'
 
 var Client = require('../lib/client.js').Client
-var emptyRequest = require('../lib/client.js').request
-var globalRequest = JSON.parse(JSON.stringify(emptyRequest))
+var globalRequest = require('../lib/client.js').emptyRequest
 globalRequest.host = 'api.test.com'
 
 describe('Client', function () {
@@ -20,7 +19,7 @@ describe('Client', function () {
           message: 'Success'
         })
 
-      var requestGet = JSON.parse(JSON.stringify(emptyRequest))
+      var requestGet = client.emptyRequest()
       requestGet.method = 'GET'
       requestGet.path = '/test'
       requestGet.queryParams['limit'] = 100
@@ -53,7 +52,7 @@ describe('Client', function () {
       var requestBody = {
         'test': 'Test Body'
       }
-      var requestPost = JSON.parse(JSON.stringify(emptyRequest))
+      var requestPost = client.emptyRequest()
       requestPost.method = 'POST'
       requestPost.path = '/test'
       requestPost.body = requestBody
@@ -84,7 +83,7 @@ describe('Client', function () {
         .reply(200, {
           message: 'Success'
         })
-      var requestGet = JSON.parse(JSON.stringify(emptyRequest))
+      var requestGet = client.emptyRequest()
       requestGet.method = 'GET'
       requestGet.path = '/test'
       client.API(requestGet, function (response) {
@@ -104,7 +103,7 @@ describe('Client', function () {
       var requestBody = {
         'test': 'Test Body'
       }
-      var requestPost = JSON.parse(JSON.stringify(emptyRequest))
+      var requestPost = client.emptyRequest()
       requestPost.body = requestBody
       requestPost.method = 'POST'
       requestPost.path = '/test'
@@ -121,7 +120,7 @@ describe('Client', function () {
         .reply(200, {
           message: 'Success'
         })
-      var requestPatch = JSON.parse(JSON.stringify(emptyRequest))
+      var requestPatch = client.emptyRequest()
       requestPatch.body = requestBody
       requestPatch.method = 'PATCH'
       requestPatch.path = '/test'
@@ -139,7 +138,7 @@ describe('Client', function () {
         .reply(200, {
           message: 'Success'
         })
-      var requestPut = JSON.parse(JSON.stringify(emptyRequest))
+      var requestPut = client.emptyRequest()
       requestPut.body = requestBody
       requestPut.method = 'PUT'
       requestPut.path = '/test'
@@ -157,7 +156,7 @@ describe('Client', function () {
         .reply(204, {
           message: 'Success'
         })
-      var requestDelete = JSON.parse(JSON.stringify(emptyRequest))
+      var requestDelete = client.emptyRequest()
       requestDelete.method = 'DELETE'
       requestDelete.path = '/test'
       client.API(requestDelete, function (response) {