Add about api

Author: javierbrea

src/About.js

@@ -0,0 +1,41 @@
+/*
+Copyright 2019 Javier Brea
+Copyright 2019 XbyOrange
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+*/
+
+"use strict";
+
+const express = require("express");
+
+const { PLUGIN_NAME } = require("./constants");
+const { version } = require("../package.json");
+
+class AboutApi {
+  constructor(core) {
+    this._core = core;
+    this._tracer = core.tracer;
+    this._fixtures = this._core.fixtures;
+    this._router = express.Router();
+    this._router.get("/", this.getAbout.bind(this));
+  }
+
+  getAbout(req, res) {
+    this._tracer.verbose(`${PLUGIN_NAME}: Sending about | ${req.id}`);
+    res.status(200);
+    res.send({
+      version
+    });
+  }
+
+  get router() {
+    return this._router;
+  }
+}
+
+module.exports = AboutApi;

src/Plugin.js

@@ -16,6 +16,7 @@ const DeprecatedApi = require("./deprecated/Api");
 const Settings = require("./Settings");
 const Behaviors = require("./Behaviors");
 const Fixtures = require("./Fixtures");
+const About = require("./About");
 
 const {
   ADMIN_API_PATH_OPTION,
@@ -25,7 +26,8 @@ const {
   SETTINGS_API_PATH,
   BEHAVIORS_API_PATH,
   FIXTURES_API_PATH,
-  DEPRECATED_API_PATH
+  DEPRECATED_API_PATH,
+  ABOUT_API_PATH
 } = require("./constants");
 
 class Plugin {
@@ -36,6 +38,7 @@ class Plugin {
     this._deprecatedApi = new DeprecatedApi(core);
     this._settingsApi = new Settings(this._core);
     this._behaviorsApi = new Behaviors(this._core);
+    this._aboutApi = new About(this._core);
     this._fixturesApi = new Fixtures(this._core);
     core.addSetting({
       name: ADMIN_API_PATH_OPTION,
@@ -66,6 +69,7 @@ class Plugin {
     this._router = express.Router();
     this._router.use(SETTINGS_API_PATH, this._settingsApi.router);
     this._router.use(BEHAVIORS_API_PATH, this._behaviorsApi.router);
+    this._router.use(ABOUT_API_PATH, this._aboutApi.router);
     this._router.use(FIXTURES_API_PATH, this._fixturesApi.router);
   }
 

src/constants.js

@@ -16,5 +16,6 @@ module.exports = {
   SETTINGS_API_PATH: "/settings",
   BEHAVIORS_API_PATH: "/behaviors",
   FIXTURES_API_PATH: "/fixtures",
-  DEPRECATED_API_PATH: "/mocks"
+  DEPRECATED_API_PATH: "/mocks",
+  ABOUT_API_PATH: "/about"
 };

test/acceptance/about-api.spec.js

@@ -0,0 +1,32 @@
+/*
+Copyright 2019 Javier Brea
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+*/
+
+const { startServer, stopServer, request } = require("./utils");
+const { version } = require("../../package.json");
+
+describe("about api", () => {
+  let server;
+  beforeAll(async () => {
+    server = await startServer("web-tutorial");
+  });
+
+  afterAll(() => {
+    stopServer(server);
+  });
+
+  describe("get /", () => {
+    it("should return current version", async () => {
+      const response = await request("/admin/about");
+      expect(response).toEqual({
+        version
+      });
+    });
+  });
+});

test/unit/src/About.mocks.js

@@ -0,0 +1,41 @@
+/*
+Copyright 2019 Javier Brea
+Copyright 2019 XbyOrange
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+*/
+
+const sinon = require("sinon");
+
+jest.mock("../../../src/About");
+
+const About = require("../../../src/About");
+
+const Mock = class Mock {
+  constructor() {
+    this._sandbox = sinon.createSandbox();
+
+    this._stubs = {
+      init: this._sandbox.stub()
+    };
+
+    About.mockImplementation(() => this._stubs);
+  }
+
+  get stubs() {
+    return {
+      Constructor: About,
+      instance: this._stubs
+    };
+  }
+
+  restore() {
+    this._sandbox.restore();
+  }
+};
+
+module.exports = Mock;

test/unit/src/About.spec.js

@@ -0,0 +1,72 @@
+/*
+Copyright 2019 Javier Brea
+Copyright 2019 XbyOrange
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+*/
+
+const express = require("express");
+const sinon = require("sinon");
+
+const LibMocks = require("../Libs.mocks");
+const CoreMocks = require("../Core.mocks");
+
+const About = require("../../../src/About");
+const { version } = require("../../../package.json");
+
+describe("About", () => {
+  let sandbox;
+  let libMocks;
+  let coreMock;
+  let coreInstance;
+  let resMock;
+  let about;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+    resMock = {
+      status: sandbox.stub(),
+      send: sandbox.stub()
+    };
+    libMocks = new LibMocks();
+    coreMock = new CoreMocks();
+    coreInstance = coreMock.stubs.instance;
+    about = new About(coreInstance);
+    expect.assertions(1);
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+    libMocks.restore();
+    coreMock.restore();
+  });
+
+  describe("when created", () => {
+    it("should create an express Router", async () => {
+      expect(express.Router.calledOnce).toEqual(true);
+    });
+
+    it("should have added get router at /", async () => {
+      expect(libMocks.stubs.express.get.getCall(0).args[0]).toEqual("/");
+    });
+  });
+
+  describe("getAbout router", () => {
+    it("should return current package version", () => {
+      about.getAbout({}, resMock);
+      expect(resMock.send.getCall(0).args[0]).toEqual({
+        version
+      });
+    });
+  });
+
+  describe("router getter", () => {
+    it("should return express created router", async () => {
+      expect(about.router).toEqual(libMocks.stubs.express);
+    });
+  });
+});

test/unit/src/Plugin.spec.js

@@ -18,6 +18,7 @@ const DeprecatedApiMocks = require("./deprecated/Api.mocks");
 const SettingsMocks = require("./Settings.mocks");
 const BehaviorsMocks = require("./Behaviors.mocks");
 const FixturesMock = require("./Fixtures.mocks");
+const AboutMock = require("./About.mocks");
 
 const Plugin = require("../../../src/Plugin");
 
@@ -31,13 +32,15 @@ describe("Plugin", () => {
   let deprecatedApiInstance;
   let coreMock;
   let coreInstance;
+  let aboutMock;
   let plugin;
 
   beforeEach(() => {
     sandbox = sinon.createSandbox();
     libMocks = new LibMocks();
     settingsMocks = new SettingsMocks();
     behaviorsMocks = new BehaviorsMocks();
+    aboutMock = new AboutMock();
     fixturesMock = new FixturesMock();
     deprecatedApiMock = new DeprecatedApiMocks();
     deprecatedApiInstance = deprecatedApiMock.stubs.instance;
@@ -54,6 +57,7 @@ describe("Plugin", () => {
     behaviorsMocks.restore();
     fixturesMock.restore();
     coreMock.restore();
+    aboutMock.restore();
     deprecatedApiMock.restore();
   });