enhance: Update donation object reference

Author: wolivera

.babelrc

@@ -0,0 +1,9 @@
+{
+  "presets": [
+    "es2015",
+    "stage-2"
+  ],
+  "plugins": [
+    "transform-runtime"
+  ]
+}

.env.example

@@ -0,0 +1,9 @@
+#NODE_ENV=development
+#PORT=5000
+#API_KEY=zircontechapi
+#DB_NAME=globalshare
+#DB_TEST_NAME=globalsharetest
+#DB_PORT=3306
+#DB_HOST=localhost
+#DB_USERNAME=will
+#DB_PASSWORD=Mustang1!

.eslintrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+    "extends": "airbnb-base",
+    "plugins": [
+        "import"
+    ],
+    "rules": {
+        "indent": ["error", 2]
+    },
+    "parserOptions": {
+        "sourceType": "module",
+        "ecmaVersion": 2017,
+        "ecmaFeatures": {
+            "experimentalObjectRestSpread": true
+        }
+    }
+};

.gitignore

@@ -0,0 +1,56 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# IDE
+.idea
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Babel ES6 compiles files
+dist
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# 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 directory
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# .env
+.env
+
+# Gradle ignores for using a gradle build
+.gradle
+build/nodejs
+build/yarn

.sequelizerc

@@ -0,0 +1,7 @@
+var path = require('path');
+
+module.exports = {
+  'config': path.resolve('./src/services/sequelize', 'index.js'),
+  'migrations-path': path.resolve('./src', 'migrations'),
+  'models-path': path.resolve('./src/api', 'models')
+}

gulpfile.babel.js

@@ -0,0 +1,60 @@
+import gulp from 'gulp';
+import gulpLoadPlugins from 'gulp-load-plugins';
+import path from 'path';
+import del from 'del';
+import runSequence from 'run-sequence';
+
+const plugins = gulpLoadPlugins();
+
+const paths = {
+  js: ['./**/*.js', '!dist/**', '!node_modules/**', '!coverage/**'],
+  nonJs: ['./package.json', './.gitignore', './.env'],
+  tests: './server/tests/*.js',
+};
+
+// Clean up dist and coverage directory
+gulp.task('clean', () => del.sync(['dist/**', 'dist/.*', 'coverage/**', '!dist', '!coverage']));
+
+// Copy non-js files to dist
+gulp.task('copy', () =>
+  gulp
+    .src(paths.nonJs)
+    .pipe(plugins.newer('dist'))
+    .pipe(gulp.dest('dist'))
+);
+
+// Compile ES6 to ES5 and copy to dist
+gulp.task('babel', () =>
+  gulp
+    .src([...paths.js, '!gulpfile.babel.js'], { base: '.' })
+    .pipe(plugins.newer('dist'))
+    .pipe(plugins.sourcemaps.init())
+    .pipe(plugins.babel())
+    .pipe(
+      plugins.sourcemaps.write('.', {
+        includeContent: false,
+        sourceRoot(file) {
+          return path.relative(file.path, __dirname);
+        },
+      })
+    )
+    .pipe(gulp.dest('dist'))
+);
+
+// Start server with restart on file changes
+gulp.task('nodemon', ['copy', 'babel'], () =>
+  plugins.nodemon({
+    script: path.join('dist', 'index.js'),
+    ext: 'js',
+    ignore: ['node_modules/**/*.js', 'dist/**/*.js'],
+    tasks: ['copy', 'babel'],
+  })
+);
+
+// gulp serve for development
+gulp.task('serve', ['clean'], () => runSequence('nodemon'));
+
+// default task: clean dist, compile js files and copy non-js files.
+gulp.task('default', ['clean'], () => {
+  runSequence(['copy', 'babel']);
+});

index.js

@@ -0,0 +1,16 @@
+// require('babel-core/register');
+
+// exports = module.exports = require('./src/app');
+
+import { env, port } from './src/config';
+import app from './src/services/express';
+// import db from './config/sequelize';
+
+// module.parent check is required to support mocha watch
+if (!module.parent) {
+  app.listen(port, () => {
+    console.info(`server started on port ${port} (${env})`); // eslint-disable-line
+  });
+}
+
+export default app;

package.json

