Monster Shop

User Story 25, User Profile displays Orders

As a registered user
When I visit my Profile Orders page, "/profile/orders"
I see every order I've made, which includes the following information:
- the ID of the order, which is a link to the order show page
- the date the order was made
- the date the order was last updated
- the current status of the order
- the total quantity of items in the order
- the grand total of all items for that order

DO THESE STORIES FIRST:

User Story 18, User Profile Show Page

Checklist:

depends on turingschool-examples#220

Epic: Core Application

Monster Shop

BE Mod 2 Week 4/5 Group Project

Background and Description

"Monster Shop" is a fictitious e-commerce platform where users can register to place items into a shopping cart and 'check out'. Users who work for a merchant can mark their items as 'fulfilled'; the last merchant to mark items in an order as 'fulfilled' will automatically set the order status to "shipped". Each user role will have access to some or all CRUD functionality for application models.

Students will be put into 3 or 4 person groups to complete the project.\n

Learning Goals

Rails

Create routes for namespaced routes
Implement partials to break a page into reusable components
Use Sessions to store information about a user and implement login/logout functionality
Use filters (e.g. before_action) in a Rails controller
Limit functionality to authorized users
Use BCrypt to hash user passwords before storing in the database

ActiveRecord

Use built-in ActiveRecord methods to join multiple tables of data, calculate statistics and build collections of data grouped by one or more attributes

Databases

Design and diagram a Database Schema
Write raw SQL queries (as a debugging tool for AR)

Requirements

must use Rails 5.1.x
must use PostgreSQL
must use 'bcrypt' for authentication
all controller and model code must be tested via feature tests and model tests, respectively
must use good GitHub branching, team code reviews via GitHub comments, and use of a project planning tool like waffle.io
must include a thorough README to describe their project

Permitted

use FactoryBot to speed up your test development
use "rails generators" to speed up your app development

Not Permitted

do not use JavaScript for pagination or sorting controls

Permission

if there is a specific gem you'd like to use in the project, please get permission from your instructors first

User Roles

Visitor - this type of user is anonymously browsing our site and is not logged in
Regular User - this user is registered and logged in to the application while performing their work; can place items in a cart and create an order
Merchant Employee - this user works for a merchant. They can fulfill orders on behalf of their merchant. They also have the same permissions as a regular user (adding items to a cart and checking out)
Merchant Admin - this user works for a merchant, and has additional capabilities than regular employees, such as changing merchant info.
Admin User - a registered user who has "superuser" access to all areas of the application; user is logged in to perform their work

Order Status

'pending' means a user has placed items in a cart and "checked out" to create an order, merchants may or may not have fulfilled any items yet
'packaged' means all merchants have fulfilled their items for the order, and has been packaged and ready to ship
'shipped' means an admin has 'shipped' a package and can no longer be cancelled by a user
'cancelled' - only 'pending' and 'packaged' orders can be cancelled

Not Everything can be FULLY Deleted

In the user stories, we talk about "CRUD" functionality. However, it's rare in a real production system to ever truly delete content, and instead we typically just 'enable' or 'disable' content. Users, items and orders can be 'enabled' or 'disabled' which blocks functionality (users whose accounts are disabled should not be allowed to log in, items which are disabled cannot be ordered, orders which are disabled cannot be processed, and so on).

Disabled content should also be restricted from showing up in the statistics pages. For example: if an item is disabled, it should not appear in a list of "popular items".

Be careful to watch out for which stories allow full deletion of content, and restrictions on when they apply.

User Story 32, Merchant sees an order show page

As a merchant employee or admin
When I visit an order show page from my dashboard
I see the customer's name and address
I only see the items in the order that are being purchased from my merchant
I do not see any items in the order being purchased from other merchants
For each item, I see the following information:
- the name of the item, which is a link to my item's show page
- an image of the item
- my price for the item
- the quantity the user wants to purchase

DO THESE STORIES FIRST:

User Story 30, Merchant Dashboard displays Orders

Checklist:

depends on turingschool-examples#207

User Story 27, User cancels an order

