Merge branch 'user-profile' into 'develop'

changes related to  https://www.topcoder.com/challenges/30064860

See merge request luettich/processor!9

Author: jmgasper

README.md

@@ -18,8 +18,6 @@ eslint is used to lint the javascript source code:
 npm run lint
 ```
 
-
-
 ## Configuration
 
 The following config parameters are supported, they are defined in `config/default.js` and can be configured in system environment:
@@ -28,24 +26,21 @@ The following config parameters are supported, they are defined in `config/defau
 | Name                           | Description                                | Default                          |
 | :----------------------------- | :----------------------------------------: | :------------------------------: |
 | LOG_LEVEL                      | the log level                              |  debug                           |
-| TOPIC                          | the kafka subscribe topic name             |  events_topic                    |
+| TOPIC                          | the kafka subscribe topic name             |  tc-x-events                    |
+| PARTITION                  | the kafka partition            |  0|
 | KAFKA_OPTIONS                  | the connection option for kafka            |  see below about KAFKA options                  |
-| MONGODB_URL  | the MongoDB URL | mongodb://127.0.0.1:27017/events |
+| MONGODB_URL  | the MongoDB URL which must be same as Ragnar tool | mongodb://127.0.0.1:27017/ragnar |
+|TC_DEV_ENV| the flag whether to use topcoder development api or production| false|
 | TC_AUTHN_URL | the Topcoder authentication url | https://topcoder-dev.auth0.com/oauth/ro |
 | TC_AUTHN_REQUEST_BODY | the Topcoder authentication request body. This makes use of some environment variables: `TC_USERNAME`, `TC_PASSWORD`, `TC_CLIENT_ID`, `CLIENT_V2CONNECTION` | see `default.js` |
 | TC_AUTHZ_URL | the Topcoder authorization url | https://api.topcoder-dev.com/v3/authorizations |
 | NEW_CHALLENGE_TEMPLATE | the body template for new challenge request. You can change the subTrack, reviewTypes, technologies, .. here | see `default.js` |
 | NEW_CHALLENGE_DURATION_IN_DAYS | the duration of new challenge | 5 |
