Merge pull request #9 from mocks-server/change-feature-by-behavior

Change feature by behavior

Author: javierbrea

.gitignore

@@ -8,6 +8,7 @@
 
 # tests
 /coverage
+/mocks
 
 # misc
 .DS_Store

CHANGELOG.md

@@ -4,13 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [To be deprecated]
+- Deprecate options "features" and "feature".
+- Remove "/features" api path.
+
 ## [unreleased]
 ### Added
 ### Changed
 ### Fixed
 ### Removed
 
-## [1.1.0]
+## [1.1.0] - 2019-11-08
+### Changed
+- Change "feature" concept by "behavior". Maintain old "feature" options and urls as aliases for maintaining compatibility.
+- Upgrade dependencies
 
 ## [1.0.3] - 2019-11-08
 ### Fixed

README.md

@@ -24,9 +24,9 @@ Mocks server with extensible fixtures groupables in predefined behaviors. Behavi
 
 ## Getting Started
 
-This package provides a server that simulates API behaviors. As input, it needs "fixtures", which are responses for specific uris, and "features", which are sets of "fixtures".
+This package provides a server that simulates API behaviors. As input, it needs "fixtures", which are responses for specific uris, and "behaviors", which are sets of "fixtures".
 
-It also provide a built-in CLI and a REST API which allows to change the currently used "feature" in any moment simply making an http request.
+It also provide a built-in CLI and a REST API which allows to change the currently used "behavior" in any moment simply making an http request.
 
 ## Installation
 
@@ -42,7 +42,7 @@ Add an script to your `package.json` file, including the path to your mocks fold
 
 ```json
 "scripts": {
-  "mocks-server" : "mocks-server --features=./mocks"
+  "mocks-server" : "mocks-server --behaviors=./mocks"
 }
 ```
 
@@ -52,166 +52,63 @@ Now, you can start the mocks server CLI simply typing:
 npm run mocks-server
 ```
 
-![cli-home](./assets/cli_home.png)
-
-### REST API
-
-The server includes a REST API that allows to change dinamically the current feature, change delay time, etc.
-
-Available api resources are:
-
-* `GET` `/mocks/features` Returns an array containing all available features.
-* `GET` `/mocks/features/current` Returns current feature.
-* `PUT` `/mocks/features/current` Set current feature.
-  * Request body example: `{ "name": "feature-name" }`
-* `GET` `/mocks/settings` Return current server settings.
-  * Response body example: `{ "delay": 0 }`
-* `PUT` `/mocks/settings` Change current server settings.
-  * Request body example: `{ "delay": 3000 }`
-
-### Programmatic usage
-
-#### CLI
-
-The interactive CLI can be instantiated and started programmatically:
-
-```js
-const { Cli } = require("@mocks-server/main");
-
-const startMyCli = () => {
-  const cli = new Cli({
-    port: 3200,
-    log: "debug",
-    watch: false
-  });
-
-  return cli.start();
-};
-
-startMyCli().catch(err => {
-  console.log("Error starting CLI", err);
-});
-```
-
-##### `Cli` (\[options\]\[,customQuitMethod\])
-For first argument options, please read the [options](#options) chapter of this documentation. Available methods of an instance are:
-- `start` ()
-Inits the server in case it was stopped, adds the watch listeners, and renders main menu.
-- `initServer` ()
-Inits the server in case it was stopped, adds the watch listeners.
-- `stopListeningServerWatch` ()
-When server watch is active, the main menu will be displayed on file changes. This behavior can be deactivated using this method. This is useful when this CLI is loaded as a submenu of another CLI, for example.
-
-#### Server
-
-The server can be instantiated and started programmatically:
-
-```js
-const { Server } = require("@mocks-server/main");
-
-const startMyServer = () => {
-  const server = new Server(path.resolve(__dirname, "mocks"), {
-    port: 3200,
-    log: "debug",
-    watch: false
-  });
-
-  return server.start();
-};
-
-startMyServer().then(server => {
-  console.log("Server started", server);
-});
-```
-
-##### `Server` (featuresFolder \[,options\])
-
-First argument is mandatory, and has to be a path to a folder containing "features". All files in the folder will be loaded recursively, including subfolders.
-For second argument options, please read the [options](#options) chapter of this documentation.
-
-Available methods of an instance are:
-
-- `start` (). Starts the server.
-- `stop` (). Stops the server.
-- `restart` (). Stops the server, initializes it again (reloading features files), and starts it again.
-- `switchWatch` (state `<Boolean>`). Enable or disable features files watch, depending of the received "state" value.
-
-Available getters are:
-
-- `features`. Returns loaded features object.
-- `watchEnabled`. Current state of the features files watcher.
-- `error`. When server has returned an error, or an error ocurred loading features, it is available in this property.
-- `events`. Returns server events object. A "watch-reload" event is emitted when the server watch detects changes in any features file, and restarts the server.
-
-### Global usage
-
-The mocks server can be used as a global dependency as well:
-
-```bash
-npm i @mocks-server/main -g
-```
-
-Now, you can start the built-in command line interface from anywhere, providing a path to a features folder:
-
-```bash
-mocks-server --features=./path-to-features
-```
+![cli-home](./assets/cli_animation.gif)
 
 ## Options
 
 * port `<Number>` Por number for the Server to be listening.
 * host `<String>` Host for the server. Default is "0.0.0.0" (Listen to any local host).
 * log `<String>` Logs level. Can be one of "silly", "debug", "verbose", "info", "warn", "error".
-* watch `<Boolean>` Watch features folder, and restart server on changes. Default is `true`.
-* feature `<String>` Selected feature when server is started.
+* watch `<Boolean>` Watch behaviors folder, and restart server on changes. Default is `true`.
+* behavior `<String>` Selected behavior when server is started.
 * delay `<Number` Responses delay time in milliseconds.
-* features `Path as <String>` Path to a folder containing features to be used by the server.
-* recursive `<Boolean>` Load features recursively. Watch is not affected by this option, it is always recursive.
+* behaviors `Path as <String>` Path to a folder containing behaviors to be used by the server.
+* recursive `<Boolean>` Load behaviors recursively. Watch is not affected by this option, it is always recursive.
 * cli `<Boolean>` Start interactive CLI. Default is `true`.
 
 ## Defining mocks
 
 The Mocks server handles two main concepts for defining mocks:
 
-### Features
+### Behaviors
 
-Each feature consists in a set of "fixtures", which are server responses for specific uris.
+Each behavior consists in a set of "fixtures", which are server responses for specific uris.
 
-Features are extensibles, so, you can have a "base" feature, which defines the standard behavior of the mocks server and responses for all api uris, and change this behavior creating new features that changes only responses for certain "uris". All features are extensible as well.
+Behaviors are extensibles, so, you can have a "base" behavior, which defines the standard behavior of the mocks server and responses for all api uris, and change this behavior creating new behaviors that changes only responses for certain "uris". All extended behaviors are extensible as well.
 
-For creating a Feature, you have to use the mocks-server "Feature" class, providing an array of "fixtures" to it:
+For creating a Behavior, you have to use the mocks-server "Behavior" class, providing an array of "fixtures" to it:
 
 ```js
