WIP: New logo. Code cleanup.

Author: vasanthv

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Vasanth V
+Copyright (c) 2019 Vasanth V <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docker/Dockerfile

@@ -5,4 +5,4 @@ COPY package.json /usr/src/app/
 RUN npm install
 COPY . /usr/src/app
 EXPOSE 3000
-CMD [ "./utils/wait-for-it.sh", "mongo:27017", "--", "npm", "start" ]
+CMD [ "./wait-for-it.sh", "mongo:27017", "--", "npm", "start" ]

utils/wait-for-it.sh docker/wait-for-it.sh

@@ -1,33 +1,33 @@
 {
-  "name": "jsonbox",
-  "version": "1.0.1",
-  "description": "Free HTTP based JSON storage.",
-  "main": "server.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "node server.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/vasanthv/jsonbox.git"
-  },
-  "keywords": [
-    "json",
-    "store",
-    "storage",
-    "restful"
-  ],
-  "author": "Vasanth V",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/vasanthv/jsonbox/issues"
-  },
-  "homepage": "https://github.com/vasanthv/jsonbox#readme",
-  "dependencies": {
-    "body-parser": "^1.19.0",
-    "cors": "^2.8.5",
-    "express": "^4.17.1",
-    "express-rate-limit": "^5.0.0",
-    "mongoose": "^5.7.8"
-  }
+	"name": "jsonbox",
+	"version": "2.0.0",
+	"description": "A Free HTTP based JSON storage.",
+	"main": "server.js",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1",
+		"start": "node server.js"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/vasanthv/jsonbox.git"
+	},
+	"keywords": [
+		"json",
+		"store",
+		"storage",
+		"restful"
+	],
+	"author": "Vasanth V",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/vasanthv/jsonbox/issues"
+	},
+	"homepage": "https://github.com/vasanthv/jsonbox#readme",
+	"dependencies": {
+		"body-parser": "^1.19.0",
+		"cors": "^2.8.5",
+		"express": "^4.17.1",
+		"express-rate-limit": "^5.0.0",
+		"mongoose": "^5.7.8"
+	}
 }

package.json

@@ -1,4 +1,4 @@
 module.exports = {
 	PORT: process.env.PORT || 3000,
 	MONGO_URL: process.env.MONGODB_URI || 'mongodb://localhost:27017/jsonbox-io-dev'
-}
+};

src/config.js

