https://github.com/artkirienko/rewards-app
đź“ťTest assignment for Senior Software Developer (Ruby on Rails + React) position
https://github.com/artkirienko/rewards-app
coding-challenge coding-task coding-test home-assignment home-task home-test rails ruby ruby-on-rails take-home-assignment take-home-project take-home-test takehome test test-assignment
Last synced: 22 days ago
JSON representation
đź“ťTest assignment for Senior Software Developer (Ruby on Rails + React) position
- Host: GitHub
- URL: https://github.com/artkirienko/rewards-app
- Owner: artkirienko
- License: mit
- Created: 2025-04-03T20:07:46.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2025-04-09T21:44:44.000Z (22 days ago)
- Last Synced: 2025-04-09T22:31:19.920Z (22 days ago)
- Topics: coding-challenge, coding-task, coding-test, home-assignment, home-task, home-test, rails, ruby, ruby-on-rails, take-home-assignment, take-home-project, take-home-test, takehome, test, test-assignment
- Language: Ruby
- Homepage:
- Size: 150 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/artkirienko/rewards-app/issues)
[](https://github.com/artkirienko/rewards-app/actions/workflows/ci.yml)
[](https://en.wikipedia.org/wiki/Source_lines_of_code)
[](https://hitsofcode.com)
# Take home challenge Rewards App
### Table of Contents
- [Summary](#summary)
- [Tech Stack](#tech-stack)
- [Core Requirements](#core-requirements)
- [Backend API](#backend-api)
- [Data Persistence](#data-persistence)
- [Interface](#interface)
- [Documentation](#documentation)
- [Important Notes](#important-notes)
- [Run with Dev Containers](#run-with-dev-containers)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Run with Docker and Docker-Compose](#run-with-docker-and-docker-compose)
- [Prerequisites](#prerequisites-1)
- [Steps](#steps-1)
- [Run](#run)
- [Prerequisites](#prerequisites-2)
- [Steps](#steps-2)
- [Run Tests](#run-tests)
- [Interact with Backend API via CLI](#interact-with-backend-api-via-command-line-interface-cli)
- [Codestyle](#codestyle)
- [TODO](#todo)
### Summary:
The challenge is to implement a basic rewards redemption web app that allows a user to do the following:
- View their current reward points balance
- Browse available rewards
- Redeem rewards using their points
- See a history of their reward redemptions
### Tech Stack:
You can use whatever technologies you’d like. I will note that the main technologies at Thanx are React for the front-end, Ruby on Rails for the backend, and MySQL for the database
### Core Requirements:
#### Backend API:
Implement RESTful endpoints for the following:
- Retrieve a user’s current points balance
- Get a list of available rewards
- Allow users to redeem a reward
- Retrieve a user’s redemption history
#### Data Persistence:
Use a database of your choice to store the information as you deem fit
#### Interface:
Implement a simple interface to interact with the backend API. This could be a command-line interface (CLI) or a web-based interface (Preferred if your focus is on the frontend)
#### Documentation:
Provide clear documentation on how to set up and run the application
## **Important Notes**
I use PointsEvent model with polymorphic association to implement rewards and bonuses, so in the `/api/v1/account/history` you could see all points transactions within your account. For now, application is Backend API only
## Run with Dev Containers
You can run this project using [Dev Containers](https://containers.dev/) to ensure a consistent development environment. Follow the steps below to get started
### Prerequisites
- **[Docker](https://www.docker.com/get-started/)** installed locally on your machine
- A [compatible editor](https://containers.dev/supporting#editors), such as [Visual Studio Code](https://code.visualstudio.com/) or [Cursor AI Editor](https://cursor.sh/), that supports Dev Containers
- The **[Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)** installed in your editor. _Note:_ This extension is typically pre-installed in VS Code and Cursor AI Editor
### Steps
1. Clone this repository to your local machine:
```bash
git clone https://github.com/artkirienko/rewards-app
cd rewards-app
```
2. Open the project folder in your editor
3. When prompted, select "Reopen in Container" (or use the command palette: Dev Containers: Reopen in Container)
4. The Dev Container will build and configure the environment based on the provided .devcontainer configuration
5. Once the dev container setup is complete, open the terminal **within your editor** and run `bin/rails s`
6. You are ready for [Interacting with Backend API via command-line interface (CLI)](#interact-with-backend-api-via-command-line-interface-cli) 🎉
7. Run tests: open the terminal **within your editor** and run `RAILS_ENV=test bin/rspec`
### Notes
- Ensure Docker is running before launching the Dev Container
- The `.devcontainer/devcontainer.json` file in this repository defines the container setup, including dependencies and tools
- It is recommended to monitor the container setup process by clicking "Connecting to Dev Container (show log)" in your editor. This can help troubleshoot any issues that arise
## Run with Docker and Docker-Compose
### Prerequisites
- **[Docker](https://www.docker.com/get-started/)** must be installed locally on your machine
### Steps
Run the following command to build and start the application:
```bash
docker-compose -f .devdocker/docker-compose.yml up --build
```
You are now ready to [interact with the Backend API via the command-line interface (CLI)](#interact-with-backend-api-via-command-line-interface-cli) 🎉
### Run Tests
To run tests, open a new terminal window or tab and execute the following command from the project directory:
```bash
docker-compose -f .devdocker/docker-compose.yml exec -e RAILS_ENV=test app bin/rspec
```
## Run
### Prerequisites
Ensure the following are installed on your machine:
- MySQL 8
- Ruby 3.4.2
- Rails 8.0.2
### Steps
Run the setup script to initialize the application:
```bash
bin/setup
```
You are now ready to [interact with the Backend API via the command-line interface (CLI)](#interact-with-backend-api-via-command-line-interface-cli) 🎉
### Run Tests
To execute tests, run:
```bash
RAILS_ENV=test bin/rspec
```
## Interact with Backend API via Command-Line Interface (CLI)
As soon as you have Rewards App up and running
- ⮕ **Sign in**
Click to expand/collapse
_Request:_
```bash
curl -X POST http://localhost:3000/api/v1/login \
-H "Content-Type: application/json" \
-d '{"user": {"email": "[email protected]", "password": "password"}}'
```
````
_Example Response:_
```json
{
"user": {
"id": 1,
"name": "Bryan Rainlord",
"email_address": "[email protected]",
"points": 45,
"created_at": "2025-04-09T14:31:15.216Z",
"updated_at": "2025-04-09T14:53:59.797Z"
},
"token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwic2NwIjoidXNlciIsImF1ZCI6bnVsbCwiaWF0IjoxNzQ0MjIyODE2LCJleHAiOjE3NDQzMDkyMTYsImp0aSI6IjRlOWQ5ZWIxLTk2MTAtNGRjMS05NTA1LWVjMzMyMWEzYmQxZiJ9.Xr_W558DnvP9zIbWVwTafgiL7DGvhx3ggUr4Xw_7O58"
}
```
- Copy your token from this response and use for all the next requests
- ⮕ **User information**
Click to expand/collapse
_Request:_
```bash
curl -X GET http://localhost:3000/api/v1/account \
-H "Authorization: Bearer " \
-H "Content-Type: application/json"
```
_Example Response:_
```json
{
"name": "Bryan Rainlord",
"email_address": "[email protected]"
}
```
- ⮕ **Retrieve a user’s current points balance**
Click to expand/collapse
_Request:_
```bash
curl -X GET http://localhost:3000/api/v1/account/balance \
-H "Authorization: Bearer " \
-H "Content-Type: application/json"
```
_Example Response:_
```json
{
"points": 395
}
```
- ⮕ **Browse available rewards** (no authentication required)
Click to expand/collapse
_Request:_
```bash
curl -X GET http://localhost:3000/api/v1/rewards
```
_Example Response:_
```json
[
{
"id": 1,
"name": "Tim's Favourite Soup",
"description": "Free Tim's favourite soup, slice of bread included.",
"points": 80,
"created_at": "2025-04-09T18:19:40.233Z",
"updated_at": "2025-04-09T18:19:40.233Z"
},
{
"id": 2,
"name": "1 Baked Pie",
"description": "Small size free baked pie at the cafe.",
"points": 50,
"created_at": "2025-04-09T18:19:40.315Z",
"updated_at": "2025-04-09T18:19:40.315Z"
},
{
"id": 3,
"name": "Free Brewed Coffee or Tea",
"description": "Any size free brewed coffee or tea at the cafe.",
"points": 50,
"created_at": "2025-04-09T18:19:40.375Z",
"updated_at": "2025-04-09T18:19:40.375Z"
},
{
"id": 4,
"name": "Vanilla Cone Pick Up only",
"description": "Regular size free Vanilla Cone Pick Up only at the cafe.",
"points": 60,
"created_at": "2025-04-09T18:19:40.417Z",
"updated_at": "2025-04-09T18:19:40.417Z"
},
{
"id": 5,
"name": "Any Size Latte",
"description": "Any size coffee latte at the cafe.",
"points": 70,
"created_at": "2025-04-09T18:19:40.460Z",
"updated_at": "2025-04-09T18:19:40.460Z"
},
{
"id": 6,
"name": "Breakfast Wrap",
"description": "Free breakfast wrap at the cafe.",
"points": 80,
"created_at": "2025-04-09T18:19:40.525Z",
"updated_at": "2025-04-09T18:19:40.525Z"
},
{
"id": 7,
"name": "Eggs Benedict Meal",
"description": "Free Eggs Benedict meal including any size brewed tea or coffee, salad, and french fries.",
"points": 150,
"created_at": "2025-04-09T18:19:40.558Z",
"updated_at": "2025-04-09T18:19:40.558Z"
},
{
"id": 8,
"name": "Dinner Voucher",
"description": "A voucher for a dinner at the cafe.",
"points": 300,
"created_at": "2025-04-09T18:19:40.589Z",
"updated_at": "2025-04-09T18:19:40.589Z"
}
]
```
- ⮕ **Show one of the rewards** (no authentication required)
Click to expand/collapse
_Request:_
```bash
curl -X GET http://localhost:3000/api/v1/rewards/3
```
_Example Response:_
```json
{
"id": 3,
"name": "Free Brewed Coffee or Tea",
"description": "Any size free brewed coffee or tea at the cafe.",
"points": 50,
"created_at": "2025-04-09T18:19:40.375Z",
"updated_at": "2025-04-09T18:19:40.375Z"
}
```
- ⮕ **Redeem this reward using points**
Click to expand/collapse
_Request:_
```bash
curl -X POST http://localhost:3000/api/v1/rewards/3/redeem \
-H "Authorization: Bearer " \
-H "Content-Type: application/json"
```
_Example Response:_
```json
{
"message": "Reward redeemed successfully",
"points_left": 345,
"points_used": 50
}
```
- ⮕ **Try redeeming most expensive reward several time till not enough points**
Click to expand/collapse
_Request:_
```bash
curl -X POST http://localhost:3000/api/v1/rewards/8/redeem \
-H "Authorization: Bearer " \
-H "Content-Type: application/json"
```
_Example Response (when insufficient points):_
```json
{
"error": "Not enough points"
}
```
- ⮕ **See a history of user's reward redemptions**
Click to expand/collapse
_Request:_
```bash
curl -X GET http://localhost:3000/api/v1/account/history \
-H "Authorization: Bearer " \
-H "Content-Type: application/json"
```
_Example Response:_
```json
[
{
"points": -300,
"type": "Reward",
"name": "Dinner Voucher",
"description": "A voucher for a dinner at the cafe.",
"created_at": "2025-04-09T18:25:25.305Z"
},
{
"points": -50,
"type": "Reward",
"name": "Free Brewed Coffee or Tea",
"description": "Any size free brewed coffee or tea at the cafe.",
"created_at": "2025-04-09T18:23:50.981Z"
},
{
"points": -50,
"type": "Reward",
"name": "Free Brewed Coffee or Tea",
"description": "Any size free brewed coffee or tea at the cafe.",
"created_at": "2025-04-09T18:19:41.787Z"
},
{
"points": 75,
"type": "Bonus",
"name": "Feedback Bonus",
"description": "Bonus for providing feedback.",
"created_at": "2025-04-09T18:19:41.739Z"
},
{
"points": 150,
"type": "Bonus",
"name": "Anniversary Bonus",
"description": "Anniversary bonus for users.",
"created_at": "2025-04-09T18:19:41.689Z"
},
{
"points": 200,
"type": "Bonus",
"name": "Birthday Bonus",
"description": "Birthday bonus for users.",
"created_at": "2025-04-09T18:19:41.610Z"
},
{
"points": -50,
"type": "Reward",
"name": "1 Baked Pie",
"description": "Small size free baked pie at the cafe.",
"created_at": "2025-04-09T18:19:41.552Z"
},
{
"points": 50,
"type": "Bonus",
"name": "Referral Bonus",
"description": "Bonus for referring a friend.",
"created_at": "2025-04-09T18:19:41.496Z"
},
{
"points": -80,
"type": "Reward",
"name": "Tim's Favourite Soup",
"description": "Free Tim's favourite soup, slice of bread included.",
"created_at": "2025-04-09T18:19:41.393Z"
},
{
"points": 100,
"type": "Bonus",
"name": "Sign Up Bonus",
"description": "Bonus for signing up.",
"created_at": "2025-04-09T18:19:41.300Z"
}
]
```
````
## Codestyle
```bash
bin/rubocop
```
## TODO
- Add code coverage using Codecov
- Update `Devise::JWT::RevocationStrategies::Null` to a more robust strategy
- Explore modern alternatives to Devise/Devise JWT
- Implement authorization and an admin dashboard
- Move some logic from controllers to JSON view templates using tools like Jbuilder, Oj, or Fast JSON
- Add pagination using Pagy, a modern gem, or implement it from scratch (offset + limit)
- Develop a TypeScript React.js frontend using either esbuild or Webpacker
- Add an animation when the user clicks the redeem button
- Integrate CodeClimate for code quality analysis
- Save cURL instructions as a Postman suite or create end-to-end tests