Staging

.Hound.yml

@@ -0,0 +1,3 @@
+eslint:
+  enabled: true
+  config_file: .eslintrc

.babelrc

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    "es2015"
+  ],
+  "env": {
+    "test": {
+      "plugins": [
+        "istanbul"
+      ]
+    }
+  }
+}

.coveralls.yml

@@ -0,0 +1 @@
+repo_token: XfNKTpzGyMpLobup5VwEThnBUw1sre4NX

.env.sample

@@ -0,0 +1,6 @@
+JWT_SECRET=''
+TEST_ADMIN_PASSWORD=''
+TEST_FELLOW_PASSWORD=''
+TEST_FACILITATOR_PASSWORD=''
+PASSWORD=''
+TEST_DB=''

.eslintignore

@@ -0,0 +1,2 @@
+node_modules/
+dist/

.eslintrc

@@ -0,0 +1,34 @@
+{
+  "root": true,
+  "extends": "airbnb-base",
+  "env": {
+  "node": true,
+  "es6": true,
+  "mocha": true
+  },
+  "rules": {
+    "one-var": 0,
+    "one-var-declaration-per-line": 0,
+    "new-cap": 0,
+    "consistent-return": 0,
+    "no-param-reassign": 0,
+    "comma-dangle": 0,
+    "curly": ["error", "multi-line"],
+    "import/no-unresolved": [0, { commonjs: true, amd: true }],
+    "max-len": [2, 80, 2],
+    "no-shadow": ["error", { "allow": ["req", "res", "err"] }],
+    "valid-jsdoc": ["error", {
+      "requireReturn": true,
+      "requireReturnType": true,
+      "requireParamDescription": false,
+      "requireReturnDescription": true
+    }],
+    "require-jsdoc": ["error", {
+      "require": {
+        "FunctionDeclaration": true,
+        "MethodDefinition": true,
+        "ClassDeclaration": true
+      }
+    }]
+  }
+}

.gitignore

@@ -0,0 +1,9 @@
+node_modules/
+coverage
+.nyc_output
+.DS_Store
+.env
+dist/
+.coverdata/
+.coverrun
+npm-debug.log

.sequelizerc

@@ -0,0 +1,8 @@
+const path = require('path');
+
+module.exports = {
+  "config": path.resolve('./server/config', 'config.js'),
+  "models-path": path.resolve('./server/models'),
+  "seeders-path": path.resolve('./server/seeders'),
+  "migrations-path": path.resolve('./server/migrations')
+};

.travis.yml

@@ -0,0 +1,10 @@
+language: node_js
+node_js:
+- '6'
+before_script:
+- npm install -g gulp-cli
+script: npm test
+after_success:
+- npm install -g codeclimate-test-reporter
+- codeclimate-test-reporter < ./coverage/lcov.info
+- cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js

Procfile

@@ -0,0 +1 @@
+web: npm start

README.md

