Create a REST API for a Tea Subscription Service
- Easily consumed by a Frontend Developer
- Restful routes
- Well-organized code, following OOP
- Test Driven Development
Exposes three endpoints to manage tea subscriptions
- subscribe a customer to a tea subscription
- cancel a customer's tea subscription
- see all of a customer's subscriptions (active and cancelled)
- Ruby v 2.7.4
- Rails v 5.2.8
- PostgreSQL
- Fork and Clone this repository locally
- Install gem packages
bundle install - Set up the database
rails db:{drop,create,migrate,seed} - Make sure all tests are passing by running
bundle exec rspec - Start up your local server by running
rails s - You can make the sample request for each endpoint by running the examples in Postman.
success
create a new subscription
Parameters
| Name | Type | Description |
|---|---|---|
| customer_id | number | customer's id |
| tea_id | number | tea's id |
| frequency | 'weekly', 'monthly', or 'seasonal' | how often |
Request
{
"customer_id": 3,
"tea_id": 6,
"frequency": "monthly"
}Response status 200
{
"data": {
"id": "13",
"type": "subscription",
"attributes": {
"customer_id": 3,
"tea_id": 6,
"title": "Sleepytime Tea",
"price": "$49.56",
"status": "active",
"frequency": "monthly"
}
}
}
error
Invalid Tea ID
Request
{
"customer_id": 3,
"tea_id": 0,
"frequency": "monthly"
}Response status 404
{
"errors": [
{
"status": "404",
"title": "Record Invalid",
"detail": "Validation failed: Tea must exist"
}
]
}
success
cancel a subscription
Parameters
| Name | Type | Description |
|---|---|---|
| customer_id | number | customer's id |
| tea_id | number | tea's id |
Request
{
"customer_id": 1,
"tea_id": 1
}Response status 200
{
"data": {
"id": "1",
"type": "subscription",
"attributes": {
"customer_id": 1,
"tea_id": 1,
"title": "Green Tea",
"price": "$49.56",
"status": "cancelled",
"frequency": "monthly"
}
}
}
error
Invalid Customer ID
Request
{
"customer_id": 0,
"tea_id": 1
}Response status 404
{
"errors": [
{
"status": "404",
"title": "Record Invalid",
"detail": "Couldn't find Subscription"
}
]
}
success
get customer details
Response status 200
{
"data": {
"id": "2",
"type": "customer",
"attributes": {
"first_name": "Harriet",
"last_name": "Murphy",
"email": "haphy@mail.com",
"address": "24 Beachwood Ave",
"subscriptions": [
{
"id": 7,
"title": "Mint Tea",
"price": "$49.56",
"status": "active",
"frequency": "monthly",
"customer_id": 2,
"tea_id": 4,
"created_at": "2023-08-06T17:43:10.359Z",
"updated_at": "2023-08-06T17:43:10.359Z"
},
{
"id": 8,
"title": "Chamomile Tea",
"price": "$49.56",
"status": "active",
"frequency": "monthly",
"customer_id": 2,
"tea_id": 5,
"created_at": "2023-08-06T17:43:10.360Z",
"updated_at": "2023-08-06T17:43:10.360Z"
},
{
"id": 9,
"title": "Sleepytime Tea",
"price": "$214.76",
"status": "cancelled",
"frequency": "weekly",
"customer_id": 2,
"tea_id": 6,
"created_at": "2023-08-06T17:43:10.361Z",
"updated_at": "2023-08-06T17:43:10.361Z"
}
]
}
}
}
error
Invalid Customer ID
Response status 404
{
"errors": [
{
"status": "404",
"title": "Record Invalid",
"detail": "Couldn't find Customer with 'id'=0"
}
]
}