Changes to API for helper functions, 4.0.0

Renamed DB `create` action helper to `insert`. Export helpers for all
SCRUD actions which follow the full chain of registered handlers,
and return the data in the Promise resolution instead of sending
via http.response.

Author: doesdev

README.md

@@ -90,19 +90,30 @@ Set global options and start API server
     - returns: `Object` - updated auth object
 
 # helper functions (used internally but exported as a courtesy)
+
+## generic helpers
 - `sendData`(response, data) - send response data to client
 - `sendErr`(response, error, code) - send error to client  
-- `logIt`(error, logLevel) - invoke logger with error and logLevel  
 - `fourOhOne`(response, error) - send 401 (unauthorized) error to client  
 - `fourOhFour`(response, error) - send 404 (not found) error to client  
 - `genToken`(payload) - generate JWT token  
 - `authenticate`(jwt) - authenticate JWT token  
+- `logIt`(error, logLevel) - invoke logger with error and logLevel  
 - `callPgFunc`(functionName, params, request) - call any PG function with single arg  
-- `search`(resource, request) - call PG search function for resource (alias `findAll`)
-- `create`(resource, request) - call PG create function for resource  
-- `read`(resource, request) - call PG read function for resource (alias `find`)  
-- `update`(resource, request) - call PG update function for resource (alias `save`)  
-- `delete`(resource, request) - call PG delete function for resource (alias `destroy`)  
+
+## database action helpers
+- `findAll`(resource, request) - call PG search function for resource  
+- `insert`(resource, request) - call PG create function for resource  
+- `find`(resource, request) - call PG read function for resource  
+- `save`(resource, request) - call PG update function for resource  
+- `destroy`(resource, request) - call PG delete function for resource  
+
+## scrud helpers
+- `search`(resource, request) - run registered search handler for resource  
+- `create`(resource, request) - run registered create handler for resource  
+- `read`(resource, request) - run registered read handler for resource  
+- `update`(resource, request) - run registered update handler for resource  
+- `delete`(resource, request) - run registered delete handler for resource  
 
 # usage
 

index.js

@@ -8,6 +8,21 @@ const tinyParams = require('tiny-params')
 const zlib = require('zlib')
 const port = process.env.PORT || process.env.port || 8091
 const defaultTimeout = 120000
+const noop = () => {}
+const dummyRes = {
+  addTrailers: noop,
+  end: noop,
+  getHeader: noop,
+  getHeaderNames: noop,
+  getHeaders: noop,
+  hasHeader: noop,
+  removeHeader: noop,
+  setHeader: noop,
+  setTimeout: noop,
+  write: noop,
+  writeContinue: noop,
+  writeHead: noop
+}
 const scrud = {
   GET: 'search',
   'GET?': 'search',
@@ -122,15 +137,16 @@ module.exports = {
   genToken,
   authenticate,
   find,
-  read: find,
   findAll,
-  search: findAll,
-  create,
+  insert: create,
   save,
-  update: save,
   destroy,
-  delete: destroy,
-  callPgFunc
+  callPgFunc,
+  read: (rsrc, req) => actionHandler(req, null, rsrc, 'read', true),
+  create: (rsrc, req) => actionHandler(req, null, rsrc, 'create', true),
+  search: (rsrc, req) => actionHandler(req, null, rsrc, 'search', true),
+  update: (rsrc, req) => actionHandler(req, null, rsrc, 'update', true),
+  delete: (rsrc, req) => actionHandler(req, null, rsrc, 'delete', true)
 }
 
 // register resource
@@ -196,13 +212,12 @@ function handleRequest (req, res) {
   let connection = req.connection || {}
   req.params.ip = headers['x-forwarded-for'] || connection.remoteAddress
   req.once('error', (err) => sendErr(res, err))
-  let handler = resource[action] || actionHandler
   let jwt = (headers.authorization || '').replace(/^Bearer\s/, '')
   let callHandler = () => {
-    if (!hasBody[action]) return handler(req, res, name, action)
+    if (!hasBody[action]) return actionHandler(req, res, name, action)
     return bodyParse(req).then((body) => {
       req.params = Object.assign(body, req.params)
-      return handler(req, res, name, action)
+      return actionHandler(req, res, name, action)
     }).catch((e) => sendErr(res, e))
   }
   if (resource.skipAuth && resource.skipAuth[action]) return callHandler()
@@ -320,14 +335,20 @@ function pgActions (resource, action, req) {
 }
 
 // default handler for all resource methods
-function actionHandler (req, res, name, action) {
-  let bq = resources[name].beforeQuery || {} // (req, res)
+function actionHandler (req, res, name, action, skipRes) {
+  let rsrc = resources[name]
+  res = res || dummyRes
+  let bq = rsrc.beforeQuery || {} // (req, res)
   if (typeof bq !== 'function') bq = bq[action]
-  let bs = resources[name].beforeSend || {} // (req, res, data)
+  let bs = rsrc.beforeSend || {} // (req, res, data)
   if (typeof bs !== 'function') bs = bs[action]
-  let act = () => handlers[action](name, req)
-  let send = (d) => sendData(res, d)
+  let act = () => rsrc[action]
+      ? rsrc[action](req, res, name, action, skipRes)
+      : handlers[action](name, req)
+  if (rsrc[action]) return bq ? bq(req, res).then(act) : act()
+  let send = (d) => skipRes ? Promise.resolve(d) : sendData(res, d)
   let finish = (d) => bs ? bs(req, res, d).then(send) : send(d)
   let run = () => bq ? bq(req, res).then(act).then(finish) : act().then(finish)
-  return run().catch((e) => sendErr(res, e))
+  let handleErr = (e) => skipRes ? Promise.reject(e) : sendErr(res, e)
+  return run().catch(handleErr)
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "scrud",
-  "version": "3.0.1",
+  "version": "4.0.0",
   "description": "Super opinionated, minimalistic, PG centric API fabric",
   "engines": {
     "node": ">=6.0.0"

test.js

@@ -91,3 +91,19 @@ test('register returns resource object', async (assert) => {
   assert.truthy(resource.hasOwnProperty('name'), 'resource has name')
   assert.is(resource.name, 'profile')
 })
+
+test(`exported resource DB helpers work as expected`, async (assert) => {
+  let locId = (await scrud.insert('member', {params: {zip: 37615}})).id
+  assert.is((await scrud.findAll('member', {params: {id: locId}}))[0].zip, '37615')
+  await assert.notThrows(scrud.save('member', {id: locId, params: {zip: '37610'}}))
+  assert.is((await scrud.find('member', {id: locId, params: {}})).zip, '37610')
+  await assert.notThrows(scrud.destroy('member', {id: locId, params: {}}))
+})
+
+test(`exported SCRUD helpers work as expected`, async (assert) => {
+  let locId = (await scrud.create('member', {params: {zip: 37615}})).id
+  assert.is((await scrud.search('member', {params: {id: locId}}))[0].zip, '37615')
+  await assert.notThrows(scrud.update('member', {id: locId, params: {zip: 37610}}))
+  assert.is((await scrud.read('member', {id: locId, params: {}})).zip, '37610')
+  await assert.notThrows(scrud.delete('member', {id: locId, params: {}}))
+})