As a registered user
When I visit an order's show page
I see a button or link to cancel the order only if the order is still pending
When I click the cancel button for an order, the following happens:
- Each row in the "order items" table is given a status of "unfulfilled"
- The order itself is given a status of "cancelled"
- Any item quantities in the order that were previously fulfilled have their quantities returned to their respective merchant's inventory for that item.
- I am returned to my profile page
- I see a flash message telling me the order is now cancelled
- And I see that this order now has an updated status of "cancelled"

DO THESE STORIES FIRST:

User Story 18, User Profile Show Page
User Story 26, User views an Order Show Page

Checklist:

depends on turingschool-examples#220

depends on turingschool-examples#212

User Story 24, User Profile displays Orders link

As a registered user
When I visit my Profile page
And I have orders placed in the system
Then I see a link on my profile page called "My Orders"
When I click this link my URI path is "/profile/orders"

DO THESE STORIES FIRST:

User Story 18, User Profile Show Page

Checklist:

depends on turingschool-examples#220

Epic: Extensions

Extensions

If your team finished all other user stories, it is expected that you will begin work on the following additional stories.

The index page indicated in these stories should be namespaced under a route "/admin". This route should only be accessible to admin users of your application. Any functionality mentioned in this epic should be performed by admin users only, and respective routes should all be namespaced under "/admin"

User Story 22, Visitors must register or log in to check out

As a visitor
When I have items in my cart
And I visit my cart
I see information telling me I must register or log in to finish the checkout process
The word "register" is a link to the registration page
The words "log in" is a link to the login page

DO THESE STORIES FIRST:

User Story 5, Visitor Navigation
User Story 2, User Registration
User Story 13, User can Login

Checklist:

depends on turingschool-examples#235

depends on turingschool-examples#239

depends on turingschool-examples#226

User Story 1, Deploy your application to Heroku

As a visitor or user of the site
I will perform all user stories
By visiting the application on Heroku.
Localhost is fine for development, but
the application must be hosted on Heroku.

Checklist:

Epic: Admins

Admins

User Story 45, Admin User Index Page

As an admin user
When I click the "Users" link in the nav (only visible to admins)
Then my current URI route is "/admin/users"
Only admin users can reach this path.
I see all users in the system
Each user's name is a link to a show page for that user ("/admin/users/5")
Next to each user's name is the date they registered
Next to each user's name I see what type of user they are

DO THESE STORIES FIRST:

User Story 8, Admin Navigation

Checklist:

depends on turingschool-examples#232

Epic: Merchant Admins

Merchant Admins

User Story 28, All Merchants fulfill items on an order

When all items in an order have been "fulfilled" by their merchants
The order status changes from "pending" to "packaged"

DO THESE STORIES FIRST:

User Story 33, Merchant fulfills part of an order

Checklist:

depends on turingschool-examples#204

User Story 12, Admin Navigation Restrictions

As an Admin
When I try to access any path that begins with the following, then I see a 404 error:
- '/merchant'
- '/cart'

DO THESE STORIES FIRST:

User Story 5, Visitor Navigation
User Story 6, User Navigation
User Story 7, Merchant Navigation
User Story 8, Admin Navigation

Checklist:

depends on turingschool-examples#235

depends on turingschool-examples#234

depends on turingschool-examples#233

depends on turingschool-examples#232

Epic: Users

Users

Registered, regular users should be able to add items to their cart, checkout, view/update their orders, and view/update thier profile.

User Story 50, Admin enables a merchant account

As an admin merchant
When I visit the merchant index page
I see an "enable" button next to any merchants whose accounts are disabled
When I click on the "enable" button
I am returned to the admin's merchant index page where I see that the merchant's account is now enabled
And I see a flash message that the merchant's account is now enabled

DO THESE STORIES FIRST:

User Story 44, Admin Merchant Index Page

Checklist:

depends on turingschool-examples#191

User Story 21, User Editing Profile Data must have unique Email address

As a registered user
When I attempt to edit my profile data
If I try to change my email address to one that belongs to another user
When I submit the form
Then I am returned to the profile edit page
And I see a flash message telling me that email address is already in use