@@ -5,10 +5,14 @@
 module.exports = (() => {
 	let instance;
 	const createInstance = () => {
-		const mongoose = require("mongoose");
-		const config = require("./config");
+		const mongoose = require('mongoose');
+		const config = require('./config');
 
-		mongoose.connect(config.MONGO_URL, { useCreateIndex: true, useNewUrlParser: true, useUnifiedTopology: true });
+		mongoose.connect(config.MONGO_URL, {
+			useCreateIndex: true,
+			useNewUrlParser: true,
+			useUnifiedTopology: true
+		});
 		const Schema = mongoose.Schema;
 
 		console.log('Data Db initialized');
@@ -23,8 +27,8 @@ module.exports = (() => {
 			data: { type: Object } // Actual data of the record
 		});
 
-		return mongoose.model("Data", dataSchema);
-	}
+		return mongoose.model('Data', dataSchema);
+	};
 	return {
 		getInstance: () => {
 			if (!instance) {

src/db.js

@@ -1,4 +1,4 @@
-const memorySizeOf = (obj) => {
+const memorySizeOf = obj => {
 	// took this function from https://stackoverflow.com/a/50180927/607608
 	var bytes = 0;
 
@@ -26,13 +26,15 @@ const memorySizeOf = (obj) => {
 			}
 		}
 		return bytes;
-	};
+	}
 	return sizeOf(obj);
 };
-const isValidKeys = (obj) => {
+
+const isValidKeys = obj => {
 	const keys = Object.keys(obj);
 	return keys.every(key => /^[A-Za-z]/i.test(key[0]));
-}
+};
+
 const responseBody = (obj, collection) => {
 	let response = {};
 	response['_id'] = obj._id;
@@ -42,15 +44,21 @@ const responseBody = (obj, collection) => {
 	if (obj._updatedOn) response['_updatedOn'] = obj._updatedOn;
 	if (!collection && obj._collection) response['_collection'] = obj._collection;
 	return response;
-}
+};
 
-const parse_query = (req_q) => {
+const parse_query = req_q => {
 	let query = {};
 	let q = {};
 	req_q.split(',').forEach(i => (q[i.split(':')[0]] = i.split(':')[1]));
-	Object.keys(q).forEach((key) => {
+	Object.keys(q).forEach(key => {
 		const value = q[key];
-		if (value.startsWith('>=') || value.startsWith('<=') || value.startsWith('>') || value.startsWith('<') || value.startsWith('=')) {
+		if (
+			value.startsWith('>=') ||
+			value.startsWith('<=') ||
+			value.startsWith('>') ||
+			value.startsWith('<') ||
+			value.startsWith('=')
+		) {
 			// Querying a Number
 			let val = 0;
 			if (value.startsWith('>=') || value.startsWith('<=')) val = value.substr(2);
@@ -68,23 +76,23 @@ const parse_query = (req_q) => {
 			if (value.endsWith('*')) val = val.substr(0, val.length - 1);
 
 			let regexp;
-			if (value.startsWith('*') && value.endsWith('*')) regexp = new RegExp(val, "i");
-			else if (value.startsWith('*')) regexp = new RegExp(val + '$', "i");
-			else if (value.endsWith('*')) regexp = new RegExp("^" + val, "i");
+			if (value.startsWith('*') && value.endsWith('*')) regexp = new RegExp(val, 'i');
+			else if (value.startsWith('*')) regexp = new RegExp(val + '$', 'i');
+			else if (value.endsWith('*')) regexp = new RegExp('^' + val, 'i');
 			query['data.' + key] = regexp;
 		} else {
 			if (value == 'true') query['data.' + key] = true;
 			else if (value == 'false') query['data.' + key] = false;
-			else query['data.' + key] = new RegExp('^' + value + '$', "i");
+			else query['data.' + key] = new RegExp('^' + value + '$', 'i');
 		}
 	});
 
 	return query;
-}
+};
 
 module.exports = {
 	memorySizeOf,
 	isValidKeys,
 	responseBody,
 	parse_query
-}
+};

src/helper.js

@@ -3,7 +3,7 @@ const Data = require('./db').getInstance();
 
 const xpost = async (req, res, next) => {
 	try {
-		const createRecord = async (body) => {
+		const createRecord = async body => {
 			const date = new Date();
 			let record = { _box: req.box };
 			if (req.collection) record['_collection'] = req.collection;
@@ -12,7 +12,7 @@ const xpost = async (req, res, next) => {
 			record['data'] = body;
 			const newRecord = await new Data(record).save();
 			return helper.responseBody(newRecord, req.collection);
-		}
+		};
 
 		if (Array.isArray(req.body)) {
 			const createRecordPromise = req.body.map(createRecord);
@@ -22,7 +22,6 @@ const xpost = async (req, res, next) => {
 			const newRecord = await createRecord(req.body);
 			res.json(newRecord);
 		}
-
 	} catch (error) {
 		next(error);
 	}
@@ -33,12 +32,12 @@ const xget = async (req, res, next) => {
 			const record = await Data.findOne({ _id: req.recordId, _box: req.box }).exec();
 			res.json(helper.responseBody(record, req.collection));
 		} else {
-			const skip = req.query.skip ? +(req.query.skip) : 0;
-			let limit = req.query.limit ? +(req.query.limit) : 20;
+			const skip = req.query.skip ? +req.query.skip : 0;
+			let limit = req.query.limit ? +req.query.limit : 20;
 			limit = limit > 1000 ? 1000 : limit;
 			let sort = req.query.sort ? req.query.sort : '-_createdOn';
 			if (!['_createdOn', '-_createdOn', '_updatedOn', '-_updatedOn'].includes(sort)) {
-				sort = (sort[0] === '-') ? '-data.' + sort.substr(1) : 'data.' + sort;
+				sort = sort[0] === '-' ? '-data.' + sort.substr(1) : 'data.' + sort;
 			}
 
 			let query = {};
@@ -48,26 +47,31 @@ const xget = async (req, res, next) => {
 			} else if (req.query.query_key && req.query.query_value) {
 				// soon to be DEPRECATED
 				let regexp;
-				const queryType = (typeof req.query.query_type === 'string') ? req.query.query_type.toLowerCase() : null;
+				const queryType =
+					typeof req.query.query_type === 'string' ? req.query.query_type.toLowerCase() : null;
 				switch (queryType) {
 					case 'startswith':
-						regexp = new RegExp("^" + req.query.query_value, "i");
+						regexp = new RegExp('^' + req.query.query_value, 'i');
 						break;
 					case 'endswith':
-						regexp = new RegExp(req.query.query_value + '$', "i");
+						regexp = new RegExp(req.query.query_value + '$', 'i');
 						break;
 					case 'anywhere':
-						regexp = new RegExp(req.query.query_value, "i");
+						regexp = new RegExp(req.query.query_value, 'i');
 						break;
 					default:
-						regexp = new RegExp('^' + req.query.query_value + '$', "i");
+						regexp = new RegExp('^' + req.query.query_value + '$', 'i');
 						break;
 				}
 				query['data.' + req.query.query_key] = regexp;
 			}
 			query['_box'] = req.box;
 			if (req.collection) query['_collection'] = req.collection;
-			const records = await Data.find(query).skip(skip).limit(limit).sort(sort).exec();
+			const records = await Data.find(query)
+				.skip(skip)
+				.limit(limit)
+				.sort(sort)
+				.exec();
 			res.json(records.map(r => helper.responseBody(r, req.collection)));
 		}
 	} catch (error) {
@@ -78,13 +82,18 @@ const xput = async (req, res, next) => {
 	try {
 		const record = await Data.findOne({ _id: req.recordId, _box: req.box }).exec();
 		if (record) {
-			await Data.updateOne({ _id: req.recordId, _box: req.box }, {
-				_updatedOn: new Date(),
-				_updatedBy: req.API_SECRET,
-				data: req.body
-			});
-			res.json({ message: "Record updated." });
-		} else { res.status(400).json({ message: "Invalid record Id" }) }
+			await Data.updateOne(
+				{ _id: req.recordId, _box: req.box },
+				{
+					_updatedOn: new Date(),
+					_updatedBy: req.API_SECRET,
+					data: req.body
+				}
+			);
+			res.json({ message: 'Record updated.' });
+		} else {
+			res.status(400).json({ message: 'Invalid record Id' });
+		}
 	} catch (error) {
 		next(error);
 	}
@@ -95,24 +104,25 @@ const xdelete = async (req, res, next) => {
 			const record = await Data.findOne({ _id: req.recordId, _box: req.box }).exec();
 			if (record) {
 				await Data.deleteOne({ _id: req.recordId, _box: req.box });
-				res.json({ message: "Record removed." });
-			} else { res.status(400).json({ message: "Invalid record Id" }) }
+				res.json({ message: 'Record removed.' });
+			} else {
+				res.status(400).json({ message: 'Invalid record Id' });
+			}
 		} else if (req.query.q) {
-			const query = helper.parse_query(req.query.q)
+			const query = helper.parse_query(req.query.q);
 			query['_box'] = req.box;
-			
+
 			const result = await Data.deleteMany(query);
-			res.json({ message: result.deletedCount + " Records removed." });
+			res.json({ message: result.deletedCount + ' Records removed.' });
 		}
 	} catch (error) {
 		next(error);
 	}
 };
 
-
 module.exports = {
 	xpost,
 	xget,
 	xput,
 	xdelete
-}
+};

src/model.js

@@ -1,5 +1,5 @@
 const router = require('express').Router();
-const rateLimit = require("express-rate-limit");
+const rateLimit = require('express-rate-limit');
 
 const model = require('./model');
 const validators = require('./validators');
@@ -11,16 +11,14 @@ router.use(validators.keysValidator);
 router.use(validators.extractParams);
 router.use(validators.validateParams);
 
-router.post('/*', rateLimit({
-	windowMs: 60 * 60 * 1000, // In 60 minutes window
-	max: 100 // only 100 POST requests are allowed
-}), model.xpost);
+// only 100 POST requests are allowed in 60 minutes window
+router.post('/*', rateLimit({ windowMs: 60 * 60 * 1000, max: 100 }), model.xpost);
 router.get('/*', model.xget);
 router.put('/*', model.xput);
 router.delete('/*', model.xdelete);
 
 /**
- * DATA endpoints common error handling middleware
+ * DATA endpoint's common error handling middleware
  */
 router.use((err, req, res, next) => {
 	console.error(err);