updated lodash usage; added jshint

.jshintrc

@@ -0,0 +1,117 @@
+{
+	// -----------------
+	// --------------------------------------------------------------------
+	// JSHint Configuration, Strict Edition
+	// --------------------------------------------------------------------
+	//
+	// This is a options template for [JSHint][1], using [JSHint example][2]
+	// and [Ory Band's example][3] as basis and setting config values to
+	// be most strict:
+	//
+	// * set all enforcing options to true
+	// * set all relaxing options to false
+	// * set all environment options to false, except the browser value
+	// * set all JSLint legacy options to false
+	//
+	// [1]: http://www.jshint.com/
+	// [2]: https://github.com/jshint/node-jshint/blob/master/example/config.json
+	// [3]: https://github.com/oryband/dotfiles/blob/master/jshintrc
+	//
+	// @author http://michael.haschke.biz/
+	// @license http://unlicense.org/
+
+	// == Enforcing Options ===============================================
+	//
+	// These options tell JSHint to be more strict towards your code. Use
+	// them if you want to allow only a safe subset of JavaScript, very
+	// useful when your codebase is shared with a big number of developers
+	// with different skill levels.
+
+	"bitwise": true,     // Prohibit bitwise operators (&, |, ^, etc.).
+	"curly": true,     // Require {} for every new block or scope.
+	"eqeqeq": true,     // Require triple equals i.e. `===`.
+	"forin": true,     // Tolerate `for in` loops without `hasOwnPrototype`.
+	"immed": true,     // Require immediate invocations to be wrapped in parens e.g. `( function(){}() );`
+	"latedef": true,     // Prohibit variable use before definition.
+	"newcap": true,     // Require capitalization of all constructor functions e.g. `new F()`.
+	"noarg": true,     // Prohibit use of `arguments.caller` and `arguments.callee`.
+	"noempty": true,     // Prohibit use of empty blocks.
+	"nonew": true,     // Prohibit use of constructors for side-effects.
+	"plusplus": true,     // Prohibit use of `++` & `--`.
+	"regexp": true,     // Prohibit `.` and `[^...]` in regular expressions.
+	"undef": true,     // Require all non-global variables be declared before they are used.
+	"strict": false,     // Require `use strict` pragma in every file.
+	"trailing": true,     // Prohibit trailing whitespaces.
+
+	// == Relaxing Options ================================================
+	//
+	// These options allow you to suppress certain types of warnings. Use
+	// them only if you are absolutely positive that you know what you are
+	// doing.
+
+	"asi": false,    // Tolerate Automatic Semicolon Insertion (no semicolons).
+	"boss": false,    // Tolerate assignments inside if, for & while. Usually conditions & loops are for comparison, not assignments.
+	"debug": false,    // Allow debugger statements e.g. browser breakpoints.
+	"eqnull": false,    // Tolerate use of `== null`.
+	"esnext": false,    // Allow ES.next specific features such as `const` and `let`.
+	"evil": false,    // Tolerate use of `eval`.
+	"expr": false,    // Tolerate `ExpressionStatement` as Programs.
+	"funcscope": false,    // Tolerate declarations of variables inside of control structures while accessing them later from the outside.
+	"globalstrict": false,    // Allow global "use strict" (also enables 'strict').
+	"iterator": false,    // Allow usage of __iterator__ property.
+	"lastsemic": false,    // Tolerat missing semicolons when the it is omitted for the last statement in a one-line block.
+	"laxbreak": false,    // Tolerate unsafe line breaks e.g. `return [\n] x` without semicolons.
+	"laxcomma": false,    // Suppress warnings about comma-first coding style.
+	"loopfunc": false,    // Allow functions to be defined within loops.
+	"multistr": false,    // Tolerate multi-line strings.
+	"onecase": false,    // Tolerate switches with just one case.
+	"proto": false,    // Tolerate __proto__ property. This property is deprecated.
+	"regexdash": false,    // Tolerate unescaped last dash i.e. `[-...]`.
+	"scripturl": false,    // Tolerate script-targeted URLs.
+	"smarttabs": false,    // Tolerate mixed tabs and spaces when the latter are used for alignmnent only.
+	"shadow": false,    // Allows re-define variables later in code e.g. `var x=1; x=2;`.
+	"sub": false,    // Tolerate all forms of subscript notation besides dot notation e.g. `dict['key']` instead of `dict.key`.
+	"supernew": false,    // Tolerate `new function () { ... };` and `new Object;`.
+	"validthis": false,    // Tolerate strict violations when the code is running in strict mode and you use this in a non-constructor function.
+
+	// == Environments ====================================================
+	//
+	// These options pre-define global variables that are exposed by
+	// popular JavaScript libraries and runtime environments—such as
+	// browser or node.js.
+
+	"browser": false,     // Standard browser globals e.g. `window`, `document`.
+	"couch": false,    // Enable globals exposed by CouchDB.
+	"devel": false,    // Allow development statements e.g. `console.log();`.
+	"dojo": false,    // Enable globals exposed by Dojo Toolkit.
+	"jquery": false,    // Enable globals exposed by jQuery JavaScript library.
+	"mootools": false,    // Enable globals exposed by MooTools JavaScript framework.
+	"node": true,    // Enable globals available when code is running inside of the NodeJS runtime environment.
+	"nonstandard": false,    // Define non-standard but widely adopted globals such as escape and unescape.
+	"prototypejs": false,    // Enable globals exposed by Prototype JavaScript framework.
+	"rhino": false,    // Enable globals available when your code is running inside of the Rhino runtime environment.
+	"wsh": false,    // Enable globals available when your code is running as a script for the Windows Script Host.
+
+	// == JSLint Legacy ===================================================
+	//
+	// These options are legacy from JSLint. Aside from bug fixes they will
+	// not be improved in any way and might be removed at any point.
+
+	"nomen": false,    // Prohibit use of initial or trailing underbars in names.
+	"onevar": true,    // Allow only one `var` statement per function.
+	"passfail": false,    // Stop on first error.
+	"white": true,    // Check against strict whitespace and indentation rules.
+
+	// == Undocumented Options ============================================
+	//
+	// While I've found these options in [example1][2] and [example2][3]
+	// they are not described in the [JSHint Options documentation][4].
+	//
+	// [4]: http://www.jshint.com/options/
+
+	"maxerr": 100,      // Maximum errors before stopping.
+	"predef": [         // Extra globals.
+		//"exampleVar",
+	],
+	"indent": 4         // Specify indentation spacing
+}

