elyhess / rails-engine

Backend API built to power a fictitious E-commerce platform.

Rails Engine

Mod 3 Solo Project: Building a Rails API

Project Description

You are working for a company developing an E-Commerce Application. Your team is working in a service-oriented architecture, meaning the front and back ends of this application are separate and communicate via APIs. Your job is to expose the data that powers the site through an API that the front end will consume.

Schema

Setup Instructions

To get a local copy up and running follow these simple steps.

1. Clone the repo

   git clone https://github.com/elyhess/rails-engine
   

2. Install dependencies

   bundle install
   

3. DB creation/migration

   rails db:create
   rails db:migrate
   rails db:seed
   

4. Run tests and view test coverage

   bundle exec rspec
   open coverage/index.html
   

5. Run server and navigate to http://localhost:3000/

   rails s
   

rails-engine's Issues

get one item

http://localhost:3000/api/v1/items/{{item_id}}

• unit_price is sent as numeric data, and not string data.

find a quantity of items sorted by descending revenue

• x is the number of items to be returned. The quantity should default to 5 if not provided, and return an error if it is not an integer greater than 0

delete an item

http://localhost:3000/api/v1/items/{{item_id}}

• destroy the corresponding record (if found) and any associated data

• destroy any invoice if this was the only item on an invoice

• NOT return any JSON body at all, and should return a 204 HTTP status code

• NOT utilize a Serializer (Rails will handle sending a 204 on its own if you just .destroy the object)

allow for OPTIONAL query parameters to be sent by the user

GET /api/v1/items?per_page=50&page=2
GET /api/v1/merchants?per_page=50&page=2

This should fetch items 51 through 100, since we’re returning 50 per “page”, and we want “page 2” of data.

find a quantity of merchants sorted by descending revenue

GET /api/v1/merchants/most_revenue?quantity=x

• x is the number of merchants to be returned. The quantity should default to 5 if not provided, and return an error if it is not an integer greater than 0.

get all items for a given merchant ID

GET /api/v1/items/:id/merchant

• return the merchant associated with an item

• return a 404 if the item is not found

get all items, a maximum of 20 at a time

http://localhost:3000/api/v1/items

GET /api/v1/items?per_page=50&page=2
GET /api/v1/merchants?per_page=50&page=2

• This should fetch items 51 through 100, since we’re returning 50 per “page”, and we want “page 2” of data.

• If a user tries to fetch a page for which there is no data, then data should report an empty array.

total revenue for a given merchant

GET /api/v1/revenue/merchants/:id

edit an item

http://localhost:3000/api/v1/items/{{item_id}}

• name

• description

• unit_price

• merchant_id

• (Note that the unit price is to be sent as a numeric value, not a string.

create an item

http://localhost:3000/api/v1/items

accept the following JSON body with only the following fields:

• name

• description

• unit_price

• merchant_id

• (Note that the unit price is to be sent as a numeric value, not a string.)

• return an error if any attribute is missing

• should ignore any attributes sent by the user which are not allowed

find one MERCHANT based on search criteria

GET /api/vi/merchants/find_one

• find a single merchant that matches a search term
• return the first object in the database in case-sensitive alphabetical order if multiple matches are found
• allow the user to specify a ‘text’ query parameter (?text=ring will search name field in db)
• case-insensitive search for text fields
• CHECK =https://backend.turing.io/module3/projects/rails_engine/requirements to ensure requirements met

get the merchant data for a given item ID

GET /api/v1/merchants/:id/items

• return all items associated with a merchant.
• return a 404 if the merchant is not found

find all ITEMS based on search criteria

GET /api/vi/items/find_all

• find all items which match a search term
• return the first object in the database in case-sensitive alphabetical order if multiple matches are found
• allow the user to specify a ‘text’ query parameter (?text=ring will search name field in db)
• case-insensitive search for text fields
• CHECK =https://backend.turing.io/module3/projects/rails_engine/requirements to ensure requirements met

total revenue generated in the whole system over a start/end date range

GET /api/v1/revenue?start_date=<start_date>&end_date=<end_date>

GET /api/v1/revenue?start=2012-03-09&end=2012-03-24

• Assume your users will only send dates in the format YYYY-MM-DD. Revenue must be counted for any invoices on the end_date as well.

• An error should be returned if either/both the start date or end date are not provided.

get all merchants, a maximum of 20 at a time

http://localhost:3000/api/v1/merchants

GET /api/v1/items?per_page=50&page=2
GET /api/v1/merchants?per_page=50&page=2

• This should fetch items 51 through 100, since we’re returning 50 per “page”, and we want “page 2” of data.

• If a user tries to fetch a page for which there is no data, then data should report an empty array.

get one merchant

http://localhost:3000/api/v1/merchants/{{merchant_id}}

• unit_price is sent as numeric data, and not string data.

find a quantity of merchants sorted by descending item quantity sold

GET /api/v1/merchants/most_items?quantity=x

• x is the number of merchants to be returned. The quantity should default to 5 if not provided, and return an error if it is not an integer greater than 0.