Merge remote-tracking branch 'github/develop'

Author: jmgasper

TCXSequenceDiagrams.tcuml

@@ -24,6 +24,9 @@ The following config parameters are supported, they are defined in `src/config.j
 | HOOK_BASE_URL            | The base URL of the topcoder-x-receiver, used when adding webhooks automatically to repositories | |
 | TOPCODER_ENV | The topcoder environment to use, can support 'dev' or 'prod' | 'dev'                     |
 |LABELS| Labels we are going to add to the repository in the form of array of object with `name` and `color` property. Color should be hex code without hash||
+|ALLOWED_TOPCODER_ROLES| The allowed Topcoder role to use Topcoder X app| see configuration |
+|COPILOT_ROLE| The role to identify copilot|'copilot'|
+|HELP_LINK| The link for help| 'https://github.com/topcoder-platform/topcoder-x-ui/wiki'|
 
 ## GitHub OAuth App Setup
 

configuration.md

@@ -76,6 +76,20 @@ _.forEach(routes, (verbs, path) => {
         return next();
       });
     }
+    if (def.allowedRoles) {
+      actions.push((req, res, next) => {
+        // check if user has allowed roles
+        if (_(req.currentUser.roles).map((i) => i.toLowerCase())
+          .intersection(_.map(def.allowedRoles, (j) => j.toLowerCase())).size() === 0) {
+          const statusCode = 403;
+          return res.status(statusCode).json({
+            code: 'Forbidden',
+            message: 'You are not allowed to access this resource.',
+          });
+        }
+        return next();
+      });
+    }
     actions.push(method);
     app[verb](`/api/${config.API_VERSION}${path}`, actions);
   });

src/app.js

@@ -0,0 +1,45 @@
+# How to work with git tickets
+
+The basic flow for handling a ticket is as follows:
+
+1. Assign the ticket to yourself, change the label to "tcx_Assigned", remove the "tcx_OpenForPickup" label.  Please only assign tickets to yourself when you are ready to work on it.  I don't want tickets assigned to someone and then not have them work on a ticket for 24 hours.  The goal here is a quick turnaround for the client.  If you can't work on a ticket immediately, leave it for someone else.
+
+1. Complete the ticket and create a merge request within 24 hours.  Please ensure your merge request can be merged automatically and that it's against the latest commit in Git when you create it.
+
+1. Change the label on the ticket to "tcx_ReadyForReview"
+
+After seeing a ticket marked as "tcx_ReadyForReview", the copilot will review that ticket, usually within 24 hours.
+
+Note that you are expected to keep your changes in-sync with Git - make sure to do a pull before you push changes to make sure there aren't any merge issues.
+
+### Accepted fix
+
+If a fix is accepted, a payment ticket will be created on the Topcoder platform within 5-10 minutes of the issue being closed.  You should see the payment in your PACTs within 24 hours.
+
+### Rejected fix
+
+If a fix is rejected, a comment, and possibly a screenshot, will be added to the ticket explaining why the fix was rejected.  The status will be changed to "tcx_Feedback".
+
+**If a fix is rejected, that ticket is your priority.  You should not assign yourself any more tickets until you complete the required additional fixes!**
+
+# Payment amounts
+
+Each ticket in GitLab has a dollar value.  That is the amount you will be paid when the ticket is completed, merged, and verified by the copilot.  Note that there is still a 30 day waiting period as the payment will be treated as a regular TopCoder challenge payment.
+
+# Important Rules:
+
+- You can assign any unassigned issue to yourself with an "Open for pick up" label (first come first serve)
+
+- You can only assign **ONE AT A TIME**. The nature of it being assigned will indicate it is not available to anyone else.
+
+- You will fix the ticket by committing changes to the master branch.
+
+- After marking a ticket "tcx_ReadyForReview" you are eligible to accept another. You do _NOT_ need to wait for the copilot to validate your fix.
+
+- You can do as many tickets as you want, as long as you follow the rules above.
+
+- If an assigned task is not done in 24 hours, you will need to explain why it is not completed as a comment on the ticket.
+
+- You can ask questions directly on the GitLab ticket.
+
+### ANYONE NOT FOLLOWING THE RULES ABOVE WILL BE WARNED AND POTENTIALLY LOSE THEIR GITLAB ACCESS!

src/assets/WorkingWithTickets.md

@@ -15,10 +15,10 @@ module.exports = {
   MONGODB_URI: process.env.MONGODB_URI || 'mongodb://localhost:27017/topcoderx',
   SESSION_SECRET: process.env.SESSION_SECRET || 'kjsdfkj34857',
   // Github and gitlab client id and secret
-  GITHUB_CLIENT_ID: process.env.GITHUB_CLIENT_ID || '',
-  GITHUB_CLIENT_SECRET: process.env.GITHUB_CLIENT_SECRET || '',
-  GITLAB_CLIENT_ID: process.env.GITLAB_CLIENT_ID || '',
-  GITLAB_CLIENT_SECRET: process.env.GITLAB_CLIENT_SECRET || '',
+  GITHUB_CLIENT_ID: process.env.GITHUB_CLIENT_ID || 'ae39bea2a2a23f1dd032',
+  GITHUB_CLIENT_SECRET: process.env.GITHUB_CLIENT_SECRET || 'f31dd2da12015f60372a5312a40a06b517a88702',
+  GITLAB_CLIENT_ID: process.env.GITLAB_CLIENT_ID || 'af4c1ea3d12783e55470a6604c169b2cdc03734c7e3969f7f4336325f6e0e6b4',
+  GITLAB_CLIENT_SECRET: process.env.GITLAB_CLIENT_SECRET || '8906a8e924df81ddadd12b37ee98767cfba3084ca3c9d52a5753412da8d9879e',
 
   // used as base to construct various URLs
   WEBSITE: process.env.WEBSITE || 'http://topcoderx.topcoder-dev.com',
@@ -30,10 +30,13 @@ module.exports = {
     ssl: {
       cert: process.env.KAFKA_CLIENT_CERT || fs.readFileSync('./kafka_client.cer'), // eslint-disable-line no-sync
       key: process.env.KAFKA_CLIENT_CERT_KEY || fs.readFileSync('./kafka_client.key'), // eslint-disable-line no-sync
+      passphrase: 'secret', // NOTE:* This configuration specifies the private key passphrase used while creating it.
     },
   },
-  HOOK_BASE_URL: process.env.HOOK_BASE_URL || 'http://x.topcoder-dev.com',
+  HOOK_BASE_URL: process.env.HOOK_BASE_URL || 'http://topcoderx.topcoder-dev.com',
   TOPCODER_ENV: process.env.TOPCODER_ENV || 'dev',
-  LABELS: process.env.LABELS || [{ name: 'Open for pickup', color: '428BCA' }, { name: 'Assigned', color: '004E00' }, { name: 'Ready for review', color: 'D1D100' }, { name: 'Paid', color: '7F8C8D' }, { name: 'Feedback', color: 'FF0000' }, { name: 'Fix accepted', color: '69D100' }],
+  LABELS: process.env.LABELS || [{ name: 'tcx_OpenForPickup', color: '428BCA' }, { name: 'tcx_Assigned', color: '004E00' }, { name: 'tcx_ReadyForReview', color: 'D1D100' }, { name: 'tcx_Paid', color: '7F8C8D' }, { name: 'tcx_Feedback', color: 'FF0000' }, { name: 'tcx_FixAccepted', color: '69D100' }],
   ALLOWED_TOPCODER_ROLES: process.env.ALLOWED_TOPCODER_ROLES || ['administrator', 'admin', 'connect manager', 'connect admin', 'copilot', 'connect copilot'],
+  COPILOT_ROLE: process.env.COPILOT_ROLE || 'copilot',
+  HELP_LINK: process.env.HELP_LINK || 'https://github.com/topcoder-platform/topcoder-x-ui/wiki',
 };

src/config.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2018 TopCoder, Inc. All rights reserved.
+ */
+
+/**
+ * This controller exposes application configuration related endpoints.
+ *
+ * @author veshu
+ * @version 1.0
+ */
+const helper = require('../common/helper');
+const AppConfigService = require('../services/AppConfigService');
+
+/**
+ * gets the application configuration required for frontend
+ * @returns {Object} the configuration details
+ */
+async function getAppConfig() {
+  return await AppConfigService.getAppConfig();
+}
+
+module.exports = {
+  getAppConfig,
+};
+
+helper.buildController(module.exports);

src/controllers/AppConfigController.js

@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2018 TopCoder, Inc. All rights reserved.
+ */
+
+/**
+ * This controller exposes payment endpoints.
+ *
+ * @author kevinkid
+ * @version 1.0
+ */
+const helper = require('../common/helper');
+const CopilotPaymentService = require('../services/CopilotPaymentService');
+
+/**
+ * update payments status
+ * @param {Object} req the request
+ * @param {Object} res the response
+ * @returns {Promise} fetch payment updates execution
+ */
+async function updateAll(req) {
+    return await CopilotPaymentService.updateAll(req.currentUser);
+}
+
+/**
+ * get all the payment for the current copilot
+ * @param {Object} req the request
+ * @param {Object} res  the response
+ * @returns {Object} the result
+ */
+async function getAll(req) {
+    const payments = await CopilotPaymentService.getAll(req.query, req.currentUser);
+    const active = [];
+    const closed = [];
+
+    payments.forEach(function (payment) {
+        if (payment.closed === true) {
+            closed.push(payment);
+        } else {
+            active.push(payment);
+        }
+    });
+    return { activePayments: active, closedPayments: closed };
+}
+
+/**
+ * create payment
+ * @param {Object} req the request
+ * @param {Object} res the response
+ * @returns {Object} the result
+ */
+async function create(req) {
+    return await CopilotPaymentService.create(req.currentUser, req.body.payment);
+}
+
+/**
+ * update payment item
+ * @param {Object} req the request
+ * @param {Object} res the response
+ * @returns {Object} the result
+ */
+async function update(req) {
+    return await CopilotPaymentService.update(req.currentUser, req.body.payment);
+}
+
+/**
+ * remove payment item
+ * @param {Object} req the request
+ * @param {Object} res the response
+ * @returns {Object} the result
+ */
+async function remove(req) {
+    return await CopilotPaymentService.remove(req.params.id, req.currentUser);
+}
+
+
+module.exports = {
+    getAll,
+    create,
+    update,
+    remove,
+    updateAll
+};
+
+helper.buildController(module.exports);

src/controllers/CopilotPaymentController.js

@@ -60,12 +60,23 @@ async function createHook(req) {
   return await ProjectService.createHook(req.body, req.currentUser.handle);
 }
 
+/**
+ * adds the wiki rules the project's repository
+ * @param {Object} req the request
+ * @param {Object} res the response
+ * @returns {Object} the result
+ */
+async function addWikiRules(req) {
+  return await ProjectService.addWikiRules(req.body, req.currentUser.handle);
+}
+
 module.exports = {
   create,
   update,
   getAll,
   createLabel,
   createHook,
+  addWikiRules,
 };
 
 helper.buildController(module.exports);

src/controllers/ProjectController.js

@@ -0,0 +1,66 @@
+'use strict';
+
+angular.module('topcoderX')
+    .controller('AddCopilotPaymentController', ['$scope', '$log', '$state', 'CopilotPaymentService', 'ProjectService', '$filter', '$rootScope', '$timeout', 'Alert',
+        function ($scope, $log, $state, CopilotPaymentService, ProjectService, $filter, $rootScope, $timeout, Alert) {
+            // below logic is trying to identify whether we are editing a payment
+            $scope.editing = true;
+            $scope.projects = [];
+            $scope.payment = {
+                project: null,
+                amount: null,
+                description: '',
+            };
+            if ($rootScope.payment) {
+                $scope.title = 'Edit a Payment';
+                $scope.payment = angular.copy($rootScope.payment);
+                $scope.payment.id = $rootScope.payment.id;
+                $scope.payment.project = $rootScope.payment.project.id;
+                $scope.editing = true;
+            } else {
+                $scope.title = 'Add a Payment';
+                $scope.editing = false;
+            }
+
+            // get topcoderx projects
+            $scope.getProjects = function () {
+                ProjectService.getProjects().then(function (response) {
+                    $scope.projects = response.data;
+                }).catch(function (error) {
+                    _handleError(error, 'There are no projects in Topcoder-X. Please create a project first.');
+                });
+            };
+
+            $scope.getProjects();
+
+            // handle error output
+            function _handleError(error, defaultMsg) {
+                const errMsg = error.data ? error.data.message : defaultMsg;
+                Alert.error(errMsg, $scope);
+            }
+
+            // create/update payment item
+            $scope.save = function () {
+                if (!$scope.editing) {
+                    CopilotPaymentService.create($scope.payment).then(function () {
+                        $state.go('app.copilotPayments');
+                    }).catch(function (error) {
+                        _handleError(error, 'An error occurred while creating Payment.');
+                    });
+                }
+                if ($scope.editing) {
+                    CopilotPaymentService.update({
+                        id: $scope.payment.id,
+                        project: $scope.payment.project,
+                        amount: $scope.payment.amount,
+                        description: $scope.payment.description,
+                    }).then(function () {
+                        $rootScope.payment = null;
+                        $state.go('app.copilotPayments');
+                    }).catch(function (error) {
+                        _handleError(error, 'An error occurred while updating Payment.');
+                    });
+                }
+            };            
+        }
+    ]);

src/front/src/app/add-copilot-payment/add-copilot-payment-controller.js

@@ -0,0 +1,43 @@
+<div ng-controller="AddCopilotPaymentController">
+    <div class="col-md-10 col-md-offset-1" ng-include src="'components/alert/alert.html'"></div>
+    <div class="row wrapper border-bottom white-bg page-heading">
+        <div class="col-lg-4">
+            <h2>{{title}}</h2>
+        </div>
+    </div>
+
+    <div class="wrapper wrapper-content animated fadeInRight">
+        <div class="row">
+            <div class="col-lg-12">
+                <div class="text-center m-t-lg">
+                    <form name="paymentForm">
+                        <label class="form-label">Project:</label>
+                        <select ng-model="payment.project" class="form-control" required>
+                            <option ng-repeat="project in projects" value={{project.id}}>{{project.title}}</option>
+                        </select>
+                        <span ng-show="paymentForm.payment.project.$touched && paymentForm.payment.project.$invalid">The payment Project is required.</span>
+                        <br />
+                        <label class="form-label">Amount:</label>
+                        <input class="form-control" type="number" ng-model="payment.amount" required/>
+                        <span ng-show="paymentForm.payment.amount.$touched && paymentForm.payment.amount.$invalid">The payment Amount is required.</span>
+                        <br />
+                        <label class="form-label">Description:</label>
+                        <input class="form-control" type="text" ng-model="payment.description" required/>
+                        <span ng-show="paymentForm.payment.description.$touched && paymentForm.payment.description.$invalid">The payment Description is required.</span>
+                        <br />
+                        <br />
+                        <button type="submit" class="with-button btn btn-sm btn-info" ng-click="paymentForm.$valid && save()">
+                            <strong>
+                                Save
+                            </strong>
+                        </button>
+                    </form>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+
+
+
+

src/front/src/app/add-copilot-payment/add-copilot-payment.html

@@ -128,8 +128,23 @@ angular.module('topcoderX', [
           templateUrl: 'app/members/member.html',
           controller: 'MemberController',
           controllerAs: 'vm',
+        })
+        .state('app.copilotPayments', {
+            url: '/copilot-payments',
+            templateUrl: 'app/copilot-payments/copilot-payments.html',
+            controller: 'CopilotPaymentsController',
+            controllerAs: 'vm',
+            resolve: { auth: authenticate }
+        })
+        .state('app.addPayment', {
+            url: '/copilot-payment',
+            templateUrl: 'app/add-copilot-payment/add-copilot-payment.html',
+            controller: 'AddCopilotPaymentController',
+            controllerAs: 'vm',
+            resolve: { auth: authenticate }
         });
 
+
       $urlRouterProvider.otherwise('/app/main');
       $compileProvider.aHrefSanitizationWhitelist(/^\s*(https?|ftp|mailto|tel|file|blob):/);
     }]);