jaredmhobson / tea_time Goto Github PK

View Code? Open in Web Editor NEW

0.0 1.0 0.0 55 KB

Dockerfile 3.13% Ruby 96.10% HTML 0.43% Shell 0.34%

tea_time's Introduction

Tea Time

Getting Started
Project Description
End Points
Contributors

Getting Started

Versions

Ruby: 3.2.2
Rails: 7.1.3

Project Description

Tea Time is a simple API that lets you start and cancel a tea subscription for a customer and retrieve all tea subscriptions that a customer has had.

This app was designed and built by myself as part of the intermission work, from Turing School of Software and Design.

Key Skills to Demonstrate

A strong understanding of Rails
Ability to create restful routes
Demonstration of well-organized code, following OOP
Test Driven Development
Clear documentation

Setup

Fork and/or Clone this Repo from GitHub.
In your terminal use $ git clone <ssh or https path>.
Change into the cloned directory using $ cd example.
Install the gem packages using $ bundle install.
Database Migrations can be set up by running:

$ rails db:{drop,create,migrate,seed}

Testing

Test using the terminal utilizing RSpec:

$ bundle exec rspec spec/<follow directory path to test specific files>

or test the whole suite with $ bundle exec rspec

Test Results as of 6/29/24: 100.0%

Database Schema

ActiveRecord::Schema[7.1].define(version: 2024_06_27_232609) do
  # These are extensions that must be enabled in order to support this database
  enable_extension "plpgsql"

  create_table "customer_subscriptions", force: :cascade do |t|
    t.bigint "customer_id", null: false
    t.bigint "subscription_id", null: false
    t.integer "status", default: 1
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["customer_id"], name: "index_customer_subscriptions_on_customer_id"
    t.index ["subscription_id"], name: "index_customer_subscriptions_on_subscription_id"
  end

  create_table "customers", force: :cascade do |t|
    t.string "first_name"
    t.string "last_name"
    t.string "email"
    t.string "address"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
    t.index ["email"], name: "index_customers_on_email", unique: true
  end

  create_table "subscriptions", force: :cascade do |t|
    t.string "title"
    t.integer "price"
    t.integer "status"
    t.integer "frequency"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
  end

  create_table "teas", force: :cascade do |t|
    t.string "title"
    t.string "description"
    t.integer "temperature"
    t.integer "brew_time"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
  end

  add_foreign_key "customer_subscriptions", "customers"
  add_foreign_key "customer_subscriptions", "subscriptions"
end

End Points

Customer Subscriptions

Create CustomerSubscription

Request:

POST /api/v1/customer_subscriptions
Content-Type: application/json
Accept: application/json

Body:

{ 
    "customer_subscription": 
        {
             "customer_id": 1,
             "subscription_id": 3
        }
 }

Response: status: 201

{
    "data": {
        "id": "1",
        "type": "customer_subscription",
        "attributes": {
            "status": "active",
            "title": "It's Tea",
            "price": 5000,
            "frequency": 3
        },
        "relationships": {
            "customer": {
                "data": {
                    "id": "1",
                    "type": "customer"
                }
            },
            "subscription": {
                "data": {
                    "id": "3",
                    "type": "subscription"
                }
            }
        }
    }
}

Cancel/Reactivate CustomerSubscription

Request:

PATCH api/v1/customer_subscriptions/1
Content-Type: application/json
Accept: application/json

Body:

{
    "status": "cancelled"
}

Response: status: 200

{
    "data": {
        "id": "1",
        "type": "customer_subscription",
        "attributes": {
            "status": "cancelled",
            "title": "It's Tea",
            "price": 5000,
            "frequency": 3
        },
        "relationships": {
            "customer": {
                "data": {
                    "id": "1",
                    "type": "customer"
                }
            },
            "subscription": {
                "data": {
                    "id": "3",
                    "type": "subscription"
                }
            }
        }
    }
}

Get All CustomerSubscriptions for a Customer

Request:

GET /api/v1/customer_subscriptions/1
Content-Type: application/json
Accept: application/json

Response: status: 200

{
    "data": [
        {
            "id": "1",
            "type": "customer_subscription",
            "attributes": {
                "status": "active",
                "title": "Expensive Tea",
                "price": 10000,
                "frequency": 1
            },
            "relationships": {
                "customer": {
                    "data": {
                        "id": "1",
                        "type": "customer"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "1",
                        "type": "subscription"
                    }
                }
            }
        },
        {
            "id": "2",
            "type": "customer_subscription",
            "attributes": {
                "status": "active",
                "title": "Least Expensive Tea",
                "price": 100,
                "frequency": 12
            },
            "relationships": {
                "customer": {
                    "data": {
                        "id": "1",
                        "type": "customer"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "2",
                        "type": "subscription"
                    }
                }
            }
        },
        ...,
        ...
    ]
}

This endpoint also accepts query params to filter subscriptions with a status of active or cancelled.

Example:

GET /api/v1/customer_subscriptions/1?status=cancelled
Content-Type: application/json
Accept: application/json

GET /api/v1/customer_subscriptions/1?status=active
Content-Type: application/json
Accept: application/json

Contributors

Jared Hobson | GitHub | LinkedIn

tea_time's People

Contributors

Watchers

tea_time's Issues

Create CustomerSubscription Endpoint

POST CustomerSubscription

Details

This endpoint should follow the pattern of POST api/v1/customer_subscriptions and should pass in a customer id and subscription id as JSON in the body of the request
This endpoint will create a new customer_subscription resource
A successful response will return a response with a 201 status code, and return the newly created customer_subscription resource
If any number of attributes are left out in the body of the request, a status code of 400, as well as a descriptive error message should be sent back in the response.
If an invalid customer id or subscription id is passed in, a 404 status code as well as a descriptive message should be sent back with the response.

Happy Path

Request:

POST /api/v1/customer_subscriptions
Content-Type: application/json  
Accept: application/json

Body:

{ 
    customer_subscription: 
        {
             "customer_id": 1,
             "subscription_id": 3
        }
 }

Response: `status: 201`

{
    "data": {
        "id": "1",
        "type": "customer_subscription",
        "attributes": {
            "status": "active",
            "title": "It's Tea",
            "price": 5000,
            "frequency": 3
        },
        "relationships": {
            "customer": {
                "data": {
                    "id": "1",
                    "type": "customer"
                }
            },
            "subscription": {
                "data": {
                    "id": "3",
                    "type": "subscription"
                }
            }
        }
    }
}

Sad Path 1

Request:

POST /api/v1/customer_subscriptions
Content-Type: application/json  
Accept: application/json

Body:

{ 
    customer_subscription: 
        {
             "subscription_id": 3
        }
 }

Response: `status: 400`

 {
     "errors": [
         {
             "detail": "Validation failed: Customer can't be blank"
         }
     ]
 }

Sad Path 2

Request:

POST /api/v1/customer_subscriptions
Content-Type: application/json  
Accept: application/json

Body:

{ 
    customer_subscription: 
        {
             "customer_id": 123123,
             "subscription_id": 3
        }
 }

Response: `status: 404`

 {
     "errors": [
         {
             "detail": "Couldn't find Customer with 'id'=123123"
         }
     ]
 }

Cancel CustomerSubscription Endpoint

UPDATE a customer_subscription

Details

This endpoint should follow the pattern of PATCH /api/v1/customer_subscriptions/:id and can pass a string of active or cancelled to the attribute status via the body of the request.
This endpoint should update an existing customer_subscription's status sent in via the body.

Happy Path

Request:

PATCH /api/v1/customer_subscriptions/1
Content-Type: application/json
Accept: application/json

Body:

{
    "status": "cancelled"
}

Response: `status: 200`