DO THESE STORIES FIRST:

User Story 18, User Profile Show Page
User Story 19, User Can Edit their Profile Data

Checklist:

depends on turingschool-examples#220

depends on turingschool-examples#219

User Story 23, Registered users can check out

As a registered user
When I add items to my cart
And I visit my cart
I see a button or link indicating that I can check out
And I click the button or link to check out
An order is created in the system, which has a status of "pending"
That order is associated with my user
I am taken to my orders page ("/profile/orders")
I see a flash message telling me my order was created
I see my new order listed on my profile orders page
My cart is now empty

Checklist:

User Story 5, Visitor Navigation

As a visitor
I see a navigation bar
This navigation bar includes links for the following:
- a link to return to the welcome / home page of the application ("/")
- a link to browse all items for sale ("/items")
- a link to see all merchants ("/merchants")
- a link to my shopping cart ("/cart")
- a link to log in ("/login")
- a link to the user registration page ("/register")

Next to the shopping cart link I see a count of the items in my cart

Checklist:

User Story 10, User Navigation Restrictions

As a User
When I try to access any path that begins with the following, then I see a 404 error:
- '/merchant'
- '/admin'

DO THESE STORIES FIRST:

User Story 5, Visitor Navigation
User Story 6, User Navigation
User Story 7, Merchant Navigation
User Story 8, Admin Navigation

Checklist:

depends on turingschool-examples#235

depends on turingschool-examples#234

depends on turingschool-examples#233

depends on turingschool-examples#232

Epic: Statistics

Statistics

User Story 18, User Profile Show Page

As a registered user
When I visit my profile page
Then I see all of my profile data on the page except my password
And I see a link to edit my profile data

Checklist:

User Story 4, Registration Email must be unique

As a visitor
When I visit the user registration page
If I fill out the registration form
But include an email address already in the system
Then I am returned to the registration page
My details are not saved and I am not logged in
The form is filled in with all previous data except the email field and password fields
I see a flash message telling me the email address is already in use

DO THESE STORIES FIRST:

User Story 2, User Registration

Checklist:

child of turingschool-examples#240

depends on turingschool-examples#239

User Story 20, User Can Edit their Password

As a registered user
When I visit my profile page
I see a link to edit my password
When I click on the link to edit my password
I see a form with fields for a new password, and a new password confirmation
When I fill in the same password in both fields
And I submit the form
Then I am returned to my profile page
And I see a flash message telling me that my password is updated

DO THESE STORIES FIRST:

User Story 18, User Profile Show Page

Checklist:

depends on turingschool-examples#220

User Story 9, Visitor Navigation Restrictions

As a Visitor
When I try to access any path that begins with the following, then I see a 404 error:
- '/merchant'
- '/admin'
- '/profile'

DO THESE STORIES FIRST:

User Story 5, Visitor Navigation
User Story 6, User Navigation
User Story 7, Merchant Navigation
User Story 8, Admin Navigation

Checklist:

depends on turingschool-examples#235

depends on turingschool-examples#234

depends on turingschool-examples#233

depends on turingschool-examples#232

Epic: Merchant Employees

Merchant Employees

User Story 14, User cannot log in with bad credentials

As a visitor
When I visit the login page ("/login")
And I submit invalid information
Then I am redirected to the login page
And I see a flash message that tells me that my credentials were incorrect
I am NOT told whether it was my email or password that was incorrect

DO THESE STORIES FIRST:

User Story 13, User can Login

Checklist:

depends on turingschool-examples#226

User Story 29, Merchant Dashboard Show Page

As a merchant employee or admin
When I visit my merchant dashboard ("/merchant")
I see the name and full address of the merchant I work for

DO THESE STORIES FIRST:

User Story 2, User Registration
User Story 7, Merchant Navigation

Checklist:

depends on turingschool-examples#239

depends on turingschool-examples#233

User Story 16, User can log out

As a logged-in registered user, merchant, or admin
When I visit the logout path
I am redirected to the welcome / home page of the site
And I see a flash message that indicates I am logged out
Any items I had in my shopping cart are deleted

