mockapi-msi 2.0.0 → 2.4.0

package/modules/log.js

@@ -1,39 +1,43 @@
-const constants = require("./constants");
-
-const Log = function(logLevel) {
-    this._logLevel = logLevel || "verbose";
-};
-
-Log.prototype._write = function (message) {
-    const date = (new Date()).toString();
-
-    console.log(`${date} ${message}`);
-};
-
-Log.prototype.debug = function (message) {
-    if (this._logLevel === constants.LOG_LEVELS.DEBUG || this._logLevel === constants.LOG_LEVELS.VERBOSE) {
-        this._write(`${constants.COLOR.fgYellow}[DEBUG]${constants.COLOR.reset} - ${message}`);
-    }
-};
-
-Log.prototype.error = function (message) {
-    if (this._logLevel === constants.LOG_LEVELS.ERROR || this._logLevel === constants.LOG_LEVELS.VERBOSE) {
-        this._write(`${constants.COLOR.fgRed}[ERROR]${constants.COLOR.reset} - ${message}`);
-    }
-};
-
-Log.prototype.info = function (message) {
-    if (this._logLevel === constants.LOG_LEVELS.VERBOSE) {
-        this._write(`${constants.COLOR.fgYellow}[INFO]${constants.COLOR.reset} - ${message}`);
-    }
-};
-
-Log.prototype.detail = function (message) {
-    if (this._logLevel === constants.LOG_LEVELS.VERBOSE) {
-        this._write(`${message}`);
-    }
-};
-
-Log.prototype.message = (message) => console.log(message);
-
+const constants = require("./constants");
+
+class Log {
+
+    constructor(logLevel) {
+        this._logLevel = logLevel || "verbose";
+    }
+
+    _write(message) {
+        const date = (new Date()).toISOString();
+        console.log(`${date} ${message}`);
+    }
+
+    debug(message) {
+        if (this._logLevel === constants.LOG_LEVELS.DEBUG || this._logLevel === constants.LOG_LEVELS.VERBOSE) {
+            this._write(`${constants.COLOR.fgYellow}[DEBUG]${constants.COLOR.reset} - ${message}`);
+        }
+    }
+
+    error(message) {
+        if (this._logLevel === constants.LOG_LEVELS.ERROR || this._logLevel === constants.LOG_LEVELS.VERBOSE) {
+            this._write(`${constants.COLOR.fgRed}[ERROR]${constants.COLOR.reset} - ${message}`);
+        }
+    }
+
+    info(message) {
+        if (this._logLevel === constants.LOG_LEVELS.VERBOSE) {
+            this._write(`${constants.COLOR.fgYellow}[INFO]${constants.COLOR.reset} - ${message}`);
+        }
+    }
+
+    detail(message) {
+        if (this._logLevel === constants.LOG_LEVELS.VERBOSE) {
+            this._write(`${message}`);
+        }
+    }
+
+    message(message) {
+        console.log(message);
+    }
+}
+
 module.exports = Log;

package/modules/moduleProxy.js

