Challenge Overview
Challenge Objectives
-
Create a wrapper for Topcoder Submission API
-
The wrapper is intended to be used as a public module for use in other applications.
Project Background
-
Submission API is a project that deals with 4 resources associated with the Topcoder Platform - submission, reviews, review summations and review types.
-
It provides a CRUD api for the mentioned resources.
Technology Stack
-
Nodejs version 8
Code access
You are writing the wrapper and there is no initial code base to start off with
Individual requirements
Create a wrapper for the Review Type resource of Submission API (Major Requirement)
-
Submission API source code can be found here. In particular, the swagger specification for the api can be found here.
-
Only the Review Type resource is in scope for this contest.
-
Create a wrapper for the submission api’s review type resource. The “Wrapper” will be a nodejs module that will be used instead of directly making HTTP calls to the submission api. The wrapper will expose methods that will be used in place of the direct http calls to the submission api that we are doing currently.
-
You can use the tc-bus-api-wrapper module as a reference. This wrapper is for the Topcoder Bus API.
-
In addition to exposing the methods for each endpoint related to the Review Type resource, you also have to write documentation and tests for the module. These are major requirements too
-
The documentation and tests will be very similar to the documentation of the bus api wrapper, where the user can view the list of exposed methods, their usage etc.
Deployment guide and validation document
You are creating a nodejs module. As such there is nothing to “deploy”. Your documentation will be describing how to use the module in any other nodejs based app. The documentation is part of the major requirement.
Important Notes
-
Use async await pattern
-
Use standard as your linter. Ensure there are no lint errors in your submission.
-
Typescript is not allowed. No build or compilation of code expected.
-
Use mocha and chai for testing
Final Submission Guidelines
Zip your solution and upload to Topcoder.