hopesgit / steep

Steep

Contributors

• Hope McGee | LinkedIn

Description

Steep is Ruby on Rails API-only backend that allows a user (customer) to subscribe to different varieties of teas.

This may implement the Tea API.

Versioning

• Ruby version: 2.5.3
• Rails version: 5.2.6

Setup

Clone the app using the "Code" button above to download it to your machine. After you've done this, you can use bundle install and rails db:setup in your terminal/shell to set up the app locally.

Testing

Testing is provided using RSpec. Test status can be checked by running bundle exec rspec in your terminal/shell once you've followed the setup above.

Endpoints

POST '/api/v1/subscribe'

• This provides a way for a customer to subscribe to a variety of tea.
• This can also reactivate a subscription for a previously-unsubscribed tea.
• This requires "customer_id" and "tea_id" query params.

POST '/api/v1/unsubscribe'

• This provides a way for a customer to unsubscribe from a variety of tea.
• This requires "customer_id" and "tea_id" query params.
• This responds with "null" if there is no active subscription for that customer and tea data set.

GET '/api/v1/subscriptions'

• This provides a way to see all of a customer's subscriptions, active and inactive.
• This requires "customer_id" query param.

steep's Issues

Interact with TeaAPI

[ ] Include Faraday gem
[ ] Set up Faraday to call Tea API
[ ] Get API Key if required
[ ] Create Tea API class
[ ] Test it all (as you go)

Update DB fields to not be null in schema

Ex: Customer's first_name should never be able to be an empty string

set up endpoint to subscribe a customer to a tea subscription

Endpoint: POST /api/v1/unsubscribe
Requires: customer_id, tea_id
[ ] Create tests for endpoint
[ ] Build endpoint
[ ] Ensure that endpoint creates a Subscriptions item that belongs to a customer and a tea OR activates the subscription if it's inactive

Create Readme/documentation

• Add Readme
• Update readme
• Document usage of API and give credit to Tea API

Update subscription/tea relationship

Change this to many-many

set up An endpoint to see all of a customer's subsciptions (active and cancelled)

Endpoint: /api/v1/customers/cust_id/subscriptions
[ ] Create testing for endpoint
[ ] Create endpoint

Add subscription user/tea id validation

Add a before_action Subscription model validation that can identify that the supplied customer/tea ids together are unique

Set up Tables

Tables:

Customers:

• first_name (string)
• last_name (string)
• email (string) (unique)
• address (string)

Teas:

• title (string)
• description (string)
• brew_time (integer / minutes)
• api_id (string) (unique)

Subscriptions:

• tea_id
• customer_id
• status (int, refers to active(0) or inactive(1))
• has and belongs to many users AND teas

set up An endpoint to cancel a customer's tea subscription

Endpoint: POST /api/v1/subscriptions/cancel
Requires: customer_id, tea_id
[ ] Create testing for endpoint
[ ] Create Endpoint
[ ] Ensure that the method changes the subscription's status to "inactive"