@@ -1,55 +1,52 @@
-const constants = require("./constants");
-const HttpException = require('./HttpException');
-
-class Proxy {
-
-    _externalModuleList = {};
-
-    constructor(externalModulePath, logger) {
-        this._externalModuleList = {};
-        this._logger = logger;
-        this._externalModulePath = externalModulePath;
-    }
-
-    async load(modules) {
-        for (const moduleName in modules) {
-            if (Object.hasOwnProperty.call(modules, moduleName)) {
-                const moduleFileName = modules[moduleName];
-                
-                try {
-                    const modulePath = `${this._externalModulePath}${moduleFileName}.js`;
-
-                    this._logger.info(`Attempting to load module ${moduleName} from ${modulePath}`);
-
-                    const module = await import(modulePath);
-
-                    this._externalModuleList[moduleName] = module;
-
-                    this._logger.info(`Module '${moduleName}' was loaded`);
-                } catch (error) {
-                    this._logger.error(`Module '${moduleName}' failed during loading ${error}`);
-                }
-            }
-        }
-    }
-
-    execute(name, requestInformation, data) {
-        for (const moduleName in this._externalModuleList) {
-            if (Object.hasOwnProperty.call(this._externalModuleList, moduleName) && moduleName === name) {
-                const module = this._externalModuleList[moduleName];
-
-                try {
-                    return module.process(requestInformation, data);    
-                } catch (error) {
-                    throw new HttpException(constants.HTTP_STATUS_CODES.INTERNAL_SERVER_ERROR, `Module ${moduleName} failed. ${error}`);
-                }
-                
-            }
-        }
-
-        throw new HttpException(constants.HTTP_STATUS_CODES.INTERNAL_SERVER_ERROR, `Module ${moduleName} doesn't exists`);
-    }
-    
-}
-
+const constants = require("./constants");
+const HttpException = require('./HttpException');
+
+class Proxy {
+
+    _externalModuleList = {};
+
+    constructor(externalModulePath, logger) {
+        this._externalModuleList = {};
+        this._logger = logger;
+        this._externalModulePath = externalModulePath;
+    }
+
+    async load(modules) {
+        for (const moduleName in modules) {
+            if (Object.hasOwnProperty.call(modules, moduleName)) {
+                const moduleFileName = modules[moduleName];
+                
+                try {
+                    const modulePath = `${this._externalModulePath}${moduleFileName}.js`;
+
+                    this._logger.info(`Attempting to load module ${moduleName} from ${modulePath}`);
+
+                    const module = await import(modulePath);
+
+                    this._externalModuleList[moduleName] = module;
+
+                    this._logger.info(`Module '${moduleName}' was loaded`);
+                } catch (error) {
+                    this._logger.error(`Module '${moduleName}' failed during loading ${error}`);
+                }
+            }
+        }
+    }
+
+    execute(name, requestInformation, data) {
+        const module = this._externalModuleList[name];
+
+        if (!module) {
+            throw new HttpException(constants.HTTP_STATUS_CODES.INTERNAL_SERVER_ERROR, `Module ${name} doesn't exist`);
+        }
+
+        try {
+            return module.process(requestInformation, data);
+        } catch (error) {
+            throw new HttpException(constants.HTTP_STATUS_CODES.INTERNAL_SERVER_ERROR, `Module ${name} failed. ${error}`);
+        }
+    }
+    
+}
+
 module.exports = Proxy;

package/modules/readers.js