Gruntfile.js

@@ -47,6 +47,14 @@ module.exports = function ConfigureGruntService(grunt) {
         stderr: true,
         failOnError: true
       }
+    },
+    jshint: {
+      options: {
+        jshintrc: true
+      },
+      files: {
+        src: ['lib/*.js', 'index.js', 'Gruntfile.js']
+      }
     }
   });
 

History.md

@@ -1,4 +1,10 @@
 
+1.0.7 / 2015-3-06
+==================
+
+  * Added JSHINT Support to Gruntfile
+  * Updated `lodash` usage
+
 1.0.5 / 2014-10-24
 ==================
 

lib/IntercomError.js

@@ -10,11 +10,11 @@ var util = require('util');
  */
 function AbstractError(message, constr) {
   Error.apply(this, arguments);
-  Error.captureStackTrace(this, constr || this)
+  Error.captureStackTrace(this, constr || this);
 
   this.name = 'AbstractError';
   this.message = message;
-};
+}
 
 /**
  * Inherit from `Error`.
@@ -30,7 +30,7 @@ function IntercomError(message) {
   AbstractError.apply(this, arguments);
   this.name = 'IntercomError';
   this.message = message;
-};
+}
 
 /**
  * Inherit from `AbstractError`.

lib/intercom.io.js

@@ -3,7 +3,7 @@
  */
 var request = require('request'),
     qs = require('qs'),
-    _ = require('lodash/dist/lodash.underscore'),
+    _ = require('lodash'),
     debug = require('debug')('intercom.io'),
     // Represents errors thrown by intercom, see [IntercomError.js](./IntercomError.js.html)
     IntercomError = require('./IntercomError'),
@@ -89,7 +89,7 @@ Intercom.create = function(appId, apiKey, options) {
  * @api public
  */
 Intercom.prototype.request = function(method, path, parameters, cb) {
-  debug('Requesting [%s] %s with data %o', method, path, parameters)
+  debug('Requesting [%s] %s with data %o', method, path, parameters);
 
   var url = this.endpoint + path;
 
@@ -148,7 +148,7 @@ Intercom.prototype.request = function(method, path, parameters, cb) {
     }
 
     // Resolve the promise
-    return deferred.resolve(parsed || data)
+    return deferred.resolve(parsed || data);
   });
 
   // Return the promise and promisify any callback provided
