Initial commit

Author: theworkflow

.travis.yml

@@ -0,0 +1,11 @@
+language: node_js
+node_js:
+  - '4'
+  - '6'
+before_install:
+  - 'npm install npm@latest codeclimate-test-reporter -g'
+addons:
+  code_climate:
+    repo_token: token
+after_script:
+  - 'npm run gen-coverage && cat coverage/lcov.info | codeclimate-test-reporter'

index.js

@@ -0,0 +1,45 @@
+'use strict'
+
+const Hoek = require('hoek');
+
+class JSONErrors {
+  constructor() {
+    this.errors = new Array();
+  }
+
+  get() {
+    return { errors: this.errors };
+  }
+
+  create(id, message, meta) {
+    var error = {};
+
+    Hoek.assert(id !== undefined, 'id required');
+    Hoek.assert(message !== undefined, 'message required');
+
+    error.id = id;
+    error.message = message;
+
+    if (meta) error.meta = meta;
+
+    return error;
+  }
+
+  createSingle(id, message, meta) {
+    var errors = new JSONErrors();
+
+    errors.add(id, message, meta);
+    return errors.get();
+  }
+
+  add(id, message, meta) {
+    var error = this.create(id, message, meta);
+    this.errors.push(error);
+  }
+
+  clear() {
+    this.errors = new Array();
+  }
+};
+
+module.exports = JSONErrors;

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "json-api-errors",
+  "version": "0.1.0",
+  "description": "JSON api errors formatter",
+  "main": "errors.js",
+  "scripts": {
+    "test": "lab -c"
+  },
+  "keywords": [
+    "json",
+    "api",
+    "errors",
+    "formatter",
+    "restify",
+    "express",
+    "hapi",
+    "koa",
+    "http",
+    "https",
+    "nodejs",
+    "node",
+    "npm"
+  ],
+  "author": "Jeremiah Harlan <jeremiah.harlan@gmail.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "code": "3.0.2",
+    "lab": "11.0.1"
+  },
+  "dependencies": {
+    "hoek": "^4.0.2"
+  }
+}

test/clear.js

@@ -0,0 +1,32 @@
+const Code = require('code');
+const Lab = require('lab');
+
+const JSONErrors = require('..');
+
+const lab = exports.lab = Lab.script();
+
+const describe = lab.describe;
+const it = lab.it;
+const expect = Code.expect;
+const beforeEach = lab.beforeEach;
+
+var Client, err, errObject;
+
+describe('JSONErrors.clear', () => {
+  err = { id: 'CUSTOM_ERROR', message: 'This is a custom error message' };
+
+  beforeEach((done) => {
+    Client = new JSONErrors();
+    Client.add(err.id, err.message);
+    done();
+  });
+
+  it('clears out errors', (done) => {
+    var errors;
+
+    Client.clear();
+    errors = Client.get();
+    expect(errors.errors).to.have.length(0);
+    done();
+  });
+});

test/create.js

@@ -0,0 +1,55 @@
+const Code = require('code');
+const Lab = require('lab');
+
+const JSONErrors = require('..');
+
+const lab = exports.lab = Lab.script();
+
+const describe = lab.describe;
+const it = lab.it;
+const expect = Code.expect;
+const beforeEach = lab.beforeEach;
+
+var Client, err, errObject;
+
+describe('JSONErrors.create', () => {
+  err = { id: 'CUSTOM_ERROR', message: 'This is a custom error' };
+  errObject = { errors: [{ id: err.id, message: err.message }] };
+
+  beforeEach((done) => {
+    Client = new JSONErrors();
+    done();
+  });
+
+  describe('validation', () => {
+    it('fails if no id is provided', (done) => {
+      expect(() => {
+        ClientClient.create(null, err.message);
+      }).to.throw();
+
+      done();
+    });
+
+    it('fails if no message is provided', (done) => {
+      expect(() => {
+        ClientClient.create(err.id, null);
+      }).to.throw();
+
+      done();
+    });
+  });
+
+  it('creates an error object', (done) => {
+    var error = Client.create(err.id, err.message);
+
+    expect(error).to.equal(err);
+    done();
+  });
+
+  it('adds meta to the error when specified', (done) => {
+    var error = Client.create(err.id, err.message, 'meta');
+
+    expect(error.meta).to.equal('meta');
+    done();
+  });
+});

test/createSingle.js

@@ -0,0 +1,25 @@
+const Code = require('code');
+const Lab = require('lab');
+
+const JSONErrors = require('..');
+
+const lab = exports.lab = Lab.script();
+
+const describe = lab.describe;
+const it = lab.it;
+const expect = Code.expect;
+
+var Client, err, errObject;
+
+describe('JSONErrors.createSingle', () => {
+  err = { id: 'CUSTOM_ERROR', message: 'This is a custom error'};
+  errObject = { errors: [{ id: err.id, message: err.message }] };
+  Client = new JSONErrors();
+
+  it('creates a single errors object', (done) => {
+    var errors = Client.createSingle(err.id, err.message);
+
+    expect(errors).to.equal(errObject);
+    done();
+  });
+});

test/get.js

@@ -0,0 +1,38 @@
+const Code = require('code');
+const Lab = require('lab');
+
+const JSONErrors = require('..');
+
+const lab = exports.lab = Lab.script();
+
+const describe = lab.describe;
+const it = lab.it;
+const expect = Code.expect;
+const beforeEach = lab.beforeEach;
+const afterEach = lab.afterEach;
+
+var Client, err, errObject;
+
+describe('JSONErrors.get', () => {
+  err = { id: 'CUSTOM_ERROR', message: 'This is a custom error message' };
+  errObject = { errors: [{ id: err.id, message: err.message }] };
+
+  beforeEach((done) => {
+    Client = new JSONErrors();
+    Client.add(err.id, err.message);
+    done();
+  });
+
+  afterEach((done) => {
+    Client.clear();
+    done();
+  });
+
+  it('returns errors as object', (done) => {
+    var errors = Client.get();
+
+    expect(errors).to.be.an.object();
+    expect(errors).to.equal(errObject);
+    done();
+  });
+});

test/index.js

@@ -0,0 +1,23 @@
+const Code = require('code');
+const Lab = require('lab');
+
+const JSONErrors = require('..');
+
+const lab = exports.lab = Lab.script();
+
+const describe = lab.describe;
+const it = lab.it;
+const expect = Code.expect;
+
+var Client = new JSONErrors();
+
+describe('JSONErrors', () => {
+  it('exports functions', (done) => {
+    expect(Client.get).to.be.a.function();
+    expect(Client.create).to.be.a.function();
+    expect(Client.createSingle).to.be.a.function();
+    expect(Client.add).to.be.a.function();
+    expect(Client.clear).to.be.a.function();
+    done();
+  });
+});