-// Features file 1
+// Behaviors file 1
 
-const { Feature } = require("@mocks-server/main");
+const { Behavior } = require("@mocks-server/main");
 
 const fixtures = require("./fixtures");
 
-const myFeature = new Feature([fixtures.uri_1_fixture, fixtures.uri_2_fixture]);
+const myBehavior = new Behavior([fixtures.uri_1_fixture, fixtures.uri_2_fixture]);
 
 module.exports = {
-  myFeature
+  myBehavior
 };
 ```
 
-Now, when loaded, the server will have available a "myFeature" feature, which contains two fixtures. You can add more features extending the first one and changing only the response for "uri_2", for example:
+Now, when loaded, the server will have available a "myBehavior" behavior, which contains two fixtures. You can add more behaviors extending the first one and changing only the response for "uri_2", for example:
 
 ```js
-// Features file 2
+// Behaviors file 2
 
-const { myFeature } = require("./features");
+const { myBehavior } = require("./behaviors");
 
 const fixtures = require("./fixtures");
 
-const myFeature2 = myFeature.extend([fixtures.uri_2_different_fixture]);
+const myBehavior2 = myBehavior.extend([fixtures.uri_2_different_fixture]);
 
 module.exports = {
-  myFeature2
+  myBehavior2
 };
 ```
 
-Now, server will have available "myFeature" and "myFeature2" features. And "myFeature2" will send a different response only for "uri_2" (supossing that "uri_2_fixture" and "uri_2_different_fixture" were defined with the same uri)
+Now, server will have available "myBehavior" and "myBehavior2" behaviors. And "myBehavior2" will send a different response only for "uri_2" (supossing that "uri_2_fixture" and "uri_2_different_fixture" were defined with the same uri)
 
 ### Fixtures
 
@@ -220,8 +117,8 @@ A "fixture" defines the response for an specific uri. It has to be an object con
 * url `uri as <String>` Uri of the resource. It can contains expressions for matching dynamic uris. Read the [route-parser](https://www.npmjs.com/package/route-parser) documentation for further info about how to use dynamic routing.
 * method `<String>` Method of the request. Defines to which method will response this fixture. Valid values are http request methods, such as "GET", "POST", "PUT", etc.
 * response `<Object>` Defines the response that the Mocks Server will send to the request:
-	* status `<Number>` Status code to send.
-	* body `<Object>` Json object to send as body in the response.
+  * status `<Number>` Status code to send.
+  * body `<Object>` Json object to send as body in the response.
 * response `<Function>` Response can be defined as a function too. The function will receive the [express](http://expressjs.com/es/api.html) `request`, `response` and `next` arguments, so you are free to handle the server request as you need.
 
 ```js
