Merge branch 'release/1.0.0-beta.1'

Author: abrain

.codeclimate.yml

@@ -0,0 +1,14 @@
+version: "2"
+plugins:
+  eslint:
+    enabled: true
+    channel: "eslint-6"
+exclude_patterns:
+  - ".idea/"
+  - ".*.json"
+  - ".*.yml"
+  - ".*ignore"
+  - "node_modules/"
+  - "__tests__/"
+  - "*.js"
+  - "*.json"

.env.example

@@ -0,0 +1,7 @@
+DEBUG=1
+DB_HOST=localhost
+DB_USER=ad_display
+DB_PASSWORD=
+DB_NAME=ad_display
+DB_PREFIX=ad_
+#PORT=3000

.eslintignore

@@ -0,0 +1,2 @@
+.idea/
+jest.config.js

.eslintrc.json

@@ -0,0 +1,20 @@
+{
+    "env": {
+        "commonjs": true,
+        "es6": true,
+        "node": true
+    },
+    "extends": [
+        "standard"
+    ],
+    "globals": {
+        "Atomics": "readonly",
+        "SharedArrayBuffer": "readonly"
+    },
+    "parserOptions": {
+        "ecmaVersion": 2018
+    },
+    "root": true,
+    "rules": {
+    }
+}

.gitignore

@@ -1,3 +1,7 @@
 node_modules
 .idea
 .env
+build
+coverage
+ext-display
+ext-console

.travis.yml

@@ -0,0 +1,32 @@
+language: node_js
+node_js:
+  - 14
+  - 12
+  - 10
+
+branches:
+  except:
+    - /^feature\/[-\w]+$/
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=c1c885065adfd5bb4901e0bb11111b73d3b71833597bc1759741e02f89b1be7b
+
+jobs:
+  include:
+    - name: "ESLint"
+      before_script: skip
+      script: npm run lint
+      after_script: skip
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+notifications:
+  email:
+    on_success: never
+    on_failure: always

LICENSE

