jgloo 1.4.0 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,43 @@
+<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)
+
+### Bug Fixes
+
+- Fixed the folder path with space characters
+
+---
+
+<a name="1.5.1"></a>
+
+## [1.5.1](https://github.com/zosma180/jgloo/compare/1.5.0...1.5.1) (2021-02-17)
+
+### Bug Fixes
+
+- Fixed the folder path for Windows environment
+
+---
+
+<a name="1.5.0"></a>
+
+## [1.5.0](https://github.com/zosma180/jgloo/compare/1.4.0...1.5.0) (2021-01-25)
+
+### Features
+
+- Added the optional "not" property to the default ReST API configuration
+
+---
+
 <a name="1.4.0"></a>
 
 ## [1.4.0](https://github.com/zosma180/jgloo/compare/1.3.0...1.4.0) (2020-06-30)

package/README.md

@@ -16,7 +16,7 @@ This project is based on the Node framework Express. The highlights are:
 
 - Create a ReST API with two rows of code
 - Create custom API easily
-- Create custom middleware easily (i.e. auth check)
+- Create custom middleware easily (e.g. auth check)
 - Store data in accessible JSON files
 - Reload the live changes of your mocks automatically (thanks to nodemon package)
 - Expose a dedicated folder for the static files (images, assets etc...)
@@ -27,11 +27,11 @@ 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).  
-The **only requirement** is to create a subfolder "api" in your chosen path (i.e. "mock/api").  
+The **only requirement** is to create a subfolder "api" in your chosen path (e.g. "mock/api").  
 Now you are ready to [create your first API](#create-a-simple-api).
 
 ---
@@ -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',
@@ -88,6 +89,17 @@ With these few rows of code will be created 6 routes:
 - PATCH /user/:id : allow to merge an existent user data with the request body values and return it as response;
 - DELETE /user/:id : allow to delete an existent user and return the deleted id.
 
+If you want to skip any of the previous routes, you can add the "not" property:
+
+```javascript
+module.exports = {
+  path: '/user',
+  method: 'resource',
+  not: ['LIST']
+};
+```
+The available values of the "not" property are ['LIST', 'READ', 'CREATE', 'UPDATE', 'PATCH', 'DELETE']
+
 ---
 
 ### Create a custom ReST API
@@ -95,7 +107,7 @@ With these few rows of code will be created 6 routes:
 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 = {
@@ -125,10 +137,10 @@ module.exports = {
 
 ### Create a middleware
 
-To add a middleware, you have to create a folder "middlewares" in your chosen root path (i.e. "mock/middlewares").  
+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);
@@ -141,11 +153,11 @@ This sample code check for all routes if the "Authorization" header is set and i
 
 ### Where data are stored
 
-The resources are stored in JSON files placed in the subfolder "db" of your chosen root path (i.e. "mock/db").  
-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 (i.e. "/auth/user" will be stored as "auth-user.json").  
+The resources are stored in JSON files placed in the subfolder "db" of your chosen root path (e.g. "mock/db").  
+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',
@@ -159,7 +171,7 @@ With this code, the JSON file will be stored as "user.json".
 
 ### Expose the static files
 
-To expose any static files you have to create the subfolder "static" in your chosen root path (i.e. "mock/static") and put all the resources inside it.  
+To expose any static files you have to create the subfolder "static" in your chosen root path (e.g. "mock/static") and put all the resources inside it.  
 The static content is reachable by "http://localhost:3000/static/...". That's it.
 
 ---
@@ -172,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/cli

@@ -6,13 +6,13 @@ const { exec } = require('child_process');
 const minimist = require('minimist');
 
 const params = minimist(process.argv.slice(2));
-const folder = path.join(process.env.PWD, params.f || params.folder || 'mock');
+const folder = path.join(process.cwd(), params.f || params.folder || 'mock');
 const port = params.p || params.port || 3000;
 const staticUrl = params.s || params.static || 'static';
 const server = `${__dirname}/server.js`;
 
 const child = exec(
-  `nodemon --watch ${folder} --ignore "db/*.json" "${server}" "${folder}" "${port}" "${staticUrl}"`
+  `nodemon --watch "${folder}" --ignore "db/*.json" "${server}" "${folder}" "${port}" "${staticUrl}"`
 );
 
 child.stdout.on('data', (data) => console.log(String(data)));

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.4.0",
+  "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"
@@ -12,7 +12,7 @@
     "deploy": "npm-deploy . ."
   },
   "bin": {
-    "jgloo": "./cli"
+    "jgloo": "cli"
   },
   "keywords": [
     "jgloo",
@@ -30,6 +30,6 @@
     "express": "^4.17.1",
     "minimist": "^1.2.5",
     "multer": "^1.4.2",
-    "nodemon": "^2.0.2"
+    "nodemon": "^2.0.4"
   }
 }

