1. Update api to support create / update and deletion of leaderboard

2. Update get api to support groupId based filter

Author: callmekatootie

README.md

@@ -3,7 +3,6 @@
 ## Dependencies
 
 - nodejs (v10)
-- Kafka (v2)
 - Mongodb (v4)
 
 ## Configuration
@@ -14,6 +13,15 @@ The following parameters can be set in config files or in env variables:
 - LOG_LEVEL: the log level
 - PORT: the server port
 - MONGODB_URL: Mongo DB URL
+- CHALLENGE_API_URL: the Topcoder challenge API URL
+- MEMBER_API_URL: the Topcoder member API URL
+- GROUP_IDS: the valid group ids
+- AUTH0_URL: Auth0 URL, used to get TC M2M token
+- AUTH0_AUDIENCE: Auth0 audience, used to get TC M2M token
+- TOKEN_CACHE_TIME: Auth0 token cache time, used to get TC M2M token
+- AUTH0_CLIENT_ID: Auth0 client id, used to get TC M2M token
+- AUTH0_CLIENT_SECRET: Auth0 client secret, used to get TC M2M token
+- AUTH0_PROXY_SERVER_URL: Proxy Auth0 URL, used to get TC M2M token
 
 ## Local deployment
 
@@ -31,12 +39,23 @@ npm run lint
 npm run lint:fix # To fix possible lint errors
 ```
 
+- Clear and Insert data into database
+
+```bash
+npm run init-db
+
+npm run test-data
+```
+
 - Start the express server
 
 ```bash
 npm start
 ```
 
+## Mock API
+For verification purpose, we need a mock app for Topcoder Challenge API and Topcoder Member API. You can run command `npm run mock-api` to start the mock app.
+
 ## Heroku Deployment
 
 - git init
@@ -48,4 +67,36 @@ npm start
 
 ## Verification
 
-- Import the collection and environment into your POSTMAN app and check out the endpoints
+### Tests
+
+- Run the following command to execute unit test and generate coverage report
+
+```bash
+npm run test
+```
+
+- Run the following command to execute e2e test and generate coverage report
+
+```bash
+npm run e2e
+```
+
+### Postman
+
+- Start mock app and it will listen on 3001 PORT.
+
+```bash
+npm run mock-api
+```
+
+- Ensure you have start MongoDB and properly configure `MONGODB_URL`. Run the following commands to clear and insert test data, step up environment variables and start the app.
+
+```bash
+npm run init-db
+npm run test-data
+export CHALLENGE_API_URL=http://localhost:3001/challenges
+export MEMBER_API_URL=http://localhost:3001/users
+npm start
+```
+
+- Import the collection and environment into your POSTMAN app and run the test case from top to down.

config/default.js

@@ -6,5 +6,16 @@ module.exports = {
   LOG_LEVEL: process.env.LOG_LEVEL || 'debug',
   PORT: process.env.PORT || 3000,
 
-  MONGODB_URL: process.env.MONGODB_URL || 'mongodb://localhost:27017/leaderboardDB'
+  MONGODB_URL: process.env.MONGODB_URL || 'mongodb://localhost:27017/leaderboardDB',
+  CHALLENGE_API_URL: process.env.CHALLENGE_API_URL || 'https://api.topcoder-dev.com/v3/challenges',
+  MEMBER_API_URL: process.env.MEMBER_API_URL || 'https://api.topcoder-dev.com/v3/users',
+
+  GROUP_IDS: process.env.GROUP_IDS || '202343,20000000', // Comma separated string of Group IDs
+
+  AUTH0_URL: process.env.AUTH0_URL || 'https://topcoder-dev.auth0.com/oauth/token',
+  AUTH0_AUDIENCE: process.env.AUTH0_AUDIENCE || 'https://m2m.topcoder-dev.com/',
+  TOKEN_CACHE_TIME: process.env.TOKEN_CACHE_TIME || 90,
+  AUTH0_CLIENT_ID: process.env.AUTH0_CLIENT_ID || '8QovDh27SrDu1XSs68m21A1NBP8isvOt',
+  AUTH0_CLIENT_SECRET: process.env.AUTH0_CLIENT_SECRET || '3QVxxu20QnagdH-McWhVz0WfsQzA1F8taDdGDI4XphgpEYZPcMTF4lX3aeOIeCzh',
+  AUTH0_PROXY_SERVER_URL: process.env.AUTH0_PROXY_SERVER_URL
 }

config/test.js

@@ -0,0 +1,9 @@
+/**
+ * Test configuration file
+ */
+
+module.exports = {
+  CHALLENGE_API_URL: 'https://api.topcoder-dev.com/v3/challenges',
+  MEMBER_API_URL: 'https://api.topcoder-dev.com/v3/users',
+  MOCK_API_PORT: 3001
+}