Add linter

.eslintrc.json

@@ -0,0 +1,42 @@
+{
+  "env": {
+    "node": true
+  },
+  "plugins": [],
+  "extends": "airbnb-base",
+  "parser": "babel-eslint",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module"
+  },
+  "rules": {
+    "indent": ["error", 2],
+    "linebreak-style": ["error", "unix"],
+    "quotes": ["error", "single"],
+    "semi": ["error", "always"],
+    "comma-dangle": ["warn"],
+    "camelcase": [0],
+    "no-plusplus": [0],
+    "no-restricted-globals": [0],
+    "no-underscore-dangle": [0],
+    "no-trailing": 0,
+    "no-trailing-spaces": 0,
+    "radix": 0,
+    "import/no-dynamic-require": 0,
+    "template-curly-spacing": ["warn", "always"],
+    "no-restricted-syntax": 0,
+    "class-methods-use-this": 0,
+    "prefer-const": "warn",
+    "array-bracket-spacing": 0,
+    "no-await-in-loop": 0,
+    "global-require": 0,
+    "guard-for-in": 0,
+    "no-shadow": 0,
+    "no-param-reassign": 0,
+    "no-else-return": 0,
+    "consistent-return": 0,
+    "import/no-unresolved": 0,
+    "no-prototype-builtins": 0,
+    "max-len": [ "warn", { "code": 120 } ]
+  }
+}

package.json

@@ -1,10 +1,12 @@
 {
   "name": "ubidots-node",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Unofficial Ubidots NodeJS API Client",
   "main": "src/ubidots.js",
   "scripts": {
-    "test": "$(npm bin)/mocha test --timeout 99999 --ui tdd --file test/_boot.js"
+    "test": "$(npm bin)/mocha test --timeout 99999 --ui tdd --file test/_boot.js",
+    "lint": "$(npm bin)/eslint src",
+    "lint-staged": "$(npm bin)/lint-staged"
   },
   "repository": {
     "type": "git",
@@ -23,12 +25,29 @@
   "homepage": "https://github.com/AlexanderC/ubidots#readme",
   "devDependencies": {
     "chai": "^4.2.0",
-    "mocha": "^5.2.0"
+    "mocha": "^5.2.0",
+    "babel-eslint": "^10.0.1",
+    "eslint": "^5.9.0",
+    "eslint-config-airbnb": "^17.1.0",
+    "eslint-plugin-import": "^2.14.0",
+    "husky": "^2.3.0",
+    "lint-staged": "^8.1.7"
   },
   "dependencies": {
     "axios": "^0.19.0",
     "debug": "^4.1.0",
     "merge-options": "^1.0.1",
     "promise-retry": "^1.1.1"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix",
+      "git add"
+    ]
   }
 }

src/api-definition/definition/index.js

@@ -7,7 +7,11 @@ const variable = require('./variable');
 const utils = require('./utils');
 
 module.exports = {
-  auth, organization, user, 
-  datasource, device, variable,
+  auth,
+  organization,
+  user, 
+  datasource,
+  device,
+  variable,
   utils,
 };

src/api-definition/endpoint.js

@@ -17,32 +17,30 @@ async function build(def, authToken = null, apiKey = null, ...args) {
     opts.headers['X-Ubidots-ApiKey'] = apiKey;
   }
 
-  if (opts.populate && typeof opts.populate == 'function') {
+  if (opts.populate && typeof opts.populate === 'function') {
     await opts.populate.call(opts, ...args);
   }
 
   return opts;
 }
 
-module.exports = ext => {
-  return mergeOptions({
-    basepath: 'api/v1.6',
-    method: 'GET',
-    path: '',
-    useAPIKey: false,
-    headers: {
-      'X-Auth-Token': '',
-      'X-Ubidots-ApiKey': ''
-    },
-    async populate(opts) {
-      if (this.method.toLowerCase() === 'get') {
-        this.params = opts || {};
-      } else {
-        this.data = opts || {};
-      }
-    },
-    build,
-    validateStatus: Response.isStatusOk,
-    process: data => data,
-  }, ext);
-};
+module.exports = ext => mergeOptions({
+  basepath: 'api/v1.6',
+  method: 'GET',
+  path: '',
+  useAPIKey: false,
+  headers: {
+    'X-Auth-Token': '',
+    'X-Ubidots-ApiKey': '',
+  },
+  async populate(opts) {
+    if (this.method.toLowerCase() === 'get') {
+      this.params = opts || {};
+    } else {
+      this.data = opts || {};
+    }
+  },
+  build,
+  validateStatus: Response.isStatusOk,
+  process: data => data,
+}, ext);

src/api-definition/index.js

@@ -7,7 +7,7 @@ const ApiBase = {
 };
 
 module.exports.ApiBase = ApiBase;