Checklist:

User Story 17, Items Index Page

As a any user
When I visit the items catalog ("/items")
Then I see all items in the system except disabled items

The item image is a link to that item's show page

DO THESE STORIES FIRST:

User Story 5, Visitor Navigation

Checklist:

depends on turingschool-examples#235

User Story 19, User Can Edit their Profile Data

As a registered user
When I visit my profile page
I see a link to edit my profile data
When I click on the link to edit my profile data
I see a form like the registration page
The form is prepopulated with all my current information except my password
When I change any or all of that information
And I submit the form
Then I am returned to my profile page
And I see a flash message telling me that my data is updated
And I see my updated information

DO THESE STORIES FIRST:

User Story 18, User Profile Show Page

Checklist:

depends on turingschool-examples#220

User Story 8, Admin Navigation

As an admin user
I see the same links as a regular user
Plus the following links
- a link to my admin dashboard ("/admin")
- a link to see all users ("/admin/users")

Minus the following links/info
- a link to my shopping cart ("/cart") or count of cart items

DO THESE STORIES FIRST:

User Story 6, User Navigation

Checklist:

depends on turingschool-examples#234

User Story 46, Admin User Profile Page

As an admin user
When I visit a user's profile page ("/admin/users/5")
I see the same information the user would see themselves
I do not see a link to edit their profile

DO THESE STORIES FIRST:

User Story 8, Admin Navigation
User Story 45, Admin User Index Page

Checklist:

depends on turingschool-examples#232

depends on turingschool-examples#190

User Story 13, User can Login

As a visitor
When I visit the login path
I see a field to enter my email address and password
When I submit valid information
If I am a regular user, I am redirected to my profile page
If I am a merchant user, I am redirected to my merchant dashboard page
If I am an admin user, I am redirected to my admin dashboard page
And I see a flash message that I am logged in

DO THESE STORIES FIRST:

User Story 2, User Registration
User Story 5, Visitor Navigation

Checklist:

depends on turingschool-examples#239

depends on turingschool-examples#235

User Story 52, Items Index Page Statistics

As any kind of user on the system
When I visit the items index page ("/items")
I see an area with statistics:
- the top 5 most popular items by quantity purchased, plus the quantity bought
- the bottom 5 least popular items, plus the quantity bought

"Popularity" is determined by total quantity of that item ordered

DO THESE STORIES FIRST:

User Story 17, Items Index Page

Checklist:

child of turingschool-examples#183

depends on turingschool-examples#221

User Story 51, Enabled Merchant Item's are active

As an admin
When I visit the merchant index page
And I click on the "enable" button for a disabled merchant
Then all of that merchant's items should be activated

DO THESE STORIES FIRST:

User Story 44, Admin Merchant Index Page

Checklist:

depends on turingschool-examples#191

User Story 2, User Registration

As a visitor
When I click on the 'register' link in the nav bar
Then I am on the user registration page ('/register')
And I see a form where I input the following data:
- my name
- my street address
- my city
- my state
- my zip code
- my email address
- my preferred password
- a confirmation field for my password

When I fill in this form completely,
And with a unique email address not already in the system
My details are saved in the database
Then I am logged in as a registered user
I am taken to my profile page ("/profile")
I see a flash message indicating that I am now registered and logged in

DO THESE STORIES FIRST:

User Story 5, Visitor Navigation

Checklist:

child of turingschool-examples#240

depends on turingschool-examples#235

User Story 3, User Registration Missing Details

As a visitor
When I visit the user registration page
And I do not fill in this form completely,
I am returned to the registration page
And I see a flash message indicating that I am missing required fields

DO THESE STORIES FIRST:

User Story 2, User Registration

Checklist:

child of turingschool-examples#240

depends on turingschool-examples#239

User Story 49, Disabled Merchant Item's are inactive

As an admin
When I visit the merchant index page
And I click on the "disable" button for an enabled merchant
Then all of that merchant's items should be deactivated

DO THESE STORIES FIRST:

User Story 44, Admin Merchant Index Page

Checklist:

depends on turingschool-examples#191

User Story 26, User views an Order Show Page

As a registered user
When I visit my Profile Orders page
And I click on a link for order's show page
My URL route is now something like "/profile/orders/15"
I see all information about the order, including the following information:
- the ID of the order
- the date the order was made
- the date the order was last updated
- the current status of the order
- each item I ordered, including name, description, thumbnail, quantity, price and subtotal
- the total quantity of items in the whole order
- the grand total of all items for that order

DO THESE STORIES FIRST:

User Story 25, User Profile displays Orders

Checklist:

depends on turingschool-examples#213

User Story 48, Admin disables a merchant account

As an admin
When I visit the merchant index page
I see a "disable" button next to any merchants who are not yet disabled
When I click on the "disable" button
I am returned to the admin's merchant index page where I see that the merchant's account is now disabled
And I see a flash message that the merchant's account is now disabled

DO THESE STORIES FIRST:

User Story 44, Admin Merchant Index Page

Checklist:

depends on turingschool-examples#191

User Story 11, Merchant Navigation Restrictions

As a merchant employee or admin
When I try to access any path that begins with the following, then I see a 404 error:
- '/admin'

DO THESE STORIES FIRST:

User Story 5, Visitor Navigation
User Story 6, User Navigation
User Story 7, Merchant Navigation
User Story 8, Admin Navigation

Checklist:

depends on turingschool-examples#235

depends on turingschool-examples#234

depends on turingschool-examples#233

depends on turingschool-examples#232

Epic: Login, Logout

Login / Logout

Our application wouldn't be much use if users could not log in to use it.

User Story 6, User Navigation

As a registered regular user
I see the same links as a visitor
Plus the following links
- a link to my profile page ("/profile")
- a link to log out ("/logout") **this path is actually specified as being the welcome/home page in User Story 16**

Minus the following links
- I do not see a link to log in or register

I also see text that says "Logged in as Ian Douglas" (or whatever my name is)

DO THESE STORIES FIRST:

User Story 5, Visitor Navigation

Checklist:

depends on turingschool-examples#235

User Story 7, Merchant Navigation

As a merchant employee or admin
I see the same links as a regular user
Plus the following links:
- a link to my merchant dashboard ("/merchant")

DO THESE STORIES FIRST:

User Story 6, User Navigation

Checklist:

depends on turingschool-examples#234

Epic: Navigation

Navigation

This series of stories will set up a navigation bar at the top of the screen and present links and information to users of your site.

There is no requirement that the nav bar be "locked" to the top of the screen.

Completion of these stories will encompass the following ideas:

the navigation is built into app/views/layouts/application.html.erb or loaded into that file as a partial
you write a single set of tests that simply click on a link and expect that your current path is what you expect to see
your nav tests don't need to check any content on the pages, just that current_path is what you expect

You will need to set up some basic routing and empty controller actions and empty action view files.

User Story 31, Merchant's Items index page

As a merchant employee or admin
When I visit my merchant dashboard
I see a link to view my own items
When I click that link
I should be taken to my merchant's items ("/merchant/items")

DO THESE STORIES FIRST:

User Story 18, User Profile Show Page

Checklist:

depends on turingschool-examples#220

Epic: User Registration

User Registration

This series of stories will allow a user to register on the site.

User Story 30, Merchant Dashboard displays Orders

As a merchant employee or admin
When I visit my merchant dashboard ("/merchant")
If any users have pending orders containing items I sell
Then I see a list of these orders.
Each order listed includes the following information:
- the ID of the order, which is a link to the order show page ("/merchant/orders/15")
- the date the order was made
- the total quantity of my items in the order
- the total value of my items for that order

DO THESE STORIES FIRST:

User Story 29, Merchant Dashboard Show Page

Checklist:

depends on turingschool-examples#208

User Story 47, Admin can see a merchant's dashboard

As an admin user
When I visit the merchant index page ("/merchants")
And I click on a merchant's name,
I should be taken to my admin merchant show page ("/admin/merchants/6")
Then I see everything that merchant would see on their merchant dashboard page

Checklist: