- Intro
- Challenge
- Project Screen Shot
- Business Rules and Possible Results
- Installation and Setup Instructions
- Folder Structure
- Project Specifications
- To Do List
API Rest developed for Codility Full Stack developer challenge.
The goal is to develop an api capable of generating tickets, awarded or not, for the traditional USA lottery, Powerball.
Powerball is a popular US lottery game with draws twice a week. For the purposes of this exercise, a Powerball lottery "ticket" includes the date of the draw and one or more "picks". Each "pick" is a set of 5 integers (from 1-69) along with a 6th integer (the Powerball, from 1-26).
For example, a pick for the draw on 2017-11-09 might be:
02 14 19 21 61 25
Your application's API will accept data for a lottery ticket, and respond with whether each pick has won, the prize won per-pick, and the total of all prizes won on the ticket. It is up to you to design and build this API.
The Powerball winning numbers change on each "draw date". In order to determine a win or a loss, your application will have to retrieve the Powerball draw dates and winning numbers from the following public URL:
https://data.ny.gov/resource/d6yy-54nr.json
To calculate the prize, consult the prize matrix image below:
- There is no time limit to this challenge.
- Use your best discretion with the design and requirements, but you can ask questions.
- You must use JavaScript and must extend this code base.
- There is no need for a UI to solve this problem.
- Follow modern JavaScript and Node best practices and conventions to the best of your ability.
- You are free to add packages, tools or improvements to your project as you see fit.
- We expect you to write the kind of feature you would put into production, including tests and documentation as you see fit.
Summary: Returns award ticket for each pick list entered
Description: Accept data for a lottery ticket, and respond with whether each pick has won, the prize won per-pick, and the total of all prizes won on the ticket
- The draw calculations correspond to the rules established by the challenge proposal which is more detailed here.
- Prize values and settlement rules are defined in this project file: /app/constants/powerball-prize-ruls.contastants.js
- The results (winning numbers) are obtained from an external service provided through this link: https://data.ny.gov/resource/d6yy-54nr.json
- Prize values are multiplied by the multiplication factor informed by the external api for each selected draw and according to the rules established for the challenge.
🚩 OBS: There was a doubt generated for the scenario when any pick is awarded the GRAND PRIZE. 🚩
As the maximum value was not established in the challenge rules table, the following rule was considered:
- For a list with a single pick that is awarded as GRAND PRIZE, will be returned GRAND PRIZE STANDARD VALUE
- For a list of more than one pick with at least 1 being awarded as a GRAND PRIZE, will be returned GRAND PRIZE STANDARD VALUE
- The values of each ticket awarded will not be calculated in total value when there is at least one value awarded as GRAND PRIZE.
{
"total_won": {
"value": 0,
"value_formatted": "Grand Prize"
}
}INPUT:
{
"draw_date": "2021-10-30", // Date of desired draw for picks analysis
"picks": [
"05 25 28 43 56 19",
"01 23 30 40 56 19",
"05 12 35 44 51 06"
]
}OUTPUT:
{
"draw_date": "2021-10-30", // Date of desired draw entered as input
"winning_numbers": "05 23 28 43 56 19", // Draw numbers for the date entered in "draw_date"
"total_won": {
"value": 100014, // Total value won as true added to the list of games in "tickets" in double format
"value_formatted": "$100,014" // Total value won as true added to the list of games in "tickets" in format US Dollar currency
},
"tickets": [
{
"pick": "05 25 28 43 56 19", // FIRST pick informed for ticket generation
"result": {
"won": true,
"value": 100000, // Ticket value for pick played
"value_formatted": "$100,000" // Ticket value for pick played
}
},
{
"pick": "01 23 30 40 56 19", // SECOND pick informed for ticket generation
"result": {
"won": true,
"value": 14,
"value_formatted": "$14"
}
},
{ // Ticket not awarded
"pick": "05 12 35 44 51 06", // THIRD pick informed for ticket generation
"result": {
"won": false,
"value": 0,
"value_formatted": "$0"
}
}
]
}
Clone down this repository. You will need node and npm installed globally on your machine.
-
clone the repository:
git clone https://github.com/matheusicaro/codility-exercise-powerball-service.git -
At the root of the project, install through:
npm install -
Decide which enviroment will be used:
OPTION_1) in the project environment settings, it is already filled with a default environment atraves do arquivo.env.
OPTION_2) Insert the deseda environment variables to run the project, following as an example the.env-cloudfile -
To Start Server:
npm start -
To Check Health Api:
http://localhost:3000/api/v1/health -
To Documentation Api:
http://localhost:3000/api-docs
-- app/ _________________________________: API business layer
-- app/config ___________________________: layer for configurations of essential services such as logger, environment, etc.
-- app/routes ___________________________: API routes
-- app/constants ________________________: layer for general constants such as messages, warnings, etc.r
-- app/controllers ______________________: layer for controllers for handling requests
-- app/exceptions _______________________: layer for custom exceptions for API
-- app/integration ______________________: layer for integration of external services such as PAI and others
-- app/models ___________________________: layer for structured objects for runtime use
-- app/services _________________________: layer for business rules that responds to requests.
-- test/ ________________________________: application unit tests
- Used Node.js with express.
- Used Jest for unit testing.
- Used Winston for the storage of the logs.
- Used Axios for promises based HTTP client.
Due to the availability of time to implement the solution for the proposed challenge that was 12 hours, some tasks that are not mandatory for the challenge, but essential to deliver the solution, are pending below as a suggestion for better futures:
-
Cache: it is recommended to use cache for searches in the external lottery results api. Once the first search is performed, the results could be cached in a database such as Redis or even in the application's memory. Thus, for queries that are in the cache, it will result in the application's response time gain. For cases where the date is more recent than what is in the cache, you should look for the result in the external api.
-
Increase unit test and integration coverage
