Initial commit

Author: ThomasKranitsas

.eslintrc

@@ -0,0 +1,30 @@
+{
+  "extends": "airbnb-base",
+  "rules": {
+    "no-use-before-define": 0,
+    "strict": 0,
+    "comma-dangle": [2, "never"],
+    "func-names": 0,
+    "no-underscore-dangle": 0,
+    "prefer-rest-params": 0,
+    "no-param-reassign": 0,
+    "prefer-template": 0,
+    "new-cap": 0,
+    "global-require": 0,
+    "consistent-return": 0,
+    "max-len": [2, 200],
+    "camelcase": 0,
+    "no-console": "off"
+  },
+  "parserOptions": {
+    "ecmaVersion": 6
+  },
+  "globals": {
+    "describe": true,
+    "it": true,
+    "before": true,
+    "beforeEach": true,
+    "after": true,
+    "afterEach": true
+  }
+}

.gitignore

@@ -0,0 +1,43 @@
+node_modules
+*.zip
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history

Dockerfile

@@ -0,0 +1,8 @@
+FROM node:10.16.3-alpine
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+COPY package*.json ./
+RUN npm install
+COPY . .
+EXPOSE 3000
+CMD [ "node", "app.js" ]

Procfile

@@ -0,0 +1 @@
+web: node app.js

README.md

