refactoring to classes

lib/api3/authBuilder.js → lib/api3/authorizerBuilder.js

@@ -3,9 +3,14 @@
 var moment = require('moment')
   , apiConst = require('./const.json')
 
-function configure (app, env, ctx) {
+/**
+ * Builder of authorization middleware functions
+ */
+function AuthorizerBuilder (app, env, ctx) {
 
-  function checkDateHeader (req, res) {
+  var self = this
+
+  self.checkDateHeader = function checkDateHeader (req, res) {
 
     var dateHeader = req.header('Date');
     if (!dateHeader) {
@@ -26,7 +31,11 @@ function configure (app, env, ctx) {
     return true;
   }
 
-  function authBuilder (permission) {
+  /**
+   * Create authorization middleware function which demands the permission
+   * @param {string} permission - permission to demand
+   */
+  self.authorizerFor = function authorizerFor (permission) {
 
     return function authorize (req, res, next) {
 
@@ -38,7 +47,7 @@ function configure (app, env, ctx) {
         return res.sendJSONStatus(res, apiConst.HTTP.FORBIDDEN, apiConst.MSG.HTTP_403_NOT_USING_HTTPS);
       }
 
-      if (checkDateHeader(req, res) !== true) {
+      if (self.checkDateHeader(req, res) !== true) {
         return;
       }
 
@@ -62,8 +71,6 @@ function configure (app, env, ctx) {
       });
     }
   }
-
-  return authBuilder;
 }
 
-module.exports = configure;
+module.exports = AuthorizerBuilder;

lib/api3/collection.js

@@ -0,0 +1,69 @@
+'use strict';
+
+/**
+  * Generic collection (abstraction over each collection specifics)
+  * @param {string} colName - name of the collection inside the storage system
+  */
+function Collection (ctx, env, app, authBuilder, colName, fallbackGetDate) {
+  var self = this
+    , CollectionStorage = require('./storage/mongoCollection')
+    , SearchOperation = require('./operation/search')
+    , CreateOperation = require('./operation/create')
+    , ReadOperation = require('./operation/read')
+    , UpdateOperation = require('./operation/update')
+    , PatchOperation = require('./operation/patch')
+    , DeleteOperation = require('./operation/delete')
+    , HistoryOperation = require('./operation/history')
+
+  self.colName = colName;
+  self.authBuilder = authBuilder;
+  self.fallbackGetDate = fallbackGetDate;
+  self.storage = new CollectionStorage(ctx, env, colName);
+
+  self.opSearch = new SearchOperation(ctx, env, app, self);
+  self.opCreate = new CreateOperation(ctx, env, app, self);
+  self.opRead = new ReadOperation(ctx, env, app, self);
+  self.opUpdate = new UpdateOperation(ctx, env, app, self);
+  self.opPatch = new PatchOperation(ctx, env, app, self);
+  self.opDelete = new DeleteOperation(ctx, env, app, self);
+  self.opHistory = new HistoryOperation(ctx, env, app, self);
+
+  self.mapRoutes = function mapRoutes () {
+    var prefix = '/' + colName;
+    var prefixId = prefix + '/:identifier';
+
+    // GET /{collection}
+    app.get(prefix, self.opSearch.operation);
+
+    // POST /{collection}
+    app.post(prefix, self.opCreate.operation);
+
+    // GET /{collection}/history
+    app.get(prefixId, self.opHistory.operation);
+
+    // GET /{collection}/{identifier}
+    app.get(prefixId, self.opRead.operation);
+
+    // PUT /{collection}/{identifier}
+    app.put(prefixId, self.opUpdate.operation);
+
+    // PATCH /{collection}/{identifier}
+    app.patch(prefixId, self.opPatch.operation);
+
+    // DELETE /{collection}/{identifier}
+    app.delete(prefixId, self.opDelete.operation);
+  }
+
+
+  /**
+    * Floor date to whole seconds (cut off milliseconds)
+    * @param {Date} date
+    */
+  self.floorSeconds = function floorSeconds (date) {
+    var ms = date.getTime();
+    ms -= ms % 1000;
+    return new Date(ms);
+  }
+}
+
+module.exports = Collection;

lib/api3/operation/create.js

@@ -3,15 +3,15 @@
 /**
   * CREATE: Inserts a new document into the collection
   */
-function configure (ctx, env, app, col) {
+function CreateOperation (ctx, env, app, col) {
 
-  var obj = { }
+  var self = this
 
-  obj.operation = function operation (req, res, next) {
+  self.col = col;
+
+  self.operation = function operation (req, res, next) {
     next();
   }
-
-  return obj;
 }
 
-module.exports = configure;
+module.exports = CreateOperation;

lib/api3/operation/delete.js

@@ -3,14 +3,14 @@
 /**
   * DELETE: Deletes a document from the collection
   */
-function configure (ctx, env, app, col) {
+function DeleteOperation (ctx, env, app, col) {
 
-  var obj = { }
-    , authBuilder = require('../authBuilder')(app, env, ctx)
+  var self = this
     , apiConst = require('../const.json')
 
+  self.col = col;
 
-  obj.operation = function operation (req, res) {
+  self.operation = function operation (req, res) {
 
     function deletePermanently () {
       col.storage.deleteOne(req.params.identifier, function deleteOneDone (err, result) {
@@ -46,7 +46,7 @@ function configure (ctx, env, app, col) {
     }
 
 
-    authBuilder('api:' + col.colName + ':delete')(req, res, function() {
+    col.authBuilder.authorizerFor('api:' + col.colName + ':delete')(req, res, function() {
 
       if (req.query.permanent && req.query.permanent === "true") {
         deletePermanently();
@@ -56,8 +56,6 @@ function configure (ctx, env, app, col) {
       }
     });
   }
-
-  return obj;
 }
 
-module.exports = configure;
+module.exports = DeleteOperation;

lib/api3/operation/history.js

@@ -3,15 +3,15 @@
 /**
   * HISTORY: Retrieves incremental changes since timestamp
   */
-function configure (ctx, env, app, col) {
+function HistoryOperation (ctx, env, app, col) {
 
-  var obj = { }
+  var self = this
 
-  obj.operation = function operation (req, res, next) {
+  self.col = col;
+
+  self.operation = function operation (req, res, next) {
     next();
   }
-
-  return obj;
 }
 
-module.exports = configure;
+module.exports = HistoryOperation;

lib/api3/operation/patch.js

@@ -3,15 +3,15 @@
 /**
   * PATCH: Partially updates document in the collection
   */
-function configure (ctx, env, app, col) {
+function PatchOperation (ctx, env, app, col) {
 
-  var obj = { }
+  var self = this
 
-  obj.operation = function operation (req, res, next) {
+  self.col = col;
+
+  self.operation = function operation (req, res, next) {
     next();
   }
-
-  return obj;
 }
 
-module.exports = configure;
+module.exports = PatchOperation;

lib/api3/operation/read.js

@@ -3,19 +3,19 @@
 /**
   * READ: Retrieves a single document from the collection
   */
-function configure (ctx, env, app, col) {
+function ReadOperation (ctx, env, app, col) {
 
-  var obj = { }
-    , authBuilder = require('../authBuilder')(app, env, ctx)
+  var self = this
     , apiConst = require('../const.json')
     , FieldsProjector = require('../fieldsProjector')
 
+  self.col = col;
 
   /**
    * Fetches modified date from document (with possible fallback and back-fill to srvModified/srvCreated) 
    * @param {any} doc - document loaded from database
    */
-  obj.resolveDates = function resolveDates (doc, fallbackGetDate) {
+  self.resolveDates = function resolveDates (doc, fallbackGetDate) {
     var modifiedDate;
     try
     {
@@ -41,7 +41,7 @@ function configure (ctx, env, app, col) {
   }
 
 
-  obj.operation = function operation (req, res) {
+  self.operation = function operation (req, res) {
 
     function loadFromDb () {
       var fieldsProjector = new FieldsProjector(req.query.fields);
@@ -65,7 +65,7 @@ function configure (ctx, env, app, col) {
         }
 
 
-        var modifiedDate = obj.resolveDates(doc, col.fallbackGetDate);
+        var modifiedDate = self.resolveDates(doc, col.fallbackGetDate);
         if (modifiedDate) {
           res.setHeader('Last-Modified', modifiedDate.toUTCString())
 
@@ -83,12 +83,10 @@ function configure (ctx, env, app, col) {
       });
     }
 
-    authBuilder('api:' + col.colName + ':read')(req, res, function() {
+    col.authBuilder.authorizerFor('api:' + col.colName + ':read')(req, res, function() {
       loadFromDb();
     });
   }
-
-  return obj;
 }
 
-module.exports = configure;
+module.exports = ReadOperation;

lib/api3/operation/search.js

@@ -3,15 +3,15 @@
 /**
   * SEARCH: Search documents from the collection
   */
-function configure (ctx, env, app, col) {
+function SearchOperation (ctx, env, app, col) {
 
-  var obj = { }
+  var self = this
 
-  obj.operation = function operation (req, res, next) {
+  self.col = col;
+
+  self.operation = function operation (req, res, next) {
     next();
   }
-
-  return obj;
 }
 
-module.exports = configure;
+module.exports = SearchOperation;