{
    "data": {
        "id": "1",
        "type": "customer_subscription",
        "attributes": {
            "status": "cancelled",
            "title": "It's Tea",
            "price": 5000,
            "frequency": 3
        },
        "relationships": {
            "customer": {
                "data": {
                    "id": "1",
                    "type": "customer"
                }
            },
            "subscription": {
                "data": {
                    "id": "3",
                    "type": "subscription"
                }
            }
        }
    }
}

Sad Path

Request:

PATCH /api/v1/customer_subscriptions/123123 (where '123123' is an invalid customer_subscription id)
Content-Type: application/json
Accept: application/json

Response: `status: 404`

{
    "errors": [
        {
            "status": "404",
            "title": "Couldn't find CustomerSubscription with 'id'=123123"
        }
    ]
}

Create Schema

Tea

Title : String
Description : String
Temperature : Integer
Brew Time : Integer (minutes)

Customer

First Name : String
Last Name : String
Email : String
Address : String

Subscription

Title : String
Price : Integer (pennies)
Status : Integer (enum) (disabled, enabled)
Frequency : Integer (months)

CustomerSubscription

Customer ID : Integer
Subscription ID : Integer
Status : Integer (enum) (cancelled, active) (default: active)

See All CustomerSubscriptions Endpoint

GET all subscriptions for a customer

Details

This endpoint should follow the pattern of GET /api/v1/customer_subscriptions.
If a valid customer id is passed in the body, a JSON object is sent back with a top-level data key that points to a collection of that customer's customer_subscriptions Each customer_subscription contains all of it’s attributes.
If an invalid customer id is passed in, a 404 status as well as a descriptive error message should be sent back in the response.

Happy Path

Request:

GET /api/v1/customer_subscriptions/1
Content-Type: application/json  
Accept: application/json

Body:

{
    customer_subscription:
        {
             "customer_id": "1",
         }
}

Response: `status: 200`

{
    "data": [
        {
            "id": "1",
            "type": "customer_subscription",
            "attributes": {
                "status": "active",
                "title": "Expensive Tea",
                "price": 10000,
                "frequency": 1
            },
            "relationships": {
                "customer": {
                    "data": {
                        "id": "1",
                        "type": "customer"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "1",
                        "type": "subscription"
                    }
                }
            }
        },
        {
            "id": "2",
            "type": "customer_subscription",
            "attributes": {
                "status": "active",
                "title": "Least Expensive Tea",
                "price": 100,
                "frequency": 12
            },
            "relationships": {
                "customer": {
                    "data": {
                        "id": "1",
                        "type": "customer"
                    }
                },
                "subscription": {
                    "data": {
                        "id": "2",
                        "type": "subscription"
                    }
                }
            }
        },
  ...,
  ...,
  }
}

Sad Path

Request:

GET /api/v1/customer_subscriptions
Content-Type: application/json  
Accept: application/json

Body:

{
    subscription:
        {
             "customer_id": "123123",
         }
}

Response: `status: 404`

{
       "errors": [
           {
               "detail": "Couldn't find Customer with 'id'=123123"
           }
       ]
   }

jaredmhobson / tea_time Goto Github PK

tea_time's Introduction

Tea Time

Table of Contents

Getting Started

Versions

Project Description

End Points

Customer Subscriptions

Contributors

tea_time's People

Contributors

Watchers

tea_time's Issues

POST CustomerSubscription

Details

Happy Path

Request:

Body:

Response: status: 201

Sad Path 1

Request:

Body:

Response: status: 400

Sad Path 2

Request:

Body:

Response: status: 404

UPDATE a customer_subscription

Details

Happy Path

Request:

Body:

Response: status: 200

Sad Path

Request:

Response: status: 404

Tea

Customer

Subscription

CustomerSubscription

GET all subscriptions for a customer

Details

Happy Path

Request:

Body:

Response: status: 200

Sad Path

Request:

Body:

Response: status: 404

Recommend Projects

Recommend Topics

Recommend Org

Response: `status: 201`

Response: `status: 400`

Response: `status: 404`

Response: `status: 200`

Response: `status: 404`

Response: `status: 200`

Response: `status: 404`