@sera4/essentia 1.1.65 → 1.1.66-rc.1

package/test/s4-pagination.spec.js

@@ -0,0 +1,196 @@
+import should from "should";
+import S4Pagination from "../paginator/s4-pagination.js";
+import http_mocks from "node-mocks-http";
+import events from "events";
+
+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: 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: 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(){
+      const items = [1,2,3,4,5,6,7,8,9,10];
+      const data = {
+        docs : items,
+        total : items.length,
+      };
+      paginator.reply(data);
+      response.statusCode.should.equal(200);
+      response._getHeaders().should.have.property("s4-pagination");
+    });
+  });
+});

package/test/serializer.spec.js

@@ -0,0 +1,34 @@
+import { expect } from "chai";
+import serializer from "../serializer/index.js";
+
+describe("Serializer", () => {
+
+  describe("Serialize", () => {
+
+    it ("should not show Hidden/Removed fields", () => {
+      const model = { prototype: {} }
+      model.prototype.get = function() { 
+        return { 
+          name: "John",
+          hidden_prefs: "should be hidden",
+          password: "password",
+          password_salt: "password_salt",
+          mfa_totp_secret: "mfa_totp_secret",
+        } 
+      }
+      const options = { hide: ["hidden_prefs"], remove: ["password", "password_salt", "mfa_totp_secret"] }
+      
+      serializer.serialize(model, options);
+      
+      const serialized = model.prototype.toJSON();
+
+      expect(serialized.name).to.eq("John");
+
+      expect(serialized.hidden_prefs).to.be.undefined;
+      expect(serialized.password).to.be.undefined;
+      expect(serialized.password_salt).to.be.undefined;
+      expect(serialized.mfa_totp_secret).to.be.undefined;
+    });
+
+  });
+});

package/test/utils.spec.js

