jgloo 1.5.2 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+<a name="1.6.0"></a>
+
+## [1.6.0](https://github.com/zosma180/jgloo/compare/1.5.2...1.6.0) (2022-02-20)
+
+### Features
+
+- Added the optional "delay" property to the configuration
+
+---
+
 <a name="1.5.2"></a>
 
 ## [1.5.2](https://github.com/zosma180/jgloo/compare/1.5.1...1.5.2) (2021-02-21)

package/README.md

@@ -27,7 +27,7 @@ This project is based on the Node framework Express. The highlights are:
 ## Installation
 
 ```bash
-npm i -g jgloo
+npm i -D jgloo
 ```
 
 After the installation create a folder "mock" in your project root (you can use another path and folder name if you want).  
@@ -45,6 +45,7 @@ Now you are ready to [create your first API](#create-a-simple-api).
 - [Where data are stored](#where-data-are-stored)
 - [Expose the static files](#expose-the-static-files)
 - [Handle requests with file uploads](#handle-requests-with-file-uploads)
+- [Simulate network delay](#simulate-network-delay)
 - [Run the server](#run-the-server)
 
 ---
@@ -53,7 +54,7 @@ Now you are ready to [create your first API](#create-a-simple-api).
 
 To setup your first API create a new file "hello.js" in the "api" folder. The name of the file does not matter. Then insert the following snippet:
 
-```typescript
+```javascript
 module.exports = {
   path: '/hello',
   method: 'get',
@@ -72,7 +73,7 @@ You are ready to [run the server](#run-the-server) now.
 
 To setup a ReST API, you have to create a new file in the "api" folder with the name you prefer and the following snippet:
 
-```typescript
+```javascript
 module.exports = {
   path: '/user',
   method: 'resource',
@@ -90,7 +91,7 @@ With these few rows of code will be created 6 routes:
 
 If you want to skip any of the previous routes, you can add the "not" property:
 
-```typescript
+```javascript
 module.exports = {
   path: '/user',
   method: 'resource',
@@ -106,7 +107,7 @@ The available values of the "not" property are ['LIST', 'READ', 'CREATE', 'UPDAT
 If you need to control the logic of your resources, you can create a custom API that read and/or write the data in the JSON database.  
 To achieve it create a new file in the "api" folder with the name you prefer and the following snippet:
 
-```typescript
+```javascript
 const { getResource, setResource } = require('jgloo');
 
 module.exports = {
@@ -139,7 +140,7 @@ module.exports = {
 To add a middleware, you have to create a folder "middlewares" in your chosen root path (e.g. "mock/middlewares").  
 Then create a new file inside with the name you prefer and the following sample snippet:
 
-```typescript
+```javascript
 module.exports = (req, res, next) => {
   const isAuthorized = req.get('Authorization') === 'my-token';
   isAuthorized ? next() : res.sendStatus(401);
@@ -156,7 +157,7 @@ The resources are stored in JSON files placed in the subfolder "db" of your chos
 The [default ReST API](#create-a-default-rest-api) store the JSON file with the name generated by resource path replacing the slashes with the minus sign (e.g. "/auth/user" will be stored as "auth-user.json").  
 If you want to specify the file name of the resources, you can set it as the "name" property of the API:
 
-```typescript
+```javascript
 module.exports = {
   path: '/my/long/path',
   method: 'resource',
@@ -183,24 +184,37 @@ It's recommended to add the `static` folder in the `.gitignore` file.
 
 ---
 
+### Simulate network delay
+
+If you want to simulate a network delay, you can add the `delay` property to your API configuration:
+
+```javascript
+module.exports = {
+  ...
+  delay: 3 // Seconds
+};
+```
+
+---
+
 ### Run the server
 
 To run the server execute the following command in your project root:
 
 ```shell
-jgloo
+npx jgloo
 ```
 
 The full optional parameters are:
 
 ```shell
-jgloo -f [FOLDER] -p [PORT] -s [STATIC_URL]
+npx jgloo -f [FOLDER] -p [PORT] -s [STATIC_URL]
 ```
 
 For example:
 
 ```shell
-jgloo -f 'mock' -p 3000 -s 'static'
+npx jgloo -f 'mock' -p 3000 -s 'static'
 ```
 
 - "**-f**" or "**--folder**": the folder where your mocks are placed. It's optional, by default it's the folder "mock".

package/jgloo.js

@@ -20,5 +20,11 @@ module.exports = {
     if (!existsSync(db)) { mkdirSync(db); }
     const path = `${db}/${name}.json`;
     writeFileSync(path, JSON.stringify(value), 'utf8');
-  }
+  },
+
+  getDelayMiddleware: (delay) => {
+    return (_, __, next) => {
+      setTimeout(() => next(), delay * 1000);
+    };
+  },
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "jgloo",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "The coldest mock server.",
-  "homepage": "https://github.com/zosma180/jgloo",
+  "homepage": "https://github.com/zosma180/jgloo#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zosma180/jgloo.git"

package/server.js

@@ -6,6 +6,7 @@ const bodyParser = require('body-parser');
 const multer = require('multer');
 
 const { configureResource } = require(path.join(__dirname, 'rest'));
+const { getDelayMiddleware } = require(path.join(__dirname, 'jgloo'));
 const app = express();
 const params = process.argv.slice(2);
 const root = params[0];
@@ -57,6 +58,11 @@ if (!api.length) {
 api.forEach((file) => {
   const config = require(path.join(apiPath, file));
 
+  // Add the API delay, if it is provided
+  if (config.delay) {
+    app.use(config.path, getDelayMiddleware(config.delay));
+  }
+
   if (config.method === 'resource') {
     // ReST resource
     configureResource(app, config);