-| GITHUB_ADMIN_TOKEN| the github repo admin/owner personal access token | see below section 'GitHub OAuth Admin Token'|
 | NODE_MAILER_OPTIONS| the node mailer smtp options, see [here](https://nodemailer.com/smtp/ for more detail)| see `default.js` |
 |EMAIL_SENDER_ADDRESS| the email sender email address||
 |ISSUE_BID_EMAIL_RECEIVER| the email receiver about bid email||
-|TC_RAGNAR_USER_MAPPING_URL| the api URL of Ragnar self service tool to get user mapping | see `default.js`|
-|TC_RAGNAR_ADMIN_LOGIN_BODY| the login request body of Admin user for Ragnar self service tool| see `default.js`|
-|TC_RAGNAR_LOGIN_URL| the api URL of Ragnar self service tool to login| see `default.js`|
-|TC_DEV_ENV| the flag whether to use topcoder development api or production| false|
+|TC_URL| the base URL of topcoder to get the challenge URL| defaults to `https://www.topcoder-dev.com`|
 |GITLAB_API_BASE_URL| the URL for gitlab host| defaults to `https://gitlab.com`|
-|GITLAB_ADMIN_TOKEN|the gitlab repo admin/owner personal access token | see below section 'Gitlab Admin Token'|
 
 KAFKA_OPTIONS should be object as described in https://github.com/SOHU-Co/kafka-node#kafkaclient
 For using with SSL, the options should be as
@@ -59,42 +54,30 @@ For using with SSL, the options should be as
  }
 ```
 
-## GitHub OAuth Admin Token
-
-- login into github.com
-- click the upper right avatar, then click `Settings`
-- click the left pannel --> Developer settings --> Personal access tokens
-- click the `Generate new token`, fill in the fields,
-  select all scopes,
-- after creating the token, you can see personal access token,
-  these should be set to GITHUB_ADMIN_TOKEN environment variables
+## Local Deployment
 
-## Gitlab Admin Token
+```shell
+npm start
+```
 
-- Log in to your GitLab account.
-- Go to your Profile settings.
-- Go to Access tokens.
-- Choose a name and optionally an expiry date for the token.
-- Choose the `api` scope at minimum.
-- Click on Create personal access token.
-- after creating the token, you can see personal access token,
-  these should be set to GITLAB_ADMIN_TOKEN environment variables.
+## Setup for verification
+Before verifying the tool, 4 service needs be configured and run them
+- processor
+- receiver
+- Ragnar Tool
+- Topcoder X (both backend and UI)
 
-## Local Setup
+First login in Ragnar tool with admin and Add owner for which requires topcoder handle, git host's username and type of git host.
 
-Create a MongoDB database, and configure `MONGODB_URL`.
+Go to Topcoder X UI login with above used topcoder username and
+- go to settings and make sure git hosts are correctly setup, if not click setup and authorize to setup.
 
-```shell
-npm start
-```
+- Go to Topcoder X UI and go to project management and add a project from git account and click save, and edit the same project and click 'Add Webhooks' button (you need to add personnel access token), verify that webhooks are set up correctly on git host's project.
 
-Run and configure the Ragnar self-service tool
+Now, receiver service can receive the webhooks from git host's project and processor can processes the requests. Now you can verify this service by following the verfication steps below
 
 ## Verification
 
-- properly config and run the `receiver` app.
-- properly config and run the `processor` app.
-- properly config and run the Ragnar self service tool.
 - create an issue in the repo, you can see the logs in `receiver` and `processor`, the `issue.created` event is generated.
 - update an issue in the repo, you can see the logs in `receiver` and `processor`, the `issue.updated` event is generated.
 - create a comment on an issue, you can see the logs in `receiver` and `processor`, the `comment.created` event is generated.

config/default.js

@@ -2,7 +2,7 @@
  * Copyright (c) 2017 TopCoder, Inc. All rights reserved.
  */
 'use strict';
-
+const fs = require('fs');
 /**
  * This module is the configuration of the app.
  * Changes in 1.1:
@@ -23,7 +23,7 @@ module.exports = {
       key: process.env.KAFKA_CLIENT_CERT_KEY || fs.readFileSync('./kafka_client.key')
    }
   },
-  MONGODB_URL: process.env.MONGODB_URI || 'mongodb://127.0.0.1:27017/topcoder-x-events',
+  MONGODB_URL: process.env.MONGODB_URI || 'mongodb://127.0.0.1:27017/ragnar',
   TC_DEV_ENV: process.env.NODE_ENV === 'production' ? false : true,
   TC_AUTHN_URL: process.env.TC_AUTHN_URL || 'https://topcoder-dev.auth0.com/oauth/ro',
   TC_AUTHN_REQUEST_BODY: {
@@ -66,8 +66,6 @@ module.exports = {
   // NOTE: if subTrack is FIRST_2_FINISH,
   // this config has no effect since the ***EndsAt will be set automatically by TC APIs
   NEW_CHALLENGE_DURATION_IN_DAYS: process.env.NEW_CHALLENGE_DURATION_IN_DAYS || 5,
-  GITHUB_ADMIN_TOKEN: process.env.GITHUB_ADMIN_TOKEN || '',
-  GITLAB_ADMIN_TOKEN:process.env.GITHUB_ADMIN_TOKEN || '',
   // node mailer option
   NODE_MAILER_OPTIONS: {
     host: process.env.SMTP_HOST || process.env.MAILGUN_SMTP_SERVER || 'smtp.gmail.com',
@@ -80,11 +78,6 @@ module.exports = {
   },
   EMAIL_SENDER_ADDRESS: process.env.EMAIL_SENDER_ADDRESS || '',
   ISSUE_BID_EMAIL_RECEIVER: process.env.ISSUE_BID_EMAIL_RECEIVER || '',
-  TC_RAGNAR_USER_MAPPING_URL: process.env.TC_RAGNAR_USER_MAPPING_URL || 'http://ragnar.topcoder-dev.com/api/v1/admin/tcuser',
-  TC_RAGNAR_ADMIN_LOGIN_BODY: {
-    username: "admin",
-    password: "password"
-  },
-  TC_RAGNAR_LOGIN_URL: process.env.TC_RAGNAR_LOGIN_URL || 'http://ragnar.topcoder-dev.com/api/v1/admin/login',
-  TC_URL: 'https://www.topcoder-dev.com'
+  TC_URL: process.env.TC_URL || 'https://www.topcoder-dev.com',
+  GITLAB_API_BASE_URL: process.env.GITLAB_API_BASE_URL || 'https://gitlab.com',
 };

constants.js

@@ -0,0 +1,28 @@
+'use strict';
+
+/*
+ * Copyright (c) 2018 TopCoder, Inc. All rights reserved.
+ */
+
+/**
+ * Define constants.
+ *
+ * @author TCSCODER
+ * @version 1.0
+ */
+
+// The user types
+const USER_TYPES = {
+  GITHUB: 'github',
+  GITLAB: 'gitlab'
+};
+
+// The user roles
+const USER_ROLES = {
+  OWNER: 'owner'
+};
+
+module.exports = {
+  USER_ROLES,
+  USER_TYPES
+};

models/Challenge.js

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2018 TopCoder, Inc. All rights reserved.
+ */
+
+/**
+ * This module contains the schema of the Challenge.
+ *
+ * @author TCSCODER
+ * @version 1.0
+ */
+'use strict';
+
+const mongoose = require('mongoose');
+
+const schema = new mongoose.Schema({
+  title: {type: String, required: true},
+  tcDirectId: {type: Number, required: true},
+  repoUrl: {type: String, required: true},
+  rocketChatWebhook: {type: String, required: true},
+  rocketChatChannelName: {type: String, required: true},
+  archieved: {type: String, required: true},
+  username: {type: String, required: true}
+});
+
+module.exports = schema;

models/User.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2018 TopCoder, Inc. All rights reserved.
+ */
+/**
+ * This defines user model.
+ */
+'use strict';
+
+const _ = require('lodash');
+const mongoose = require('mongoose');
+const constants = require('../constants');
+
+const Schema = mongoose.Schema;
+
+const schema = new Schema({
+  topcoderUsername: {type: String, required: true},
+  userProviderId: {type: Number, required: true},
+  username: {type: String, required: true},
+  role: {type: String, required: true, enum: _.values(constants.USER_ROLES)},
+  type: {type: String, required: true, enum: _.values(constants.USER_TYPES)},
+  // gitlab token data
+  accessToken: String,
+  accessTokenExpiration: Date,
+  refreshToken: String
+});
+
+schema.index({topcoderUsername: 1});
+schema.index({userProviderId: 1});
+schema.index({username: 1});
+schema.index({role: 1});
+schema.index({type: 1});
+schema.index({topcoderUsername: 1, type: 1}, {unique: true});
+
+module.exports = schema;

models/UserMapping.js

@@ -0,0 +1,20 @@
+/**
+ * This defines user mapping model.
+ */
+'use strict';
+
+const mongoose = require('mongoose');
+
+const Schema = mongoose.Schema;
+
+const schema = new Schema({
+  topcoderUsername: {type: String, required: true, unique: true},
+  githubUsername: String,
+  gitlabUsername: String,
+  githubUserId: Number,
+  gitlabUserId: Number
+});
+
+schema.index({topcoderUsername: 1});
+
+module.exports = schema;

models/index.js

@@ -19,7 +19,10 @@ const connection = mongoose.createConnection(config.MONGODB_URL);
 /* eslint-disable global-require */
 const models = {
   Issue: connection.model('Issue', require('./Issue')),
-  Project: connection.model('Project', require('./Project'))
+  Project: connection.model('Project', require('./Project')),
+  User: connection.model('User', require('./User')),
+  Challenge: connection.model('Challenge', require('./Challenge')),
+  UserMapping: connection.model('UserMapping', require('./UserMapping'))
 };
 /* eslint-enable global-require */