@@ -0,0 +1,145 @@
+import { expect } from "chai";
+
+import { utils } from "../utils/index.js";
+import { TWS_ROUTE_TYPES } from "../constants/index.js";
+
+describe("Utils", () => {
+
+  describe("UUID V4", () => {
+
+    it ("should not validate ABCD", () => {
+      expect(utils.isValidUuidV4("ABC")).to.be.false
+    });
+
+    it ("should not validate null", () => {
+      expect(utils.isValidUuidV4(null)).to.be.false
+    });
+
+    it ("should not validate undefined", () => {
+      expect(utils.isValidUuidV4()).to.be.false
+    });
+
+    it ("should not validate empty string", () => {
+      expect(utils.isValidUuidV4("")).to.be.false
+    });
+
+    it ("should not validate 26d61a823587-4875-98a8e950e1bf2350", () => {
+      expect(utils.isValidUuidV4("26d61a823587-4875-98a8-950e1bf2350")).to.be.false
+    });
+
+    it ("should not validate 26d61a82-3587-4875-98a8-e950e1bf235", () => {
+      expect(utils.isValidUuidV4("26d61a82-3587-4875-98a8-e950e1bf235")).to.be.false
+    });
+
+    it ("should not validate 26d61a8-3587-4875-98a8-e950e1bf2350", () => {
+      expect(utils.isValidUuidV4("26d61a8-3587-4875-98a8-e950e1bf2350")).to.be.false
+    });
+
+    it ("should not validate 26d61a82-3587-487-98a8-e950e1bf2350", () => {
+      expect(utils.isValidUuidV4("26d61a82-3587-487-98a8-e950e1bf2350")).to.be.false
+    });
+
+    it ("should validate 26d61a82-3587-4875-98a8-e950e1bf2350", () => {
+      expect(utils.isValidUuidV4("26d61a82-3587-4875-98a8-e950e1bf2350")).to.be.true
+    });
+
+    it ("should validate 26D61A82-3587-4875-98A8-E950E1BF2350", () => {
+      expect(utils.isValidUuidV4("26D61A82-3587-4875-98A8-E950E1BF2350")).to.be.true
+    });
+
+  });
+
+  describe("String -> Integer Array", () => {
+    it ("Should return [] with a null/undefined input", () => {
+      expect(utils.convertToIntegerArray()).to.be.an('array').that.is.empty;
+    });
+
+    it ("Should return a valid integer array for '1,2,3'", () => {
+      expect(utils.convertToIntegerArray('1,2,3')).to.be.an('array').to.deep.equal([1, 2, 3])
+    });
+
+    it ("Should return a valid integer array for '[1,2,3]'", () => {
+      expect(utils.convertToIntegerArray('[1,2,3]')).to.be.an('array').to.deep.equal([1, 2, 3])
+    });
+
+    it ("Should return a valid integer array for '[1,2],3'", () => {
+      expect(utils.convertToIntegerArray('[1,2],3')).to.be.an('array').to.deep.equal([1, 2])
+    });
+
+    it ("Should return a valid integer array for '[1,2]],3'", () => {
+      expect(utils.convertToIntegerArray('[1,2]],3')).to.be.an('array').to.deep.equal([1, 2])
+    });
+
+    it ("Should return a valid integer array for '[1,2,3'", () => {
+      expect(utils.convertToIntegerArray('[1,2,3')).to.be.an('array').to.deep.equal([1, 2, 3])
+    });
+
+    it ("Should return a valid integer array for '1[1,2],3'", () => {
+      expect(utils.convertToIntegerArray('1[1,2],3')).to.be.an('array').to.deep.equal([1, 2])
+    });
+
+    it ("Should return a valid integer array for 1", () => {
+      expect(utils.convertToIntegerArray(1)).to.be.an('array').to.deep.equal([1])
+    });
+
+    it ("Should return a valid integer array for '1'", () => {
+      expect(utils.convertToIntegerArray('1')).to.be.an('array').to.deep.equal([1])
+    });
+
+    it ("Should return a valid integer array for '1w'", () => {
+      expect(utils.convertToIntegerArray('1w')).to.be.an('array').to.deep.equal([1])
+    });
+
+    it ("Should return a valid integer array for '[1,2e'", () => {
+      expect(utils.convertToIntegerArray('[1,2e')).to.be.an('array').to.deep.equal([1,2])
+    });
+  });
+
+  describe("Route testing", () => {
+    it ("Return -1 for a blank domain", () => {
+      expect(utils.getRouteType('')).to.eq(-1);
+    });
+    it ("Return a web route type for tws-web", () => {
+      const route = utils.getRouteType('tws-web.sera4.com/v3/xxx');
+      expect(route).to.eq(TWS_ROUTE_TYPES['web']);
+      expect(utils.isWebRoute(route)).to.be.true
+    });
+    it ("Return a web route type for tws-web-staging", () => {
+      const route = utils.getRouteType('tws-web-environmentX.sera4.com/v3/xxx');
+      expect(route).to.eq(TWS_ROUTE_TYPES['web']);
+      expect(utils.isWebRoute(route)).to.be.true
+    });
+    it ("Return a mobile route type for tws-mob", () => {
+      const route = utils.getRouteType('tws-mob.sera4.com/v3/xxx');
+      expect(route).to.eq(TWS_ROUTE_TYPES['mobile']);
+      expect(utils.isMobileRoute(route)).to.be.true
+    });
+    it ("Return a mobile route type for tws-mob-staging", () => {
+      const route = utils.getRouteType('tws-mob-environmentX.sera4.com/v3/xxx');
+      expect(route).to.eq(TWS_ROUTE_TYPES['mobile']);
+      expect(utils.isMobileRoute(route)).to.be.true
+    });
+    it ("Return an API route type for tws-api-xxxx", () => {
+      const route = utils.getRouteType('tws-api-1234.sera4.com/v3/xxx');
+      expect(route).to.eq(TWS_ROUTE_TYPES['api']);
+      expect(utils.isApiRoute(route)).to.be.true
+    });
+    it ("Return isWebRoute TRUE for 1 or '1'", () => {
+      expect(utils.isWebRoute(1)).to.eq(true);
+      expect(utils.isWebRoute('1')).to.eq(true);
+    });
+    it ("Return isMobileRoute TRUE for 2 or '2'", () => {
+      expect(utils.isMobileRoute(2)).to.eq(true);
+      expect(utils.isMobileRoute('2')).to.eq(true);
+    });
+    it ("Return isApiRoute TRUE for 3 or '3'", () => {
+      expect(utils.isApiRoute(3)).to.eq(true);
+      expect(utils.isApiRoute('3')).to.eq(true);
+    });
+    it ("Return isApiRoute TRUE for many other values", () => {
+      expect(utils.isOtherRoute(4)).to.eq(true);
+      expect(utils.isOtherRoute('4')).to.eq(true);
+      expect(utils.isOtherRoute('a')).to.eq(true);
+    });
+  });
+});