README - Tea Subscription API

Overview

This is a Rails API for a Tea Subscription Service that has built several endpoints for Customers and their Tea Subscriptions.

🍵 Technologies Used:

🍵 Database Schema:

This database was designed with the intention of Teas and Customers being linked via a Subscription joins table. Customers are able to subscribe or cancel a tea subscription, without any effect on the Tea database. Subscriptions can be updated to be canceled without having to permanently remove the Subscription from the database. The business logic here would allow a Customer to easily activate their subscription at a later point.

🍵 API Endpoints:

All SUBSCRIPTIONS for a single CUSTOMER (active AND canceled):

GET /api/v1/customers/$id/subscriptions

  "data": [
      { 
          "id": "1",
          "type": "subscription"
          "attributes": { 
                  "title": "Stress Buster", 
                  "price": 15.25, 
                  "status": "active", 
                  "frequency": "canceled", 
                  "customer_id": 1, 
                  "tea_id": 1 
                  }, 
                      {
            "id": "5",
            "type": "subscription",
            "attributes": {
                "title": "Sleepy Time",
                "price": 10.15,
                "status": "active",
                "frequency": "weekly",
                "customer_id": 1,
                "tea_id": 1
            }
        }]

CREATE SUBSCRIPTION for a single CUSTOMER:

POST /api/v1/subscriptions

params inside JSON body: title, price, status, frequency, customer_id, tea_id

    {
    "data": {
        "id": "7",
        "type": "subscription",
        "attributes": {
            "title": "Sleepy Time",
            "price": 10.15,
            "status": "active",
            "frequency": "weekly",
            "customer_id": 1,
            "tea_id": 1
        }
    }
}

UPDATE(cancel) SUBSCRIPTION for a single CUSTOMER:

PATCH /api/v1/subscriptions/remove?$id

params { $id, "status": "canceled" }

{
    "data": {
        "id": "6",
        "type": "subscription",
        "attributes": {
            "title": "Sleepy Time",
            "price": 10.15,
            "status": "canceled",
            "frequency": "weekly",
            "customer_id": 1,
            "tea_id": 1
        }
    }
}

🍵 Local Setup

1. Fork and clone the repo to your local machine
2. Install gems and dependencies: bundle install
3. Set up database: rails db:{drop,create,migrate,seed}
4. Run test suite: bundle exec rspec (100% SimpleCov testing coverage)
5. Start up your local server: rails s
6. Visualize the endpoints in Postman
   GET http://localhost:3000/api/v1/customers/{{customer_id}}/subscriptions
   POST http://localhost:3000/api/v1/subscriptions
   PATCH http://localhost:3000/api/v1/subscriptions/remove?id={{id}}