Module Assembly - TC API - Port UnifiedSubmissionValidator Logic For Analyzing Submitted File

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.

Previously, we have run the Module Assembly - TopCoder NodeJS Submit Design Submissions API to implement the related logic except the generateAlternateRepresentations method. This contest is going to implement the UnifiedSubmissionValidator related logic in generateAlternateRepresentations method.

Analyze Sumitted File

In the generating alternative representation process, there are two main parts: analyze the submitted file and generate files with alternative representation of the submissions.

This contest is going to port the logic (methods) provided in UnifiedSubmissionValidator class to node.js,  so we can use them in the generateAlternateRepresentations logic.

the core usage of UnifiedSubmissionValidator class is  in FileGenerator, like

• UnifiedSubmissionValidator.getBundledFileParser
• BundledFilteAnalyzer.analyze
• BundledFilteAnalyzer.isPreviewImageAvailable
• UnifiedSubmissionValidator.getFileName
• BundledFilteAnalyzer.getPreviewImageContent
• BundledFilteAnalyzer.getPreviewIMageFileType
• BundledFilteAnalyzer.isPreviewFileAvaiable
• UnifiedSubmissionValidator.calcAlternateFileName
• BundledFilteAnalyzer.getFiles
• UnifiedSubmissionValidator.getFileType
• may be more, please check the java source code.

Please implement them as utility, so we can reuse these method to port the generateAlternateRepresentations method.

But please provide ways to verify that your implementation is working exactly like the java classes.

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.