restful-dummy-server 1.0.0

package/dist/bundle.js.LICENSE.txt

@@ -0,0 +1,250 @@
+/*!
+ * accepts
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * body-parser
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2014-2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * body-parser
+ * Copyright(c) 2014-2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * bytes
+ * Copyright(c) 2012-2014 TJ Holowaychuk
+ * Copyright(c) 2015 Jed Watson
+ * MIT Licensed
+ */
+
+/*!
+ * content-disposition
+ * Copyright(c) 2014-2017 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * content-type
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * cookie
+ * Copyright(c) 2012-2014 Roman Shtylman
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * depd
+ * Copyright(c) 2014-2018 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * destroy
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2015-2022 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * ee-first
+ * Copyright(c) 2014 Jonathan Ong
+ * MIT Licensed
+ */
+
+/*!
+ * encodeurl
+ * Copyright(c) 2016 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */
+
+/*!
+ * etag
+ * Copyright(c) 2014-2016 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * express
+ * Copyright(c) 2009-2013 TJ Holowaychuk
+ * Copyright(c) 2013 Roman Shtylman
+ * Copyright(c) 2014-2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * express
+ * Copyright(c) 2009-2013 TJ Holowaychuk
+ * Copyright(c) 2014-2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * finalhandler
+ * Copyright(c) 2014-2022 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * forwarded
+ * Copyright(c) 2014-2017 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * fresh
+ * Copyright(c) 2012 TJ Holowaychuk
+ * Copyright(c) 2016-2017 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * http-errors
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2016 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * media-typer
+ * Copyright(c) 2014 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * merge-descriptors
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * methods
+ * Copyright(c) 2013-2014 TJ Holowaychuk
+ * Copyright(c) 2015-2016 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * mime-db
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2015-2022 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * mime-types
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * negotiator
+ * Copyright(c) 2012 Federico Romero
+ * Copyright(c) 2012-2014 Isaac Z. Schlueter
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * on-finished
+ * Copyright(c) 2013 Jonathan Ong
+ * Copyright(c) 2014 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * parseurl
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2014-2017 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * proxy-addr
+ * Copyright(c) 2014-2016 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * range-parser
+ * Copyright(c) 2012-2014 TJ Holowaychuk
+ * Copyright(c) 2015-2016 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * raw-body
+ * Copyright(c) 2013-2014 Jonathan Ong
+ * Copyright(c) 2014-2022 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * send
+ * Copyright(c) 2012 TJ Holowaychuk
+ * Copyright(c) 2014-2022 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * serve-static
+ * Copyright(c) 2010 Sencha Inc.
+ * Copyright(c) 2011 TJ Holowaychuk
+ * Copyright(c) 2014-2016 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * statuses
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2016 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * toidentifier
+ * Copyright(c) 2016 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * type-is
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2014-2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * unpipe
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*!
+ * vary
+ * Copyright(c) 2014-2017 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */

package/index.js

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+
+const express = require('express');
+// const yargs = require('yargs');
+const path = require('path');
+const commander = require('commander');
+
+//const app = express();
+const server = require('./server');
+
+commander
+    .option('-host, --host [host]', 'Specify host.', '')
+    .option('-port, --port [port]', 'Specify port.', '')
+    .option('-proxy, --proxy [proxy]', 'Specify proxy like "localhost:80".', '')
+    .option('-static, --static [static]', 'Specify static files location.', '')
+    .option('-config, --config [config]', 'Specify config files location.', '')
+    .parse(process.argv);
+
+// const { static, config, port, host, proxy } = yargs
+// .usage('mock-server [options]')
+// .options({
+//     host: {
+//         alias: 'h',
+//         description: 'Set host'
+//     },
+//     port: {
+//         alias: 'P',
+//         description: 'Set port'
+//     },
+//     proxy: {
+//         alias: 'p',
+//         description: 'Set proxy'
+//     },
+//     watch: {
+//         alias: 'w',
+//         description: 'Watch files'
+//     },
+//     static: {
+//         alias: 's',
+//         description: 'Static files path'
+//     },
+//     config: {
+//         alias: 'c',
+//         description: 'Config file path'
+//     }
+// }).argv;
+
+const { static, config, port, host, proxy } = commander?.opts();
+
+server.start({
+    port: port,
+    host: host,
+    proxy: proxy,
+    staticPath: static ? path.resolve(static) : undefined,
+    configPath: config ? path.resolve(config) : undefined
+});

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "restful-dummy-server",
+  "version": "1.0.0",
+  "description": "This can be used to mock restful api responses.",
+  "main": "dist/bundle.js",
+  "scripts": {
+    "build": "rm -rf dist && webpack",
+    "publish:package": "npm run build && npm publish --access=public"
+  },
+  "bin": {
+    "restful-dummy-server": "dist/bundle.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SuneetBansal/restful-dummy-server.git"
+  },
+  "keywords": [
+    "dummy",
+    "mock",
+    "rest server",
+    "restful dummy server",
+    "fake"
+  ],
+  "author": "Suneet Bansal",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/SuneetBansal/restful-dummy-server/issues"
+  },
+  "homepage": "https://github.com/SuneetBansal/restful-dummy-server#readme",
+  "dependencies": {
+    "commander": "^11.0.0",
+    "express": "^4.18.2",
+    "express-http-proxy": "^1.6.3"
+  },
+  "devDependencies": {
+    "rimraf": "^3.0.2",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.1"
+  }
+}

package/server.js

