auto-crud v0.2.8

autocrud({
    app: app,                   // The express application object.
    collection: mongo.hoosit,   // The collection object generated by the mongo driver.
    name: 'hoosit',             // The name of the object (this will be appended to the end of path).
    path: '/api',               // The root URL path that this API should be generated at.
    schema: {                   // The json schema that should be used for validation
        type: 'object',
        properties: {
            name: {type: 'string', required: true},
            description: {type: 'string'},
            rating: {type: 'integer'},
            comments: {type: 'array', items: {type: 'string'}}
        },
        additionalProperties: false
    }
});

autocrud({
    ... // Default options
    postTransform: function (body) {
        if (!body.rating) body.rating = 1;
    }
});

Transform functions take a single parameter, which is the message body after it has been validated.

• defaultTransform If specified, this transform function will be applied to both POST and PUT operations.
• postTransform If specified, this function will be used for POST operations, overriding the defaultTransform.
• putTransform If specified, this function will be used for PUT operations, overriding the defaultTransform.

autocrud({
    ... // Default options
    defaultAuthentication: function (req, res, next) {
        if (req.isAuthenticated() && _.contains(req.user.roles, 'administrator')) next();
        else res.send(401, 'Unauthenticated');
    }
});

• defaultAuthentication If specified, this middleware will by applied to all HTTP methods on the auto-curd route.
• getAuthentication If specified, this middleware will be applied to the GET HTTP method. Overrides default.
• postAuthentication If specified, this middleware will be applied to the POST HTTP method. Overrides default.
• putAuthentication If specified, this middleware will be applied to the PUT HTTP method. Overrides default.
• deleteAuthentication If specified, this middleware will be applied to the DELETE HTTP method. Overrides default.

autocrud({
    ... // Default options
    ownerIdFromReq: function (req) {
        return new ObjectID(req.user._id);
    },
    ownerField: 'owner'
});

NOTE: Both of the following fields must be provided for object ownership to be enabled.

• ownerIdFromReq A function that extracts the user id value from the request object. This is passed as the first param.
• ownerField The name of the field in each mongo document that holds the owner id.