@@ -1 +1,112 @@
-# document-manager
+[![Build Status](https://travis-ci.org/iakhator/document-manager.svg?branch=staging)](https://travis-ci.org/iakhator/document-manager)
+[![Coverage Status](https://coveralls.io/repos/github/iakhator/document-manager/badge.svg?branch=staging)](https://coveralls.io/github/iakhator/document-manager?branch=staging)
+[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate)
+
+# document-manager
+Document manager provides REST API endpoints for a document management system. It allows create, retrieve, update and delete actions to be carried out.
+It also ensures that users are authorized.
+
+# API Documentation
+The API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API status and errors. Go to documentation [doksmanager](http://doksmanager.herokuapp.com)
+
+## Features
+
+**Users**:
+A created user will have a role, either an admin or a fellow.
+- A Fellow User can:
+    - Create an account: User can create a new account.
+    - Search users: search for a specific user by Id.
+    - Create a document: User can create document and assign an access type to each document created.
+    - Edit a document: User can edit/update document by the document Id.
+    - Retrieve a document: User can retrieve document based on access type or roles
+    - Delete a document: User can delete document by Id if the Id matches the logged in id.
+    - Limit access to a document by specifying an access group `i.e. public, private or role`.
+    - View public documents created by other user
+    - View documents created by his access group with access level set as `role`.
+    - Search documents: User can search through document to get all document related to the search query.
+    - View `public` and `role` access level documents of other fellows.
+
+- An Admin User can:
+    - View all users: An admin has the right to view all users
+    - View all created documents: An admin can view all documents
+    - Delete any user: An admin can delete any user by the user Id.
+    - Update any user's role: An admin can update user Role
+    - Create a new role if more roles are needed
+    - View all created roles
+    - Search for any user
+    - Search for any document
+
+**Documents**:
+Documents can be created and must have:
+  - Published date: This is the created date and updated date of new document created
+  - Title: This is the required title field of the document to be created.
+  - Content: This is the body of the document created
+  - Access (`private, public or role`): This is the access type of the document created.
+
+**Roles**:
+Roles can also be created, the default roles are `admin` and `fellow`.
+Only an admin user can create and manage role(s)
+
+**Authentication**:
+Users are authenticated and validated using JSON web token (JWT).
+By generating a token on login, API endpoints and documents are protected from unauthorized access.
+Requests to protected routes are validated using the generated token.
+
+## Development
+Document Management System API is built with the following technologies;
+- EcmaScript6 (ES6)
+- [NodeJs](https://nodejs.org)
+- [Express](http://expressjs.com/)
+- [Postgresql](https://www.postgresql.org/)
+- [Sequelize ORM](http://docs.sequelizejs.com/en/v3/)
+
+## Installation
+  - Install [NodeJs](https://nodejs.org/en/) and [Postgres](https://www.postgresql.org/) on your machine
+  - Clone the repository `$ git clone https://github.com/iakhator/document-manager.git`
+  - Change into the directory `$ cd /document-manager`
+  - Install all required dependencies with `$ npm install`
+  - Create a `.env` file in your root directory as described in `.env.sample` file
+  - Start the app with `npm start`
+
+## Testing
+  - Open a terminal and navigate to the project directory
+  - Add a test database url (DATABASE_URL) to the .env file.(optional)
+  - Run `npm test`
+
+## Contributing
+- Fork this repository to your GitHub account
+- Clone the forked repository
+- Create your feature branch
+- Commit your changes
+We recommend that commit messages have a Header, Body and Footer.
+
+```
+feature(): This feature addresses some particular issue(s)
+- implements functionality A.
+- implements functionality B.
+[Delivers #STORY_ID]
+
+```
+- Push to the remote branch
+- Open a Pull Request
+We recommend that pull requests follow this convention:
+
+```
+- Describe what this PR does
+- How should this be manually tested?
+- Any background context you want to provide?
+- Screenshots (if appropriate)
+- Questions:
+
+```
+
+## Limitations
+The limitations of the API are:
+- The application cannot accommodate millions of users for now because the database only allow limited number of users since it is a free account.
+- Users cannot share documents with other users through social sharing
+
+## FAQ
+- If there are any question you want to ask, contact me via mail [[email protected]](mailto:[email protected])
+
+## LICENSE
+ This project is authored by [Itua Akhator](https://github.com/iakhator) it is licensed under the MIT license.

codeclimate.yml

@@ -0,0 +1,20 @@
+engines:
+  eslint:
+    enabled: true
+    config:
+      config: .eslintrc
+  duplication:
+    enabled: false
+    config:
+      languages:
+      - javascript
+  fixme:
+    enabled: true
+ratings:
+  paths:
+  - "**.es6"
+  - "**.js"
+  - "**.jsx"
+exclude_paths:
+- node_modules/**/*
+- test/

gulpfile.babel.js

@@ -0,0 +1,41 @@
+import gulp from 'gulp';
+import loadPlugins from 'gulp-load-plugins';
+import path from 'path';
+import shell from 'gulp-shell';
+
+// Load the gulp plugins into the `plugins` variable
+const plugins = loadPlugins();
+
+// Compile all Babel Javascript into ES5 and place in dist folder
+const paths = {
+  js: ['./**/*.js', '!dist/**', '!node_modules/**', '!./server/tests/**']
+};
+
+// Compile all Babel Javascript into ES5 and put it into the dist dir
+gulp.task('babel', () =>
+  gulp.src(paths.js, { base: '.' })
+    .pipe(plugins.babel())
+    .pipe(gulp.dest('dist'))
+);
+
+gulp.task('migrate', shell.task([
+  'cross-env NODE_ENV=test sequelize db:migrate',
+]));
+
+gulp.task('coverage', shell.task([
+  'cross-env NODE_ENV=test nyc mocha ./server/test/**/*.js',
+]));
+
+// Restart server with on every changes made to file
+gulp.task('nodemon', ['babel'], () =>
+  plugins.nodemon({
+    script: path.join('dist', 'index.js'),
+    ignore: ['README.md', 'node_modules/**/*.js', 'dist/**/*.js'],
+    ext: 'js',
+    tasks: ['babel']
+  })
+);
+
+gulp.task('test', ['migrate', 'coverage']);
+gulp.task('default', ['nodemon']);
+gulp.task('production', ['babel']);

index.js

@@ -0,0 +1,72 @@
+import express from 'express';
+import path from 'path';
+import bodyParser from 'body-parser';
+import logger from 'morgan';
+import expressValidator from 'express-validator';
+import swaggerJSDoc from 'swagger-jsdoc';
+import routes from './server/routes';
+
+const app = express();
+
+const port = process.env.PORT || 3000
+// swagger definition
+const swaggerDefinition = {
+  info: {
+    title: 'Doksmanager API',
+    version: '1.0.0',
+    description: 'Doksmanager API is the API for a document management system, complete with roles and privileges. Each document defines access rights; the document defines which roles can access it. Also, each document specifies the date it was published. Users are categorized by roles. Each user must have a role defined for them.',
+    contact: {
+      email: '[email protected]',
+    },
+    license: {
+      name: 'MIT',
+      url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
+    }
+  },
+  host: 'doksmanager.herokuapp.com',
+  basePath: '/',
+};
+
+// options for the swagger docs
+const options = {
+  // import swaggerDefinitions
+  swaggerDefinition,
+  // path to the API docs
+  apis: [path.join(__dirname, './server/routes/*.js')],
+};
+const swaggerSpec = swaggerJSDoc(options);
+
+app.use(logger('dev'));
+
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({ extended: false }));
+app.use(expressValidator());
+
+// initialize swagger-jsdoc
+app.use(express.static('public/api-doc'));
+
+// serve swagger
+app.get('/swagger.json', (req, res) => {
+  res.setHeader('Content-Type', 'application/json');
+  res.send(swaggerSpec);
+});
+
+app.use((req, res, next) => {
+  const send = res.send;
+  let sent = false;
+  res.send = (data) => {
+    if (sent) return;
+    send.bind(res)(data);
+    sent = true;
+  };
+  next();
+});
+
+// mount all routes on /api path
+app.use('/api/v1', routes);
+
+const server = app.listen(port, () => {
+  console.log('API Server started and listening on port 3000');
+});
+
+export default server;