Update to work with latest versions of Node, Express, and Mongoose. Special thank you to @maxiejbe
Baucis was awarded the MongoDB Open Source Hack Contest 2014!
Update readme and roadmap.
Fix some typos.
Add more info about baucis.rest to the README.
Use caret for dependencies. If you're using an older npm, let's talk about a fork or other migration path.
README tweaks. More tests.
Minor tweaks.
Revisit all error conditions. Make 422 error response body an array.
Fix issue #183.
Update baucis-error version.
Make 200 default for empty collection/search. Split out baucis-errors and baucis-vivify.
Fix #149. Fix #181. Move handleErrors from Api to Controller. Add parentController method. Add emptyCollection method to controller. It is set to 204 by defult, but can be set to 200, 204, or 404 to set how collection endpoint requests handle no matching documents per controller.
Use published version of baucis-json.
Allow turning off error handling per API. Fix #178.
baucis().handleErrors(false);
Correctly handle errors in user streams. Improve error handling. Fix #177.
Rename baucisPath to fragment. Use a decorator for Mongoose models, rather than a wrapper object. Wrap mongoose.model to add decorator to all models. Move lastModified and locking to model objects.
Move parsers/formatters from Api to baucis object.
Add PATENTS file. A little more cleaning up.
Remove request.baucis.controller. Remove controller.api.
Express 4! del -> delete Controller activation is no longer required (again) API activation is not required Controller properties can change at runtime, and the API will now reflect those changes Remove X-Powered-By for all baucis routes
Merge to master and make small update to the README.
Add Model. Change X-Baucis-Update-Operator to Update-Operator. Begin refactoring Api into smaller decorators.
Update to the latest baucis-json. Fixes an issue where POSTing or PUTing some kinds of malformed JSON bodies could crash the instance. Now sends a 400 Bad Request for malformed JSON. Fix #168
Check additional opportunities to send 400 Bad Request.
README improvements.
Fix bug that overwrote Express' parent property. Please use the controller.children property instead. (Fixes #161.)
Fix publish and some typos.
Add controller.vivify method for embedding subcontrollers. Deprecate basePath controller option. Update configuration to "methods over values." Move baucis errors from baucis.errors to baucis.Error. Enable relations by default. Improve & update README.
Handle duplicate key error as a 422. (Fix #160).
Fix #159.
Add context to incoming and outgoing user streams. (Fix #151).
Internal refactor to use protected pipeline method for internal as well as external stream interfaces.
Update to use the latest baucis-json.
Don't try to set the Last-Modified header if the feature isn't enabled (fix #157).
Fix an issue where the request's content type would not be recognized when it used a MIME type parameter. (#152)
Use the mongoose toCollectionName util method, instead of the lingo module.
Deprecate documents stage of middleware.
Update dependency for deco.
Updated outdated dependencies.
Improve error messages, correct some status codes, fix issue #147.
Discriminators - correctly handle POST. The correct model is used based on the __t that is passed in the request body.
Use tilde instead of caret so older npms don't fall over!
Move JSON parser and formatter to a separate module.
Fix outdated require.
Add distinct request query option.
Fix missing dependency on event-stream.
Send 415 on unparseable request content type. Also added experimental Api.setParser method.
Ensure 406 is sent on requests with Accept header that cannot be fulfilled. Fix bug with calling api.setFormatter.
Allow passing in map function to incoming/outgoing user streams. It's turned into a stream internally.
Add experimental Api.setFormatter method.
Fix incorrect Accept header.
Allow passing in a mongoose model to the model controller option, in addition to string name.
Update dependency for Express to 3.5.
Fix issue #142. Also, use event-stream over highland.
Fix issue #141
Fix issue #131
Add documentation for streaming and clean up documentation.
Republish failed npm publish.
Streamy goodness! Documentation will be updated for v0.16.2. Things are in flux...
Stream documents to manage resources more efficiently. (Performance tests forthcoming.)
The documentation has not been updated yet... public interface subject to change. Suggestions welcome!
Send a descriptive body for validation errors.
Send 422 on validation error.
Remove stale calls to connect.utils.merge.
Update to use latest deco features. Other additional refactoring.
Add support for external decorator plugins and move swagger support to its own module.
npm install --save baucis-swagger
Allow setting model for controller, separately from singular. This way, model name and controller path are not coupled.
Add dependency on connect for connect.utils. (Special thanks to lcalvy.)
Fix issue #107. (Special thanks to stemey.)
Fix issue #108. (Special thanks to stemey.)
Major internal refactor!
Controller version range is now specified with the versions key on baucis.rest.
Controllers no longer need to be initialized.
Add API versioning using the API-Version header.
Send 405 when DELETE is disabled on a controller. (Special thanks to lukaszfiszer.)
Fix a bug where Accept used "DEL" instead of "DELETE." Fix another bug where ETag was not sent for HEAD requests. (Special thanks to lukaszfiszer.)
Don't change status to 204 for HEAD requests. (Special thanks to lukaszfiszer.)
Send 204 when no content.
Improvements to optimistic locking. Adds the 'locking' controller option. When set to true, this option enables automatic version increments and strict version checking. When enabled, __v must always be sent with updates, and the baucis query must always have the __v key selected.
If this option is not enabled, no extra lock checking or version incrementing is performed outside what is normally done by Mongoose.
The 'always check version' controller option has been deprecated.
Deprecated
Fix an issue where remove middleware wasn't called. Special thanks to lukaszfiszer!
Set X-Powered-By to baucis for baucis routes
Don't list "sort" query parameter for plural endpoints.
Custom swagger definitions — add an example to the README.
controller.addSwaggerApi has been destroyed in favor of exposing the controller Swagger APIs and models at controller.swagger.apis and controller.swagger.models. These may be modified directly to change the genereated Swagger definitions.
More Swagger!
Add custom API definitions to a controller with controller.addSwaggerApi. Other minor Swagger fixes.
Add support for hint and comment. Enable them like so:
baucis.rest({
singular: 'fish',
'allow hints': true,
'allow comments': true
});
Note: I decided to be more strict with implementing semver. Minor version will be increasing with each new feature and patch number will be increased with bug fixes and misc. patches.
Fix issue #86 which caused request.baucis.controller to sometimes be set incorrectly.
Fix dependecy on async
Fix an issue where POST middleware could be called at query stage
Fix tests for latest version of Mongoose & Express
Respond with 400 for requests with malformed IDs. Respond with 405 for disabled verbs.
Adds default support for form POST (application/x-www-form-urlencoded). Also allows use of default Express request query string parser (conditions[name]=Tomato), in addition to the JSON string format that is supported.
Adds request.baucis.controller. This also fixes issue #76 that was occurring with newer Express versions when they were used as a peer dependency.
Move Express to peer dependency.
Fix an issue where the Location response header would be set incorrectly. Special thanks to feychenie.
Fix an issue with swagger when using models with hyphenated names. Special thanks to feychenie.
Better error handling when detecing selected fields when populating via query.
Fixes issue #72. The Location header is now only set for POST responses.
This fixes the related issue of response headers being too large when doing
GET requests that return a large number of documents.
Fixes a bug in v0.6.16 that could allow deselected paths to be sent back in the response body of a POST request.
Fixes issue #67
Allow support for $pull, and $set
-
Deprecates X-Baucis-Push
-
Enables X-Baucis-Update-Operator
-
By default, a mongoose document is updated using
doc.setthendoc.save. -
When the X-Baucis-Update-Operator is set,
findOneAndUpdateis used -
THIS BYPASSES VALIDATION
-
Operators must be enabled per-controller
-
Supported operators are currently:
$set,$pull, and$push. -
Now positional $ can be used with
$set! -
Fields must be whitelisted by setting the appropriate controller option (notice additional $ character)
var controller = baucis.rest({ singular: 'arrbitrary', 'allow $push': 'arr.$.pirates', 'allow $pull': 'arr.$.pirates' });
// Later...
// PUT /api/arbitraries/1234567890abcdef12345678?conditions={ "arr.flag": "jolly roger" }
// X-Baucis-Update-Operator: $push
// BODY
// { "arr.$.pirates": { name: 'Blue beard' } }
// Blue beard's dead, pull him from the array
// PUT /api/arbitraries/1234567890abcdef12345678?conditions={ "arr.flag": "jolly roger" }
// X-Baucis-Update-Operator: $pull
// BODY
// { "arr.$.pirates": { name: 'Blue beard' } }
Add examples for AngularJS. Contributed by Illniyar.
Allow pushing to embedded arrays using positional $
-
Validation is ignored
-
Paths with positional $ must be whitelisted
-
Embedded array must be specified in the conditions query parameter
var controller = baucis.rest({ singular: 'arbitrary', 'allow push': 'arr.$.pirates' });
// Later...
// PUT /api/arbitraries/1234567890abcdef12345678?conditions={ "arr.flag": "jolly roger" }
// X-Baucis-Push: true
// BODY
// { "arr.$.pirates": { name: 'Blue beard' } }
Added X-Baucis-Push header for PUTs
-
Setting this uses $push on the body rather than $set for the update
-
Validation is ignored
-
Feature must be enabled per-controller
-
Fields must be whitelisted by setting the 'allow push' controller option, e.g.
var controller = baucis.rest({ singular: 'arbitrary', 'allow push': 'field some.path some.other.path' });