bookings api challenge 1 output

Author: gondzo

.gitignore

@@ -0,0 +1,116 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

README.md

@@ -0,0 +1,43 @@
+# Topcoder Bookings API
+
+## Dependencies
+
+- nodejs https://nodejs.org/en/ (v12+)
+- Postgres
+
+## Configuration
+
+Configuration for the application is at `config/default.js`.
+The following parameters can be set in config files or in env variables:
+
+- `LOG_LEVEL`: the log level, default is 'debug'
+- `PORT`: the server port, default is 3000
+- `BASE_PATH`: the server api base path
+- `AUTH_SECRET`: The authorization secret used during token verification.
+- `VALID_ISSUERS`: The valid issuer of tokens, a json array contains valid issuer.
+- `POSTGRES_URL`: Postgres database url.
+- `DB_SCHEMA_NAME`: string - postgres database target schema
+- `PROJECT_API_URL`: the project service url
+
+
+## Postgres Database Setup
+Go to https://www.postgresql.org/ download and install the Postgres.
+Modify `POSTGRES_URL` under `config/default.js` to meet your environment.
+Run `npm run init-db` to create table
+
+## Local Deployment
+
+- Install dependencies `npm install`
+- Run lint `npm run lint`
+- Run lint fix `npm run lint:fix`
+- Clear and init db `npm run init-db`
+- Start app `npm start`
+- App is running at `http://localhost:3000`
+
+## Testing
+- Run mock-project-service app
+- Run `npm run test` to execute unit tests
+- Run `npm run cov` to execute unit tests and generate coverage report.
+
+## Verification
+Refer to the verification document [Verification.md](Verification.md)

Verification.md

@@ -0,0 +1,36 @@
+# Topcoder Bookings API
+
+## Postman test
+- Refer `mock-project-service/ReadMe.md` to start the mock app
+- Refer `ReadMe.md` to start the app and postgres database
+- Run `npm run init-db` to init db before testing.
+- Import Postman collection and environment file in the `docs` folder to Postman and execute the scripts to validate the app from top to bottom.
+
+
+
+## Unit test Coverage
+
+
+  62 passing (176ms)
+
+
+File                        | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
+----------------------------|---------|----------|---------|---------|-------------------
+All files                   |   99.36 |       96 |     100 |   99.67 |                   
+ config                     |     100 |      100 |     100 |     100 |                   
+  default.js                |     100 |      100 |     100 |     100 |                   
+  test.js                   |     100 |      100 |     100 |     100 |                   
+ src                        |   90.48 |       50 |     100 |   94.12 |                   
+  bootstrap.js              |   90.48 |       50 |     100 |   94.12 | 18                
+ src/common                 |     100 |    96.55 |     100 |     100 |                   
+  errors.js                 |     100 |       50 |     100 |     100 | 23                
+  helper.js                 |     100 |      100 |     100 |     100 |                   
+ src/models                 |     100 |    92.86 |     100 |     100 |                   
+  Job.js                    |     100 |      100 |     100 |     100 |                   
+  JobCandidate.js           |     100 |      100 |     100 |     100 |                   
+  ResourceBooking.js        |     100 |      100 |     100 |     100 |                   
+  index.js                  |     100 |       80 |     100 |     100 | 29                
+ src/services               |     100 |      100 |     100 |     100 |                   
+  JobCandidateService.js    |     100 |      100 |     100 |     100 |                   
+  JobService.js             |     100 |      100 |     100 |     100 |                   
+  ResourceBookingService.js |     100 |      100 |     100 |     100 |                   

app-constants.js

@@ -0,0 +1,11 @@
+/**
+ * App constants
+ */
+
+const UserRoles = {
+  BookingManager: 'bookingmanager'
+}
+
+module.exports = {
+  UserRoles
+}

app-routes.js

@@ -0,0 +1,67 @@
+/**
+ * Configure all routes for express app
+ */
+
+const _ = require('lodash')
+const config = require('config')
+const HttpStatus = require('http-status-codes')
+const helper = require('./src/common/helper')
+const routes = require('./src/routes')
+const constants = require('./app-constants')
+const authenticator = require('tc-core-library-js').middleware.jwtAuthenticator
+
+/**
+ * Configure all routes for express app
+ * @param app the express app
+ */
+module.exports = (app) => {
+  // Load all routes
+  _.each(routes, (verbs, path) => {
+    _.each(verbs, (def, verb) => {
+      const controllerPath = `./src/controllers/${def.controller}`
+      const method = require(controllerPath)[def.method]; // eslint-disable-line
+      if (!method) {
+        throw new Error(`${def.method} is undefined`)
+      }
+
+      const actions = []
+      actions.push((req, res, next) => {
+        req.signature = `${def.controller}#${def.method}`
+        next()
+      })
+
+      // add Authenticator check if route has auth
+      if (def.auth) {
+        actions.push((req, res, next) => {
+          authenticator(_.pick(config, ['AUTH_SECRET', 'VALID_ISSUERS']))(req, res, next)
+        })
+
+        actions.push((req, res, next) => {
+          req.authUser.jwtToken = req.headers.authorization
+          if (_.includes(req.authUser.roles, constants.UserRoles.BookingManager)) {
+            req.authUser.isBookingManager = true
+          }
+          next()
+        })
+      }
+
+      actions.push(method)
+      const fullPath = config.get('BASE_PATH') + path
+      app[verb](fullPath, helper.autoWrapExpress(actions))
+    })
+  })
+
+  // Check if the route is not found or HTTP method is not supported
+  app.use('*', (req, res) => {
+    let url = req.baseUrl
+    if (url.indexOf(config.get('BASE_PATH')) === 0) {
+      url = url.substring(config.get('BASE_PATH').length)
+    }
+    const route = routes[url]
+    if (route) {
+      res.status(HttpStatus.METHOD_NOT_ALLOWED).json({ message: 'The requested HTTP method is not supported.' })
+    } else {
+      res.status(HttpStatus.NOT_FOUND).json({ message: 'The requested resource cannot be found.' })
+    }
+  })
+}