-module.exports.api = baseURL => {
+module.exports.api = (baseURL) => {
   const api = {};
 
   for (const namespace in definitions) {
@@ -16,7 +16,7 @@ module.exports.api = baseURL => {
     for (const name in definitions[namespace]) {
       api[namespace][name] = mergeOptions(
         { baseURL },
-        definitions[namespace][name]
+        definitions[namespace][name],
       );
     }
   }

src/api.js

@@ -17,7 +17,7 @@ class Api {
     this.key = key;
     this.opts = opts;
 
-    debug(`endpoints:${this.namespace}`, this.endpoints);
+    debug(`endpoints:${ this.namespace }`, this.endpoints);
   }
 
   /**
@@ -31,11 +31,11 @@ class Api {
     }
 
     return new Endpoint(
-      `${this.namespace}:${endpoint}`,
+      `${ this.namespace }:${ endpoint }`,
       this._endpoints[endpoint],
       this.token,
       this.key,
-      this.opts
+      this.opts,
     );
   }
 

src/endpoint.js

@@ -32,7 +32,7 @@ class Endpoint {
       this.definition,
       this.token,
       this.key,
-      ...args
+      ...args,
     );
 
     debug(`call:${ name }`, opts);

src/error/api.js

@@ -7,8 +7,8 @@ class ApiError extends BaseError {
    */
   constructor(endpoint, error) {
     super(
-      `Request to "${endpoint.name}" ${endpoint.token ? 'w/' : 'wo/'} token failed: ` +
-      ApiError.details(error)
+      `Request to "${ endpoint.name }" ${ endpoint.token ? 'w/' : 'wo/' } token failed: ${ 
+        ApiError.details(error) }`,
     );
   }
 
@@ -25,23 +25,24 @@ class ApiError extends BaseError {
         && typeof error.response.data === 'object'
       ) {
         switch (error.response.status) {
-          case 403:
-            msg = error.response.data.detail;
-            break;
-          case 400:
-            const issues = [];
-
-            for (const field in error.response.data) {
-              issues.push(`${field} (${error.response.data[field].join(', ')})`);
-            }
-
-            msg = `Invalid payload data- ${issues.join(', ')}`;
-            break;
-          default: msg = 'Unknown Error';
+        case 403:
+          msg = error.response.data.detail;
+          break;
+        case 400:
+          // eslint-disable-next-line no-case-declarations
+          const issues = [];
+
+          for (const field in error.response.data) {
+            issues.push(`${ field } (${ error.response.data[field].join(', ') })`);
+          }
+
+          msg = `Invalid payload data- ${ issues.join(', ') }`;
+          break;
+        default: msg = 'Unknown Error';
         }
       }
 
-      return `Failed with status ${error.response.status}. ${msg}`;
+      return `Failed with status ${ error.response.status }. ${ msg }`;
     } else if (error.request) {
       return 'No response received';
     }

src/error/missing-api-endpoint.js

@@ -6,7 +6,7 @@ class MissingApiEndpointError extends BaseError {
    * @param {string} endpoint 
    */
   constructor(namespace, endpoint) {
-    super(`Missing API endpoint "${namespace}:${endpoint}"`);
+    super(`Missing API endpoint "${ namespace }:${ endpoint }"`);
   }
 }
 

src/error/missing-api-namespace.js

@@ -5,7 +5,7 @@ class MissingApiNamespaceError extends BaseError {
    * @param {string} namespace 
    */
   constructor(namespace) {
-    super(`Missing API namespace "${namespace}"`);
+    super(`Missing API namespace "${ namespace }"`);
   }
 }
 

src/response.js

@@ -26,7 +26,7 @@ class Response {
     const data = this._response.data || {};
     const processor = this.endpoint.definition.process;
 
-    if (processor && typeof processor == 'function') {
+    if (processor && typeof processor === 'function') {
       return processor(data);
     }
 
@@ -54,7 +54,7 @@ class Response {
 
     return new ApiError(
       this.endpoint,
-      this._error || { response: this._response }
+      this._error || { response: this._response },
     );
   }
 

src/ubidots.js

@@ -55,7 +55,7 @@ class Ubidots {
       this._api[namespace],
       this.token,
       this.key,
-      this.opts
+      this.opts,
     );
   }
 
@@ -113,7 +113,7 @@ class Ubidots {
         retries: 5,
         factor: 1.4,
         minTimeout: 500,
-      }
+      },
     };
   }
 }

src/utils/debug.js

@@ -1,5 +1,5 @@
 const debug = require('debug');
-const pkg = require('../../package.json');
 const path = require('path');
+const pkg = require('../../package.json');
 
 module.exports = file => debug(`${ pkg.name }:${ path.basename(file, '.js') }`);

src/utils/string.js

@@ -1,8 +1,9 @@
 module.exports.interpolate = (template, vars) => {
   for (const key in vars) {
     template = template.replace(
-      new RegExp(`{\s*${key}\s*}`, 'ig'),
-      vars[key]
+      // eslint-disable-next-line no-useless-escape
+      new RegExp(`{\s*${ key }\s*}`, 'ig'),
+      vars[key],
     );
   }