chore: add all the code :allthethings:

dietah · dietah · commit 5da8ed887c7f · 2020-04-29T00:07:14.000+02:00
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,11 @@
+.git
+.gitignore
+npm-debug.log
+node_modules
+Dockerfile*
+docker-compose*
+README.md
+LICENSE
+.vscode
+logs
+.env
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,43 @@
+module.exports = {
+	root: true,
+	extends: ['airbnb-base'],
+	rules: {
+		'arrow-parens': 0,
+		'comma-dangle': [2, 'only-multiline'],
+		'import/extensions': 0,
+		'import/no-extraneous-dependencies': 0,
+		'import/no-unresolved': 0,
+		'indent': 0,
+		'indent-legacy': ['error', 'tab', { SwitchCase: 1 }], // we need legacy because eslint-plugin-vue doesn't support the new indent options yet
+		'max-len': ['error', { code: 180, tabWidth: 4, ignoreUrls: true, ignoreComments: true }],
+		'no-lonely-if': 0,
+		'no-mixed-operators': 0,
+		'no-param-reassign': 0,
+		'no-plusplus': 0,
+		'no-tabs': 0,
+		'no-underscore-dangle': ['error'],
+		'no-use-before-define': [2, { functions: false, classes: true }],
+		'object-curly-newline': ['error', {
+			ObjectExpression: { minProperties: 5, multiline: true, consistent: true },
+			ObjectPattern: { minProperties: 5, multiline: true, consistent: true }
+		}],
+		'prefer-destructuring': ['error', {
+			VariableDeclarator: {
+				array: false,
+				object: true,
+			},
+			AssignmentExpression: {
+				array: false,
+				object: true,
+			},
+		}, {
+			enforceForRenamedProperties: false,
+		}],
+	},
+	env: {
+		node: true
+	},
+	globals: {
+		api: true
+	}
+};
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+.env
+
 # Logs
 logs
 *.log
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,12 @@
+FROM node:10.20.1-alpine3.9
+EXPOSE 3000
+
+WORKDIR /usr/src/app
+
+COPY package*.json ./
+RUN npm install
+
+COPY . /usr/src/app
+ENV NODE_ENV production
+
+CMD [ "npm", "start" ]
diff --git a/LICENSE b/LICENSE
diff --git a/Makefile b/Makefile
@@ -0,0 +1,5 @@
+lint:
+	npm run lint
+
+ocker:
+	docker build -t nut-http .
diff --git a/README.md b/README.md
@@ -1,2 +1,4 @@
-# nut2json
+# nut-http
 An API wrapper that outputs the upsc command as a JSON output
