Add a few example tasks.
Change Log
- example tasks:
- add the migration that creates a few example tasks:
- add the utility for applying migrations;
- add the solutions for the example tasks.
- add the migration that creates a few example tasks:
Features
- RESTful API:
- models:
- task model:
- storing:
- author ID;
- title;
- description;
- boilerplate code;
- test cases:
- all test cases are represented by a single string;
- operations:
- getting all tasks:
- calculate a total correctness flag based on all solutions of a requesting author;
- sort the results by creation time in descending order;
- process pagination:
- implemented using an offset and a limit;
- getting a single task by an ID:
- calculate a total correctness flag based on all solutions of a requesting author;
- creating:
- automatically format a task boilerplate code;
- updating by an ID:
- allowed for its author only;
- automatically format a task boilerplate code;
- deleting by an ID:
- allowed for its author only;
- getting all tasks:
- storing:
- solution model:
- storing:
- author ID;
- task ID;
- code;
- correctness flag;
- testing result:
- represented by a string;
- operations:
- getting all solutions by a task ID:
- filtered by a requesting author:
- allow a solution task author to get solutions of other authors;
- sort the results by creation time in descending order;
- process pagination:
- implemented using an offset and a limit;
- filtered by a requesting author:
- getting a single solution by an ID:
- allowed for:
- solution author;
- solution task author;
- allowed for:
- creating:
- automatically format a solution code;
- updating by an ID:
- performed by a queue consumer only (see below);
- formatting a solution code;
- getting all solutions by a task ID:
- storing:
- task model:
- representing:
- in a JSON:
- payloads:
- of requests;
- of responses;
- payloads:
- as a plain text:
- errors;
- in a JSON:
- models:
- server:
- additional routing:
- serving static files;
- storing settings in environment variables;
- supporting graceful shutdown;
- logging:
- logging requests;
- logging errors;
- panics:
- recovering on panics;
- logging of panics;
- additional routing:
- authentication:
- use the Bearer authentication scheme based on JSON Web Tokens:
- store in a JWT claims:
- expiration time claim;
- user claim:
- contains a whole user model;
- store in a JWT claims:
- generate a token signing key automatically by default;
- user model:
- storing:
- username (unique);
- password hash:
- generated using the bcrypt function;
- flag indicating whether the user is disabled or not;
- storing:
- use the Bearer authentication scheme based on JSON Web Tokens:
- databases:
- storing data in the PostgreSQL database;
- interaction with queues:
- using the RabbitMQ message broker;
- common properties:
- automatic declaring of the used queues;
- passing of a message data in JSON;
- operations:
- producing solutions:
- concurrent producing;
- consuming solution results:
- concurrent consuming;
- once requeue the solution on failure;
- producing solutions:
- utilities:
- utility for managing users:
- commands:
- add a user:
- parameters:
- username;
- password;
- password hashing cost;
- flag indicating the need to generate a password;
- generated password length;
- flag indicating whether the user is disabled or not;
- parameters:
- update a user:
- parameters:
- username;
- new username;
- password;
- password hashing cost;
- flag indicating the need to generate a password;
- generated password length;
- flag indicating whether the user is disabled or not;
- flag indicating whether the user is enabled or not;
- can update the user fields individually;
- parameters:
- add a user:
- commands:
- utility for managing users:
- distributing:
- Docker image;
- Docker Compose configuration.