app.js

@@ -0,0 +1,95 @@
+/**
+ * The application entry point
+ */
+
+require('./src/bootstrap')
+const _ = require('lodash')
+const config = require('config')
+const express = require('express')
+const cors = require('cors')
+const HttpStatus = require('http-status-codes')
+const logger = require('./src/common/logger')
+const interceptor = require('express-interceptor')
+
+// setup express app
+const app = express()
+
+app.use(cors())
+app.use(express.json())
+app.use(express.urlencoded({ extended: true }))
+app.set('port', config.PORT)
+
+// intercept the response body from jwtAuthenticator
+app.use(interceptor((req, res) => {
+  return {
+    isInterceptable: () => {
+      return res.statusCode === 403
+    },
+
+    intercept: (body, send) => {
+      let obj
+      if (body.length > 0) {
+        try {
+          obj = JSON.parse(body)
+        } catch (e) {
+          logger.error('Invalid response body.')
+        }
+      }
+      if (obj && _.get(obj, 'result.content.message')) {
+        const ret = { message: obj.result.content.message }
+        res.statusCode = 401
+        send(JSON.stringify(ret))
+      } else {
+        send(body)
+      }
+    }
+  }
+}))
+
+// Register routes
+require('./app-routes')(app)
+
+// The error handler
+// eslint-disable-next-line no-unused-vars
+app.use((err, req, res, next) => {
+  logger.logFullError(err, req.signature || `${req.method} ${req.url}`)
+  const errorResponse = {}
+  const status = err.isJoi ? HttpStatus.BAD_REQUEST : (err.status || err.httpStatus || HttpStatus.INTERNAL_SERVER_ERROR)
+
+  if (_.isArray(err.details)) {
+    if (err.isJoi) {
+      _.map(err.details, (e) => {
+        if (e.message) {
+          if (_.isUndefined(errorResponse.message)) {
+            errorResponse.message = e.message
+          } else {
+            errorResponse.message += `, ${e.message}`
+          }
+        }
+      })
+    }
+  }
+
+  if (err.response) {
+    // extract error message from V3 API
+    errorResponse.message = _.get(err, 'response.body.result.content')
+  }
+
+  if (_.isUndefined(errorResponse.message)) {
+    if (err.message && (err.httpStatus || status !== HttpStatus.INTERNAL_SERVER_ERROR)) {
+      errorResponse.message = err.message
+    } else {
+      errorResponse.message = 'Internal server error'
+    }
+  }
+
+  res.status(status).json(errorResponse)
+})
+
+const server = app.listen(app.get('port'), () => {
+  logger.info(`Express server listening on port ${app.get('port')}`)
+})
+
+if (process.env.NODE_ENV === 'test') {
+  module.exports = server
+}

config/default.js

@@ -0,0 +1,12 @@
+module.exports = {
+  LOG_LEVEL: process.env.LOG_LEVEL || 'debug',
+  PORT: process.env.PORT || 3000,
+  BASE_PATH: process.env.BASE_PATH || '/api/v5',
+
+  AUTH_SECRET: process.env.AUTH_SECRET || 'mysecret',
+  VALID_ISSUERS: process.env.VALID_ISSUERS || '["https://api.topcoder-dev.com", "https://api.topcoder.com", "https://topcoder-dev.auth0.com/"]',
+
+  POSTGRES_URL: process.env.POSTGRES_URL || 'postgres://postgres:postgres@localhost:5432/postgres',
+  DB_SCHEMA_NAME: process.env.DB_SCHEMA_NAME || 'bookings',
+  PROJECT_API_URL: process.env.PROJECT_API_URL || 'http://localhost:4000'
+}

config/test.js

@@ -0,0 +1,3 @@
+module.exports = {
+  LOG_LEVEL: process.env.LOG_LEVEL || 'info'
+}