Fix issue #17, #31, #33 (#35)

Fixes and Improvements

Author: asadath1395

README.md

@@ -40,18 +40,14 @@ The following parameters can be set in config files or in env variables:
 - follow (https://neo4j.com/download-thanks-desktop/?edition=desktop&flavour=winstall64&release=1.1.13&offline=true) to add graph database
 - configure graph database connection details in config file
 
-
 ## 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`
-- Add db indices `npm run create-index`
-- Insert test data `npm run test-data`
 - Start app `npm start`
-- App is running at `http://localhost:3000`
-
+- App will be running at `http://localhost:3000`
+- Application can be run in development mode using the command `npm run dev`
 
 ## Heroku deployment
 - git init
@@ -63,33 +59,12 @@ The following parameters can be set in config files or in env variables:
 - to set some environment variables in heroku, run command like:
   `heroku config:set LOG_LEVEL=info`
 - git push heroku master // push code to Heroku
-- to initialize db, run `heroku run npm run init-db`
-- to create db indices, run `heroku run npm run create-index`
-- to insert test data, run `heroku run npm run test-data`
-
-
-I deployed the code to:
-https://thawing-savannah-55254.herokuapp.com
-
-
 
 ## Graph Database Structure
 
-The graph database consists of 3 node types: SecurityGroup, Group and User, and one relation type: GroupContains.
+The graph database consists of 3 node types: Group and User, and one relation type: GroupContains.
 The GroupContains relation links from a group to a child group or user.
 
-### SecurityGroup node
-
-The security group node contains these fields:
-
-- id: the group UUID corresponding to the security group
-- name: the security group name, should be unique (usually the same as the group)
-- createdAt: the created at date string
-- createdBy: the created by user id
-- updatedAt: the updated at date string
-- updatedBy: the updated by user id
-
-
 ### Group node
 
 The group node contains these fields:
@@ -113,18 +88,11 @@ The user node contains these fields:
 - id: the user UUID
 - handle: the user handle, should be unique
 
-
 ### GroupContains relation
 
 The GroupContains relation contains these fields:
 
 - id: the relationship UUID
 - type: the relationship type, 'group' or 'user'
 - createdAt: the created at date string
-- createdBy: the created by user id
-
-## Notes
-
-In the app-constants.js Topics field, the used topics are using a test topic,
-the suggested ones are commented out, because these topics are not created in TC dev Kafka yet.
-
+- createdBy: the created by user id

app-constants.js

@@ -15,19 +15,15 @@ const EVENT_ORIGINATOR = 'topcoder-groups-api'
 
 const EVENT_MIME_TYPE = 'application/json'
 
-// using a testing topc, should be changed to use real topics in comments when they are created
-const Topics = {
-  GroupCreated: 'test.new.bus.events', // 'user.action.group.created',
-  GroupUpdated: 'test.new.bus.events', // 'user.action.group.updated',
-  GroupDeleted: 'test.new.bus.events', // 'user.action.group.deleted',
-  GroupMemberCreated: 'test.new.bus.events', // 'user.action.group.member.created',
-  GroupMemberDeleted: 'test.new.bus.events' // 'user.action.group.member.deleted'
+const GroupStatus = {
+  Active: 'active',
+  InActive: 'inactive'
 }
 
 module.exports = {
   UserRoles,
   MembershipTypes,
   EVENT_ORIGINATOR,
   EVENT_MIME_TYPE,
-  Topics
+  GroupStatus
 }

app.js

@@ -12,7 +12,10 @@ const cors = require('cors')
 const logger = require('./src/common/logger')
 const HttpStatus = require('http-status-codes')
 const morgan = require('morgan')
+const swaggerUi = require('swagger-ui-express')
+const YAML = require('yamljs')
 
+const swaggerDocument = YAML.load('./docs/swagger.yml')
 // setup express app
 const app = express()
 
@@ -24,6 +27,11 @@ app.set('port', config.PORT)
 // Request logger
 app.use(morgan('common', { skip: (req, res) => res.statusCode < 400 }))
 
+// Serve Swagger Docs after setting host and base path
+swaggerDocument.host = config.HOST
+swaggerDocument.basePath = config.API_PREFIX
+app.use('/groups/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
+
 // Register routes
 require('./app-routes')(app)
 

config/default.js

@@ -14,6 +14,7 @@ module.exports = {
   VALID_ISSUERS: process.env.VALID_ISSUERS
     ? process.env.VALID_ISSUERS.replace(/\\"/g, '')
     : '["https://api.topcoder-dev.com", "https://api.topcoder.com","https://topcoder-dev.auth0.com/"]',
+  HOST: process.env.HOST || 'localhost:3000',
 
   // Auth0 config params
   AUTH0_URL: process.env.AUTH0_URL || 'https://topcoder-dev.auth0.com/oauth/token',
@@ -31,11 +32,11 @@ module.exports = {
   HEALTH_CHECK_TIMEOUT: process.env.HEALTH_CHECK_TIMEOUT || 3000,
 
   // Kafka Topics
-  KAFKA_GROUP_CREATE_TOPIC: process.env.KAFKA_GROUP_CREATE_TOPIC,
-  KAFKA_GROUP_UPDATE_TOPIC: process.env.KAFKA_GROUP_UPDATE_TOPIC,
-  KAFKA_GROUP_DELETE_TOPIC: process.env.KAFKA_GROUP_DELETE_TOPIC,
-  KAFKA_GROUP_MEMBER_ADD_TOPIC: process.env.KAFKA_GROUP_MEMBER_ADD_TOPIC,
-  KAFKA_GROUP_MEMBER_DELETE_TOPIC: process.env.KAFKA_GROUP_MEMBER_DELETE_TOPIC,
+  KAFKA_GROUP_CREATE_TOPIC: process.env.KAFKA_GROUP_CREATE_TOPIC || 'groups.notification.create',
+  KAFKA_GROUP_UPDATE_TOPIC: process.env.KAFKA_GROUP_UPDATE_TOPIC || 'groups.notification.update',
+  KAFKA_GROUP_DELETE_TOPIC: process.env.KAFKA_GROUP_DELETE_TOPIC || 'groups.notification.delete',
+  KAFKA_GROUP_MEMBER_ADD_TOPIC: process.env.KAFKA_GROUP_MEMBER_ADD_TOPIC || 'groups.notification.member.add',
+  KAFKA_GROUP_MEMBER_DELETE_TOPIC: process.env.KAFKA_GROUP_MEMBER_DELETE_TOPIC || 'groups.notification.member.delete',
 
   USER_ROLES: {
     Admin: 'Administrator',