bflanagan138/tea_service

Tea Service

Table of Contents

• Project Overview
• Schema
• Technologies
• Setup and Installation
• Learning Goals

Project Overview

Tea Service is an application that creates back end API endpoints for Customers to add Tea Subscriptions.

Schema

API Endpoints

Here is a list of all mapped client requests with their respective json responses below them:

Root directory: 'http://localhost:3000/api/v1'

Shows Customer and their subscriptions:

• `GET /customers/1/subscriptions'

• Successful response:

{
    "data": {
        "id": 1,
        "attributes": {
            "first_name": "Alejandra",
            "last_name": "Stark",
            "email": "jack@wisozk-marks.biz",
            "address": "Apt. 818 754 Kuhlman Manors, Steuberside, AZ 22149-1295",
            "subscriptions": [
                {
                    "id": 1,
                    "title": "Subscription 1",
                    "price": 11.88,
                    "status": "active",
                    "frequency": "Monthly",
                    "tea": {
                        "title": "Bai Mu Dan",
                        "description": "faint, watery, musty, honeydew, tamarind",
                        "temperature": 281,
                        "brew_time": 88
                    }
                },
                {
                    "id": 2,
                    "title": "Subscription 2",
                    "price": 22.12,
                    "status": "cancelled",
                    "frequency": "Weekly",
                    "tea": {
                        "title": "Vietnamese",
                        "description": "unbalanced, creamy, wheat, raspberry, peach",
                        "temperature": 993,
                        "brew_time": 40
                    }
                },
                {
                    "id": 4,
                    "title": "Subscription 4",
                    "price": 8.88,
                    "status": "active",
                    "frequency": "Yearly",
                    "tea": {
                        "title": "Xinyang Maojian",
                        "description": "structured, slick, hops, red currant, hops",
                        "temperature": 629,
                        "brew_time": 16
                    }
                }
            ]
        }
    }
}

If customer has no subscriptions:

• GET /customers/1/subscriptions

• Successful response:

{
    "data": {
        "id": 2,
        "attributes": {
            "first_name": "Modesto",
            "last_name": "Langworth",
            "email": "von@schinner.org",
            "address": "Suite 790 479 Clement Locks, Lake Mallie, MN 19861-3397",
            "subscriptions": "No Subscriptions Found"
        }
    }
}

Creates a new subscription for a customer:

• POST /customers/1/subscriptions

• Body:

{
    "title": "Add a Subscription",
    "price": 44.00,
    "frequency": "Annually",
    "tea_id": 1
}

• Successful response:

{
    "data": {
        "id": 5,
        "title": "Add a Subscription",
        "price": 44.0,
        "frequency": "Annually",
        "status": "active",
        "tea": {
            "title": "Kukicha",
            "description": "juicy, full, hay, honeydew, clementine",
            "temperature": 429,
            "brew_time": 57
        }
    }
}

Cancels a customer subscription:

• PATCH /customers/1/subscriptions/1
• Body:

 {   
    "data": {
        "attributes": {
            "subscriptions": [
                {
                "id": 1,
                "status": "cancelled"
                }
            ]
        }
    }
}

• Successful response:

    "data": {
        "id": 1,
        "title": "Subscription 1",
        "price": 11.88,
        "frequency": "Monthly",
        "status": "cancelled",
        "tea": {
            "title": "Kukicha",
            "description": "juicy, full, hay, honeydew, clementine",
            "temperature": 429,
            "brew_time": 57
        }
      }
    }

Technologies

Setup and Installation

From your terminal, run:

• git clone https://github.com/bflanagan138/tea_service.git
• bundle install
• rails db:create
• To run the tests: bundle exec rspec
• In your command line, run rails s then in a webbrowser, visit "http://localhost:3000/api/v1/customers/#{customer.id}/subscriptions" to run on your local host

Learning Goals

• Employ Service-Oriented Architecture to create back end API endpoints for front end consumption
• Document process utilizing project board
• Create ReadMe to ensure users can easily use service
• Graduate Turing