first commit

Author: felipekm

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.env

@@ -0,0 +1,2 @@
+NODE_ENV=development
+MONGODB_URL=mongodb://admin:foo12345@ds139334.mlab.com:39334/your_db_name

.eslintignore

@@ -0,0 +1,118 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 8
+  },
+  "parser": "babel-eslint",
+  "plugins": [
+    "jest"
+  ],
+  "env": {
+    "node": true,
+    "es6": true,
+    "mocha": true,
+    "phantomjs": true,
+    "jest/globals": true
+  },
+  "globals": {
+    "expect": true
+  },
+  "extends": [
+    "plugin:jest/recommended"
+  ],
+  "rules": {
+    "no-reserved-keys": 0,
+    "quote-props": 0,
+    "no-extra-boolean-cast": 0,
+    "guard-for-in": 0,
+    "valid-jsdoc": 0,
+    "no-console": 0,
+    "no-debugger": 1,
+    "no-constant-condition": 1,
+    "no-empty": 1,
+    "no-sparse-arrays": 1,
+    "no-multi-str": 1,
+    "comma-dangle": 2,
+    "no-cond-assign": 2,
+    "no-dupe-args": 2,
+    "no-dupe-keys": 2,
+    "no-duplicate-case": 2,
+    "no-ex-assign": 2,
+    "no-extra-parens": 2,
+    "no-extra-semi": 2,
+    "no-inner-declarations": 2,
+    "no-invalid-regexp": 2,
+    "no-irregular-whitespace": 2,
+    "no-negated-in-lhs": 2,
+    "no-obj-calls": 2,
+    "no-regex-spaces": 2,
+    "no-unreachable": 2,
+    "use-isnan": 2,
+    "valid-typeof": 2,
+    "no-unexpected-multiline": 2,
+    "block-scoped-var": 2,
+    "eqeqeq": 2,
+    "no-eq-null": 2,
+    "no-eval": 2,
+    "no-extra-bind": 2,
+    "no-fallthrough": 2,
+    "no-floating-decimal": 2,
+    "no-labels": 2,
+    "no-lone-blocks": 2,
+    "no-loop-func": 2,
+    "no-native-reassign": 2,
+    "no-new-func": 2,
+    "no-new-wrappers": 2,
+    "no-new": 2,
+    "no-redeclare": 2,
+    "no-return-assign": 2,
+    "no-script-url": 2,
+    "no-self-compare": 2,
+    "no-sequences": 2,
+    "no-throw-literal": 2,
+    "no-unused-expressions": 2,
+    "no-with": 2,
+    "radix": 2,
+    "vars-on-top": 2,
+    "no-label-var": 2,
+    "no-shadow-restricted-names": 2,
+    "no-undef": 2,
+    "no-undef-init": 2,
+    "no-undefined": 2,
+    "no-unused-vars": 2,
+    "no-use-before-define": 2,
+    "comma-spacing": 2,
+    "comma-style": 2,
+    "indent": [
+      "error",
+      2,
+      {
+        "SwitchCase": 1
+      }
+    ],
+    "lines-around-comment": 2,
+    "new-cap": 0,
+    "new-parens": 1,
+    "newline-after-var": 2,
+    "no-array-constructor": 2,
+    "no-inline-comments": 1,
+    "no-lonely-if": 2,
+    "no-mixed-spaces-and-tabs": 2,
+    "no-multiple-empty-lines": 2,
+    "no-new-object": 2,
+    "no-spaced-func": 2,
+    "no-trailing-spaces": 2,
+    "operator-assignment": 2,
+    "operator-linebreak": 2,
+    "quotes": [
+      2, "single"
+    ],
+    "semi-spacing": 2,
+    "semi": 2,
+    "keyword-spacing": 0,
+    "space-before-blocks": 2,
+    "spaced-comment": 2,
+    "wrap-regex": 2,
+    "no-var": 0,
+    "prefer-const": 0
+  }
+}

.eslintrc.json

@@ -0,0 +1,2 @@
+node_modules/
+.DS_STORE

.gitattributes

