Code coverage report for src/router.js

Statements: 99.25% (132 / 133)      Branches: 95.45% (63 / 66)      Functions: 100% (12 / 12)      Lines: 99.25% (132 / 133)      Ignored: none     

All files » src/ » router.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 2641 1 1 1 1 1   1 1 1       1     29     29     29     29     29 29 29           29     1 1                       1       25 1       24     24     24       24 24 24 24 24 24 24 24 24 24     24 24 12 12 12 12 12 10 10 4 4 4 1   3   4 6 2 2 1   2     12     4 2 2   2 2   4     4 4 2   2       24 10 10 9   10 1           24       4 4     24       1 17     2 2 6 12 12 2       2   15 7   8   15 15 4   15 14     1       1     16 3 3 8   3 2         16 3 3   16 16 2 14     1   16       1 2 5   2   2         1 4 10   4   4 2   2         1 1     1 1 3   1       29   29             29    
var express = require('express')
var methodOverride = require('method-override')
var bodyParser = require('body-parser')
var _ = require('underscore')
var low = require('lowdb')
var utils = require('./utils')
 
low.mixin(require('underscore-db'))
low.mixin(require('underscore.inflections'))
low.mixin({
  createId: utils.createId
})
 
module.exports = function (source) {
 
  // Create router
  var router = express.Router()
 
  // Add middlewares
  router.use(bodyParser.json({
    limit: '10mb'
  }))
  router.use(bodyParser.urlencoded({
    extended: false
  }))
  router.use(methodOverride())
 
  // Create database
  Eif (_.isObject(source)) {
    var db = low()
    db.object = source
  } else {
    var db = low(source)
  }
 
  // Expose database
  router.db = db
 
  // GET /db
  function showDatabase(req, res, next) {
    res.jsonp(db.object)
  }
 
  // GET /:resource
  // GET /:resource?q=
  // GET /:resource?attr=&attr=
  // GET /:resource/:id
  // GET /:parent/:parentId/:resource
  // GET /:parent/:parentId/:resource/:resourceId etc. ad infinutum
  // GET /:parent/:parentId/:resource?attr=&attr=
  // GET /*?*&_end=
  // GET /*?*&_start=&_end=
  function parse(req, res, next) {
 
 
    // Test if resource exists
    if (!db.object.hasOwnProperty(req.params.resource)) {
      return res.sendStatus(404)
    }
 
    // Set internals
    req._internal = {}
 
    // Filters list
    req._internal.filters = {}
 
    // Result array
    var array
 
    // Remove _start, _end and _limit from req.query to avoid filtering using those
    // parameters. Attach to req._internal for use by future middleware
    req._internal._start = req.query._start
    req._internal._end = req.query._end
    req._internal._sort = req.query._sort
    req._internal._order = req.query._order
    req._internal._limit = req.query._limit
    delete req.query._start
    delete req.query._end
    delete req.query._sort
    delete req.query._order
    delete req.query._limit
 
    // Handle sub resources if present, and assign id if it's not already there.
    req._internal.subResources = []
    if (req.params['0']) { // If anything beyond the first resource is provided
      req._internal.subResources = req.params['0'].split('/')
      req._internal.subResources.shift()
      req._internal.subResourceMap = []
      req._internal.originalId = req._internal.subResources.shift() // set the resource's original to the first variadic parameter
      _.forEach(req._internal.subResources, function (value, index) { // build the subResource objects as provided
        var obj = {}
        if (index % 2 > 0) { // if this parameter is even, build an object with id, resource, and <parent>Id
          obj.id = value
          obj.resource = req._internal.subResources[index - 1]
          if (index > 1) {
            obj[req._internal.subResources[index - 3].slice(0, -1) + 'Id'] = req._internal.subResources[index - 2]
          } else {
            obj[req.params.resource.slice(0, -1) + 'Id'] = req._internal.originalId
          }
          req._internal.subResourceMap.push(obj)
        } else if (index === (req._internal.subResources.length - 1)) { // if this parameter is odd AND the last one, build an object without an ID
          obj.resource = value
          if (index > 1) {
            obj[req._internal.subResources[index - 2].slice(0, -1) + 'Id'] = req._internal.subResources[index - 1]
          }
          req._internal.subResourceMap.push(obj)
        }
      })
      if (req._internal.subResourceMap.length > 0) { // if there are any subResources at all (e.g. /posts/12/comments, /posts/12/comments/247, /posts/12/comments/247/user, ...)
 
        // Set up parents
        if (req._internal.subResourceMap.length < 2) { // if there is only one subResource (e.g. /posts/12/comments, /posts/12/comments/247)
          req._internal.parent = req.params.resource // Assign original resource and id to parent
          req._internal.parentId = req._internal.originalId
        } else { // if there is more than one subResource (e.g. /posts/12/comments/247/user, /posts/12/comments/247/user/25, ...)
          req._internal.parent = req._internal.subResourceMap[req._internal.subResourceMap.length - 2].resource // Assign the second to last subResource as parent
          req._internal.parentId = req._internal.subResourceMap[req._internal.subResourceMap.length - 2].id
        }
        req._internal.filters[req._internal.parent.slice(0, -1) + 'Id'] = +req._internal.parentId
 
        // Set up resource
        req.params.resource = req._internal.subResourceMap[req._internal.subResourceMap.length - 1].resource // assign the last subResource's data to resource and id
        if (req._internal.subResourceMap[req._internal.subResourceMap.length - 1].id) {
          req._internal.originalId = req._internal.subResourceMap[req._internal.subResourceMap.length - 1].id
        } else {
          delete req._internal.originalId // remove id if subResource doesn't have one
        }
      }
    }
    if (req._internal.originalId) {
      req._internal.filters.id = +req._internal.originalId // convert original ID to number and set as filter
      if (req._internal.filters.id.toString() === req._internal.originalId) {
        delete req._internal.originalId
      }
      if (isNaN(req._internal.filters.id)) {
        req._internal.filters.id = req._internal.originalId
      }
    }
 
    // Add query parameters filters
    // Convert query parameters to their native counterparts
    for (var key in req.query) {
 
      // don't take into account JSONP query parameters
      // jQuery adds a '_' query parameter too
      Eif (key !== 'callback' && key !== '_') {
        req._internal.filters[key] = utils.toNative(req.query[key])
      }
    }
    next()
  }
 
  // GET /:resource/:id
  function find(req, res, next) {
    if (req.query.q) {
 
      // Full-text search
      var q = req.query.q.toLowerCase()
      req._internal.resource = db(req.params.resource).filter(function (obj) {
        for (var key in obj) {
          var value = obj[key]
          if (_.isString(value) && value.toLowerCase().indexOf(q) !== -1) {
            return true
          }
        }
      })
      return next() // don't worry about filters or 404ing, just move along.
    }
    if (_(req._internal.filters).isEmpty() || typeof req._internal.filters === 'undefined') { // No filters at all, including ID
      req._internal.resource = db(req.params.resource).value()
    } else { // filters present
      req._internal.resource = db(req.params.resource).filter(req._internal.filters)
    }
    Eif (req._internal.resource) { // if there even is a resource found
      if (req._internal.filters.id && req._internal.resource.length === 1) {
        req._internal.resource = req._internal.resource[0]
      }
      if (req._internal.resource.length !== 0) {
        return next()
      }
    }
    res.status(404).jsonp({})
  }
 
  // Presentation layer: Apply sorting / pagination to response
  function present(req, res, next) {
 
    // Sort
    if (req._internal._sort) {
      req._internal._order = req._internal._order || 'ASC'
      req._internal.resource = _.sortBy(req._internal.resource, function (element) {
        return element[req._internal._sort];
      })
      if (req._internal._order === 'DESC') {
        req._internal.resource.reverse();
      }
    }
 
    // Slice result
    if (req._internal._end || req._internal._limit) {
      res.setHeader('X-Total-Count', req._internal.resource.length)
      res.setHeader('Access-Control-Expose-Headers', 'X-Total-Count')
    }
    req._internal._start = parseInt(req._internal._start) || 0
    if (req._internal._end) {
      req._internal.resource = req._internal.resource.slice(req._internal._start, parseInt(req._internal._end))
    } else if (req._internal._limit) {
 
      // Convert strings to int and sum to get end value
      req._internal.resource = req._internal.resource.slice(req._internal._start, parseInt(req._internal._start) + parseInt(req._internal._limit))
    }
    res.jsonp(req._internal.resource)
  }
 
  // POST /:resource
  function create(req, res, next) {
    for (var key in req.body) {
      req.body[key] = utils.toNative(req.body[key])
    }
    var resource = db(req.params.resource)
      .insert(req.body)
    res.jsonp(resource)
  }
 
  // PUT /:resource/:id
  // PATCH /:resource/:id
  function update(req, res, next) {
    for (var key in req.body) {
      req.body[key] = utils.toNative(req.body[key])
    }
    var resource = db(req.params.resource)
      .update(utils.toNative(req._internal.filters.id), req.body)
    if (resource) {
      res.jsonp(resource)
    } else {
      res.status(404).jsonp({})
    }
  }
 
  // DELETE /:resource/:id
  function destroy(req, res, next) {
    db(req.params.resource).remove(utils.toNative(req._internal.filters.id))
 
    // Remove dependents documents
    var removable = utils.getRemovable(db.object)
    _(removable).each(function (item) {
      db(item.name).remove(item.id)
    })
    res.status(200).jsonp({})
  }
 
 
  router.get('/db', showDatabase)
 
  router.route('/:resource*')
    .get(parse, find, present)
    .post(parse, create)
    .put(parse, update)
    .patch(parse, update)
    .delete(parse, destroy)
 
  return router
}