Challenge Overview

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 update the Basic User Profile API to possibly return the private info about the user, including email, name, address, age, gender, and shirt_size.

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.

For this contest, you are expected to update the Basic User Profile API to possibly return the private info about the user and add tests for the new features.

Basic User Profile API

The API path is like /:apiVersion/users/:handle, see https://github.com/cloudspokes/tc-api/blob/master/routes.js#L105

The current implemenation can be found at https://github.com/cloudspokes/tc-api/blob/master/actions/memberStatistics.js#L71-L179

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

So we'd like to update the Basic User Profile API to return the private info.

if no jwt passed, simply return the public info as current.

if jwt passed but not an admin and the same user as request, simply return the public info as current.

if jwt is present and the same user as request (viewing his own profile), return the public info as current plus the private info email, name, address, age, gender, and shirt_size.

if jwt is present and not the same user as request but an admin role, return the public info as current plus the private info email, name, address, age, gender, and shirt_size.

You are expected to

  • update the action code.
  • add/update new queries to return the data.
  • add/update tests to verified the changes
  • update the API doc (apiary.apib) to show different cases based on the current user.

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.

Note: Tests must follow this standard - Tests Creation Guide.docx

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



Final Submission Guidelines

Submission Deliverables

Below is an overview of the deliverables:

  • Source Code Changes including commit hash the changes based on.
  • Deployment guide to configure and verify the application.

Final Submission

For each member, the final submission should be uploaded to the Online Review Tool.

ELIGIBLE EVENTS:

2014 TopCoder(R) Open

Review style

Final Review

Community Review Board

Approval

User Sign-Off

ID: 30039514