Module Assembly - TopCoder NodeJS Get Marathon Match Challenge Reg Info 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.

This contest is going to implement the Get Marathon Match Challange Reg Info API.

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.

Get Marathon Match Challenge Reg Info API

The path will be like "/:apiVersion/data/marathon/challenges/:roundId/regInfo", the current user will be already set by Authentication Middleware. This API should use GET method.

Anonymous user will be forbbiden to use this API.

This API is going to minic the same functionality when first clicking the the Register button for Marathon Match Challenges, which is implemented in com.topcoder.web.tc.codinginterface.longcontest.controller.request.ViewReg

and web_module/src/main/com/topcoder/web/codinginterface/longcontest/view/reg.js

You can find them in web_module project, all the integration code is already in repository. If you are forbbiden to access the following link, please send request to support@topcoder.com for svn access.

It mainly covers following parts.

• General registration checking, please reuse any existing checking logic in Register Marathon Match API
• Load round terms
• Load round questions

the expected response will be like

{
    term: {
        contestName: "Marathon Match 82",
        roundtName: "Marathon Match 82 ",
        termsContent: "Marathon Match 82  Terms Content"
    },
    questions: [
        {
            id: 1,
            style: "Single Choice/Multiple Choice/Long Answer/Short Answer",
            type: "Tournament Survey Question", -- check question_type table.
            text: "Question Text 1",
            answers: [
                {
                    id: 1,
                    text: "Answer 1",
                    sortOrder: 1,
                    correct: true
                },
                {
                    id: 2,
                    text: "Answer 2",
                    sortOrder: 2,
                    correct: false
                },
            ]
        },
    ]
}

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

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

Heroku Deployment

Submitters need to include the heroku deployment information, like heroku url, and how to verify with heroku deployment, in case there is a problem to deploy your submission. This is just a aid reference, as submitters can deploy after submission.

Reviewers will have to provide the heroku deployment information in the reviewer scorecard also, this will be good for appeals to figure out the problems inside the reviewers' deployment. This will be part of reviewer rating judgement also.

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.