@@ -0,0 +1,60 @@
+<p align="center">
+  <h1 align="center">NodeJS - HapiJS API Worker - Monolith</h1>
+</p>
+
+## Developing at NodeJS - HapiJS API Worker - Monolith
+
+> NodeJS - HapiJS API Worker - Monolith built for study proposes, it provides **RESTFUL** services on resource oriented architecture projects (ROA).
+
+> The barebone is located under `app/api` and `app/core`, it is desgined by default covered by an Users API which is the authentecion is supported by a JWT plugin (app/core/plugins). There is also a Workers layer which comes with the `webapi` as default but it also ables you to create your own workers such Notification (notify) or Transactions (shake data in db) workers. If you need more details of how apply in your business feel free to get in touch and I'll be happy to help.
+
+## Configuring development environment
+
+#### Step 1: installing tools
+
+* install git: [git-scm](http://git-scm.com/)
+* install NodeJS@12+: [nodejs.org](http://nodejs.org)
+
+#### Step 2: preparing repository
+
+Clone repository:
+```
+git clone https:/github.com/felipekm/nodejs-hapijs-monolith
+```
+
+Install project packages
+```
+cd nodejs-hapijs-monolith
+npm install
+```
+### Step 3: run tests to check if things are fine, the tests file must be created in app/core/tests:
+
+To run your tests:
+```
+npm test
+```
+
+## How to debug it
+
+To debug we are explicity using the [Visual Code](https://code.visualstudio.com/):
+
+* Open your the project in VS Code;
+* Press `F5` or symply runs `node server.js` in this project folder;
+
+### Development environment variables
+
+For development, you must set this variables and values in your OS:
+  * __NODE_ENV__: development
+  * __ENGINE__: The engine to start the process, the defined value matches the folder name at `app/core/workers/NAME`, the defaut is `webapi, you can have several others such a Notificator or Transactions worker that keeps running every time.
+
+### NPM tasks
+
+Several tasks are scripted to make things easier to dev team. In this project, you will find:
+  * ```npm start```     : this task is only used on AWS EC2 machine.
+  * ```npm test```      : runs all automated tests and coding best practices check.
+  * ```npm stop```      : kill the process.
+  * ```npm dev```       : debug (dev) mode using nodemon.
+
+### Support
+
+If you find any problem or question please raise an issue

.gitignore

@@ -0,0 +1,28 @@
+// App dependenciess
+const pkg = require('../../../../package.json');
+
+exports.config = {
+  auth: false,
+  tags: [ 'main', 'debug' ],
+  notes: 'Provides details about environment. Needs debug flag set as true in conf file.',
+  description: 'Debug route'
+};
+
+/**
+ * @function {handle} - Manage requests
+ * @param  {object} request { The request object }
+ * @param  {function} reply { The callback function }
+ * @return {object} { Retorno da função invocada }
+ */
+exports.handle = ({ reply }) => {
+  const data = {
+    name: global.nodename,
+    kernel: global.config.kernel.process,
+    version: pkg.version,
+    loaded_apis: global.apis,
+    loaded_routes: global.routes,
+    loaded_plugins: global.plugins
+  };
+
+  return reply(data);
+};

README.md

@@ -0,0 +1,24 @@
+const pkg = require('../../../../package.json');
+
+exports.config = {
+  auth: false,
+  tags: [ 'main', 'ping' ],
+  notes: 'Ping route to check if server is up or not.',
+  description: 'Ping route!'
+};
+
+/**
+ * @function {handle} - Função de Ping que retorna informações do web sever
+ * @param  {object} request { The request object }
+ * @param  {function} reply { The callback function }
+ * @return {object} { Retorno da função invocada }
+ */
+exports.handle = () => {
+  const welcomeData = {
+    name: pkg.description,
+    version: pkg.version,
+    environment: process.env.NODE_ENV
+  };
+
+  return welcomeData;
+};

app/api/main/controllers/debug-controller.js

@@ -0,0 +1,18 @@
+const rootHandler = require('./controllers/root-controller');
+const debugHandler = require('./controllers/debug-controller');
+
+module.exports = [
+  {
+    path: '/',
+    method: 'GET',
+    config: rootHandler.config,
+    handler: rootHandler.handle
+  },
+
+  {
+    path: '/debug',
+    method: 'GET',
+    config: debugHandler.config,
+    handler: debugHandler.handle
+  }
+];

app/api/main/controllers/root-controller.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const Joi = require('joi');
+
+const generalTemplate = {
+  tags: [ 'v1', 'authentication' ],
+  description: 'Authentication routes',
+  auth: 'jwt',
+  notes: 'API to perform login/logout.'
+};
+
+exports.login = {
+  ...generalTemplate,
+  auth: false,
+  validate: {
+    payload: {
+      email: Joi.string().email().required(),
+      password: Joi.string().required()
+    }
+  }
+};
+
+exports.logout = {
+  ...generalTemplate
+};

app/api/main/main-routes.js

@@ -0,0 +1,35 @@
+'use strict';
+
+const usersHelper = require('../../../core/helpers/users-helper');
+const authenticationHelper = require('../../../core/helpers/authentication-helper');
+
+exports.login = async(request, h) => {
+  try {
+
+    const userData = await authenticationHelper.authenticate(request.payload.email, request.payload.password);
+    const token = await authenticationHelper.generateToken(userData, request);
+
+    await usersHelper.registerLastLogin(userData._id);
+
+    return h.response(token);
+
+  } catch(err) {
+    console.error(err);
+    return h.response(err);
+  }
+};
+
+exports.logout = async(request, h) => {
+  try {
+
+    const userToken = request.auth.token;
+    const logoutResponse = await authenticationHelper.logout(userToken);
+
+    return h.response(logoutResponse);
+
+  } catch(err) {
+    console.error(err);
+    return h.response(err);
+  }
+};
+

app/api/v1/authentication/authentication-config.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const config = require('./authentication-config');
+const controller = require('./authentication-controller');
+
+module.exports = [
+
+  {
+    path: '/api/v1/login',
+    method: 'POST',
+    handler: controller.login,
+    options: config.login
+  },
+
+  {
+    path: '/api/v1/logout',
+    method: 'GET',
+    handler: controller.logout,
+    options: config.logout
+  }
+
+];