Merge pull request #3 from icapps/develop

Merge 'develop' into 'master'

.gitignore

@@ -28,5 +28,4 @@ package-lock.json
 
 # Yarn
 .yarnclean
-yarn.lock
 yarn-error.log

.npmignore

@@ -19,9 +19,11 @@ tslint.json
 
 # Testing and coverage
 test
+tests
+jest.config.js
 
 # Coverage directory used by tools like istanbul
-coverage
+coverage/
 
 # NPM
 .npm
@@ -33,3 +35,6 @@ package-lock.json
 .yarnrc
 yarn.lock
 yarn-error.log
+
+# Travis
+.travis.yml

.npmrc

@@ -0,0 +1 @@
+registry=https://registry.npmjs.org/

.travis.yml

@@ -16,4 +16,7 @@ cache:
     - "node_modules"
 
 script:
-  - yarn run test
+  - yarn run test:coverage
+
+# Send coverage data to Coveralls
+after_script: "cat coverage/lcov.info | node_modules/coveralls/bin/coveralls.js"

.yarnrc

@@ -1 +1 @@
-registry "https://npm.icapps.com/"
+registry "https://registry.npmjs.org/"

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at development@icapps.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.

HISTORY.md

@@ -0,0 +1,3 @@
+# Treehouse errors Changelog
+
+All notable changes to this project will be documented in this file.

LICENSE → LICENSE.md

@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright (c) 2018 Brent Van Geertruy
 

README.md