@@ -266,11 +163,92 @@ module.exports = {
 };
 ```
 
+### REST API
+
+The server includes a REST API that allows to change dinamically the current behavior, change delay time, etc. This is __very useful when running acceptance tests, as you can change the behavior of the api__ simply with a request in your tests `before` method.
+
+Available api resources are:
+
+* `GET` `/mocks/behaviors` Returns an array containing all available behaviors.
+* `GET` `/mocks/behaviors/current` Returns current behavior.
+* `PUT` `/mocks/behaviors/current` Set current behavior.
+  * Request body example: `{ "name": "behavior-name" }`
+* `GET` `/mocks/settings` Return current server settings.
+  * Response body example: `{ "delay": 0 }`
+* `PUT` `/mocks/settings` Change current server settings.
+  * Request body example: `{ "delay": 3000 }`
+
+### Programmatic usage
+
+#### Server
+
+The server can be instantiated and started programmatically:
+
+```js
+const { Server } = require("@mocks-server/main");
+
+const startMyServer = () => {
+  const server = new Server(path.resolve(__dirname, "mocks"), {
+    port: 3200,
+    log: "debug",
+    watch: false
+  });
+
+  return server.start();
+};
+
+startMyServer().then(server => {
+  console.log("Server started", server);
+});
+```
+
+##### `Server` (behaviorsFolder \[,options\])
+
+First argument is mandatory, and has to be a path to a folder containing "behaviors" and "fixtures". All files in the folder will be loaded recursively, including subfolders.
+For second argument options, please read the [options](#options) chapter of this documentation.
+
+Available methods of an instance are:
+
+- `start` (). Starts the server.
+- `stop` (). Stops the server.
+- `restart` (). Stops the server, initializes it again (reloading behaviors files), and starts it again.
+- `switchWatch` (state `<Boolean>`). Enable or disable behaviors files watch, depending of the received "state" value.
+
+Available getters are:
+
+- `behaviors`. Returns loaded behaviors object.
+- `watchEnabled`. Current state of the behaviors files watcher.
+- `error`. When server has returned an error, or an error ocurred loading behaviors, it is available in this property.
+- `events`. Returns server events object. A "watch-reload" event is emitted when the server watch detects changes in any behaviors or fixtures file, and restarts the server.
+
+> The interactive CLI can be started programatically too. Read the [cli advanced docs](./docs/cli.md) for further info.
+
+### Global usage
+
+The mocks server can be used as a global dependency as well:
+
+```bash
+npm i @mocks-server/main -g
+```
+
+Now, you can start the built-in command line interface from anywhere, providing a path to a folder containing behaviors:
+
+```bash
+mocks-server --behaviors=./path-to-behaviors
+```
+
+### Support (OS Terminals)
+
+This package uses [inquirer][inquirer-url] for displaying CLI. You can [consult his OS Terminals support here][inquirer-support].
+
 ## Contributing
 
 Contributors are welcome.
 Please read the [contributing guidelines](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md).
 
+[inquirer-url]: https://www.npmjs.com/package/inquirer#support-os-terminals
+[inquirer-support]: https://www.npmjs.com/package/inquirer#support-os-terminals
+
 [coveralls-image]: https://coveralls.io/repos/github/mocks-server/main/badge.svg
 [coveralls-url]: https://coveralls.io/github/mocks-server/main
 [travisci-image]: https://travis-ci.com/mocks-server/main.svg?branch=master

assets/cli_animation.gif

@@ -0,0 +1,30 @@
+#### CLI
+
+The interactive CLI can be instantiated and started programmatically:
+
+```js
+const { Cli } = require("@mocks-server/main");
+
+const startMyCli = () => {
+  const cli = new Cli({
+    port: 3200,
+    log: "debug",
+    watch: false
+  });
+
+  return cli.start();
+};
+
+startMyCli().catch(err => {
+  console.log("Error starting CLI", err);
+});
+```
+
+##### `Cli` (\[options\]\[,customQuitMethod\])
+For first argument options, please read the [options](#options) chapter of this documentation. Available methods of an instance are:
+- `start` ()
+Inits the server in case it was stopped, adds the watch listeners, and renders main menu.
+- `initServer` ()
+Inits the server in case it was stopped, adds the watch listeners.
+- `stopListeningServerWatch` ()
+When server watch is active, the main menu will be displayed on file changes. This behavior can be deactivated using this method. This is useful when this CLI is loaded as a submenu of another CLI, for example.

assets/cli_home.png

@@ -1,4 +1,5 @@
 /*
+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
@@ -17,5 +18,6 @@ const Feature = require("./lib/features/Feature");
 module.exports = {
   Cli,
   Server,
-  Feature
+  Feature,
+  Behavior: Feature
 };

docs/cli.md

@@ -28,5 +28,6 @@ module.exports = {
   testEnvironment: "node",
 
   // The glob patterns Jest uses to detect test files
-  testMatch: ["**/test/unit/**/?(*.)+(spec|test).js?(x)"]
+  testMatch: ["**/test/unit/**/?(*.)+(spec|test).js?(x)"],
+  //testMatch: ["**/test/unit/**/options.spec.js"]
 };