Merge branch 'add-computer'

Author: kudapara

config/routes.js

@@ -4,6 +4,7 @@ module.exports.
 mount = app => {
 	const usersRoutes = require('../models/users/user.routes')
 	const authRoutes = require('../models/auth/auth.routes')
+	const computerRoutes = require('../models/computers/computer.routes')
 	const restoreDatabaseRoutes = require('../models/restore-database/restore-database.routes')
 
 	// tomake the travis builds succeed
@@ -14,5 +15,6 @@ mount = app => {
 
 	app.use('/api/v1/users', usersRoutes)
 	app.use('/api/v1/auth', authRoutes)
+	app.use('/api/v1/computers', computerRoutes)
 	app.use('/restore-database', restoreDatabaseRoutes)
 }

database/migrations/20180112131730_computers.js

@@ -0,0 +1,12 @@
+
+exports.up = function(knex, Promise) {
+  return knex.schema.createTable('computers', table => {
+    table.string('name').primary()
+    table.boolean('active').defaultTo(true)
+    table.timestamp('created_at').defaultTo(knex.fn.now())
+  })   
+}
+
+exports.down = function(knex, Promise) {
+  return knex.schema.dropTable('computers')
+}

database/seeds/computers.js

@@ -0,0 +1,15 @@
+
+exports.seed = function(knex, Promise) {
+  // Deletes ALL existing entries
+  return knex('computers').del()
+    .then(function () {
+      // Inserts seed entries
+      return knex('computers').insert([
+        { name: 'computer1', created_at: new Date },
+        { name: 'computer2', created_at: new Date },
+        { name: 'computer3', created_at: new Date },
+        { name: 'computer4', created_at: new Date },
+        { name: 'computer5', active: false, created_at: new Date }
+      ])
+    })
+}

models/auth/auth.controller.js

@@ -38,7 +38,8 @@ module.exports.logout = async (req, res) => {
   if (error) return buildResponse(res, 400, { message: 'bad request', reason: error.details[0].message})
 
   try {
-    await userModel.logout(value)
+    const userApi = new userModel()
+    await userApi.logout(value)
     buildResponse(res, 200, { message: 'Successfully logged out'})
   } catch (error) {
     buildResponse(res, 500, { message: 'Something aweful happend and we couldn\'t log out', error })

models/auth/auth.spec.e2e.js

@@ -81,7 +81,7 @@ describe('POST /api/v1/auth/login', () => {
       .send(user)
       .query({
         app: 'desktop',
-        computer_name: 'Computer1'
+        computer_name: 'computer1'
       })
       .end((err, res) => {
         should.not.exist(err)
@@ -379,7 +379,7 @@ describe('POST /api/v1/auth/login', () => {
     chai.request(server)
       .post(loginUrl)     
       .send(user)
-      .query({ computer_name: 'Computer1' })
+      .query({ computer_name: 'computer1' })
       .end((err, res) => {
         should.exist(err)
         res.redirects.length.should.eql(0)

models/computers/computer.controller.js

@@ -0,0 +1,66 @@
+const ComputerModel = require('./')
+const { buildResponse } = require('../../utils/responseService')
+
+async function create (req, res) {
+  try {
+    let newComputer = req.body
+    const computerApi = new ComputerModel()
+    const createdComputer = await computerApi.create(newComputer)
+    buildResponse(res, 200, { message: 'successfully created computer.', computer: createdComputer })
+  } catch (error) {
+    if (error.status) return buildResponse(res, error.status, { message: error.message, error })
+    buildResponse(res, 500, { message: 'something happened', error })
+  }
+}
+
+async function getAllComputers (req, res) {
+  try {
+    const computerApi = new ComputerModel()
+    const computers = await computerApi.getAllComputers()
+    buildResponse(res, 200, { computers })
+  } catch (err) {
+    buildResponse(res, 500, err)
+  }
+}
+
+async function deactivate (req, res) {
+  try {
+    let name = req.body.name
+    const computerApi = new ComputerModel()
+    const response = await computerApi.deactivate({ name })
+    buildResponse(res, 200, { message: response.message })
+  } catch (err) {
+    buildResponse(res, 500, err)
+  }
+}
+
+
+async function reactivate (req, res) {
+  try {
+    let name = req.body.name
+    const computerApi = new ComputerModel()
+    const response = await computerApi.reactivate({ name })
+    buildResponse(res, 200, { message: response.message })
+  } catch (err) {
+    buildResponse(res, 500, err)
+  }
+}
+
+async function unregister (req, res) {
+  try {
+    let name = req.body.name
+    const computerApi = new ComputerModel()
+    const response = await computerApi.unregister({ name })
+    buildResponse(res, 200, { message: response.message })
+  } catch (err) {
+    buildResponse(res, 500, err)
+  }
+}
+
+module.exports = {
+  create,
+  getAllComputers,
+  deactivate,
+  reactivate,
+  unregister
+}

models/computers/computer.readme.md

@@ -0,0 +1,229 @@
+## User.js
+
+## Routes available
+
+The following routes are available for the ```Computer``` resource. They are all prefixed by ```/api/v1/computer```.
+
+| Methods | Path | Authentication | Description |
+| --- | --- | --- | --- |
+| `POST` | '/new' | Admin Required | Add a new computer to the system |
+| `GET` | '/' | Required | Gets all the computers registered in the system |
+| `PUT` | '/deactivate' | Admin Required | Deactivate the computer so that it is not accessible |
+| `PUT` | '/reactivate' | Admin Required | Reactivate the computer so that it can be accessible |
+| `Delete` | '/unregister' | Admin Required | Remove the computer from the system |
+
+## #create()
+
+This method creates a new computer in the database
+
+**Usage**
+```javascript
+  const axios = require('axios')
+
+  const res = await axios.post('/api/v1/computers/new', {
+    name: 'computer3'
+  })
+
+  console.log(res.data)
+```
+
+> The responses below are just a demo to show the keys that the response object may have 
+### Success response
+
+```json
+{
+    "message": "successfully created computer.",
+    "computer": {
+        "name": "computer3",
+        "active": true,
+        "created_at": "2018-01-12T16:25:11.893Z"
+    }
+}
+```
+
+### Error response
+
+**If no token is provided**
+```json
+{
+    "message": "No token provided."
+}
+```
+
+**validation errors**
+```json
+{
+    "message": "Validation errors occured",
+    "error": {
+        "message": "Validation errors occured",
+        "errors": [
+            {
+                "message": "\"name\" is required",
+                "path": "name",
+                "type": "any.required",
+                "context": {
+                    "key": "name"
+                }
+            }
+        ],
+        "status": 400
+    }
+}
+```
+---
+## #getAllComputers()
+
+Returns all the computers in the databse
+
+**Usage**
+```javascript
+  const axios = require('axios')
+
+  const res = await axios.post('/api/v1/computers')
+
+  console.log(res)
+```
+
+> The responses below are just a demo to show the keys that the response object may have 
+### Success response
+
+```js
+{
+    "computers": [
+        {
+            "name": "computer1",
+            "active": true,
+            "created_at": "2018-01-12T15:56:42.181Z",
+            "username": "garikai",
+            "login_time": "18:15:41",
+            "login_date": "2018-01-12T18:15:41.522+02:00",
+            "computer_name": "computer1",
+            "status": "in_use"
+        },
+        {
+            "name": "computer3",
+            "active": true,
+            "created_at": "2018-01-12T16:25:11.893Z",
+            "username": null,
+            "login_time": null,
+            "login_date": null,
+            "computer_name": null,
+            "status": "available"
+        }
+    ]
+}
+```
+
+### Error response
+
+**If no token is provided**
+```json
+{
+    "message": "No token provided."
+}
+```
+---
+
+## #deactivate()
+
+Deactivate the computer so that it is not accessible
+
+**Usage**
+```javascript
+  const axios = require('axios')
+
+  const res = await axios.put('/api/v1/computers/deactivate', {
+    name: 'computer3'
+  })
+
+  console.log(res.data)
+```
+
+> The responses below are just a demo to show the keys that the response object may have 
+### Success response
+
+```json
+{
+    "message": "successfully deactivated computer."
+}
+```
+
+### Error response
+
+**If no token is provided**
+```json
+{
+    "message": "No token provided."
+}
+```
+---
+
+
+## #reactivate()
+
+Deactivate the computer so that it is not accessible
+
+**Usage**
+```javascript
+  const axios = require('axios')
+
+  const res = await axios.put('/api/v1/computers/reactivate', {
+    name: 'computer3'
+  })
+
+  console.log(res.data)
+```
+
+> The responses below are just a demo to show the keys that the response object may have 
+### Success response
+
+```json
+{
+    "message": "successfully reactivated computer."
+}
+```
+
+### Error response
+
+**If no token is provided**
+```json
+{
+    "message": "No token provided."
+}
+```
+---
+
+
+## #unregister()
+
+Deactivate the computer so that it is not accessible
+
+**Usage**
+```javascript
+  const axios = require('axios')
+
+  const res = await axios.delete('/api/v1/computers/unregister', {
+    name: 'computer3'
+  })
+
+  console.log(res.data)
+```
+
+> The responses below are just a demo to show the keys that the response object may have 
+### Success response
+
+```json
+{
+    "message": "successfully unregistered computer."
+}
+```
+
+### Error response
+
+**If no token is provided**
+```json
+{
+    "message": "No token provided."
+}
+```
+---

models/computers/computer.routes.js

@@ -0,0 +1,12 @@
+const router = require('express').Router()
+const controller = require('./computer.controller')
+
+const { authenticateAdmin, authenticate } = require('../../utils/middlewareService')
+
+router.post('/new', authenticateAdmin, controller.create)
+router.get('/', authenticate, controller.getAllComputers)
+router.put('/deactivate', authenticateAdmin, controller.deactivate)
+router.put('/reactivate', authenticateAdmin, controller.reactivate)
+router.delete('/unregister', authenticateAdmin, controller.unregister)
+
+module.exports = router