thinky-rest/lib/index.js

Create REST resources and controllers with thinky and Express or Restify

'use strict';

var _ = require('lodash'),
    inflection = require('inflection'),

    Resource = require('./resource'),
    Endpoint = require('./endpoint'),
    Controllers = require('./controllers'),
    Errors = require('./errors');

function isRestify(app) {
  if (app.name === 'restify') return true;
  if (app.hasOwnProperty('router')) {
    try { app.router; return true; } catch (e) {}
  }

  return false;
}

module.exports = {
  initialize: function(options) {
    options = options || {};
    if (!options.app)
      throw new Error('please specify an app');

    if (!options.odm && !options.thinky)
      throw new Error('please specify an ODM instance');

    this.app = options.app;
    this.isRestify = !!options.isRestify ? options.isRestify : isRestify(this.app);
    this.odm = options.odm;
    if (!!options.thinky) this.odm = options.thinky;
    this.base = options.base || '';

    this.updateMethod = undefined;
    if (options.updateMethod) {
      var method = options.updateMethod.toLowerCase();
      if (!method.match(/^(put|post|patch)$/)) {
        throw new Error('updateMethod must be one of PUT, POST, or PATCH');
      }

      this.updateMethod = method;
    }
  },

  resource: function(options) {
    options = options || {};
    if (!options.model)
      throw new Error('please specify a valid model');

    if (!options.endpoints || !options.endpoints.length) {
      options.endpoints = [];
      var plural = inflection.pluralize(options.model._name);
      var singular = inflection.singularize(options.model._name);
      var pk = options.model._pk;
      options.endpoints.push('/' + plural);
      options.endpoints.push('/' + singular + '/:' + pk);
    }

    var endpoints = [];
    options.endpoints.forEach(function(e) {
      var endpoint = this.base + e;
      endpoints.push(endpoint);
    }.bind(this));

    var resource = new Resource({
      app: this.app,
      odm: this.odm,
      model: options.model,
      endpoints: endpoints,
      actions: options.actions,
      pagination: options.pagination,
      updateMethod: this.updateMethod,
      search: options.search,
      sort: options.sort,
      documentValidation: options.documentValidation,
      isRestify: this.isRestify
    });

    return resource;
  },

  Resource: Resource,
  Endpoint: Endpoint,
  Controllers: Controllers,
  Errors: Errors
};