@sera4/essentia 1.0.0

package/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  paginator : require("./paginator/s4-pagination"),
+  logger : require("./logger/s4-logger")
+}

package/logger/s4-logger.js

@@ -0,0 +1,35 @@
+const winston = require('winston');
+const logger = new winston.Logger();
+const loggerName = "console.debug";
+
+logger.add(winston.transports.Console, {
+  name: loggerName,
+  colorize: true,
+  showLevel: true,
+  level: 'debug'
+});
+
+class S4Logger {
+  setLevel(level) {
+    if (level && ["debug", "info", "error"].indexOf(level.toLowerCase())) {
+      logger.transports[loggerName].level = level;  
+    }
+  }
+  mute() {
+    logger.transports[loggerName].silent = true;
+  }
+  unmute() {
+    logger.transports[loggerName].silent = false;
+  }
+  debug(str, args) {
+    logger.log("debug", str, args);
+  }
+  info(str, args) {
+    logger.log("info", str, args);
+  }
+  error(str, args) {
+    logger.log("error", str, args);
+  }
+}
+
+module.exports = new S4Logger();

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@sera4/essentia",
+  "version": "1.0.0",
+  "description": "A library of utilities for Teleporte Web Services",
+  "main": "index.js",
+  "scripts": {
+    "test": "./node_modules/.bin/mocha --reporter mocha-junit-reporter --reporter-options mochaFile=./test-results/result.xml --exit",
+    "testdev": "./node_modules/.bin/mocha --watch"
+  },
+  "author": "Dev DM <dev@sera4.com>",
+  "license": "UNLICENSED",
+  "devDependencies": {
+    "chai": "^4.1.2",
+    "mocha": "^5.1.1",
+    "mocha-junit-reporter": "^1.17.0",
+    "node-mocks-http": "^1.5.8",
+    "nodemon": "^1.17.3",
+    "should": "^13.2.1",
+    "sinon": "^5.0.1"
+  },
+  "dependencies": {
+    "winston": "^2.4.2"
+  }
+}

package/paginator/s4-pagination.js

@@ -0,0 +1,50 @@
+const default_page = 1;
+const default_size = 5;
+
+function parseRequest(req, item, default_value) {
+  if (!req || !req.query) {
+    return default_value;
+  }
+  var r = parseInt(req.query[item]);
+  if (isNaN(r) || r < default_value) {
+    r = default_value;
+  }
+  return r;
+}
+
+class S4Pagination {
+  createPaginator(req, res, next) {
+    var paginator = {
+      page : parseRequest(req, "page", default_page),
+      page_size : parseRequest(req, "page_size", default_size),
+      reply : function(data) {
+        if (!data) {
+          res.status(500).end();
+          return;
+        }
+        var pagination = {
+          total : data.total,
+          total_pages : data.pages,
+          current_page : data.page,
+          first_page : data.page === 1,
+          last_page : data.offset === data.pages,
+          page_size : data.limit,
+          out_of_bounds : data.docs.length === 0
+        }
+        if (!pagination.out_of_bounds) {
+          if (pagination.current_page > 1) {
+            pagination.previous_page = pagination.current_page - 1;
+          }
+          if (pagination.current_page < pagination.total_pages) {
+            pagination.next_page = pagination.current_page + 1;
+          }
+        }
+        res.set("s4-pagination", JSON.stringify(pagination));
+        res.json(data.docs)
+      }
+    }
+    return paginator;
+  }
+}
+
+module.exports = new S4Pagination();

package/test/s4-pagination.spec.js