package/rest.js

@@ -5,78 +5,91 @@ module.exports = {
   configureResource: (app, config) => {
     const fallback = config.path.split('/').filter(Boolean).join('-');
     const resourceName = config.name || fallback;
+    const skips = config.not || [];
 
     // List
-    app.get(config.path, (req, res) => {
-      const resource = getResource(resourceName) || [];
-      res.json(resource);
-    });
+    if (skips.includes('LIST') === false) {
+      app.get(config.path, (req, res) => {
+        const resource = getResource(resourceName) || [];
+        res.json(resource);
+      });
+    }
 
     // Read
-    app.get(`${config.path}/:id`, (req, res) => {
-      const id = Number(req.params.id);
+    if (skips.includes('READ') === false) {
+      app.get(`${config.path}/:id`, (req, res) => {
+        const id = Number(req.params.id);
 
-      const resource = getResource(resourceName) || [];
-      const model = resource.find(r => r.id === id);
-      if (!model) { return res.sendStatus(404); }
+        const resource = getResource(resourceName) || [];
+        const model = resource.find(r => r.id === id);
+        if (!model) { return res.sendStatus(404); }
 
-      res.json(model);
-    });
+        res.json(model);
+      });
+    }
 
     // Create
-    app.post(config.path, (req, res) => {
-      const resource = getResource(resourceName) || [];
-      const model = req.body;
+    if (skips.includes('CREATE') === false) {
+      app.post(config.path, (req, res) => {
+        const resource = getResource(resourceName) || [];
+        const model = req.body;
 
-      model.id = Date.now();
-      resource.push(model);
-      setResource(resourceName, resource);
+        model.id = Date.now();
+        resource.push(model);
+        setResource(resourceName, resource);
 
-      res.json(model);
-    });
+        res.json(model);
+      });
+    }
 
     // Update
-    app.put(`${config.path}/:id`, (req, res) => {
-      const id = Number(req.params.id);
+    if (skips.includes('UPDATE') === false) {
+      app.put(`${config.path}/:id`, (req, res) => {
+        const id = Number(req.params.id);
 
-      const resource = getResource(resourceName) || [];
-      const index = resource.findIndex(r => r.id === id);
-      if (index === -1) { return res.sendStatus(404); }
+        const resource = getResource(resourceName) || [];
+        const index = resource.findIndex(r => r.id === id);
+        if (index === -1) { return res.sendStatus(404); }
 
-      resource[index] = req.body;
-      resource[index].id = id;
-      setResource(resourceName, resource);
+        resource[index] = req.body;
+        resource[index].id = id;
+        setResource(resourceName, resource);
 
-      res.json(resource[index]);
-    });
+        res.json(resource[index]);
+      });
+    }
 
     // Patch
-    app.patch(`${config.path}/:id`, (req, res) => {
-      const id = Number(req.params.id);
+    if (skips.includes('PATCH') === false) {
+      app.patch(`${config.path}/:id`, (req, res) => {
+        const id = Number(req.params.id);
 
-      const resource = getResource(resourceName) || [];
-      const index = resource.findIndex(r => r.id === id);
-      if (index === -1) { return res.sendStatus(404); }
+        const resource = getResource(resourceName) || [];
+        const index = resource.findIndex(r => r.id === id);
+        if (index === -1) { return res.sendStatus(404); }
 
-      resource[index] = { ...resource[index], ...req.body };
-      resource[index].id = id;
-      setResource(resourceName, resource);
+        resource[index] = { ...resource[index], ...req.body };
+        resource[index].id = id;
+        setResource(resourceName, resource);
 
-      res.json(resource[index]);
-    });
+        res.json(resource[index]);
+      });
+    }
 
     // Delete
-    app.delete(`${config.path}/:id`, (req, res) => {
-      const id = Number(req.params.id);
+    if (skips.includes('DELETE') === false) {
+      app.delete(`${config.path}/:id`, (req, res) => {
+        const id = Number(req.params.id);
 
-      let resource = getResource(resourceName) || [];
-      const index = resource.findIndex(r => r.id === id);
-      if (index === -1) { return res.sendStatus(404); }
+        let resource = getResource(resourceName) || [];
+        const index = resource.findIndex(r => r.id === id);
+        if (index === -1) { return res.sendStatus(404); }
 
-      resource = resource.filter(r => r.id !== id);
-      setResource(resourceName, resource);
+        resource = resource.filter(r => r.id !== id);
+        setResource(resourceName, resource);
 
-      res.json(id);
-    });
+        res.json(id);
+      });
+    }
   }
 }

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);