@@ -0,0 +1,115 @@
+{
+    "name": "globalshare-blockchain-api",
+    "version": "0.1.0",
+    "description": "Node JS Blockchain API",
+    "author": "Will Olivera <[email protected]>",
+    "main": "index.js",
+    "engines": {
+        "node": ">=8.10.0",
+        "npm": ">=5.6.0",
+        "yarn": ">=1.5.1"
+    },
+    "scripts": {
+        "start": "gulp serve",
+        "build": "gulp",
+        "copy": "gulp copy",
+        "babel": "gulp babel",
+        "lint": "esw *.js server config --color",
+        "lint:watch": "yarn lint -- --watch",
+        "beautify": "es-beautifier -u -c .eslintrc.js *.js server config",
+        "precommit": "yarn lint && yarn test",
+        "test": "cross-env NODE_ENV=test ./node_modules/.bin/jest server/tests",
+        "test:watch": "jest --watch",
+        "test:coverage": "cross-env NODE_ENV=test ./node_modules/.bin/istanbul cover _jest -- --ui bdd --reporter spec --colors --compilers js:babel-core/register server/tests --recursive",
+        "test:check-coverage": "yarn test:coverage && istanbul check-coverage",
+        "report-coverage": "coveralls < ./coverage/lcov.info",
+        "sequelize": "NODE_ENV=development ./node_modules/.bin/babel-node ./node_modules/.bin/sequelize",
+        "db:migrate": "npm run sequelize db:migrate"
+    },
+    "jest": {
+        "automock": false,
+        "bail": false,
+        "verbose": false,
+        "setupFiles": [],
+        "testMatch": [
+            "**/Tests/**/*.js",
+            "**/?(*.)(spec|test|integration).js?(x)"
+        ],
+        "testPathIgnorePatterns": [
+            "/node_modules/",
+            "/coverage/",
+            "/dist/"
+        ],
+        "testEnvironment": "node"
+    },
+    "dependencies": {
+        "babel-core": "6.24.0",
+        "babel-plugin-transform-runtime": "^6.23.0",
+        "babel-register": "^6.26.0",
+        "babel-runtime": "^6.26.0",
+        "body-parser": "1.15.2",
+        "compression": "1.6.2",
+        "cookie-parser": "1.4.3",
+        "cors": "2.8.1",
+        "debug": "^2.4.5",
+        "del": "^2.2.0",
+        "dotenv-safe": "^4.0.3",
+        "express": "4.14.0",
+        "express-jwt": "5.1.0",
+        "express-validation": "1.0.1",
+        "express-winston": "2.1.2",
+        "gulp": "3.9.0",
+        "gulp-load-plugins": "^1.2.0",
+        "helmet": "3.1.0",
+        "http-status": "^0.2.0",
+        "joi": "10.0.6",
+        "jsonwebtoken": "7.1.9",
+        "lodash": "4.17.10",
+        "method-override": "^2.3.5",
+        "morgan": "1.7.0",
+        "mysql": "^2.13.0",
+        "mysql2": "^1.6.1",
+        "run-sequence": "^1.1.5",
+        "sequelize": "4.38.0",
+        "sequelize-cli": "^5.2.0",
+        "supertest": "2.0.1",
+        "supertest-as-promised": "4.0.2",
+        "winston": "2.3.0"
+    },
+    "devDependencies": {
+        "babel-cli": "6.24.0",
+        "babel-plugin-add-module-exports": "0.2.1",
+        "babel-plugin-transform-object-rest-spread": "6.26.0",
+        "babel-preset-es2015": "6.24.1",
+        "babel-preset-stage-2": "6.18.0",
+        "commitizen": "^2.9.2",
+        "coveralls": "^2.11.6",
+        "cross-env": "3.1.3",
+        "eslint": "3.16.1",
+        "eslint-config-airbnb-base": "7.1.0",
+        "eslint-plugin-import": "1.16.0",
+        "eslint-watch": "2.1.14",
+        "gulp-babel": "6.1.2",
+        "gulp-newer": "^1.1.0",
+        "gulp-nodemon": "^2.0.6",
+        "gulp-sourcemaps": "^1.6.0",
+        "gulp-util": "^3.0.7",
+        "husky": "^0.13.1",
+        "istanbul": "1.1.0-alpha.1",
+        "jest": "23.4.2"
+    },
+    "babel": {
+        "presets": [
+            "es2015",
+            "stage-2"
+        ],
+        "plugins": [
+            "add-module-exports",
+            "transform-object-rest-spread"
+        ],
+        "ignore": [
+            "build/yarn/**/*.js",
+            "build/nodejs/**/*.js"
+        ]
+    }
+}

src/api/controllers/document.js

@@ -0,0 +1,15 @@
+import db from '../../services/sequelize';
+
+const { Document } = db;
+
+const list = async (req, res, next) => {
+  try {
+    const { limit = 50, offset = 0 } = req.query;
+    const documents = await Document.findAll({ limit, offset });
+    res.json(documents);
+  } catch (err) {
+    next(err);
+  }
+};
+
+export default { list };

src/api/controllers/index.js

@@ -0,0 +1,5 @@
+import documentCtrl from './document';
+
+export default {
+  documentCtrl,
+};

src/api/helpers/APIError.js

@@ -0,0 +1,33 @@
+import httpStatus from 'http-status';
+
+/**
+ * @extends Error
+ */
+class ExtendableError extends Error {
+  constructor(message, status, isPublic) {
+    super(message);
+    this.name = this.constructor.name;
+    this.message = message;
+    this.status = status;
+    this.isPublic = isPublic;
+    Error.captureStackTrace(this, this.constructor.name);
+  }
+}
+
+/**
+ * Class representing an API error.
+ * @extends ExtendableError
+ */
+class APIError extends ExtendableError {
+  /**
+   * Creates an API error.
+   * @param {string} message - Error message.
+   * @param {number} status - HTTP status code of error.
+   * @param {boolean} isPublic - Whether the message should be visible to user or not.
+   */
+  constructor(message, status = httpStatus.INTERNAL_SERVER_ERROR, isPublic = false) {
+    super(message, status, isPublic);
+  }
+}
+
+export default APIError;