+
+TBA
diff --git a/env.js b/env.js
@@ -0,0 +1,15 @@
+const envalid = require('envalid'); // eslint-disable-line object-curly-newline
+
+/* eslint-disable key-spacing */
+
+module.exports = envalid.cleanEnv(process.env, {
+	LOG_LEVEL: 		envalid.str({ choices: ['OFF', 'FATAL', 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE', 'ALL'], default: 'DEBUG', devDefault: 'DEBUG' }),
+
+	SERVER_PORT: 	envalid.port({ default: 3001, desc: 'The port on which to expose the HTTP server' }),
+	SERVER_TIMEOUT: envalid.num({ default: 2 * 60 * 1000, desc: 'Global response timeout for incoming HTTP calls' }),
+
+	NUT_ADDRESS:	envalid.host({ desc: 'The url or ip address of the NUT server' }),
+	NUT_PORT:		envalid.port({ default: 3493, desc: 'The NUT port' }),
+}, {
+	strict: true
+});
diff --git a/helpers.js b/helpers.js
@@ -0,0 +1,58 @@
+const moment = require('moment');
+require('moment-duration-format');
+const stereotype = require('stereotype');
+
+module.exports = {
+	parseList,
+	parseUpsVars,
+	getCurrentTimestamp,
+	getProjectRoot,
+	time
+};
+
+function parseList(list) {
+	return Object.keys(list).map(val => ({ name: val, description: list[val] }), []);
+}
+
+function getCurrentTimestamp() {
+	return moment().format('YYYY-MM-DD-HH-mm-ss');
+}
+
+function getProjectRoot() {
+	const directory = __dirname.split('/');
+
+	return directory.join('/');
+}
+
+function time(startDateTime, endDateTime) {
+	const duration = moment.duration(endDateTime.diff(startDateTime));
+	if (duration < 1000) {
+		return duration.format('S [ms]');
+	}
+
+	return duration.format('h [hours] m [minutes] s [seconds]');
+}
+
+// http://jsfiddle.net/brandonscript/tfjH3/
+function parseUpsVars(obj) {
+	Object.keys(obj).forEach(key => {
+		if (key.indexOf('.') !== -1) parseDotNotation(key, obj[key], obj);
+	});
+	return obj;
+}
+
+function parseDotNotation(str, val, obj) {
+	const keys = str.split('.');
+	let currentObj = obj;
+	let key;
+	let i = 0;
+
+	for (i; i < Math.max(1, keys.length - 1); ++i) {
+		key = keys[i];
+		currentObj[key] = currentObj[key] || {};
+		currentObj = currentObj[key];
+	}
+
+	currentObj[keys[i]] = stereotype(val.trim());
+	delete obj[str];
+}
diff --git a/index.js b/index.js
@@ -0,0 +1,99 @@
+const restify = require('restify');
+const moment = require('moment');
+const logger = require('./logger');
+const { parseList, time, parseUpsVars } = require('./helpers');
+const NUT = require('./node-nut');
+const config = require('./env');
+
+logger.info('Environment variables:\n', config);
+
+// nut settings
+const nut = new NUT(config.NUT_PORT, config.NUT_ADDRESS);
+
+// api settings
+const server = restify.createServer();
+server.server.setTimeout(config.SERVER_TIMEOUT);
+server.use(restify.plugins.queryParser({ mapParams: false }));
+
+// some handling
+nut.on('connect', () => {
+	logger.info(`nut connection established to ${config.NUT_ADDRESS}:${config.NUT_PORT}`);
+});
+
+nut.on('error', err => {
+	logger.error('nut encountered an error:', err);
+});
+
+nut.on('close', () => {
+	logger.info('nut connection closed');
+});
+
+server.on('error', (err) => {
+	logger.error('server encountered an error', err);
+	nut.disconnect();
+	process.exit(1); // if in docker it should be restarted automatically
+});
+
+// router
+server.get('/devices', (req, res) => {
+	const startDateTime = moment();
+	logger.logRequest('nut-http.devices.list');
+
+	connectNut();
+
+	nut
+	.getUpsList()
+	.then((list) => {
+		if (req.query.parsed && req.query.parsed === 'true') list = parseList(list);
+
+		const endDateTime = moment();
+		logger.debug(`processing took ${time(startDateTime, endDateTime)}`);
+
+		res.send(list);
+		return list;
+	})
+	.catch((err) => {
+		logger.error(err);
+		res.send(500, { code: 500, message: `an internal error occurred ${err}` });
+		return err;
+	});
+});
+
+server.get('/devices/:name', (req, res) => {
+	const startDateTime = moment();
+	const ups = req.params.name;
+	logger.logRequest('nut-http.devices.getUps', ups);
+
+	connectNut();
+
+	nut
+	.getUpsVars(ups)
+	.then((vars) => {
+		if (req.query.parsed && req.query.parsed === 'true') vars = parseUpsVars(vars);
+
+		const endDateTime = moment();
+		logger.debug(`processing took ${time(startDateTime, endDateTime)}`);
+
+		res.send(vars);
+		return vars;
+	})
+	.catch((err) => {
+		if (err === 'UNKNOWN-UPS') {
+			logger.error('unknown ups requested');
+			res.send(404, { code: 404, message: `UPS '${ups}' is not unknown at ${config.NUT_ADDRESS}` });
+			return err;
+		}
+
+		logger.error(err);
+		res.send(500, { code: 500, message: `an internal error occurred ${err}` });
+		return err;
+	});
+});
+
+server.listen(config.SERVER_PORT, () => {
+	logger.info(`nut-http listening on port ${config.SERVER_PORT}`);
+});
+
+function connectNut() {
+	if (!nut.connected) nut.connect();
+}
diff --git a/logger.js b/logger.js
@@ -0,0 +1,85 @@
+// Get external dependencies
+const log4js = require('log4js');
+const { getProjectRoot, getCurrentTimestamp } = require('./helpers');
+
+log4js.configure({
+	appenders: {
+		console: { type: 'console' },
+		file: {
+			type: 'file',
+			filename: `${getProjectRoot()}/logs/${getCurrentTimestamp()}.log`
+		}
+	},
+	categories: {
+		default: { appenders: ['console', 'file'], level: 'debug' }
+	}
+});
+
+const logger = log4js.getLogger('nut-http');
+
+// Log4js Log Levels
+// OFF
+// FATAL
+// ERROR
+// WARN
+// INFO
+// DEBUG
+// TRACE
+// ALL
+// The levels are cumulative.
+// If you for example set the logging level to WARN all warnings, errors and fatals are logged
+
+module.exports = {
+	logRequest,
+	trace,
+	info,
+	debug,
+	warn,
+	error,
+	line
+};
+
+function logRequest(request, entity) {
+	request = request.split('.');
+
+	// const api = request[0];
+	const model = request[1];
+	const method = request[2];
+
+	// logger.debug('%s.%s - received %s%s', api, model, method, (entity ? ` for ${entity}` : ''));
+	logger.debug(`received ${method.toUpperCase()} /${model} ${entity ? `for ${entity}` : ''}`);
+}
+
+function trace(...args) {
+	run(logger.trace, parseArgs(args));
+}
+
+function info(...args) {
+	run(logger.info, parseArgs(args));
+}
+
+function debug(...args) {
+	run(logger.debug, parseArgs(args));
+}
+
+function warn(...args) {
+	run(logger.warn, parseArgs(args));
+}
+
+function error(...args) {
+	run(logger.error, parseArgs(args));
+}
+
+function parseArgs(args) {
+	let sentence = args.shift();
+	if (typeof sentence === 'object') sentence = JSON.stringify(sentence);
+	return [sentence].concat(args);
+}
+
+function line() {
+	logger.debug('-------------------------------------------------------------------------------');
+}
+
+function run(f, args) {
+	f.apply(logger, args);
+}
diff --git a/node-nut.js b/node-nut.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.env`
	`2`	`+`
`1`	`3`	`# Logs`
`2`	`4`	`logs`
`3`	`5`	`*.log`