@@ -1,43 +1,43 @@
-const fs = require('fs');
-const path = require('path');
-const constants = require("./constants");
-const CSV = require('./csv');
-const HttpException = require('./HttpException');
-
-const text_reader = (file) => {
-    return () => {
-        if (!fs.existsSync(file)) {
-            throw new HttpException(constants.HTTP_STATUS_CODES.NOT_FOUND, `File ${file} doesn't exists`);
-        }
-
-        return fs.readFileSync(file, 'utf8');
-    };
-};
-
-const file_exists = (file) => fs.existsSync(file);
-
-const folder_reader = (folder) => {
-    return (urlInformation) => {
-
-        if (!urlInformation.hasFile) {
-            throw new HttpException(constants.HTTP_STATUS_CODES.NOT_ACCEPTABLE, "File not provided");
-        }
-
-        const file = path.join(folder, urlInformation.file);
-        return text_reader(file)()
-    };
-};
-
-const csv_reader = function (file, parameters) {
-    const csvContent = text_reader(file, parameters)();
-    const csvReader = new CSV(csvContent, parameters);
-
-    return csvReader.read.bind(csvReader);
-};
-
-module.exports = {
-    text_reader: text_reader,
-    folder_reader: folder_reader,
-    csv_reader: csv_reader,
-    file_exists: file_exists
+const fs = require('fs');
+const path = require('path');
+const constants = require("./constants");
+const CSV = require('./csv');
+const HttpException = require('./HttpException');
+
+const text_reader = (file) => {
+    return () => {
+        if (!fs.existsSync(file)) {
+            throw new HttpException(constants.HTTP_STATUS_CODES.NOT_FOUND, `File ${file} doesn't exists`);
+        }
+
+        return fs.readFileSync(file, 'utf8');
+    };
+};
+
+const file_exists = (file) => fs.existsSync(file);
+
+const folder_reader = (folder) => {
+    return (urlInformation) => {
+
+        if (!urlInformation.hasFile) {
+            throw new HttpException(constants.HTTP_STATUS_CODES.NOT_ACCEPTABLE, "File not provided");
+        }
+
+        const file = path.join(folder, urlInformation.file);
+        return text_reader(file)()
+    };
+};
+
+const csv_reader = function (file, parameters) {
+    const csvContent = text_reader(file, parameters)();
+    const csvReader = new CSV(csvContent, parameters);
+
+    return csvReader.read.bind(csvReader);
+};
+
+module.exports = {
+    text_reader: text_reader,
+    folder_reader: folder_reader,
+    csv_reader: csv_reader,
+    file_exists: file_exists
 };

package/modules/urlParser.js

@@ -1,23 +1,54 @@
-const constants = require("./constants");
-
-const parser = (url) => {
-
-    const parsedUrl = new URL(url, constants.BASE_URL);
-    const urlSections = parsedUrl.pathname.split("/").filter((e) => e !== "");
-
-    const baseUrl = "/" + urlSections.filter((e) => e.indexOf(".") < 0).join("/");
-    const file = urlSections.filter((e) => e.indexOf(".") >= 0);
-    const hasFile = file.length > 0;
-
-    return {
-        base: baseUrl,
-        file: hasFile ? file[0] : "",
-        hasFile: hasFile,
-        search: parsedUrl.searchParamss
-    };
-
-};
-
-module.exports = {
-    parse: parser
+const constants = require("./constants");
+
+const parser = (url) => {
+
+    const parsedUrl = new URL(url, constants.BASE_URL);
+    const urlSections = parsedUrl.pathname.split("/").filter((e) => e !== "");
+
+    const baseUrl = "/" + urlSections.filter((e) => e.indexOf(".") < 0).join("/");
+    const file = urlSections.filter((e) => e.indexOf(".") >= 0);
+    const hasFile = file.length > 0;
+
+    return {
+        pathname: parsedUrl.pathname,
+        base: baseUrl,
+        file: hasFile ? file[0] : "",
+        hasFile: hasFile,
+        search: parsedUrl.searchParams
+    };
+
+};
+
+/**
+ * Matches a request path against an endpoint pattern that may contain
+ * path parameters (e.g., /users/:id/orders/:orderId).
+ *
+ * @param {string} pattern - The endpoint pattern from the configuration.
+ * @param {string} requestPath - The actual incoming request base path.
+ * @returns {{ match: boolean, params: Object }} Whether it matched and extracted path parameters.
+ */
+const matchPath = (pattern, requestPath) => {
+    const patternParts = pattern.split("/").filter((e) => e !== "");
+    const requestParts = requestPath.split("/").filter((e) => e !== "");
+
+    if (patternParts.length !== requestParts.length) {
+        return { match: false, params: {} };
+    }
+
+    const params = {};
+
+    for (let i = 0; i < patternParts.length; i++) {
+        if (patternParts[i].startsWith(":")) {
+            params[patternParts[i].substring(1)] = requestParts[i];
+        } else if (patternParts[i] !== requestParts[i]) {
+            return { match: false, params: {} };
+        }
+    }
+
+    return { match: true, params };
+};
+
+module.exports = {
+    parse: parser,
+    matchPath: matchPath
 };

package/package.json

@@ -1,21 +1,39 @@
-{
-  "name": "mockapi-msi",
-  "version": "2.0.0",
-  "description": "Mock API is a lightweight configurable HTTP API for testing and prototyping.",
-  "main": "main.js",
-  "scripts": {
-    "start": "node ./main.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "Matias Iacono",
-  "license": "ISC",
-  "bin": {
-    "mockapi": "main.js"
-  },
-  "engines": {
-    "node": ">=16"
-  },
-  "dependencies": {
-    "yaml": "2.0.0-5"
-  }
+{
+  "name": "mockapi-msi",
+  "version": "2.4.0",
+  "description": "Mock API is a lightweight configurable HTTP API for testing and prototyping.",
+  "main": "main.js",
+  "scripts": {
+    "start": "node ./main.js",
+    "test": "node --test tests/*.test.js"
+  },
+  "keywords": [
+    "mock",
+    "api",
+    "testing",
+    "prototyping",
+    "http",
+    "rest",
+    "fake-api",
+    "stub"
+  ],
+  "author": "Matias Iacono",
+  "license": "ISC",
+  "bin": {
+    "mockapi": "main.js"
+  },
+  "files": [
+    "main.js",
+    "modules/",
+    "apiHandlers/",
+    "testdata/",
+    "LICENSE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "yaml": "2.2.2"
+  }
 }

package/testdata/data.csv

@@ -1,6 +1,6 @@
-id,name,money
-1,"test 1",100
-2,"test 2",100
-3,"test 3",100
-4,"test, 4",100
+id,name,money
+1,"test 1",100
+2,"test 2",100
+3,"test 3",100
+4,"test, 4",100
 5,"test 5",100

package/.dockerignore

@@ -1,24 +0,0 @@
-**/.classpath
-**/.dockerignore
-**/.env
-**/.git
-**/.gitignore
-**/.project
-**/.settings
-**/.toolstarget
-**/.vs
-**/.vscode
-**/*.*proj.user
-**/*.dbmdl
-**/*.jfm
-**/azds.yaml
-**/charts
-**/docker-compose*
-**/compose*
-**/Dockerfile*
-**/node_modules
-**/npm-debug.log
-**/obj
-**/secrets.dev.yaml
-**/values.dev.yaml
-README.md

package/.mockapi-config

@@ -1,47 +0,0 @@
-
-# basic Mock API configuration
-port: 8001
-enableCors: true
-#externalModulesPath: "../apiHandlers/"
-
-# dummy example configurations
-# PATH must point to a existing CSV file
-# 3 native readers are supported: text | csv | folder
-data:
-  myRows:
-    path: "./testdata/data.csv"
-    reader: csv
-    properties: 
-      - json
-      - seq
-      - 0
-    #options
-    #json || text
-    #seq || rand
-    #-1 = return every record on every request
-    #0...n starting index (always reset to 0 when reach EOR)
-
-# custom http response handlers section
-#customHandlers:
-#  "custom": 
-#    "myCustomHandler"
-
-# Mock API available endpoints, return types and
-# general configuration
-# verb: any | get | post | delete | ...
-# data: refers to previously configured data and readers
-# responseStatus: 200 | 404 | 500 | ...
-# responseContentType: any MIME available type
-# handler: refers to any previously configured custom handler
-endpoints:
-  "/data":
-    verb: get
-    data: myRows
-    responseStatus: 200
-    responseContentType: "application/json"
-
-log: verbose
-  #debug
-  #error
-  #verbose
-  #none

package/Dockerfile

@@ -1,8 +0,0 @@
-FROM node:12.18-alpine
-ENV NODE_ENV=production
-WORKDIR /usr/src/app
-COPY ["package.json", "package-lock.json*", "npm-shrinkwrap.json*", "./"]
-RUN npm install --production --silent && mv node_modules ../
-COPY . .
-EXPOSE 8001
-CMD ["node", "main.js"]

package/docker-compose.debug.yml

@@ -1,14 +0,0 @@
-version: '3.4'
-
-services:
-  mockapi:
-    image: mockapi
-    build:
-      context: .
-      dockerfile: ./Dockerfile
-    environment:
-      NODE_ENV: development
-    ports:
-      - 3000:3000
-      - 9229:9229
-    command: ["node", "--inspect=0.0.0.0:9229", "main.js"]

package/docker-compose.yml

@@ -1,12 +0,0 @@
-version: '3.4'
-
-services:
-  mockapi:
-    image: mockapi
-    build:
-      context: .
-      dockerfile: ./Dockerfile
-    environment:
-      NODE_ENV: production
-    ports:
-      - 3001:8001