@@ -0,0 +1,45 @@
+# Starter pack for NodeJs API
+
+## Dependencies
+
+- runs on node.js v10.16.3
+- [express 4+](http://expressjs.com/)
+- [eslint](http://eslint.org/)
+- [PostGre] - docker image of postgre
+- [POSTMAN](https://www.getpostman.com) chrome extension for verification
+
+## Configuration
+
+- Edit configuration in `config/default.json` and
+- custom environment variables names in `config/custom-environment-variables.json`,
+- Db configuration in config.json
+  Following variables can be configured:
+
+- `port` the port to listen
+- `logLevel` the log level `debug` or `info`
+- `version` the version of api
+- `config.json use for db onfiguration`
+
+## Local Deployment
+
+- Please make sure to configure url of database rightly in `config/config.json` or use **host:0.0.0.0**.
+- mongo docker instance run : cd docker/postgre ->run docker-compose up
+- Install dependencies `npm i`
+- run lint check `npm run lint`
+- Start app `npm start`
+
+## Docker Deployment
+
+- Please make sure to configure url of database rightly in `config/config.json` or use host **host:db**.
+- docker ps -a //to check already postgres instance is running
+- docker stop containerid
+- docker rm containerid
+- docker-compose build --no-cache
+- docker-compose up
+
+## Verification
+
+- Load postman collection:
+  - endpoints: docs/api.postman_collection.json
+  - environment: docs/api.postman_environment.json
+  - use Authorization header Bearer {{user_token}}

app-routes.js

@@ -0,0 +1,49 @@
+'use strict';
+
+/*
+ * Copyright (c) 2016 TopCoder, Inc. All rights reserved.
+ */
+
+/**
+ * This configuration of passport for express App.
+ */
+const _ = require('lodash');
+const glob = require('glob');
+const Path = require('path');
+const config = require('config');
+const helper = require('./common/helper');
+/**
+ * Configure routes for express
+ * @param app the express app
+ */
+module.exports = (app) => {
+  // load all routes.js in modules folder.
+  glob.sync(Path.join(__dirname, './modules/**/routes.js')).forEach((routes) => {
+    /* Load all routes */
+    _.each(
+      require(Path.resolve(routes)), // eslint-disable-line import/no-dynamic-require
+      (verbs, path) => {
+        _.each(verbs, (def, verb) => {
+          const controllerPath = Path.join(
+            Path.dirname(routes),
+            `./controllers/${def.controller}`
+          );
+          const method = require(controllerPath)[def.method]; // eslint-disable-line import/no-dynamic-require
+          if (!method) {
+            throw new Error(`${def.method} is undefined`);
+          }
+          const actions = [];
+          actions.push((req, res, next) => {
+            req.signature = `${def.controller}#${def.method}`;
+            next();
+          });
+          actions.push(method);
+          app[verb](
+            `/api/${config.version}${path}`,
+            helper.autoWrapExpress(actions)
+          );
+        });
+      }
+    );
+  });
+};

app.js

@@ -0,0 +1,72 @@
+'use strict';
+
+/*
+ * Copyright (c) 2016 TopCoder, Inc. All rights reserved.
+ */
+/**
+ * Contains express application configurations.
+ */
+if (!process.env.NODE_ENV) {
+  process.env.NODE_ENV = 'development';
+}
+
+const cors = require('cors');
+const config = require('config');
+const express = require('express');
+
+const app = express();
+const morgan = require('morgan');
+const bodyParser = require('body-parser');
+const _ = require('lodash');
+const logger = require('./common/logger');
+
+const { port } = config;
+
+app.use(cors());
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({ extended: true }));
+app.use(morgan('dev'));
+
+require('./app-routes')(app);
+
+// The error handler,log error and return 500 error
+// eslint-disable-next-line no-unused-vars
+app.use((err, req, res, next) => {
+  logger.logFullError(err, req.signature || `${req.method} ${req.url}`);
+  const errorResponse = {};
+  const status = err.isJoi ? 400 : err.httpStatus || 500;
+
+  if (_.isArray(err.details)) {
+    errorResponse.fields = _.map(err.details, 'path').join(', ');
+    if (err.isJoi) {
+      _.map(err.details, (e) => {
+        if (e.message) {
+          if (_.isUndefined(errorResponse.message)) {
+            errorResponse.message = e.message;
+          } else {
+            errorResponse.message += ', ' + e.message;
+          }
+        }
+      });
+    }
+  }
+  if (_.isUndefined(errorResponse.message)) {
+    if (err.message) {
+      errorResponse.message = err.message;
+    } else {
+      errorResponse.message = 'server error';
+    }
+  }
+
+  errorResponse.code = status;
+  res.status(status).json(errorResponse);
+});
+
+app.listen(port, '0.0.0.0');
+logger.info(
+  'Express server listening on port %d in %s mode',
+  port,
+  process.env.NODE_ENV
+);
+
+module.exports = app;

common/errors.js

@@ -0,0 +1,47 @@
+'use strict';
+
+/*
+ * Copyright (c) 2016 TopCoder, Inc. All rights reserved.
+ */
+
+/**
+ * This file defines application errors.
+ */
+
+const util = require('util');
+
+/**
+ * Helper function to create generic error object with http status code
+ * @param {String} name the error name
+ * @param {Number} statusCode the http status code
+ * @returns {Function} the error constructor
+ * @private
+ */
+function _createError(name, statusCode) {
+  /**
+   * The error constructor
+   * @param {String} message the error message
+   * @param {String} [cause] the error cause
+   * @constructor
+   */
+  function ErrorCtor(message, cause) {
+    Error.call(this);
+    Error.captureStackTrace(this);
+    this.message = message || name;
+    this.cause = cause;
+    this.httpStatus = statusCode;
+  }
+
+  util.inherits(ErrorCtor, Error);
+  ErrorCtor.prototype.name = name;
+  return ErrorCtor;
+}
+
+module.exports = {
+  ValidationError: _createError('ValidationError', 400),
+  BadRequestError: _createError('BadRequestError', 400),
+  NotFoundError: _createError('NotFoundError', 404),
+  ForbiddenError: _createError('ForbiddenError', 403),
+  UnauthorizedError: _createError('UnauthorizedError', 401),
+  InternalserverError: _createError('InternalserverError', 500)
+};

common/helper.js

@@ -0,0 +1,49 @@
+'use strict';
+
+/*
+ * Copyright (c) 2016 TopCoder, Inc. All rights reserved.
+ */
+
+/**
+ * This file defines helper methods
+ */
+const _ = require('lodash');
+const co = require('co');
+
+
+/**
+ * Wrap generator function to standard express function
+ * @param {Function} fn the generator function
+ * @returns {Function} the wrapped function
+ */
+function wrapExpress(fn) {
+  return function wrapGenerator(req, res, next) {
+    co(fn(req, res, next)).catch(next);
+  };
+}
+
+/**
+ * Wrap all generators from object
+ * @param obj the object (controller exports)
+ * @returns {Object|Array} the wrapped object
+ */
+function autoWrapExpress(obj) {
+  if (_.isArray(obj)) {
+    return obj.map(autoWrapExpress);
+  }
+  if (_.isFunction(obj)) {
+    if (obj.constructor.name === 'GeneratorFunction') {
+      return wrapExpress(obj);
+    }
+    return obj;
+  }
+  _.each(obj, (value, key) => {
+    obj[key] = autoWrapExpress(value);
+  });
+  return obj;
+}
+
+module.exports = {
+  wrapExpress,
+  autoWrapExpress
+};