@@ -0,0 +1,81 @@
+// lib imports
+const express = require('express');
+const path = require('path');
+const fs = require('fs');
+const httpProxy = require('express-http-proxy');
+
+// custom imports
+const app = express();
+const defaultServerSetting = require('./default-server-setting');
+const utils = require('./utils');
+
+/**
+ * to start express server with provided configuration
+ * 
+ * @param {*} serverSettings 
+ */
+function start(serverSettings) {
+    const { staticPath, configPath, ...others } = serverSettings;
+    const { port, host, proxy } = others;
+
+    // merging user server settings with default server settings
+    const options = Object.assign({}, defaultServerSetting, serverSettings);
+
+    app.set('options', options);
+
+    app.use(function(req, res, next) {
+        const result = utils.getMatchingDummyData(req, configPath);
+        const { response: defaultResponse } = app.get('options');
+
+        if (result?.response) {
+            const { body, headers: responseHeaders, delay } = result?.response;
+            const headers = { ...defaultResponse?.headers,  ...responseHeaders };
+
+            res.set(headers);
+            res.status(200);
+
+            setTimeout(() => {
+                try {
+                    if (typeof body === 'string') {
+                        const filePath = path.join(configPath, body);
+                        const fileStat = fs.statSync(filePath);
+    
+                        if (fileStat.isFile()) {
+                            res.sendFile(filePath);
+                        } else {
+                            res.send(body);
+                        }
+                    } else {
+                        res.send(body);
+                    }
+                } catch (e) {
+                    res.send(body);
+                }
+            }, delay ?? 0);
+        } else if (proxy) {
+            next();
+        } else {
+            res.status(404);
+            res.send({ 'message': 'not found' });
+        }
+    });
+
+    // adding proxy middleware which would work when no response is found and proxy is configured
+    if (proxy) {
+        app.use(
+            httpProxy(proxy, {
+                proxyReqPathResolver: function (req) {
+                    return req.url;
+                }
+            })
+        );
+    }
+
+    app.listen(port, host, () => {
+        console.log('Mock server started at ' + port);
+    });
+}
+
+module.exports = {
+    start
+};

package/utils.js

@@ -0,0 +1,91 @@
+// lib imports
+const fs = require('fs');
+const path = require('path');
+
+function getMatchingDummyData(req, configPath) {
+    let fileList;
+
+    try {
+        fileList = fs.readdirSync(configPath);
+    } catch (exception) {
+        console.log('There is no file found at ' + configPath);    
+    }
+
+    // checking if fileList is not empty
+    if (fileList?.length > 0) {
+        let result;
+
+        for (let index = 0; index < fileList?.length > 0; index ++) {
+            const file = fileList[index];
+            const filePath = path.join(configPath, file);
+            const fileStat = fs.statSync(filePath);
+
+            if (fileStat.isFile()) {
+                result = getItem(req, filePath);
+            } else if (fileStat.isDirectory()) {
+                getMatchingDummyData(req, filePath);
+            }
+
+            if (result) {
+                return result;
+            }
+        }
+    }
+}
+
+/**
+ * To get matching mock data
+ * 
+ * @param req, filePath
+ */
+function getItem(req, filePath) {
+    const fileContent = fs.readFileSync(filePath);
+    let mockData = [];
+
+    if (/.json$/.test(filePath)) {
+        mockData = JSON.parse(fileContent) ?? [];
+    }
+
+    if (!Array.isArray(mockData)) {
+        mockData = [mockData];
+    }
+
+   return mockData?.find((item) => (isMatchingPathExists(req, item)));
+}
+
+/**
+ * To check if req path exists on mock data
+ */
+function isMatchingPathExists(req, mockData) {
+    let { path, method: reqMethod } = req;
+    let { url: mockPath, method: mockMethod } = mockData?.request; 
+
+    // removing starting and trailing /
+    path = path.replace(/^\//, '').replace(/\/$/, '');
+    mockPath = mockPath.replace(/^\//, '').replace(/\/$/, '');  
+
+    // Below cases supporting - 
+    // 1. url: /test/:input will match with /test/abc or /test/xyz etc.
+    // 2. url: /test/*.* will match with /test/abc.jpg or /test/xyz.png etc.
+    // 3. url: /test/**/*.jpg will match with /test/abc.jpg or /test/xyz/abc.jpg or /test/test2/xyg.jpg etc.
+    // 4. url: /test/**/*.* will match with /test/test2/xyz.jpg or /test/test2/test3/xyz.png etc.
+    const regexForMockPath = mockPath?.replace(/\//g, '\\/')
+                                .replace(/\./g, '\\.')         
+                                .replace(/\*{2,}/g, '[\\w-\.\/]\+')         
+                                .replace(/\*/g, '[\\w-]\+')            
+                                .replace(/:[\w-\.]+/g, '[\\w-\.]\+');
+    const regexEval = eval('/^' + regexForMockPath + '$/'); ; 
+
+    if (reqMethod?.toLowerCase() !== mockMethod?.toLowerCase()) {
+        return false;
+    } else if (!regexEval?.test(path)) {
+        return false;
+    }
+
+    return true;
+}
+
+
+module.exports = {
+    getMatchingDummyData
+};

package/webpack.config.js

@@ -0,0 +1,24 @@
+// lib imports
+const path = require('path');
+const webpack = require('webpack');
+
+module.exports = {  
+    mode: 'production',
+    entry: './index.js',
+    target: 'node',
+    output: {
+        filename: 'bundle.js',
+        path: path.resolve(__dirname, 'dist'),
+    },
+    module: {
+        rules: [
+        {
+            test: /\.js$/,
+            exclude: /node_modules/,
+        },
+        ],
+    },
+    plugins: [
+        new webpack.BannerPlugin({ banner: '#!/usr/bin/env node', raw: true }),
+    ]
+};