This project is an API sales data analysis tool. The return format for all endpoints is JSON.
The markdown for this project can be found here
Adam Gunther github
Natalia Colome github
Clone the repo in your terminal:
git clone https://github.com/adamgunther1/rales_engine.git
Navigate into the project:
cd rales_engine
Bundle:
bundle install
Create, migrate, and seed your database:
rake db:{create,migrate}
rake load:csv_seed
Run rspec in your terminal to ensure all tests are passing.
You can visit these endpoints to see a JSON response.
In your terminal, start a local server: rails s
Open your browser to localhost:3000
/api/v1/merchantsreturns all merchants/api/v1/merchants/:idreturns a specific merchant based on id/api/v1/merchants/randomreturns a random merchant/api/v1/merchants/find?paramsreturns the first merchant it finds based onfindparams./api/v1/merchants/find_all?paramsreturns all the merchants that match the find_all param. For merchants, you can search by:
| Parameter | Description |
|---|---|
| id | search based on the primary key |
| name | search based on the name attribute |
| created_at | search based on created_at timestamp |
| updated_at | search based on updated_at timestamp |
/api/v1/customers/api/v1/customers/:id/api/v1/customers/random/api/v1/customers/find?paramsreturns the first customer it finds based onfindparams./api/v1/customers/find_all?paramsreturns all the customers that match the find_all param. For customers, you can search by:
| Parameter | Description |
|---|---|
| id | search based on the primary key |
| first_name | search based on the first_name attribute |
| last_name | search based on the last_name attribute |
| created_at | search based on created_at timestamp |
| updated_at | search based on updated_at timestamp |
/api/v1/items/api/v1/items/:id/api/v1/items/random/api/v1/items/find?paramsreturns the first item it finds based onfindparams./api/v1/items/find_all?paramsreturns all the item that match the find_all param. For items, you can search by:
| Parameter | Description |
|---|---|
| id | search based on the primary key |
| name | search based on the name attribute |
| description | search based on the description attribute |
| unit_price | search based on the unit_price attribute |
| merchant_id | search based on the merchant foreign key |
| created_at | search based on created_at timestamp |
| updated_at | search based on updated_at timestamp |
/api/v1/invoices/api/v1/invoices/:id/api/v1/invoices/random/api/v1/invoices/find?paramsreturns the first invoices it finds based onfindparams./api/v1/invoices/find_all?paramsreturns all the invoices that match the find_all param. For invoices, you can search by:
| Parameter | Description |
|---|---|
| id | search based on the primary key |
| customer_id | search based on the customer foreign key |
| merchant_id | search based on the merchant foreign key |
| status | search based on the status attribute |
| created_at | search based on created_at timestamp |
| updated_at | search based on updated_at timestamp |
/api/v1/invoice_items/api/v1/invoice_items/:id/api/v1/invoice_items/random/api/v1/invoice_items/find?paramsreturns the firstinvoice_itemit finds based onfindparams./api/v1/invoice_items/find_all?paramsreturns all theinvoice_itemsthat match the find_all param. Forinvoice_items, you can search by:
| Parameter | Description |
|---|---|
| id | search based on the primary key |
| item_id | search based on the item foreign key |
| invoice_id | search based on the invoice foreign key |
| quantity | search based on the quantity attribute |
| unit_price | search based on the unit_price attribute |
| created_at | search based on created_at timestamp |
| updated_at | search based on updated_at timestamp |
/api/v1/transactions/api/v1/transactions/:id/api/v1/transactions/random/api/v1/transactions/find?paramsreturns the first transaction it finds based onfindparams./api/v1/transactions/find_all?paramsreturns all the transactions that match the find_all param. For transactions, you can search by:
| Parameter | Description |
|---|---|
| id | search based on the primary key |
| invoice_id | search based on the invoice foreign key |
| credit_ card_number | search based on the credit card number attribute |
| result | search based on the result attribute |
| created_at | search based on created_at timestamp |
| updated_at | search based on updated_at timestamp |
/api/v1/merchants/:id/itemsreturns a collection of items associated with that merchant/api/v1/merchants/:id/invoicesreturns a collection of invoices associated with that merchant from their known orders
/api/v1/invoices/:id/transactionsreturns a collection of associated transactions/api/v1/invoices/:id/invoice_itemsreturns a collection of associated invoice items/api/v1/invoices/:id/itemsreturns a collection of associated items/api/v1/invoices/:id/customerreturns the associated customer/api/v1/invoices/:id/merchantreturns the associated merchant
/api/v1/invoice_items/:id/invoicereturns the associated invoice/api/v1/invoice_items/:id/itemreturns the associated item
/api/v1/items/:id/invoice_itemsreturns a collection of associated invoice items/api/v1/items/:id/merchantreturns the associated merchant
/api/v1/transactions/:id/invoicereturns the associated invoice
/api/v1/customers/:id/invoicesreturns a collection of associated invoices/api/v1/customers/:id/transactionsreturns a collection of associated transactions
/api/v1/merchants/most_revenue?quantity=xreturns the top x merchants ranked by total revenue/api/v1/merchants/most_items?quantity=xreturns the top x merchants ranked by total number of items sold/api/v1/merchants/revenue?date=xreturns the total revenue for date x across all merchants/api/v1/merchants/:id/revenuereturns the total revenue for that merchant across all transactions/api/v1/merchants/:id/revenue?date=xreturns the total revenue for that merchant for a specific invoice date x/api/v1/merchants/:id/favorite_customerreturns the customer who has conducted the most total number of successful transactions.
/api/v1/items/most_revenue?quantity=xreturns the top x items ranked by total revenue generated/api/v1/items/most_items?quantity=xreturns the top x item instances ranked by total number sold/api/v1/items/:id/best_dayreturns the date with the most sales for the given item using the invoice date. If there are multiple days with equal number of sales, return the most recent day.
/api/v1/customers/:id/favorite_merchantreturns a merchant where the customer has conducted the most successful transactions
- Clone down rales-engine spec harness
- Navigate into the railes-engine directory
cd rails-engine - If you haven't, run the setup instructions.
- Run
rails server - In a separate terminal window, navigate into rales_engine_spec_harness directory
- Run
rake
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent