Merge pull request #19 from packethost/improve-tests

Replace grunt ci tasks with npm scripts

.gitignore

@@ -1,3 +1,4 @@
+**.orig
 # Logs
 logs
 *.log

.jscsrc

@@ -0,0 +1,5 @@
+{
+    "preset": "google",
+    "validateIndentation": 4,
+    "maximumLineLength": 100
+}

.jshintrc

@@ -0,0 +1,32 @@
+{
+    "indent"        : 4,        // {int} Number of spaces to use for indentation
+    "latedef"       : false,    // true: Require variables/functions to be defined before being used
+    "newcap"        : true,     // true: Require capitalization of all constructor functions e.g. `new F()`
+    "noarg"         : true,     // true: Prohibit use of `arguments.caller` and `arguments.callee`
+    "noempty"       : true,     // true: Prohibit use of empty blocks
+    "nonbsp"        : true,     // true: Prohibit "non-breaking whitespace" characters.
+    "nonew"         : false,    // true: Prohibit use of constructors for side-effects (without assignment)
+    "plusplus"      : false,    // true: Prohibit use of `++` & `--`
+    "quotmark"      : "single", // Quotation mark consistency:
+                                //   false    : do nothing (default)
+                                //   true     : ensure whatever is used is consistent
+                                //   "single" : require single quotes
+                                //   "double" : require double quotes
+    "undef"         : true,     // true: Require all non-global variables to be declared (prevents global leaks)
+    "unused"        : true,     // Unused variables:
+                                //   true     : all variables, last function parameter
+                                //   "vars"   : all variables only
+                                //   "strict" : all variables, all function parameters
+    "strict"        : true,     // true: Requires all functions run in ES5 Strict Mode
+    "maxparams"     : false,    // {int} Max number of formal params allowed per function
+    "maxdepth"      : false,    // {int} Max depth of nested blocks (within functions)
+    "maxstatements" : false,    // {int} Max number statements per function
+    "maxcomplexity" : false,    // {int} Max cyclomatic complexity per function
+    "maxlen"        : false,    // {int} Max number of characters per line
+
+    "node"          : true,     // Node.js
+    "mocha"         : true,     // Mocha testing framework
+
+    // Custom Globals
+    "globals"       : {}        // additional predefined global variables
+}

lib/config/config.json

@@ -1,3 +1,3 @@
 {
-	"apiUrl": "https://api.packet.net"
-}
+    "apiUrl": "https://api.packet.net"
+}

lib/packet.js

@@ -1,7 +1,7 @@
+'use strict';
+
 var request = require('request');
-var querystring = require('querystring');
 var config = require('./config/config.json');
-
 var Packet = function(apiKey) {
     this.apiKey = apiKey;
     this.currentEnvironment = config.apiUrl;
@@ -254,7 +254,7 @@ Packet.prototype.removeEmail = function(id, callback) {
     });
 };
 
-Packet.prototype._get = function(url, parameters, callback){
+Packet.prototype._get = function(url, parameters, callback) {
     var self = this;
     request(
         {
@@ -264,12 +264,12 @@ Packet.prototype._get = function(url, parameters, callback){
             headers: self.getAuthHeaders(),
             json:true
         }, function(err, res, body) {
-            callback(handleRequestError(err,body), body || {});
+            callback(handleRequestError(err, body), body || {});
         }
     );
 };
 
-Packet.prototype._post = function(url, postData, callback){
+Packet.prototype._post = function(url, postData, callback) {
     var self = this;
     request(
         {
@@ -279,12 +279,12 @@ Packet.prototype._post = function(url, postData, callback){
             headers: self.getAuthHeaders(),
             json:true
         }, function(err, res, body) {
-            callback(handleRequestError(err,body), body || {});
+            callback(handleRequestError(err, body), body || {});
         }
     );
 };
 
-Packet.prototype._patch = function(url, postData, callback){
+Packet.prototype._patch = function(url, postData, callback) {
     var self = this;
     request(
         {
@@ -294,12 +294,12 @@ Packet.prototype._patch = function(url, postData, callback){
             headers: self.getAuthHeaders(),
             json:true
         }, function(err, res, body) {
-            callback(handleRequestError(err,body), body || {});
+            callback(handleRequestError(err, body), body || {});
         }
     );
 };
 
-Packet.prototype._delete = function(url, callback){
+Packet.prototype._delete = function(url, callback) {
     var self = this;
     request(
         {
@@ -308,13 +308,13 @@ Packet.prototype._delete = function(url, callback){
             headers: self.getAuthHeaders(),
             json:true
         }, function(err, res, body) {
-            callback(handleRequestError(err,body), body || {});
+            callback(handleRequestError(err, body), body || {});
         }
     );
 };
 
 Packet.prototype.getAuthHeaders = function() {
-    return { 
+    return {
         'X-Auth-Token': this.apiKey,
         'Content-Type': 'application/json',
         'Accept': 'application/json'
@@ -347,7 +347,7 @@ function getProjectsUrl(id, action) {
 
 function getDevicesUrl(projectId, id, action) {
     if (id) {
-        return '/devices/' + (id + '/' || '') + (action || '');    
+        return '/devices/' + (id + '/' || '') + (action || '');
     }
     if (projectId) {
         return '/projects/' + projectId + '/devices/';
@@ -402,7 +402,3 @@ function getNotificationsUrl(id) {
 function getEmailsUrl(id) {
     return '/emails/' + (id || '');
 }
-
-function getApiKeysUrl(id) {
-    return '/api-keys/' + (id || '');
-}

package.json

@@ -4,6 +4,12 @@
   "author": "Lucas Perez <lucas@packet.net>",
   "description": "Packet API wrapper",
   "main": "./lib/packet.js",
+  "scripts": {
+    "cs": "jscs lib test",
+    "lint": "jshint lib test",
+    "test": "mocha --reporter spec test",
+    "ci": "npm run cs && npm run lint && npm test"
+  },
   "dependencies": {
     "request": "2.x"
   },
@@ -15,9 +21,9 @@
   ],
   "devDependencies": {
     "chai": "^3.0.0",
-    "grunt": "^0.4.5",
-    "grunt-contrib-jshint": "^0.11.2",
-    "grunt-mocha-test": "^0.12.7",
+    "jscs": "^1.11.0",
+    "jshint": "^2.8.0",
+    "mocha": "^2.2.5",
     "nock": "^2.3.0",
     "node-uuid": "^1.4.3"
   }

shippable.yaml

@@ -6,11 +6,12 @@ node_js:
 cache: true
 
 before_install: 
-  - npm install -g grunt-cli
   - npm install
 
 script:
-  - grunt
+  - npm run cs
+  - npm run lint
+  - npm test
 
 notifications:
-   email: true
+   email: true

test/devicesSpec.js

@@ -1,11 +1,40 @@
+'use strict';
+
 var nock = require('nock');
 var Packet = new require('../lib/packet');
 var uuid = require('node-uuid');
+var apiConfig = require('../lib/config/config.json');
 var expect = require('chai').expect;
 var projectId;
 var deviceId;
 var api = new Packet('');
 describe('Client Devices Methods', function() {
     beforeEach(function() {
+        projectId = uuid.v4();
+        deviceId = uuid.v4();
     });
-});
+    describe('getDevices', function() {
+        it('should get a list of devices', function(done) {
+            var mock = nock(apiConfig.apiUrl)
+            .intercept('/projects/' + projectId + '/devices/', 'GET')
+            .reply(200, {devices:[{name:'device 1'}]});
+            api.getDevices(projectId, false, false, function(err, data) {
+                expect(err).to.equal(null);
+                expect(data.devices).to.deep.equal([{name:'device 1'}]);
+                done();
+                mock.done();
+            });
+        });
+        it('should get a single device', function(done) {
+            var mock = nock(apiConfig.apiUrl)
+            .intercept('/devices/' + deviceId + '/', 'GET')
+            .reply(200, {name:'device 1'});
+            api.getDevices(false, deviceId, false, function(err, data) {
+                expect(err).to.equal(null);
+                expect(data).to.deep.equal({name:'device 1'});
+                done();
+                mock.done();
+            });
+        });
+    });
+});

test/emailsSpec.js

@@ -1,3 +1,5 @@
+'use strict';
+// jshint ignore: start
 var nock = require('nock');
 var Packet = new require('../lib/packet');
 var uuid = require('node-uuid');
@@ -7,4 +9,4 @@ var api = new Packet('');
 describe('Client Emails Methods', function() {
     beforeEach(function() {
     });
-});
+});

test/eventsSpec.js

@@ -1,3 +1,5 @@
+'use strict';
+
 var nock = require('nock');
 var Packet = new require('../lib/packet');
 var uuid = require('node-uuid');
@@ -11,20 +13,28 @@ describe('Client Events Methods', function() {
     });
     describe('getEvents', function() {
         it('should get a list of events', function(done) {
-            var randomId_1 = uuid.v4();
-            var randomId_2 = uuid.v4();
+            var randomId1 = uuid.v4();
+            var randomId2 = uuid.v4();
             var mock = nock(apiUrl)
             .intercept('/events/', 'GET')
             .reply(200, {
                 events:[
-                {href: apiUrl + '/events/'+ randomId_1},
-                {href: apiUrl + '/events/'+ randomId_2}
-                ]});
+                    {href: apiUrl + '/events/' + randomId1},
+                    {href: apiUrl + '/events/' + randomId2}
+                ]
+            });
             api.getEvents(false, false, function(err, data) {
-                expect(data).to.deep.equal({events:[{href: apiUrl + '/events/'+ randomId_1}, {href: apiUrl + '/events/'+ randomId_2}]});
+                expect(err).to.equal(null);
+                expect(data).to.deep.equal({events:[
+                    {
+                        href: apiUrl + '/events/' + randomId1
+                    }, {
+                        href: apiUrl + '/events/' + randomId2
+                    }
+                ]});
                 done();
                 mock.done();
             });
         });
     });
-});
+});

test/facilitiesSpec.js

@@ -1,14 +1,15 @@
+'use strict';
+
 var nock = require('nock');
 var Packet = new require('../lib/packet');
-var uuid = require('node-uuid');
 var apiConfig = require('../lib/config/config.json');
 var expect = require('chai').expect;
 var api = new Packet('');
 describe('Client Facilities Methods', function() {
-	beforeEach(function() {
-	});
-	describe('getLocations', function() {
-		it('should get a list of facilities', function(done) {
+    beforeEach(function() {
+    });
+    describe('getLocations', function() {
+        it('should get a list of facilities', function(done) {
             var mock = nock(apiConfig.apiUrl)
             .intercept('/facilities/', 'GET')
             .reply(200, {
@@ -17,10 +18,11 @@ describe('Client Facilities Methods', function() {
                 {name:'facility 2'}
             ]});
             api.getLocations(function(err, data) {
+                expect(err).to.equal(null);
                 expect(data).to.deep.equal({facilities:[{name:'facility 1'}, {name:'facility 2'}]});
                 done();
                 mock.done();
             });
         });
     });
-});
+});

test/invitationsSpec.js

@@ -1,3 +1,5 @@
+'use strict';
+// jshint ignore: start
 var nock = require('nock');
 var Packet = new require('../lib/packet');
 var uuid = require('node-uuid');
@@ -8,4 +10,4 @@ var api = new Packet('');
 describe('Client Invitations Methods', function() {
     beforeEach(function() {
     });
-});
+});

test/membershipsSpec.js

@@ -1,3 +1,5 @@
+'use strict';
+// jshint ignore: start
 var nock = require('nock');
 var Packet = new require('../lib/packet');
 var uuid = require('node-uuid');
@@ -8,4 +10,4 @@ var api = new Packet('');
 describe('Client Membership Methods', function() {
     beforeEach(function() {
     });
-});
+});

test/notificationsSpec.js

@@ -1,27 +1,32 @@
+'use strict';
+// jshint ignore: start
 var nock = require('nock');
 var Packet = new require('../lib/packet');
 var uuid = require('node-uuid');
 var apiConfig = require('../lib/config/config.json');
 var expect = require('chai').expect;
-var notificationId;
 var api = new Packet('');
 describe('Client Notification Methods', function() {
-	describe('getNotifications', function() {
+    describe('getNotifications', function() {
         it('should get a list of notifications', function(done) {
-            var randomId_1 = uuid.v4();
-            var randomId_2 = uuid.v4();
+            var randomId1 = uuid.v4();
+            var randomId2 = uuid.v4();
             var mock = nock(apiConfig.apiUrl)
             .intercept('/notifications/', 'GET')
             .reply(200, {
                 notifications:[
-                {id:randomId_1},
-                {id:randomId_2}
-                ]});
+                {id:randomId1},
+                {id:randomId2}
+            ]});
             api.getNotifications(false, false, function(err, data) {
-                expect(data).to.deep.equal({notifications:[{id:randomId_1}, {id:randomId_2}]});
+                expect(err).to.equal(null);
+                expect(data).to.deep.equal({notifications:[
+                    {id:randomId1},
+                    {id:randomId2}
+                ]});
                 mock.done();
                 done();
             });
         });
     });
-});
+});