@@ -0,0 +1,19 @@
+# Display  Backend
+[![Build Status](https://travis-ci.com/alarmdisplay/display-backend.svg?branch=develop)](https://travis-ci.com/alarmdisplay/display-backend)
+
+This component is the connection point for all Display units.
+While it maintains a [Socket.IO](https://socket.io/) connection with the Displays to push updates, it also offers a REST API to manage the Displays and their contents.
+
+## Development
+In order to run a development version on your local system, you need a [Node.js](https://nodejs.org/) environment and a MariaDB instance.
+Clone the repository and run `npm install` inside the project folder to install all the dependencies.
+Then create a `.env` file based on `.env.example` and adapt it to your local setup.
+
+Start the development server by running `npm run dev`, it will automatically restart when files have changed.
+Now you can access the server on http://localhost:3000 (may be a different port if you changed it in the `.env` file).
+
+## Deployment
+At the moment, this project is not ready for deployment outside of a development environment.
+
+## API
+The server offers an OpenAPI specification under `/api-docs.json` that can be used with tools like [Swagger UI](https://swagger.io/tools/swagger-ui/).

README.md

@@ -0,0 +1,8 @@
+{
+  "env": {
+    "jest": true
+  },
+  "extends": [
+    "../.eslintrc.json"
+  ]
+}

__tests__/.eslintrc.json

@@ -0,0 +1,226 @@
+const supertest = require('supertest')
+const DisplayService = require('../../../src/services/DisplayService')
+const NotFoundError = require('../../../src/errors/NotFoundError')
+
+jest.mock('../../../src/services/DisplayService')
+
+const baseUrl = '/api/v1/displays'
+
+describe(baseUrl, () => {
+  const app = require('../../../src/app')
+  let displayService
+  let request
+
+  beforeAll(() => {
+    displayService = new DisplayService(undefined, undefined, undefined, undefined)
+    const theApp = app(displayService, undefined, undefined)
+    request = supertest(theApp)
+  })
+
+  beforeEach(() => {
+    DisplayService.mock.instances[0].getAllDisplays.mockClear()
+    DisplayService.mock.instances[0].createDisplay.mockClear()
+    DisplayService.mock.instances[0].getDisplayById.mockClear()
+    DisplayService.mock.instances[0].updateDisplay.mockClear()
+    DisplayService.mock.instances[0].deleteDisplay.mockClear()
+    DisplayService.mock.instances[0].getViewsForDisplay.mockClear()
+  })
+
+  describe('GET /', () => {
+    it('should correctly call DisplayService.getAllDisplays()', () => {
+      return request.get(`${baseUrl}/`)
+        .expect(() => {
+          expect(DisplayService.mock.instances[0].getAllDisplays.mock.calls).toHaveLength(1)
+          expect(DisplayService.mock.instances[0].getAllDisplays.mock.calls[0]).toEqual([])
+        })
+    })
+
+    it('should return a JSON array', () => {
+      DisplayService.mock.instances[0].getAllDisplays.mockResolvedValueOnce([])
+      return request.get(`${baseUrl}/`)
+        .expect('Content-Type', /json/)
+        .expect(200)
+        .expect([])
+    })
+
+    it('should return the stored Displays', () => {
+      const displays = [{ id: 1, name: 'A' }, { id: 2, name: 'B' }]
+      DisplayService.mock.instances[0].getAllDisplays.mockResolvedValueOnce(displays)
+      return request.get(`${baseUrl}/`)
+        .expect('Content-Type', /json/)
+        .expect(200)
+        .expect(displays)
+    })
+
+    it('should return 500 on internal error', () => {
+      DisplayService.mock.instances[0].getAllDisplays.mockRejectedValueOnce(new Error('Error during GET /'))
+      return request.get(`${baseUrl}/`)
+        .expect('Content-Type', /json/)
+        .expect(500)
+        .expect({ error: { message: 'Error during GET /' } })
+    })
+  })
+
+  describe('POST /', () => {
+    it('should correctly call DisplayService.getDisplayById()', () => {
+      const display = { name: 'Some name', active: true, clientId: 'X29GH', description: 'Just testing', location: 'Somewhere' }
+      return request.post(`${baseUrl}/`)
+        .send(display)
+        .expect(() => {
+          expect(DisplayService.mock.instances[0].createDisplay.mock.calls).toHaveLength(1)
+          expect(DisplayService.mock.instances[0].createDisplay.mock.calls[0]).toEqual(['Some name', true, 'X29GH', 'Just testing', 'Somewhere'])
+        })
+    })
+
+    it('should return the newly created Display with status 201', () => {
+      const display = { id: 42, name: 'Another name', active: false, clientId: 'KJFLH2', description: 'Just testing...', location: 'Somewhere else' }
+      DisplayService.mock.instances[0].createDisplay.mockResolvedValueOnce(display)
+      return request.post(`${baseUrl}/`)
+        .send({})
+        .expect('Content-Type', /json/)
+        .expect(201)
+        .expect('Location', `${baseUrl}/42`)
+        .expect(display)
+    })
+
+    it('should allow to only submit the name', () => {
+      return request.post(`${baseUrl}/`)
+        .send({ name: 'The name' })
+        .expect(() => {
+          expect(DisplayService.mock.instances[0].createDisplay.mock.calls).toHaveLength(1)
+          expect(DisplayService.mock.instances[0].createDisplay.mock.calls[0]).toEqual(['The name', false, '', '', ''])
+        })
+    })
+
+    it('should return 500 on internal error', () => {
+      DisplayService.mock.instances[0].createDisplay.mockRejectedValueOnce(new Error('Error during POST /'))
+      return request.post(`${baseUrl}/`)
+        .expect('Content-Type', /json/)
+        .expect(500)
+        .expect({ error: { message: 'Error during POST /' } })
+    })
+  })
+
+  describe('GET /{id}', () => {
+    it('should correctly call DisplayService.getDisplayById()', () => {
+      return request.get(`${baseUrl}/165`)
+        .expect(() => {
+          expect(DisplayService.mock.instances[0].getDisplayById.mock.calls).toHaveLength(1)
+          expect(DisplayService.mock.instances[0].getDisplayById.mock.calls[0]).toEqual([165])
+          expect(Number.isInteger(DisplayService.mock.instances[0].getDisplayById.mock.calls[0][0])).toBeTruthy()
+        })
+    })
+
+    it('should return the Display if it exists', () => {
+      const display = { id: 623, name: 'Name', active: false, clientId: 'KJFLH2', description: 'Just testing...', location: 'Somewhere else' }
+      DisplayService.mock.instances[0].getDisplayById.mockResolvedValueOnce(display)
+      return request.get(`${baseUrl}/623`)
+        .expect('Content-Type', /json/)
+        .expect(200)
+        .expect(display)
+    })
+
+    it('should return 404 if the Display does not exist', () => {
+      DisplayService.mock.instances[0].getDisplayById.mockRejectedValueOnce(null)
+      return request.get(`${baseUrl}/14`)
+        .expect(404)
+    })
+
+    it('should return 500 on internal error', () => {
+      DisplayService.mock.instances[0].getDisplayById.mockRejectedValueOnce(new Error('Error during GET /{id}'))
+      return request.get(`${baseUrl}/5`)
+        .expect('Content-Type', /json/)
+        .expect(500)
+        .expect({ error: { message: 'Error during GET /{id}' } })
+    })
+  })
+
+  describe('PUT /{id}', () => {
+    it('should correctly call DisplayService.updateDisplay()', () => {
+      return request.put(`${baseUrl}/56`)
+        .send({
+          id: 56,
+          name: 'Another name',
+          active: false,
+          clientId: 'KJFLH2',
+          description: 'Just testing...',
+          location: 'Somewhere else'
+        })
+        .expect(() => {
+          expect(DisplayService.mock.instances[0].updateDisplay.mock.calls).toHaveLength(1)
+          expect(DisplayService.mock.instances[0].updateDisplay.mock.calls[0]).toEqual([56, 'Another name', false, 'KJFLH2', 'Just testing...', 'Somewhere else'])
+        })
+    })
+
+    it('should return the updated Display', () => {
+      const display = { id: 253, name: 'Hello', active: true, clientId: 'JLA73G', description: 'None', location: 'Also none' }
+      DisplayService.mock.instances[0].updateDisplay.mockResolvedValueOnce(display)
+      return request.put(`${baseUrl}/253`)
+        .send({})
+        .expect('Content-Type', /json/)
+        .expect(200)
+        .expect(display)
+    })
+
+    it('should return 404 when Display does not exist', () => {
+      DisplayService.mock.instances[0].updateDisplay.mockRejectedValueOnce(null)
+      return request.put(`${baseUrl}/12`)
+        .expect(404)
+    })
+
+    it('should return 500 on internal error in DisplayService.updateDisplay()', () => {
+      DisplayService.mock.instances[0].updateDisplay.mockRejectedValueOnce(new Error('Error during PUT /{id}'))
+      return request.put(`${baseUrl}/5`)
+        .expect('Content-Type', /json/)
+        .expect(500)
+        .expect({ error: { message: 'Error during PUT /{id}' } })
+    })
+  })
+
+  describe('DELETE /{id}', () => {
+    it('should correctly call DisplayService.deleteDisplay()', () => {
+      return request.delete(`${baseUrl}/1238`)
+        .expect(() => {
+          expect(DisplayService.mock.instances[0].deleteDisplay.mock.calls).toHaveLength(1)
+          expect(DisplayService.mock.instances[0].deleteDisplay.mock.calls[0]).toEqual([1238])
+        })
+    })
+
+    it('should return 500 on internal error', () => {
+      DisplayService.mock.instances[0].deleteDisplay.mockRejectedValueOnce(new Error('Error during DELETE /{id}'))
+      return request.delete(`${baseUrl}/5`)
+        .expect('Content-Type', /json/)
+        .expect(500)
+        .expect({ error: { message: 'Error during DELETE /{id}' } })
+    })
+  })
+
+  describe('GET /{id}/views', () => {
+    it('should correctly call DisplayService.getDisplayById()', () => {
+      return request.get(`${baseUrl}/272/views`)
+        .expect(() => {
+          expect(DisplayService.mock.instances[0].getDisplayById.mock.calls).toHaveLength(1)
+          expect(DisplayService.mock.instances[0].getDisplayById.mock.calls[0]).toEqual([272])
+        })
+    })
+
+    it('should correctly call DisplayService.getViewsForDisplay()', () => {
+      DisplayService.mock.instances[0].getDisplayById.mockResolvedValueOnce({ id: 312 })
+      return request.get(`${baseUrl}/312/views`)
+        .expect(() => {
+          expect(DisplayService.mock.instances[0].getViewsForDisplay.mock.calls).toHaveLength(1)
+          expect(DisplayService.mock.instances[0].getViewsForDisplay.mock.calls[0]).toEqual([312])
+        })
+    })
+
+    it('should return a list of Views', () => {
+      const views = []
+      DisplayService.mock.instances[0].getDisplayById.mockResolvedValueOnce({ id: 1268 })
+      DisplayService.mock.instances[0].getViewsForDisplay.mockResolvedValueOnce(views)
+      return request.get(`${baseUrl}/1268/views`)
+        .expect('Content-Type', /json/)
+        .expect(200)
+        .expect(views)
+    })
+  })
+})