I'm a nature-loving nerd with a kid-like enthusiasm who can't help but tell it like it is.
As for hobbies, I'm a bookworm who loves magical realism, fantasy, sci-fi, and books about social stuff and nature. Nature itself, whether it's by the sea or deep in the forests, is where I find my peace, and I hold a dream close to my heart of one day running an animal sanctuary. Trains, Doctor Who, and sharing my passions with others are my absolute joys. I also find immense satisfaction in hands-on activities like carpentry, pottery, whipping up homemade jams, and tending to my garden. :seedling: :train: :books: :turtle: :sauropod: :black_cat: :mountain:
Store API is a Ruby on Rails application that provides a simple API for managing a Reedsy's (fictional) Merchandising Store.
- Ruby (3.2.2 recommended)
- Ruby on Rails (7.0 recommended)
- PostgreSQL
- Bundler
Assuming you work on macOS and use [rvm]:
-
Install dependencies listed in the dependencies section
rvm install 3.2.2 && rvm use 3.2.2 brew update -
Clone the repository and change the directory:
git clone git@github.com:iku-avery/reedsy-challenge-backend.git && cd store_api bundle install
-
Setup database:
rails db:create && rails db:migrate && rails db:seed
To ensure the functionality of the Store API, you can run automated tests using RSpec.
Execute the following command to run the tests:
bundle exec rspec spec- URL:
/api/products - Method: GET
- Description: Get a list of all available products.
- Response: Returns a JSON array of products with details including ID, code, name, price, and timestamps.
[
{
"id": "11kdkk111",
"code": "MUG",
"name": "Reedsy Mug",
"price": "6.00",
"created_at": "2023-09-18T17:15:35Z",
"updated_at": "2023-09-18T17:15:35Z"
},
{
"id": "31kdkk222",
"code": "TSHIRT",
"name": "Reedsy T-shirt",
"price": "15.00",
"created_at": "2023-09-18T17:15:35Z",
"updated_at": "2023-09-18T17:15:35Z"
}
]-
URL:
/api/products/:id -
Method: UPDATE
-
Description: Update the price of a specific product.
-
Request Parameters:
- id (required): The ID of the product to update.
- product (required): An object containing the new price.
-
Request:
PUT /api/products/:id- Request body:
{
"product": {
"price": 8.99
}
}-
Response:
- Returns the updated product with details including ID, code, name, price, and timestamps.
- Expected Response Code: 200 (OK)
- Expected Response Body:
{ "id": "11kdkk111", "code": "MUG", "name": "Reedsy Mug", "price": "11.99", "created_at": "2023-09-18T17:15:35Z", "updated_at": "2023-09-18T17:15:35Z" } -
Possible Error Response (404 Not Found):
{
"error": "Product not found"
}- Possible Error Response (400 Bad Request):
{
"error": "Price must be a positive number"
}-
URL:
/api/cart -
Method: POST
-
Description: Add items to the shopping cart.
-
Request Parameters:
- products (required): An array of objects containing product IDs and quantities.
-
Request:
POST /api/cart- Request body:
{
"products": [
{
"product_id": "11kdkk111",
"quantity": 2
},
{
"product_id": "31kdkk222",
"quantity": 1
}
]
}- Response:
- Returns a JSON object representing the cart, including a list of products added and the total price.
- Expected Response Code: 200 (OK)
- Expected Response Body:
{
"products": [
{
"id": "11kdkk111",
"code": "MUG",
"name": "Reedsy Mug",
"price": "6.00",
"quantity": 2
},
{
"id": "31kdkk222",
"code": "TSHIRT",
"name": "Reedsy T-shirt",
"price": "15.00",
"quantity": 1
}
],
"total_price": "27.00"
}- Possible Error Response (404 Not Found - Product Not Found):
{
"error": "Product not found"
}- Possible Error Response (400 Bad Request - Negative Quantity):
{
"error": "Quantity must be a positive number"
}- Possible Error Response (400 Bad Request - Invalid Request Parameters):
{
"error": "Invalid request parameters"
}You can interact with the Store API by making HTTP requests to its endpoints:
GET /api/productsTo retrieve a list of available products, you can use the following curl command:
curl -X 'GET' \
'http://localhost:3000/api/products' \
-H 'accept: application/json'To update the price of a product, use the PUT request on the following endpoint:
PUT /api/products/{id}Replace {id} with the unique identifier of the product you want to update.
The request body should be in JSON format and include the new price of the product:
{
"product": {
"price": 11.99
}
}You can use the following curl commands:
-
Update product price with a 200 response
curl -X PUT http://localhost:3000/api/products/{id} -H 'Content-Type: application/json' -d '{"product":{"price":11.99}}' -
Attempt to update product using invalid id with a 404 response:
curl -X PUT http://localhost:3000/api/products/not_existing_id -H 'Content-Type: application/json' -d '{"product":{"price":11.99}}'
-
Attempt to update a product with a negative price with a 400 response
curl -X PUT http://localhost:3000/api/products/{id} -H 'Content-Type: application/json' -d '{"product":{"price":-11.99}}'
To add items to the cart, use the POST request on the following endpoint:
POST /api/cartThe request body should be in JSON format and include an array of products with their product_id and quantity:
{
"products": [
{ "product_id": {id}, "quantity": 2 },
{ "product_id": {id}, "quantity": 1 }
]
}You can use the following curl commands:
curl -X POST http://localhost:3000/api/cart -H 'Content-Type: application/json' -d '{
"products": [
{ "product_id": {id}, "quantity": 2 },
{ "product_id": {id}, "quantity": 1 }
]
}'Testing with Postman:
You can also test API using Postman. I've provided a Postman collection that includes pre-configured requests for API endpoints. You can import the collection into Postman and use it to interact with API. The collection includes sample requests, expected responses, and variables for easy testing.
Postman Collection: Download Postman Collection