@@ -1,2 +1,165 @@
-Treehouse Errors
-=========
+# Treehouse Errors
+
+Custom NodeJS error classes and definitions with an error parser utility function
+
+[![npm version](https://badge.fury.io/js/tree-house-errors.svg)](https://badge.fury.io/js/tree-house-errors)
+[![Dependencies](https://david-dm.org/icapps/tree-house-errors.svg)](https://david-dm.org/icapps/tree-house-errors.svg)
+[![Build Status](https://travis-ci.org/icapps/tree-house-errors.svg?branch=master)](https://travis-ci.org/icapps/tree-house-errors)
+[![Coverage Status](https://coveralls.io/repos/github/icapps/tree-house-errors/badge.svg)](https://coveralls.io/github/icapps/tree-house-errors)
+
+## Installation
+
+Install via npm
+
+```shell
+npm install tree-house-errors
+```
+
+or via yarn
+
+```shell
+yarn add tree-house-errors
+```
+
+## Error types
+
+### ApiError
+
+Base error class which extends from the `Error` class.
+
+```javascript
+// All keys are required
+const error = {
+  code: 'BAD_REQUEST_DUE_TO',
+  message: 'This is a bad request',
+}
+
+// All keys are optional
+const optionalArgs = {
+  message: 'Overwrite the message for custom error',
+  detail: 'Extra details containing pertinent information',
+  stack: 'stacktrace...',
+}
+
+throw new ApiError(400, error, optionalArgs);
+```
+
+### BadRequestError
+
+extends from ApiError with a preset of status code 400 and BAD_REQUEST as error.
+
+```javascript
+throw new BadRequestError(); // or
+throw new BadRequestError(error, optionalArgs);
+```
+
+### NotFoundError
+
+extends from ApiError with a preset of status code 404 and RESOURCE_NOT_FOUND as error.
+
+```javascript
+throw new NotFoundError(); // or
+throw new NotFoundError(error, optionalArgs);
+```
+
+### ForbiddenError
+
+extends from ApiError with a preset of status code 403 and FORBIDDEN as error.
+
+```javascript
+throw new ForbiddenError(); // or
+throw new ForbiddenError(error, optionalArgs);
+```
+
+### InternalServerError
+
+extends from ApiError with a preset of status code 500 and INTERNAL_ERROR as error.
+
+```javascript
+throw new InternalServerError(); // or
+throw new InternalServerError(error, optionalArgs);
+```
+
+### UnauthorizedError
+
+extends from ApiError with a preset of status code 401 and UNAUTHORIZED as error.
+
+```javascript
+throw new UnauthorizedError(); // or
+throw new UnauthorizedError(error, optionalArgs);
+```
+
+### ValidationError
+
+extends from ApiError with a preset of status code 400 and INVALID_INPUT as error.
+
+```javascript
+throw new ValidationError(); // or
+throw new ValidationError(error, optionalArgs);
+```
+
+### AuthenticationError
+
+extends from ApiError with a preset of status code 400 and AUTHENTICATION_FAILED as error.
+
+```javascript
+throw new AuthenticationError(); // or
+throw new AuthenticationError(error, optionalArgs);
+```
+
+## Error definitions
+
+Predefined error types that can be used over multiple projects with a message and code per type. The current list provides following errors:
+
+```javascript
+INTERNAL_ERROR:           { code: 'INTERNAL_ERROR', message: 'An unkown error occurred' },
+INVALID_INPUT:            { code: 'INVALID_INPUT', message: 'Invalid input provided' },
+AUTHENTICATION_FAILED:    { code: 'AUTHENTICATION_FAILED', message: 'Authentication failed' },
+BAD_REQUEST:              { code: 'BAD_REQUEST', message: 'Bad request' },
+MISSING_HEADERS:          { code: 'MISSING_HEADERS', message: 'Missing headers' },
+UNAUTHORIZED:             { code: 'UNAUTHORIZED', message: 'Unauthorized' },
+FORBIDDEN:                { code: 'FORBIDDEN', message: 'No access' },
+RESOURCE_NOT_FOUND:       { code: 'RESOURCE_NOT_FOUND', message: 'Resource not found' },
+```
+
+Example
+
+```javascript
+import { errorConfig as errors } from 'tree-house-errors'
+throw new ApiError(400, errors.BAD_REQUEST);
+```
+
+## Error parsing
+
+### parseErrors(error)
+
+Parse any data into an error object with all properties needed for jsonade parser. Also parses `express-validation` errors.
+
+```javascript
+const error = new BadRequestError(...);
+const parsedError = parseErrors(error);
+
+// jsonade serializer afterwards (optional)
+serializer.serialize([parsedError]);
+```
+
+## Tests
+
+- You can run `yarn test` to run all tests
+- You can run `yarn test:coverage` to run all tests with coverage report
+
+## Bugs
+
+When you find issues, please report them:
+
+- web: [https://github.com/icapps/tree-house-errors/issues](https://github.com/icapps/tree-house-errors/issues)
+
+Be sure to include all of the output from the npm command that didn't work as expected. The npm-debug.log file is also helpful to provide.
+
+## Authors
+
+See the list of [contributors](https://github.com/icapps/tree-house-errors/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

jest.config.js

@@ -20,11 +20,10 @@ module.exports = {
     "\\.(ts|tsx)$": "<rootDir>/node_modules/ts-jest/preprocessor.js"
   },
   testRegex: "/tests/.*\\.(ts|tsx|js)$",
-  mapCoverage: true,
   coveragePathIgnorePatterns: [
     '/node_modules/',
     'src/index.ts',
-    'src/config',
-    'src/lib/base.*'
+    'src/lib/errorConfig.ts',
+    'src/lib/constants.ts'
   ],
 };

package.json

@@ -1,13 +1,12 @@
 {
   "name": "tree-house-errors",
   "version": "1.0.0",
-  "description": "Tree House Errors module",
-  "main": "./build/index.js",
+  "description": "NodeJS default error definitions with an error parser utility function",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
   "scripts": {
-    "cleanup": "rm -rf ./build/*",
-    "build": "yarn cleanup && tsc",
-    "start": "node ./build/index.js",
-    "serve": "nodemon --exec ./node_modules/.bin/ts-node -- ./src/index.ts",
+    "clean": "rimraf ./build",
+    "build": "yarn clean && tsc",
     "lint": "tslint 'src/**/*.ts'",
     "test": "jest --forceExit",
     "test:coverage": "jest --coverage --collectCoverageFrom=src/**/*.ts --forceExit",
@@ -18,40 +17,51 @@
   "precommit": [
     "lint"
   ],
+  "dependencies": {
+    "express-validation": "~1.0.2",
+    "http-status": "~1.0.1",
+    "joi": "~13.1.2",
+    "uuid": "~3.2.1"
+  },
   "devDependencies": {
-    "@types/node": "^8.0.47",
-    "jest": "^21.2.1",
-    "nodemon": "^1.12.1",
+    "@types/http-status": "~0.2.30",
+    "@types/jest": "~22.2.0",
+    "@types/uuid": "~3.4.3",
+    "coveralls": "^3.0.0",
+    "jest": "^22.1.4",
     "pre-commit": "^1.2.2",
+    "rimraf": "^2.6.2",
     "supertest": "^3.0.0",
-    "ts-jest": "^21.1.4",
-    "ts-node": "^3.0.6",
-    "tslint": "^5.8.0",
-    "tslint-config-airbnb": "^5.3.0",
-    "typescript": "^2.6.0"
+    "ts-jest": "^22.4.2",
+    "tslint": "^5.9.1",
+    "tslint-config-airbnb": "^5.8.0",
+    "typescript": "^2.7.2"
   },
   "engines": {
-    "node": ">=4.0.0"
+    "node": ">=6.0.0"
   },
+  "contributors": [
+    {
+      "name": "Willem Horsten",
+      "email": "willem.horsten@icapps.com"
+    },
+    {
+      "name": "Brent Van Geertruy",
+      "email": "brent.vangeertruy@icapps.com"
+    }
+  ],
   "directories": {
-    "test": "test"
+    "test": "tests"
   },
   "keywords": [
     "tree House",
     "treehouse",
     "errors"
   ],
-  "author": "Brent Van Geertruy <brentvangeertruy@outlook.com>",
   "license": "MIT",
   "repository": "git@github.com:icapps/tree-house-errors.git",
   "bugs": {
     "url": "https://github.com/icapps/tree-house-errors/issues"
   },
-  "homepage": "https://github.com/icapps/tree-house-errors#readme",
-  "dependencies": {
-    "express-validation": "^1.0.2",
-    "http-status": "^1.0.1",
-    "jsonade": "^1.1.0",
-    "uuid": "^3.2.1"
-  }
+  "homepage": "https://github.com/icapps/tree-house-errors#readme"
 }

src/index.ts

@@ -1,2 +1,3 @@
-export { handleErrors } from './lib/errorHandler';
+export { parseErrors } from './lib/errorParser';
+export { errorConfig as errors } from './lib/errorConfig';
 export * from './lib/errors';