Module Assembly - TopCoder NodeJS Submit Design Submissions API

Project Overview

The submission phase for this contest will be 6 days considering the complexity.

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 Submit Design Challenge Submission API for Submission and Final Fix.

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.

Submit Design Challenge Submission API

The path will be like /:apiVersion/design/challenges/:challangeId/submit, it will use POST method to submit the content.

It will take extra optional type parameter, the value will be either submission or finalfix, if not specified, it will be default to submission.

For other parameters, please check the corresponding Submit class for detail, like submission, submissionSource, submissionPreview, font, fontName, fontURL, stockArtName, stockArtURL, sortArtFile, submissionComment, submissionRank etc.

The logic related to generateAlternateReppresentations method can be leave to next phase.

The API will do authentication based on jwt, please check Authentication Middleware, the user info will be available when reaching into the action code.

if no jwt passed, throw 401 Unauthorized error,

if jwt is present, but the user is not registered for that challange, throw 403 Forbidden error.

if jwt is present and the user is registered for that challange, submit the solution properly.

if the corresponding phase (submission phase or final fix phase) is not open, throw proper error.

The API should be transactional.

Existing Code Reference

Please find the following code for reference.

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

• Submit
• submit.jsp

Update API Doc

the apiary.apib  should be updated to describe the Submit Design Challenge Submission 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

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.

Technology Overview

• JavaScript
• Node.js 0.10.x
• actionhero.js framework
• supertest
• mocha