@@ -0,0 +1,195 @@
+var should = require('should');
+var S4Pagination = require('../paginator/s4-pagination');
+var http_mocks = require('node-mocks-http');
+
+describe("Pagination", function () {
+  var paginator = null;
+  var request = null;
+  var response = null;
+  var next = null;
+
+  before("Setup", function () {
+    next = function () { };
+    response = http_mocks.createResponse({ eventEmitter: require('events').EventEmitter });
+    request = http_mocks.createRequest({
+      method: "GET",
+      url: "/"
+    })
+    paginator = S4Pagination.createPaginator(request, response, next);
+  });
+
+  describe("Parsing query parameters", function () {
+    describe("Default values", function () {
+      it("should have default page set to 1", function () {
+        paginator.should.have.property("page", 1);
+      });
+
+      it("should have default page size set to 5", function () {
+        paginator.should.have.property("page_size", 5);
+      });
+    });
+
+    describe("Page value set to 0", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page=0"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page to 1", function () {
+        paginator.should.have.property("page", 1);
+      });
+    });
+
+    describe("Page value set to negative", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page=-1"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page to 1", function () {
+        paginator.should.have.property("page", 1);
+      });
+    });
+
+    describe("Page value set to 2", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page=2"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page to 2", function () {
+        paginator.should.have.property("page", 2);
+      });
+    });
+
+    describe("Page value set to 10", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page=10"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page to 10", function () {
+        paginator.should.have.property("page", 10);
+      });
+    });
+
+    describe("Page value set to 100", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page=100"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page to 100", function () {
+        paginator.should.have.property("page", 100);
+      });
+    });
+
+    describe("Page Size value set to 0", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page_size=0"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page size to 5", function () {
+        paginator.should.have.property("page_size", 5);
+      });
+    });
+
+    describe("Page Size value set to negative", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page_size=-1"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page size to 5", function () {
+        paginator.should.have.property("page_size", 5);
+      });
+    });
+
+    describe("Page Size value set to 2", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page_size=2"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page size to 5", function () {
+        paginator.should.have.property("page_size", 5);
+      });
+    });
+
+    describe("Page Size value set to 10", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page_size=10"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page size to 10", function () {
+        paginator.should.have.property("page_size", 10);
+      });
+    });
+
+    describe("Page Size value set to 100", function () {
+      before("Setup", function () {
+        request = http_mocks.createRequest({
+          method: "GET",
+          url: "/?page_size=100"
+        })
+        paginator = S4Pagination.createPaginator(request, response, next);
+      });
+
+      it("should set page size to 100", function () {
+        paginator.should.have.property("page_size", 100);
+      });
+    });
+  });
+
+  describe("Replying", function() {
+    beforeEach("Clear request", function() {
+      response = http_mocks.createResponse({ eventEmitter: require('events').EventEmitter });
+      paginator = S4Pagination.createPaginator(request, response, next);
+    });
+
+    it ("should return 500 if data is null", function(){
+      paginator.reply(null);
+      response.statusCode.should.equal(500);
+    });
+
+    it ("should return pagination data", function(){
+      var items = [1,2,3,4,5,6,7,8,9,10];
+      data = {
+        docs : items,
+        total : items.length,
+      };
+      paginator.reply(data);
+      response.statusCode.should.equal(200);
+      response._getHeaders().should.have.property("s4-pagination");
+    });
+  });
+});

package/test-results/result.xml

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="Mocha Tests" time="0.007" tests="14" failures="0">
+  <testsuite name="Root Suite" timestamp="2018-06-06T13:57:10" tests="0" failures="0" time="0">
+  </testsuite>
+  <testsuite name="Pagination" timestamp="2018-06-06T13:57:10" tests="0" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+  </testsuite>
+  <testsuite name="Parsing query parameters" timestamp="2018-06-06T13:57:10" tests="0" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+  </testsuite>
+  <testsuite name="Default values" timestamp="2018-06-06T13:57:10" tests="2" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0.003">
+    <testcase name="Pagination Parsing query parameters Default values should have default page set to 1" time="0.002" classname="should have default page set to 1">
+    </testcase>
+    <testcase name="Pagination Parsing query parameters Default values should have default page size set to 5" time="0.001" classname="should have default page size set to 5">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page value set to 0" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0.001">
+    <testcase name="Pagination Parsing query parameters Page value set to 0 should set page to 1" time="0.001" classname="should set page to 1">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page value set to negative" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+    <testcase name="Pagination Parsing query parameters Page value set to negative should set page to 1" time="0" classname="should set page to 1">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page value set to 2" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+    <testcase name="Pagination Parsing query parameters Page value set to 2 should set page to 2" time="0" classname="should set page to 2">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page value set to 10" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+    <testcase name="Pagination Parsing query parameters Page value set to 10 should set page to 10" time="0" classname="should set page to 10">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page value set to 100" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+    <testcase name="Pagination Parsing query parameters Page value set to 100 should set page to 100" time="0" classname="should set page to 100">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page Size value set to 0" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+    <testcase name="Pagination Parsing query parameters Page Size value set to 0 should set page size to 5" time="0" classname="should set page size to 5">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page Size value set to negative" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+    <testcase name="Pagination Parsing query parameters Page Size value set to negative should set page size to 5" time="0" classname="should set page size to 5">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page Size value set to 2" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0.001">
+    <testcase name="Pagination Parsing query parameters Page Size value set to 2 should set page size to 5" time="0.001" classname="should set page size to 5">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page Size value set to 10" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+    <testcase name="Pagination Parsing query parameters Page Size value set to 10 should set page size to 10" time="0" classname="should set page size to 10">
+    </testcase>
+  </testsuite>
+  <testsuite name="Page Size value set to 100" timestamp="2018-06-06T13:57:10" tests="1" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0">
+    <testcase name="Pagination Parsing query parameters Page Size value set to 100 should set page size to 100" time="0" classname="should set page size to 100">
+    </testcase>
+  </testsuite>
+  <testsuite name="Replying" timestamp="2018-06-06T13:57:10" tests="2" file="/Users/denis/Development/lockedup/repos/s4-node-modules/test/s4-pagination.spec.js" failures="0" time="0.002">
+    <testcase name="Pagination Replying should return 500 if data is null" time="0.001" classname="should return 500 if data is null">
+    </testcase>
+    <testcase name="Pagination Replying should return pagination data" time="0.001" classname="should return pagination data">
+    </testcase>
+  </testsuite>
+</testsuites>