feat: add resource to admin custom routes variants

Author: javierbrea

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Add mocks, routes and routes-variants apis
 ### Changed
 - Move behaviors and fixtures apis under legacy folder
+- refactor: Use helper to create routers with same structure
 ### Fixed
 ### Removed
 - Remove deprecated api paths

README.md

@@ -7,39 +7,46 @@
 
 # [![Mocks Server][logo-url]][website-url] Mocks Server Plugin Admin Api
 
-Plugin for [Mocks Server][website-url] that provides an API REST that allows to change dinamically the current behavior, change delay time, and another [Mocks Server options][options-url].
+Plugin for [Mocks Server][website-url] that provides an API REST that allows to change the current behavior, change delay time, and another [Mocks Server options][options-url].
 
-This is __very useful when running acceptance tests, as you can change the behavior of the api__ simply making an HTTP request in your tests `before` method, for example.
+This is __very useful when running acceptance tests, as you can change the current mock__ simply with a HTTP request in the `before` method of your tests, for example.
+
+A __client for the administration api__ is also distributed as a separated package: [@mocks-server/admin-api-client](https://www.npmjs.com/package/@mocks-server/admin-api-client).
 
 ## Usage
 
 This plugin is included in the [main distribution of the Mocks Server project][main-distribution-url], so you can refer to the [official documentation website][website-url].
 
 ## Options
 
-* `adminApiPath` - Base path for the administration api. Default is "/admin". You should change it only if there is any conflict with the api you are mocking.
-* `adminApiDeprecatedPaths` - Boolean option, disables deprecated "/mocks" api path, which is still enabled by default.
+* __`adminApiPath`__ _(String)_: Path for the administration api. Default is `/admin`. You should change it only in case there is any conflict with the api you are mocking.
 
-Read more about [how to define options for the mocks-server plugins here](https://www.mocks-server.org/docs/configuration-options).
+Read more about [how to set options in Mocks Server here](https://www.mocks-server.org/docs/configuration-options).
 
 ## API Resources
 
 Available api resources are:
 
-* `GET` `/admin/about` Returns plugin information.
+* `GET` `/admin/about` Returns "plugin-admin-api" information.
   * Response body example: `{ "version": "1.2.0" }`
-* `GET` `/admin/behaviors` Returns behaviors collection.
-* `GET` `/admin/behaviors/:id` Returns an specific behavior.
-* `GET` `/admin/fixtures` Returns fixtures collection.
-* `GET` `/admin/fixtures/:id` Returns an specific fixture.
+* `GET` `/admin/mocks` Returns mocks.
+* `GET` `/admin/mocks/:id` Returns a specific mock.
+* `GET` `/admin/routes` Returns routes collection.
+* `GET` `/admin/routes/:id` Returns a specific route.
+* `GET` `/admin/routes-variants` Returns routes variants collection.
+* `GET` `/admin/routes-variants/:id` Returns a specific route variant.
+* `GET` `/admin/mock-custom-routes-variants` Returns an array of currently custom routes variants ids.
+* `POST` `/admin/mock-custom-routes-variants` Defines a route variant to be used by current mock.
+  * Request body example: `{ "id": "users:error" }`
+* `DELETE` `/admin/mock-custom-routes-variants` Restore routes variants to those defined in current mock.
 * `GET` `/admin/settings` Returns current server settings.
-  * Response body example: `{ "delay": 0, behavior: "foo-behavior", path: "mocks" }`
+  * Response body example: `{ "delay": 0, mock: "foo-mock", path: "mocks" }`
 * `PATCH` `/admin/settings` Changes current server settings.
   * Request body example: `{ "delay": 3000 }`
 * `GET` `/admin/alerts` Returns current alerts.
-* `GET` `/admin/alerts/:id` Returns an specific alert. The alert `id` is equivalent to the alert `context`.
+* `GET` `/admin/alerts/:id` Returns a specific alert. The alert `id` is equivalent to the alert `context` _(read the [developing plugins chapter](plugins-developing-plugins.md) for further info about alerts)_.
 
-> Deprecated api resources under "/mocks" api path are still available.
+> v1.x deprecated api resources are also still available under the `/legacy` path.
 
 ## Contributing
 

jest.e2e.config.js

@@ -9,7 +9,7 @@ module.exports = {
   // testMatch: ["<rootDir>/test/e2e/**/stop-plugin.spec.js"],
 
   // Indicates whether the coverage information should be collected while executing the test
-  collectCoverage: false,
+  collectCoverage: true,
 
   // The test environment that will be used for testing
   testEnvironment: "node",

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@mocks-server/plugin-admin-api",
   "version": "1.5.0",
-  "description": "Plugin for Mocks Server. Provides a REST API for administrating settings, fixtures and behaviors",
+  "description": "Mocks Server plugin providing a REST API for administration",
   "keywords": [
     "mocks-server-plugin",
     "administration",
@@ -31,15 +31,15 @@
     "test:unit": "npm run test"
   },
   "peerDependencies": {
-    "@mocks-server/core": ">=1.3.0"
+    "@mocks-server/core": ">=2.0.0"
   },
   "dependencies": {
-    "@mocks-server/admin-api-paths": "2.0.0-beta.1",
+    "@mocks-server/admin-api-paths": "2.0.0-beta.2",
     "@hapi/boom": "9.1.0",
     "express": "4.17.1"
   },
   "devDependencies": {
-    "@mocks-server/core": "1.6.0",
+    "@mocks-server/core": "2.0.0-beta.1",
     "eslint": "7.12.1",
     "eslint-plugin-no-only-tests": "2.4.0",
     "eslint-config-prettier": "6.15.0",

package.json

@@ -13,7 +13,7 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 const express = require("express");
 
-const { PLUGIN_NAME } = require("./constants");
+const { PLUGIN_NAME } = require("./support/constants");
 const { version } = require("../package.json");
 
 class AboutApi {

src/About.js

@@ -12,17 +12,25 @@ Unless required by applicable law or agreed to in writing, software distributed
 "use strict";
 
 const express = require("express");
-const Boom = require("@hapi/boom");
 
-const { PLUGIN_NAME } = require("./constants");
+const { addCollectionMiddleware, addModelMiddleware } = require("./support/middlewares");
 
 class AlertsApi {
   constructor(core) {
     this._core = core;
     this._tracer = core.tracer;
     this._router = express.Router();
-    this._router.get("/", this.getCollection.bind(this));
-    this._router.get("/:id", this.getModel.bind(this));
+    addCollectionMiddleware(this._router, {
+      name: "alerts",
+      getItems: this._parseCollection.bind(this),
+      tracer: core.tracer,
+    });
+    addModelMiddleware(this._router, {
+      name: "alert",
+      getItems: this._getCollection.bind(this),
+      parseItem: this._parseModel.bind(this),
+      tracer: core.tracer,
+    });
   }
 
   _parseModel(alert) {
@@ -44,22 +52,8 @@ class AlertsApi {
     return this._core.alerts.map(this._parseModel);
   }
 
-  getCollection(req, res) {
-    this._tracer.verbose(`${PLUGIN_NAME}: Sending alerts | ${req.id}`);
-    res.status(200);
-    res.send(this._parseCollection());
-  }
-
-  getModel(req, res, next) {
-    const id = req.params.id;
-    this._tracer.verbose(`${PLUGIN_NAME}: Sending alert ${id} | ${req.id}`);
-    const foundAlert = this._core.alerts.find((alert) => alert.context === id);
-    if (foundAlert) {
-      res.status(200);
-      res.send(this._parseModel(foundAlert));
-    } else {
-      next(Boom.notFound(`Alert with id "${id}" was not found`));
-    }
+  _getCollection() {
+    return this._core.alerts;
   }
 
   get router() {

src/Alerts.js

@@ -0,0 +1,63 @@
+/*
+Copyright 2020 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 Boom = require("@hapi/boom");
+
+const { addCollectionMiddleware } = require("./support/middlewares");
+
+class CustomRoutesVariants {
+  constructor(core) {
+    this._core = core;
+    this._tracer = core.tracer;
+    this._router = express.Router();
+    addCollectionMiddleware(this._router, {
+      name: "custom routes variants",
+      getItems: this._getCollection.bind(this),
+      tracer: core.tracer,
+    });
+
+    this._router.post("/", this.add.bind(this));
+    this._router.delete("/", this.delete.bind(this));
+  }
+
+  _getCollection() {
+    return this._core.mocks.customRoutesVariants;
+  }
+
+  add(req, res, next) {
+    const id = req.body.id;
+    const routeVariant = this._core.mocks.plainRoutesVariants.find(
+      (routeVariant) => routeVariant.id === id
+    );
+    if (routeVariant) {
+      this._core.mocks.useRouteVariant(id);
+      res.status(204);
+      res.send();
+    } else {
+      next(Boom.badRequest(`Route variant with id "${id}" was not found`));
+    }
+  }
+
+  delete(req, res) {
+    this._core.mocks.restoreRoutesVariants();
+    res.status(204);
+    res.send();
+  }
+
+  get router() {
+    return this._router;
+  }
+}
+
+module.exports = CustomRoutesVariants;