Module Assembly - Integrating Forums Wrapper with Challenge Registration API

Project Overview

TopCoder and the TopCoder community have worked hard to get the platform to its currently level of maturity, but we're far from done. It's time to take the platform to the next level. TopCoder is going to start taking some steps to open up the platform API to the outside and community developers so they could incorporate it in their websites, applications or build their own applications (web, mobile or desktop).

The ultimate goal is to open up and build an "API" that is targeting all different type of audiences - Software and Studio Competitors, SRM/MM competitors, Copilots, Admins and TopCoder partners - each audience will have different interests and usages of the API, so it will be a huge project and we need to make sure that we are in the right direction from the beginning.

Competition Task Overview

Please raise questions as quick as you can, I am familiar with related database and code base, I can provide as much support as I can.

Currently, we have provided installation guide for different environments, like CentOS 6.x, Ubuntu, Mac OS and Windows. please check https://github.com/cloudspokes/tc-api/wiki

The updated code must still deploy and work on heroku - any submission which can't be deployed on heroku successfully will be failed in screening phase - primary reviewer must check this.

The implementation will base on the node.js version of TC platform API - https://github.com/cloudspokes/tc-api. Please follow the existing actionhero pattern for your development.

Challenge Registration API Update

Previously, we have implemented the Challenge Registration API without implementing the logic to set the forum permissions.

And we have worked out the logic to call Forums EJB in NodeJS. The code can be found at https://github.com/cloudspokes/forums-wrapper (The winning submission will be also in fourms for environment setup).

For this contest, you are expected to integrate the forums operation with challenge registration API.

Followings are the high level requirements.

1. update package.json to have forums-wrapper module loaded.
2. update the challenge registration API to call the forums-wrapper for granting forum access, notes, only software challenges has this logic.
3. Add a control variable in config.js and overridable by environment variable, default to false, so we can toggle the forums operation easily. As for VM environment, the forums is unavaiable.
4. Setup the forums based on the winning submission of Forums Wrapper contest.
5. Manually test the Challenge Registration API with various software challenge types, and fix the problems if there is any.
   • Manually create challenges through TopCoder Cockpit
   • use Postman or curl command to manually test the challenge Registration API, making sure it is working properly.
   • You can include a screencast to demonstrate your manual testing (the video can be uploaded to www.screencast.com and password protected).

Existing Code Reference

Please find the following code for reference.

If you are forbbiden to access the following link, please send request to subversion@topcoder.com for svn access.

• Register (Develop)
• Register (Design)

Update API Doc

the apiary.apib  should be updated to describe the API.

Standarize Query Naming Convension

we like to use the underscore approach in all SQL queries under the queries directory, please follow same approach.

Notes, for the JSON data returned, we will use camelCase approach.

Testing

Please write functional tests for the new API.

The API Framework supports tests. Use supertest with mocha. Don't install mocha globally.

you must use mocha BDD style (which is the default), within that, you can optionally use chai.

Please check Test Creation Guide page in wiki

Code Format

All code must pass jslint. You may use "nomen: true".

Winner Only

Winner will create pull request against the main github repo in final fix phase and help merge with master. The changed files should be unix style, you can use dos2unix command to convert it before commiting.

Virutal Machines (VMs)

VM specific information is found here: http://www.topcoder.com/wiki/display/docs/VM+Image+2.5

Upon registration as a submitter or reviewer you will need to request a VM based on the TopCoder systems image. The VM will be active through aggregation review, after which it will be terminated except for the winner's and the reviewers'. To request your image, please post in contest forum.

Before requesting your VM, you need to ensure that you have an SSH key created and in your member profile. Instructions to do so are here: http://www.topcoder.com/wiki/display/projects/Generate+SSH+Key, and instructions to connect afterwards are here: http://www.topcoder.com/wiki/display/projects/Connect+Using+SSH+Key.

Please realize that VMs are currently issued manually. We make every attempt to issue the VM as soon as it is requested, however, there may be delays of up to 12 hours depending on time of day when you request. We encourage everyone to request a VM as soon as possible to minimize any such delays.