Add 402 payment required (#130)

Closes #128

README.md

@@ -191,6 +191,26 @@ Generates the following response:
 }
 ```
 
+### `Boom.paymentRequired([message], [data])`
+
+Returns a 402 Payment Required error where:
+- `message` - optional message.
+- `data` - optional additional error data.
+
+```js
+Boom.paymentRequired('bandwidth used');
+```
+
+Generates the following response payload:
+
+```json
+{
+    "statusCode": 402,
+    "error": "Payment Required",
+    "message": "bandwidth used"
+}
+```
+
 ### `Boom.forbidden([message], [data])`
 
 Returns a 403 Forbidden error where:

lib/index.js

@@ -220,6 +220,12 @@ exports.unauthorized = function (message, scheme, attributes) {          // Or f
 };
 
 
+exports.paymentRequired = function (message, data) {
+
+    return internals.create(402, message, data, exports.paymentRequired);
+};
+
+
 exports.forbidden = function (message, data) {
 
     return internals.create(403, message, data, exports.forbidden);

test/index.js

@@ -239,6 +239,28 @@ describe('unauthorized()', () => {
 });
 
 
+describe('paymentRequired()', () => {
+
+    it('returns a 402 error statusCode', (done) => {
+
+        expect(Boom.paymentRequired().output.statusCode).to.equal(402);
+        done();
+    });
+
+    it('sets the message with the passed in message', (done) => {
+
+        expect(Boom.paymentRequired('my message').message).to.equal('my message');
+        done();
+    });
+
+    it('sets the message to HTTP status if none provided', (done) => {
+
+        expect(Boom.paymentRequired().message).to.equal('Payment Required');
+        done();
+    });
+});
+
+
 describe('methodNotAllowed()', () => {
 
     it('returns a 405 error statusCode', (done) => {