Template Upload
This commit is contained in:
18
node_modules/boom/.npmignore
generated
vendored
Normal file
18
node_modules/boom/.npmignore
generated
vendored
Normal file
@ -0,0 +1,18 @@
|
||||
.idea
|
||||
*.iml
|
||||
npm-debug.log
|
||||
dump.rdb
|
||||
node_modules
|
||||
results.tap
|
||||
results.xml
|
||||
npm-shrinkwrap.json
|
||||
config.json
|
||||
.DS_Store
|
||||
*/.DS_Store
|
||||
*/*/.DS_Store
|
||||
._*
|
||||
*/._*
|
||||
*/*/._*
|
||||
coverage.*
|
||||
lib-cov
|
||||
|
8
node_modules/boom/.travis.yml
generated
vendored
Normal file
8
node_modules/boom/.travis.yml
generated
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
language: node_js
|
||||
|
||||
node_js:
|
||||
- 0.10
|
||||
- 4.0
|
||||
|
||||
sudo: false
|
||||
|
1
node_modules/boom/CONTRIBUTING.md
generated
vendored
Normal file
1
node_modules/boom/CONTRIBUTING.md
generated
vendored
Normal file
@ -0,0 +1 @@
|
||||
Please view our [hapijs contributing guide](https://github.com/hapijs/hapi/blob/master/CONTRIBUTING.md).
|
28
node_modules/boom/LICENSE
generated
vendored
Normal file
28
node_modules/boom/LICENSE
generated
vendored
Normal file
@ -0,0 +1,28 @@
|
||||
Copyright (c) 2012-2014, Walmart and other contributors.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* The names of any contributors may not be used to endorse or promote
|
||||
products derived from this software without specific prior written
|
||||
permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY
|
||||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
* * *
|
||||
|
||||
The complete list of contributors can be found at: https://github.com/hapijs/boom/graphs/contributors
|
652
node_modules/boom/README.md
generated
vendored
Normal file
652
node_modules/boom/README.md
generated
vendored
Normal file
@ -0,0 +1,652 @@
|
||||

|
||||
|
||||
HTTP-friendly error objects
|
||||
|
||||
[](http://travis-ci.org/hapijs/boom)
|
||||
[](https://www.npmjs.com/package/boom)
|
||||
|
||||
Lead Maintainer: [Adam Bretz](https://github.com/arb)
|
||||
|
||||
**boom** provides a set of utilities for returning HTTP errors. Each utility returns a `Boom` error response
|
||||
object (instance of `Error`) which includes the following properties:
|
||||
- `isBoom` - if `true`, indicates this is a `Boom` object instance.
|
||||
- `isServer` - convenience bool indicating status code >= 500.
|
||||
- `message` - the error message.
|
||||
- `output` - the formatted response. Can be directly manipulated after object construction to return a custom
|
||||
error response. Allowed root keys:
|
||||
- `statusCode` - the HTTP status code (typically 4xx or 5xx).
|
||||
- `headers` - an object containing any HTTP headers where each key is a header name and value is the header content.
|
||||
- `payload` - the formatted object used as the response payload (stringified). Can be directly manipulated but any
|
||||
changes will be lost
|
||||
if `reformat()` is called. Any content allowed and by default includes the following content:
|
||||
- `statusCode` - the HTTP status code, derived from `error.output.statusCode`.
|
||||
- `error` - the HTTP status message (e.g. 'Bad Request', 'Internal Server Error') derived from `statusCode`.
|
||||
- `message` - the error message derived from `error.message`.
|
||||
- inherited `Error` properties.
|
||||
|
||||
The `Boom` object also supports the following method:
|
||||
- `reformat()` - rebuilds `error.output` using the other object properties.
|
||||
|
||||
## Overview
|
||||
|
||||
- Helper methods
|
||||
- [`wrap(error, [statusCode], [message])`](#wraperror-statuscode-message)
|
||||
- [`create(statusCode, [message], [data])`](#createstatuscode-message-data)
|
||||
- HTTP 4xx Errors
|
||||
- 400: [`Boom.badRequest([message], [data])`](#boombadrequestmessage-data)
|
||||
- 401: [`Boom.unauthorized([message], [scheme], [attributes])`](#boomunauthorizedmessage-scheme-attributes)
|
||||
- 403: [`Boom.forbidden([message], [data])`](#boomforbiddenmessage-data)
|
||||
- 404: [`Boom.notFound([message], [data])`](#boomnotfoundmessage-data)
|
||||
- 405: [`Boom.methodNotAllowed([message], [data])`](#boommethodnotallowedmessage-data)
|
||||
- 406: [`Boom.notAcceptable([message], [data])`](#boomnotacceptablemessage-data)
|
||||
- 407: [`Boom.proxyAuthRequired([message], [data])`](#boomproxyauthrequiredmessage-data)
|
||||
- 408: [`Boom.clientTimeout([message], [data])`](#boomclienttimeoutmessage-data)
|
||||
- 409: [`Boom.conflict([message], [data])`](#boomconflictmessage-data)
|
||||
- 410: [`Boom.resourceGone([message], [data])`](#boomresourcegonemessage-data)
|
||||
- 411: [`Boom.lengthRequired([message], [data])`](#boomlengthrequiredmessage-data)
|
||||
- 412: [`Boom.preconditionFailed([message], [data])`](#boompreconditionfailedmessage-data)
|
||||
- 413: [`Boom.entityTooLarge([message], [data])`](#boomentitytoolargemessage-data)
|
||||
- 414: [`Boom.uriTooLong([message], [data])`](#boomuritoolongmessage-data)
|
||||
- 415: [`Boom.unsupportedMediaType([message], [data])`](#boomunsupportedmediatypemessage-data)
|
||||
- 416: [`Boom.rangeNotSatisfiable([message], [data])`](#boomrangenotsatisfiablemessage-data)
|
||||
- 417: [`Boom.expectationFailed([message], [data])`](#boomexpectationfailedmessage-data)
|
||||
- 422: [`Boom.badData([message], [data])`](#boombaddatamessage-data)
|
||||
- 428: [`Boom.preconditionRequired([message], [data])`](#boompreconditionrequiredmessage-data)
|
||||
- 429: [`Boom.tooManyRequests([message], [data])`](#boomtoomanyrequestsmessage-data)
|
||||
- HTTP 5xx Errors
|
||||
- 500: [`Boom.badImplementation([message], [data])`](#boombadimplementationmessage-data)
|
||||
- 501: [`Boom.notImplemented([message], [data])`](#boomnotimplementedmessage-data)
|
||||
- 502: [`Boom.badGateway([message], [data])`](#boombadgatewaymessage-data)
|
||||
- 503: [`Boom.serverTimeout([message], [data])`](#boomservertimeoutmessage-data)
|
||||
- 504: [`Boom.gatewayTimeout([message], [data])`](#boomgatewaytimeoutmessage-data)
|
||||
- [FAQ](#faq)
|
||||
|
||||
|
||||
## Helper Methods
|
||||
|
||||
### `wrap(error, [statusCode], [message])`
|
||||
|
||||
Decorates an error with the **boom** properties where:
|
||||
- `error` - the error object to wrap. If `error` is already a **boom** object, returns back the same object.
|
||||
- `statusCode` - optional HTTP status code. Defaults to `500`.
|
||||
- `message` - optional message string. If the error already has a message, it adds the message as a prefix.
|
||||
Defaults to no message.
|
||||
|
||||
```js
|
||||
var error = new Error('Unexpected input');
|
||||
Boom.wrap(error, 400);
|
||||
```
|
||||
|
||||
### `create(statusCode, [message], [data])`
|
||||
|
||||
Generates an `Error` object with the **boom** decorations where:
|
||||
- `statusCode` - an HTTP error code number. Must be greater or equal 400.
|
||||
- `message` - optional message string.
|
||||
- `data` - additional error data set to `error.data` property.
|
||||
|
||||
```js
|
||||
var error = Boom.create(400, 'Bad request', { timestamp: Date.now() });
|
||||
```
|
||||
|
||||
## HTTP 4xx Errors
|
||||
|
||||
### `Boom.badRequest([message], [data])`
|
||||
|
||||
Returns a 400 Bad Request error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.badRequest('invalid query');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 400,
|
||||
"error": "Bad Request",
|
||||
"message": "invalid query"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.unauthorized([message], [scheme], [attributes])`
|
||||
|
||||
Returns a 401 Unauthorized error where:
|
||||
- `message` - optional message.
|
||||
- `scheme` can be one of the following:
|
||||
- an authentication scheme name
|
||||
- an array of string values. These values will be separated by ', ' and set to the 'WWW-Authenticate' header.
|
||||
- `attributes` - an object of values to use while setting the 'WWW-Authenticate' header. This value is only used
|
||||
when `schema` is a string, otherwise it is ignored. Every key/value pair will be included in the
|
||||
'WWW-Authenticate' in the format of 'key="value"' as well as in the response payload under the `attributes` key.
|
||||
`null` and `undefined` will be replaced with an empty string. If `attributes` is set, `message` will be used as
|
||||
the 'error' segment of the 'WWW-Authenticate' header. If `message` is unset, the 'error' segment of the header
|
||||
will not be present and `isMissing` will be true on the error object.
|
||||
|
||||
If either `scheme` or `attributes` are set, the resultant `Boom` object will have the 'WWW-Authenticate' header set for the response.
|
||||
|
||||
```js
|
||||
Boom.unauthorized('invalid password');
|
||||
```
|
||||
|
||||
Generates the following response:
|
||||
|
||||
```json
|
||||
"payload": {
|
||||
"statusCode": 401,
|
||||
"error": "Unauthorized",
|
||||
"message": "invalid password"
|
||||
},
|
||||
"headers" {}
|
||||
```
|
||||
|
||||
```js
|
||||
Boom.unauthorized('invalid password', 'sample');
|
||||
```
|
||||
|
||||
Generates the following response:
|
||||
|
||||
```json
|
||||
"payload": {
|
||||
"statusCode": 401,
|
||||
"error": "Unauthorized",
|
||||
"message": "invalid password",
|
||||
"attributes": {
|
||||
"error": "invalid password"
|
||||
}
|
||||
},
|
||||
"headers" {
|
||||
"WWW-Authenticate": "sample error=\"invalid password\""
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
Boom.unauthorized('invalid password', 'sample', { ttl: 0, cache: null, foo: 'bar' });
|
||||
```
|
||||
|
||||
Generates the following response:
|
||||
|
||||
```json
|
||||
"payload": {
|
||||
"statusCode": 401,
|
||||
"error": "Unauthorized",
|
||||
"message": "invalid password",
|
||||
"attributes": {
|
||||
"error": "invalid password",
|
||||
"ttl": 0,
|
||||
"cache": "",
|
||||
"foo": "bar"
|
||||
}
|
||||
},
|
||||
"headers" {
|
||||
"WWW-Authenticate": "sample ttl=\"0\", cache=\"\", foo=\"bar\", error=\"invalid password\""
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.forbidden([message], [data])`
|
||||
|
||||
Returns a 403 Forbidden error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.forbidden('try again some time');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 403,
|
||||
"error": "Forbidden",
|
||||
"message": "try again some time"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.notFound([message], [data])`
|
||||
|
||||
Returns a 404 Not Found error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.notFound('missing');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 404,
|
||||
"error": "Not Found",
|
||||
"message": "missing"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.methodNotAllowed([message], [data])`
|
||||
|
||||
Returns a 405 Method Not Allowed error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.methodNotAllowed('that method is not allowed');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 405,
|
||||
"error": "Method Not Allowed",
|
||||
"message": "that method is not allowed"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.notAcceptable([message], [data])`
|
||||
|
||||
Returns a 406 Not Acceptable error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.notAcceptable('unacceptable');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 406,
|
||||
"error": "Not Acceptable",
|
||||
"message": "unacceptable"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.proxyAuthRequired([message], [data])`
|
||||
|
||||
Returns a 407 Proxy Authentication Required error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.proxyAuthRequired('auth missing');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 407,
|
||||
"error": "Proxy Authentication Required",
|
||||
"message": "auth missing"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.clientTimeout([message], [data])`
|
||||
|
||||
Returns a 408 Request Time-out error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.clientTimeout('timed out');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 408,
|
||||
"error": "Request Time-out",
|
||||
"message": "timed out"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.conflict([message], [data])`
|
||||
|
||||
Returns a 409 Conflict error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.conflict('there was a conflict');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 409,
|
||||
"error": "Conflict",
|
||||
"message": "there was a conflict"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.resourceGone([message], [data])`
|
||||
|
||||
Returns a 410 Gone error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.resourceGone('it is gone');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 410,
|
||||
"error": "Gone",
|
||||
"message": "it is gone"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.lengthRequired([message], [data])`
|
||||
|
||||
Returns a 411 Length Required error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.lengthRequired('length needed');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 411,
|
||||
"error": "Length Required",
|
||||
"message": "length needed"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.preconditionFailed([message], [data])`
|
||||
|
||||
Returns a 412 Precondition Failed error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.preconditionFailed();
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 412,
|
||||
"error": "Precondition Failed"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.entityTooLarge([message], [data])`
|
||||
|
||||
Returns a 413 Request Entity Too Large error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.entityTooLarge('too big');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 413,
|
||||
"error": "Request Entity Too Large",
|
||||
"message": "too big"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.uriTooLong([message], [data])`
|
||||
|
||||
Returns a 414 Request-URI Too Large error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.uriTooLong('uri is too long');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 414,
|
||||
"error": "Request-URI Too Large",
|
||||
"message": "uri is too long"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.unsupportedMediaType([message], [data])`
|
||||
|
||||
Returns a 415 Unsupported Media Type error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.unsupportedMediaType('that media is not supported');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 415,
|
||||
"error": "Unsupported Media Type",
|
||||
"message": "that media is not supported"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.rangeNotSatisfiable([message], [data])`
|
||||
|
||||
Returns a 416 Requested Range Not Satisfiable error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.rangeNotSatisfiable();
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 416,
|
||||
"error": "Requested Range Not Satisfiable"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.expectationFailed([message], [data])`
|
||||
|
||||
Returns a 417 Expectation Failed error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.expectationFailed('expected this to work');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 417,
|
||||
"error": "Expectation Failed",
|
||||
"message": "expected this to work"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.badData([message], [data])`
|
||||
|
||||
Returns a 422 Unprocessable Entity error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.badData('your data is bad and you should feel bad');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 422,
|
||||
"error": "Unprocessable Entity",
|
||||
"message": "your data is bad and you should feel bad"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.preconditionRequired([message], [data])`
|
||||
|
||||
Returns a 428 Precondition Required error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.preconditionRequired('you must supply an If-Match header');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 428,
|
||||
"error": "Precondition Required",
|
||||
"message": "you must supply an If-Match header"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.tooManyRequests([message], [data])`
|
||||
|
||||
Returns a 429 Too Many Requests error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.tooManyRequests('you have exceeded your request limit');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 429,
|
||||
"error": "Too Many Requests",
|
||||
"message": "you have exceeded your request limit"
|
||||
}
|
||||
```
|
||||
|
||||
## HTTP 5xx Errors
|
||||
|
||||
All 500 errors hide your message from the end user. Your message is recorded in the server log.
|
||||
|
||||
### `Boom.badImplementation([message], [data])`
|
||||
|
||||
Returns a 500 Internal Server Error error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.badImplementation('terrible implementation');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 500,
|
||||
"error": "Internal Server Error",
|
||||
"message": "An internal server error occurred"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.notImplemented([message], [data])`
|
||||
|
||||
Returns a 501 Not Implemented error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.notImplemented('method not implemented');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 501,
|
||||
"error": "Not Implemented",
|
||||
"message": "method not implemented"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.badGateway([message], [data])`
|
||||
|
||||
Returns a 502 Bad Gateway error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.badGateway('that is a bad gateway');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 502,
|
||||
"error": "Bad Gateway",
|
||||
"message": "that is a bad gateway"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.serverTimeout([message], [data])`
|
||||
|
||||
Returns a 503 Service Unavailable error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.serverTimeout('unavailable');
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 503,
|
||||
"error": "Service Unavailable",
|
||||
"message": "unavailable"
|
||||
}
|
||||
```
|
||||
|
||||
### `Boom.gatewayTimeout([message], [data])`
|
||||
|
||||
Returns a 504 Gateway Time-out error where:
|
||||
- `message` - optional message.
|
||||
- `data` - optional additional error data.
|
||||
|
||||
```js
|
||||
Boom.gatewayTimeout();
|
||||
```
|
||||
|
||||
Generates the following response payload:
|
||||
|
||||
```json
|
||||
{
|
||||
"statusCode": 504,
|
||||
"error": "Gateway Time-out"
|
||||
}
|
||||
```
|
||||
|
||||
## F.A.Q.
|
||||
|
||||
###### How do I include extra information in my responses? `output.payload` is missing `data`, what gives?
|
||||
|
||||
There is a reason the values passed back in the response payloads are pretty locked down. It's mostly for security and to not leak any important information back to the client. This means you will need to put in a little more effort to include extra information about your custom error. Check out the ["Error transformation"](https://github.com/hapijs/hapi/blob/master/API.md#error-transformation) section in the hapi documentation.
|
BIN
node_modules/boom/images/boom.png
generated
vendored
Normal file
BIN
node_modules/boom/images/boom.png
generated
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 29 KiB |
318
node_modules/boom/lib/index.js
generated
vendored
Normal file
318
node_modules/boom/lib/index.js
generated
vendored
Normal file
@ -0,0 +1,318 @@
|
||||
// Load modules
|
||||
|
||||
var Http = require('http');
|
||||
var Hoek = require('hoek');
|
||||
|
||||
|
||||
// Declare internals
|
||||
|
||||
var internals = {};
|
||||
|
||||
exports.wrap = function (error, statusCode, message) {
|
||||
|
||||
Hoek.assert(error instanceof Error, 'Cannot wrap non-Error object');
|
||||
return (error.isBoom ? error : internals.initialize(error, statusCode || 500, message));
|
||||
};
|
||||
|
||||
|
||||
exports.create = function (statusCode, message, data) {
|
||||
|
||||
return internals.create(statusCode, message, data, exports.create);
|
||||
};
|
||||
|
||||
internals.create = function (statusCode, message, data, ctor) {
|
||||
|
||||
var error = new Error(message ? message : undefined); // Avoids settings null message
|
||||
Error.captureStackTrace(error, ctor); // Filter the stack to our external API
|
||||
error.data = data || null;
|
||||
internals.initialize(error, statusCode);
|
||||
return error;
|
||||
};
|
||||
|
||||
internals.initialize = function (error, statusCode, message) {
|
||||
|
||||
var numberCode = parseInt(statusCode, 10);
|
||||
Hoek.assert(!isNaN(numberCode) && numberCode >= 400, 'First argument must be a number (400+):', statusCode);
|
||||
|
||||
error.isBoom = true;
|
||||
error.isServer = numberCode >= 500;
|
||||
|
||||
if (!error.hasOwnProperty('data')) {
|
||||
error.data = null;
|
||||
}
|
||||
|
||||
error.output = {
|
||||
statusCode: numberCode,
|
||||
payload: {},
|
||||
headers: {}
|
||||
};
|
||||
|
||||
error.reformat = internals.reformat;
|
||||
error.reformat();
|
||||
|
||||
if (!message &&
|
||||
!error.message) {
|
||||
|
||||
message = error.output.payload.error;
|
||||
}
|
||||
|
||||
if (message) {
|
||||
error.message = (message + (error.message ? ': ' + error.message : ''));
|
||||
}
|
||||
|
||||
return error;
|
||||
};
|
||||
|
||||
|
||||
internals.reformat = function () {
|
||||
|
||||
this.output.payload.statusCode = this.output.statusCode;
|
||||
this.output.payload.error = Http.STATUS_CODES[this.output.statusCode] || 'Unknown';
|
||||
|
||||
if (this.output.statusCode === 500) {
|
||||
this.output.payload.message = 'An internal server error occurred'; // Hide actual error from user
|
||||
}
|
||||
else if (this.message) {
|
||||
this.output.payload.message = this.message;
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
// 4xx Client Errors
|
||||
|
||||
exports.badRequest = function (message, data) {
|
||||
|
||||
return internals.create(400, message, data, exports.badRequest);
|
||||
};
|
||||
|
||||
|
||||
exports.unauthorized = function (message, scheme, attributes) { // Or function (message, wwwAuthenticate[])
|
||||
|
||||
var err = internals.create(401, message, undefined, exports.unauthorized);
|
||||
|
||||
if (!scheme) {
|
||||
return err;
|
||||
}
|
||||
|
||||
var wwwAuthenticate = '';
|
||||
var i = 0;
|
||||
var il = 0;
|
||||
|
||||
if (typeof scheme === 'string') {
|
||||
|
||||
// function (message, scheme, attributes)
|
||||
|
||||
wwwAuthenticate = scheme;
|
||||
|
||||
if (attributes || message) {
|
||||
err.output.payload.attributes = {};
|
||||
}
|
||||
|
||||
if (attributes) {
|
||||
var names = Object.keys(attributes);
|
||||
for (i = 0, il = names.length; i < il; ++i) {
|
||||
var name = names[i];
|
||||
if (i) {
|
||||
wwwAuthenticate += ',';
|
||||
}
|
||||
|
||||
var value = attributes[name];
|
||||
if (value === null ||
|
||||
value === undefined) { // Value can be zero
|
||||
|
||||
value = '';
|
||||
}
|
||||
wwwAuthenticate += ' ' + name + '="' + Hoek.escapeHeaderAttribute(value.toString()) + '"';
|
||||
err.output.payload.attributes[name] = value;
|
||||
}
|
||||
}
|
||||
|
||||
if (message) {
|
||||
if (attributes) {
|
||||
wwwAuthenticate += ',';
|
||||
}
|
||||
wwwAuthenticate += ' error="' + Hoek.escapeHeaderAttribute(message) + '"';
|
||||
err.output.payload.attributes.error = message;
|
||||
}
|
||||
else {
|
||||
err.isMissing = true;
|
||||
}
|
||||
}
|
||||
else {
|
||||
|
||||
// function (message, wwwAuthenticate[])
|
||||
|
||||
var wwwArray = scheme;
|
||||
for (i = 0, il = wwwArray.length; i < il; ++i) {
|
||||
if (i) {
|
||||
wwwAuthenticate += ', ';
|
||||
}
|
||||
|
||||
wwwAuthenticate += wwwArray[i];
|
||||
}
|
||||
}
|
||||
|
||||
err.output.headers['WWW-Authenticate'] = wwwAuthenticate;
|
||||
|
||||
return err;
|
||||
};
|
||||
|
||||
|
||||
exports.forbidden = function (message, data) {
|
||||
|
||||
return internals.create(403, message, data, exports.forbidden);
|
||||
};
|
||||
|
||||
|
||||
exports.notFound = function (message, data) {
|
||||
|
||||
return internals.create(404, message, data, exports.notFound);
|
||||
};
|
||||
|
||||
|
||||
exports.methodNotAllowed = function (message, data) {
|
||||
|
||||
return internals.create(405, message, data, exports.methodNotAllowed);
|
||||
};
|
||||
|
||||
|
||||
exports.notAcceptable = function (message, data) {
|
||||
|
||||
return internals.create(406, message, data, exports.notAcceptable);
|
||||
};
|
||||
|
||||
|
||||
exports.proxyAuthRequired = function (message, data) {
|
||||
|
||||
return internals.create(407, message, data, exports.proxyAuthRequired);
|
||||
};
|
||||
|
||||
|
||||
exports.clientTimeout = function (message, data) {
|
||||
|
||||
return internals.create(408, message, data, exports.clientTimeout);
|
||||
};
|
||||
|
||||
|
||||
exports.conflict = function (message, data) {
|
||||
|
||||
return internals.create(409, message, data, exports.conflict);
|
||||
};
|
||||
|
||||
|
||||
exports.resourceGone = function (message, data) {
|
||||
|
||||
return internals.create(410, message, data, exports.resourceGone);
|
||||
};
|
||||
|
||||
|
||||
exports.lengthRequired = function (message, data) {
|
||||
|
||||
return internals.create(411, message, data, exports.lengthRequired);
|
||||
};
|
||||
|
||||
|
||||
exports.preconditionFailed = function (message, data) {
|
||||
|
||||
return internals.create(412, message, data, exports.preconditionFailed);
|
||||
};
|
||||
|
||||
|
||||
exports.entityTooLarge = function (message, data) {
|
||||
|
||||
return internals.create(413, message, data, exports.entityTooLarge);
|
||||
};
|
||||
|
||||
|
||||
exports.uriTooLong = function (message, data) {
|
||||
|
||||
return internals.create(414, message, data, exports.uriTooLong);
|
||||
};
|
||||
|
||||
|
||||
exports.unsupportedMediaType = function (message, data) {
|
||||
|
||||
return internals.create(415, message, data, exports.unsupportedMediaType);
|
||||
};
|
||||
|
||||
|
||||
exports.rangeNotSatisfiable = function (message, data) {
|
||||
|
||||
return internals.create(416, message, data, exports.rangeNotSatisfiable);
|
||||
};
|
||||
|
||||
|
||||
exports.expectationFailed = function (message, data) {
|
||||
|
||||
return internals.create(417, message, data, exports.expectationFailed);
|
||||
};
|
||||
|
||||
exports.badData = function (message, data) {
|
||||
|
||||
return internals.create(422, message, data, exports.badData);
|
||||
};
|
||||
|
||||
|
||||
exports.preconditionRequired = function (message, data) {
|
||||
|
||||
return internals.create(428, message, data, exports.preconditionRequired);
|
||||
};
|
||||
|
||||
|
||||
exports.tooManyRequests = function (message, data) {
|
||||
|
||||
return internals.create(429, message, data, exports.tooManyRequests);
|
||||
};
|
||||
|
||||
|
||||
// 5xx Server Errors
|
||||
|
||||
exports.internal = function (message, data, statusCode) {
|
||||
|
||||
return internals.serverError(message, data, statusCode, exports.internal);
|
||||
};
|
||||
|
||||
internals.serverError = function (message, data, statusCode, ctor) {
|
||||
|
||||
var error;
|
||||
if (data instanceof Error) {
|
||||
error = exports.wrap(data, statusCode, message);
|
||||
} else {
|
||||
error = internals.create(statusCode || 500, message, undefined, ctor);
|
||||
error.data = data;
|
||||
}
|
||||
|
||||
return error;
|
||||
};
|
||||
|
||||
|
||||
exports.notImplemented = function (message, data) {
|
||||
|
||||
return internals.serverError(message, data, 501, exports.notImplemented);
|
||||
};
|
||||
|
||||
|
||||
exports.badGateway = function (message, data) {
|
||||
|
||||
return internals.serverError(message, data, 502, exports.badGateway);
|
||||
};
|
||||
|
||||
|
||||
exports.serverTimeout = function (message, data) {
|
||||
|
||||
return internals.serverError(message, data, 503, exports.serverTimeout);
|
||||
};
|
||||
|
||||
|
||||
exports.gatewayTimeout = function (message, data) {
|
||||
|
||||
return internals.serverError(message, data, 504, exports.gatewayTimeout);
|
||||
};
|
||||
|
||||
|
||||
exports.badImplementation = function (message, data) {
|
||||
|
||||
var err = internals.serverError(message, data, 500, exports.badImplementation);
|
||||
err.isDeveloperError = true;
|
||||
return err;
|
||||
};
|
89
node_modules/boom/package.json
generated
vendored
Normal file
89
node_modules/boom/package.json
generated
vendored
Normal file
@ -0,0 +1,89 @@
|
||||
{
|
||||
"_args": [
|
||||
[
|
||||
"boom@2.x.x",
|
||||
"C:\\Users\\x2mjbyrn\\Source\\Repos\\Skeleton\\node_modules\\hawk"
|
||||
]
|
||||
],
|
||||
"_from": "boom@>=2.0.0-0 <3.0.0-0",
|
||||
"_id": "boom@2.10.1",
|
||||
"_inCache": true,
|
||||
"_location": "/boom",
|
||||
"_nodeVersion": "0.10.40",
|
||||
"_npmUser": {
|
||||
"email": "arbretz@gmail.com",
|
||||
"name": "arb"
|
||||
},
|
||||
"_npmVersion": "2.11.1",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"name": "boom",
|
||||
"raw": "boom@2.x.x",
|
||||
"rawSpec": "2.x.x",
|
||||
"scope": null,
|
||||
"spec": ">=2.0.0-0 <3.0.0-0",
|
||||
"type": "range"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/cryptiles",
|
||||
"/hawk"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/boom/-/boom-2.10.1.tgz",
|
||||
"_shasum": "39c8918ceff5799f83f9492a848f625add0c766f",
|
||||
"_shrinkwrap": null,
|
||||
"_spec": "boom@2.x.x",
|
||||
"_where": "C:\\Users\\x2mjbyrn\\Source\\Repos\\Skeleton\\node_modules\\hawk",
|
||||
"bugs": {
|
||||
"url": "https://github.com/hapijs/boom/issues"
|
||||
},
|
||||
"dependencies": {
|
||||
"hoek": "2.x.x"
|
||||
},
|
||||
"description": "HTTP-friendly error objects",
|
||||
"devDependencies": {
|
||||
"code": "1.x.x",
|
||||
"lab": "7.x.x"
|
||||
},
|
||||
"directories": {},
|
||||
"dist": {
|
||||
"shasum": "39c8918ceff5799f83f9492a848f625add0c766f",
|
||||
"tarball": "https://registry.npmjs.org/boom/-/boom-2.10.1.tgz"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.10.40"
|
||||
},
|
||||
"gitHead": "ff1a662a86b39426cdd18f4441b112d307a34a6f",
|
||||
"homepage": "https://github.com/hapijs/boom#readme",
|
||||
"installable": true,
|
||||
"keywords": [
|
||||
"error",
|
||||
"http"
|
||||
],
|
||||
"license": "BSD-3-Clause",
|
||||
"main": "lib/index.js",
|
||||
"maintainers": [
|
||||
{
|
||||
"name": "hueniverse",
|
||||
"email": "eran@hueniverse.com"
|
||||
},
|
||||
{
|
||||
"name": "wyatt",
|
||||
"email": "wpreul@gmail.com"
|
||||
},
|
||||
{
|
||||
"name": "arb",
|
||||
"email": "arbretz@gmail.com"
|
||||
}
|
||||
],
|
||||
"name": "boom",
|
||||
"optionalDependencies": {},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git://github.com/hapijs/boom.git"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "lab -a code -t 100 -L",
|
||||
"test-cov-html": "lab -a code -r html -o coverage.html -L"
|
||||
},
|
||||
"version": "2.10.1"
|
||||
}
|
654
node_modules/boom/test/index.js
generated
vendored
Normal file
654
node_modules/boom/test/index.js
generated
vendored
Normal file
@ -0,0 +1,654 @@
|
||||
// Load modules
|
||||
|
||||
var Code = require('code');
|
||||
var Boom = require('../lib');
|
||||
var Lab = require('lab');
|
||||
|
||||
|
||||
// Declare internals
|
||||
|
||||
var internals = {};
|
||||
|
||||
|
||||
// Test shortcuts
|
||||
|
||||
var lab = exports.lab = Lab.script();
|
||||
var describe = lab.describe;
|
||||
var it = lab.it;
|
||||
var expect = Code.expect;
|
||||
|
||||
|
||||
it('returns the same object when already boom', function (done) {
|
||||
|
||||
var error = Boom.badRequest();
|
||||
var wrapped = Boom.wrap(error);
|
||||
expect(error).to.equal(wrapped);
|
||||
done();
|
||||
});
|
||||
|
||||
it('returns an error with info when constructed using another error', function (done) {
|
||||
|
||||
var error = new Error('ka-boom');
|
||||
error.xyz = 123;
|
||||
var err = Boom.wrap(error);
|
||||
expect(err.xyz).to.equal(123);
|
||||
expect(err.message).to.equal('ka-boom');
|
||||
expect(err.output).to.deep.equal({
|
||||
statusCode: 500,
|
||||
payload: {
|
||||
statusCode: 500,
|
||||
error: 'Internal Server Error',
|
||||
message: 'An internal server error occurred'
|
||||
},
|
||||
headers: {}
|
||||
});
|
||||
expect(err.data).to.equal(null);
|
||||
done();
|
||||
});
|
||||
|
||||
it('does not override data when constructed using another error', function (done) {
|
||||
|
||||
var error = new Error('ka-boom');
|
||||
error.data = { useful: 'data' };
|
||||
var err = Boom.wrap(error);
|
||||
expect(err.data).to.equal(error.data);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets new message when none exists', function (done) {
|
||||
|
||||
var error = new Error();
|
||||
var wrapped = Boom.wrap(error, 400, 'something bad');
|
||||
expect(wrapped.message).to.equal('something bad');
|
||||
done();
|
||||
});
|
||||
|
||||
it('throws when statusCode is not a number', function (done) {
|
||||
|
||||
expect(function () {
|
||||
|
||||
Boom.create('x');
|
||||
}).to.throw('First argument must be a number (400+): x');
|
||||
done();
|
||||
});
|
||||
|
||||
it('will cast a number-string to an integer', function (done) {
|
||||
|
||||
var codes = [
|
||||
{ input: '404', result: 404 },
|
||||
{ input: '404.1', result: 404 },
|
||||
{ input: 400, result: 400 },
|
||||
{ input: 400.123, result: 400 }];
|
||||
for (var i = 0, il = codes.length; i < il; ++i) {
|
||||
var code = codes[i];
|
||||
var err = Boom.create(code.input);
|
||||
expect(err.output.statusCode).to.equal(code.result);
|
||||
}
|
||||
|
||||
done();
|
||||
});
|
||||
|
||||
it('throws when statusCode is not finite', function (done) {
|
||||
|
||||
expect(function () {
|
||||
|
||||
Boom.create(1 / 0);
|
||||
}).to.throw('First argument must be a number (400+): null');
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets error code to unknown', function (done) {
|
||||
|
||||
var err = Boom.create(999);
|
||||
expect(err.output.payload.error).to.equal('Unknown');
|
||||
done();
|
||||
});
|
||||
|
||||
describe('create()', function () {
|
||||
|
||||
it('does not sets null message', function (done) {
|
||||
|
||||
var error = Boom.unauthorized(null);
|
||||
expect(error.output.payload.message).to.not.exist();
|
||||
expect(error.isServer).to.be.false();
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets message and data', function (done) {
|
||||
|
||||
var error = Boom.badRequest('Missing data', { type: 'user' });
|
||||
expect(error.data.type).to.equal('user');
|
||||
expect(error.output.payload.message).to.equal('Missing data');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('isBoom()', function () {
|
||||
|
||||
it('returns true for Boom object', function (done) {
|
||||
|
||||
expect(Boom.badRequest().isBoom).to.equal(true);
|
||||
done();
|
||||
});
|
||||
|
||||
it('returns false for Error object', function (done) {
|
||||
|
||||
expect((new Error()).isBoom).to.not.exist();
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('badRequest()', function () {
|
||||
|
||||
it('returns a 400 error statusCode', function (done) {
|
||||
|
||||
var error = Boom.badRequest();
|
||||
|
||||
expect(error.output.statusCode).to.equal(400);
|
||||
expect(error.isServer).to.be.false();
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.badRequest('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message to HTTP status if none provided', function (done) {
|
||||
|
||||
expect(Boom.badRequest().message).to.equal('Bad Request');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('unauthorized()', function () {
|
||||
|
||||
it('returns a 401 error statusCode', function (done) {
|
||||
|
||||
var err = Boom.unauthorized();
|
||||
expect(err.output.statusCode).to.equal(401);
|
||||
expect(err.output.headers).to.deep.equal({});
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.unauthorized('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
|
||||
it('returns a WWW-Authenticate header when passed a scheme', function (done) {
|
||||
|
||||
var err = Boom.unauthorized('boom', 'Test');
|
||||
expect(err.output.statusCode).to.equal(401);
|
||||
expect(err.output.headers['WWW-Authenticate']).to.equal('Test error="boom"');
|
||||
done();
|
||||
});
|
||||
|
||||
it('returns a WWW-Authenticate header set to the schema array value', function (done) {
|
||||
|
||||
var err = Boom.unauthorized(null, ['Test','one','two']);
|
||||
expect(err.output.statusCode).to.equal(401);
|
||||
expect(err.output.headers['WWW-Authenticate']).to.equal('Test, one, two');
|
||||
done();
|
||||
});
|
||||
|
||||
it('returns a WWW-Authenticate header when passed a scheme and attributes', function (done) {
|
||||
|
||||
var err = Boom.unauthorized('boom', 'Test', { a: 1, b: 'something', c: null, d: 0 });
|
||||
expect(err.output.statusCode).to.equal(401);
|
||||
expect(err.output.headers['WWW-Authenticate']).to.equal('Test a="1", b="something", c="", d="0", error="boom"');
|
||||
expect(err.output.payload.attributes).to.deep.equal({ a: 1, b: 'something', c: '', d: 0, error: 'boom' });
|
||||
done();
|
||||
});
|
||||
|
||||
it('returns a WWW-Authenticate header when passed attributes, missing error', function (done) {
|
||||
|
||||
var err = Boom.unauthorized(null, 'Test', { a: 1, b: 'something', c: null, d: 0 });
|
||||
expect(err.output.statusCode).to.equal(401);
|
||||
expect(err.output.headers['WWW-Authenticate']).to.equal('Test a="1", b="something", c="", d="0"');
|
||||
expect(err.isMissing).to.equal(true);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the isMissing flag when error message is empty', function (done) {
|
||||
|
||||
var err = Boom.unauthorized('', 'Basic');
|
||||
expect(err.isMissing).to.equal(true);
|
||||
done();
|
||||
});
|
||||
|
||||
it('does not set the isMissing flag when error message is not empty', function (done) {
|
||||
|
||||
var err = Boom.unauthorized('message', 'Basic');
|
||||
expect(err.isMissing).to.equal(undefined);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets a WWW-Authenticate when passed as an array', function (done) {
|
||||
|
||||
var err = Boom.unauthorized('message', ['Basic', 'Example e="1"', 'Another x="3", y="4"']);
|
||||
expect(err.output.headers['WWW-Authenticate']).to.equal('Basic, Example e="1", Another x="3", y="4"');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('methodNotAllowed()', function () {
|
||||
|
||||
it('returns a 405 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.methodNotAllowed().output.statusCode).to.equal(405);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.methodNotAllowed('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('notAcceptable()', function () {
|
||||
|
||||
it('returns a 406 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.notAcceptable().output.statusCode).to.equal(406);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.notAcceptable('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('proxyAuthRequired()', function () {
|
||||
|
||||
it('returns a 407 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.proxyAuthRequired().output.statusCode).to.equal(407);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.proxyAuthRequired('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('clientTimeout()', function () {
|
||||
|
||||
it('returns a 408 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.clientTimeout().output.statusCode).to.equal(408);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.clientTimeout('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('conflict()', function () {
|
||||
|
||||
it('returns a 409 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.conflict().output.statusCode).to.equal(409);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.conflict('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('resourceGone()', function () {
|
||||
|
||||
it('returns a 410 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.resourceGone().output.statusCode).to.equal(410);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.resourceGone('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('lengthRequired()', function () {
|
||||
|
||||
it('returns a 411 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.lengthRequired().output.statusCode).to.equal(411);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.lengthRequired('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('preconditionFailed()', function () {
|
||||
|
||||
it('returns a 412 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.preconditionFailed().output.statusCode).to.equal(412);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.preconditionFailed('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('entityTooLarge()', function () {
|
||||
|
||||
it('returns a 413 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.entityTooLarge().output.statusCode).to.equal(413);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.entityTooLarge('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('uriTooLong()', function () {
|
||||
|
||||
it('returns a 414 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.uriTooLong().output.statusCode).to.equal(414);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.uriTooLong('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('unsupportedMediaType()', function () {
|
||||
|
||||
it('returns a 415 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.unsupportedMediaType().output.statusCode).to.equal(415);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.unsupportedMediaType('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('rangeNotSatisfiable()', function () {
|
||||
|
||||
it('returns a 416 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.rangeNotSatisfiable().output.statusCode).to.equal(416);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.rangeNotSatisfiable('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('expectationFailed()', function () {
|
||||
|
||||
it('returns a 417 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.expectationFailed().output.statusCode).to.equal(417);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.expectationFailed('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('badData()', function () {
|
||||
|
||||
it('returns a 422 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.badData().output.statusCode).to.equal(422);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.badData('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('preconditionRequired()', function () {
|
||||
|
||||
it('returns a 428 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.preconditionRequired().output.statusCode).to.equal(428);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.preconditionRequired('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('tooManyRequests()', function () {
|
||||
|
||||
it('returns a 429 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.tooManyRequests().output.statusCode).to.equal(429);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed-in message', function (done) {
|
||||
|
||||
expect(Boom.tooManyRequests('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('serverTimeout()', function () {
|
||||
|
||||
it('returns a 503 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.serverTimeout().output.statusCode).to.equal(503);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.serverTimeout('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('forbidden()', function () {
|
||||
|
||||
it('returns a 403 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.forbidden().output.statusCode).to.equal(403);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.forbidden('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('notFound()', function () {
|
||||
|
||||
it('returns a 404 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.notFound().output.statusCode).to.equal(404);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.notFound('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('internal()', function () {
|
||||
|
||||
it('returns a 500 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.internal().output.statusCode).to.equal(500);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
var err = Boom.internal('my message');
|
||||
expect(err.message).to.equal('my message');
|
||||
expect(err.isServer).to.true();
|
||||
expect(err.output.payload.message).to.equal('An internal server error occurred');
|
||||
done();
|
||||
});
|
||||
|
||||
it('passes data on the callback if its passed in', function (done) {
|
||||
|
||||
expect(Boom.internal('my message', { my: 'data' }).data.my).to.equal('data');
|
||||
done();
|
||||
});
|
||||
|
||||
it('returns an error with composite message', function (done) {
|
||||
|
||||
try {
|
||||
JSON.parse('{');
|
||||
}
|
||||
catch (err) {
|
||||
var boom = Boom.internal('Someting bad', err);
|
||||
expect(boom.message).to.equal('Someting bad: Unexpected end of input');
|
||||
expect(boom.isServer).to.be.true();
|
||||
done();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('notImplemented()', function () {
|
||||
|
||||
it('returns a 501 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.notImplemented().output.statusCode).to.equal(501);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.notImplemented('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('badGateway()', function () {
|
||||
|
||||
it('returns a 502 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.badGateway().output.statusCode).to.equal(502);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.badGateway('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('gatewayTimeout()', function () {
|
||||
|
||||
it('returns a 504 error statusCode', function (done) {
|
||||
|
||||
expect(Boom.gatewayTimeout().output.statusCode).to.equal(504);
|
||||
done();
|
||||
});
|
||||
|
||||
it('sets the message with the passed in message', function (done) {
|
||||
|
||||
expect(Boom.gatewayTimeout('my message').message).to.equal('my message');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('badImplementation()', function () {
|
||||
|
||||
it('returns a 500 error statusCode', function (done) {
|
||||
|
||||
var err = Boom.badImplementation();
|
||||
expect(err.output.statusCode).to.equal(500);
|
||||
expect(err.isDeveloperError).to.equal(true);
|
||||
expect(err.isServer).to.be.true();
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
describe('stack trace', function () {
|
||||
|
||||
it('should omit lib', function (done) {
|
||||
|
||||
['badRequest', 'unauthorized', 'forbidden', 'notFound', 'methodNotAllowed',
|
||||
'notAcceptable', 'proxyAuthRequired', 'clientTimeout', 'conflict',
|
||||
'resourceGone', 'lengthRequired', 'preconditionFailed', 'entityTooLarge',
|
||||
'uriTooLong', 'unsupportedMediaType', 'rangeNotSatisfiable', 'expectationFailed',
|
||||
'badData', 'preconditionRequired', 'tooManyRequests',
|
||||
|
||||
// 500s
|
||||
'internal', 'notImplemented', 'badGateway', 'serverTimeout', 'gatewayTimeout',
|
||||
'badImplementation'
|
||||
].forEach(function (name) {
|
||||
|
||||
var err = Boom[name]();
|
||||
expect(err.stack).to.not.match(/\/lib\/index\.js/);
|
||||
});
|
||||
|
||||
done();
|
||||
});
|
||||
});
|
Reference in New Issue
Block a user