Added HTTP code 423 Locked (#112)

Author: Jason Maurer

README.md

@@ -508,6 +508,26 @@ Generates the following response payload:
 }
 ```
 
+### `Boom.locked([message], [data])`
+
+Returns a 423 Locked error where:
+- `message` - optional message.
+- `data` - optional additional error data.
+
+```js
+Boom.locked('this resource has been locked');
+```
+
+Generates the following response payload:
+
+```json
+{
+    "statusCode": 423,
+    "error": "Locked",
+    "message": "this resource has been locked"
+}
+```
+
 ### `Boom.preconditionRequired([message], [data])`
 
 Returns a 428 Precondition Required error where:

lib/index.js

@@ -316,6 +316,12 @@ exports.badData = function (message, data) {
 };
 
 
+exports.locked = function (message, data) {
+
+    return internals.create(423, message, data, exports.locked);
+};
+
+
 exports.preconditionRequired = function (message, data) {
 
     return internals.create(428, message, data, exports.preconditionRequired);

test/index.js

@@ -463,6 +463,22 @@ describe('badData()', () => {
 });
 
 
+describe('locked()', () => {
+
+    it('returns a 423 error statusCode', (done) => {
+
+        expect(Boom.locked().output.statusCode).to.equal(423);
+        done();
+    });
+
+    it('sets the message with the passed in message', (done) => {
+
+        expect(Boom.locked('my message').message).to.equal('my message');
+        done();
+    });
+});
+
+
 describe('preconditionRequired()', () => {
 
     it('returns a 428 error statusCode', (done) => {