@@ -189,8 +189,8 @@ Intercom.prototype.getUser = function(userObj, cb) {
 };
 
 Intercom.prototype.viewUser = function(userObj, cb) {
-  if (userObj.hasOwnProperty('id')) {
-      return this.request('GET', 'users' + '/' + userObj['id'], {}, cb);
+  if (userObj && userObj.hasOwnProperty('id')) {
+      return this.request('GET', 'users' + '/' + userObj.id, {}, cb);
   } else {
       return this.request('GET', 'users', userObj, cb);
   }
@@ -218,8 +218,8 @@ Intercom.prototype.listCompanies = function(companyObj, cb) {
 };
 
 Intercom.prototype.viewCompany = function(companyObj, cb) {
-  if (companyObj.hasOwnProperty('id')) {
-      return this.request('GET', 'companies/' + companyObj['id'], {}, cb);
+  if (companyObj && companyObj.hasOwnProperty('id')) {
+      return this.request('GET', 'companies/' + companyObj.id, {}, cb);
   } else {
       return this.request('GET', 'companies', companyObj, cb);
   }
@@ -241,8 +241,8 @@ Intercom.prototype.deleteCompany = function(companyObj, cb) {
 */
 
 Intercom.prototype.listCompanyUsers = function(companyObj, cb) {
-  if (companyObj.hasOwnProperty('id')) {
-      return this.request('GET', 'companies/' + companyObj['id'] + '/users', {}, cb);
+  if (companyObj && companyObj.hasOwnProperty('id')) {
+      return this.request('GET', 'companies/' + companyObj.id + '/users', {}, cb);
   } else {
       return this.request('GET', 'companies', companyObj, cb);
   }
@@ -251,7 +251,7 @@ Intercom.prototype.listCompanyUsers = function(companyObj, cb) {
 // ### Admins
 Intercom.prototype.listAdmins = function(adminObj, cb) {
   return this.request('GET', 'admins', adminObj, cb);
-}
+};
 
 // ### Notes
 Intercom.prototype.createNote = function(noteObj, cb) {
@@ -263,7 +263,11 @@ Intercom.prototype.listNotes = function(noteObj, cb) {
 };
 
 Intercom.prototype.viewNote = function(noteObj, cb) {
-  return this.request('GET', 'notes/' + noteObj['id'], {}, cb);
+  if (noteObj && noteObj.hasOwnProperty('id')) {
+    return this.request('GET', 'notes/' + noteObj.id, {}, cb);
+  } else {
+    return this.request('GET', 'notes', noteObj, cb);
+  }
 };
 
 // ### Tags
@@ -283,21 +287,25 @@ Intercom.prototype.updateTag = function(tagObj, cb) {
 // ### Segments
 Intercom.prototype.listSegments = function(segmentObj, cb) {
   return this.request('GET', 'segments', segmentObj, cb);
-}
+};
 
 Intercom.prototype.viewSegment = function(segmentObj, cb) {
-  return this.request('GET', 'segments/' + segmentObj['segment_id'], {}, cb);
-}
+  if (segmentObj && segmentObj.hasOwnProperty('id')) {
+    return this.request('GET', 'segments/' + segmentObj.id || segmentObj.segment_id, {}, cb);
+  } else {
+    return this.request('GET', 'segments', segmentObj, cb);
+  }
+};
 
 // ### Events
 Intercom.prototype.createEvent = function(eventObj, cb) {
   return this.request('POST', 'events', eventObj, cb);
-}
+};
 
 // ### Counts
 Intercom.prototype.getCounts = function(countObj, cb) {
   return this.request('GET', 'counts', countObj, cb);
-}
+};
 
 // ### Conversations
 Intercom.prototype.createUserMessage = function(messageObj, cb) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "intercom.io",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "An NodeJS API client for intercom.io",
   "keywords": [
     "api",
@@ -23,9 +23,10 @@
   },
   "devDependencies": {
     "docker": "~0.2.8",
+    "grunt": "~0.4.1",
+    "grunt-contrib-jshint": "^0.11.0",
     "grunt-docker": "0.0.5",
     "grunt-shell": "~0.3.0",
-    "grunt": "~0.4.1",
     "matchdep": "~0.1.1"
   },
   "main": "index"