# A2: Actors and User stories

The project consists in developing a global marketplace which specializes in the sale of gaming related digital products using redemption keys.

This artefact contais the specification of the actors and their user stories, it also serves as a lightweight documentation of the project's requirements and business rules.

## 1. Actors

###### Picture 1: Diagram identifying actors and their relationships.

| Identifier| Description| Examples|
| ------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
|User| Generic user. Has access to public information such as products on discount, sellers reviews and feedback.| n/a|
|Unauthenticated User| Has the ability to sign up and login into the website.| n/a|
|Authenticated User| Is capable of logging out, managing their personal account information and buy and sell products.| nightwalker739 |
|Active User| Is a user with full rights in the platform, he can buy and sell products without any restriction.| nightwalker739 |
|Buyer| Has the ability, review and report sellers of his purchased products.| nightwalker739|
|Banned User| Is banned from making new transactions, whether it is selling or buying, but still has access to past transactions' details.| trustlessuser123|
|Administrator| Has the capacity to delete offensive reviews, update products' details, block certain users from selling and buying games, add games to the database, manage the reports made by users. | admin |
|API User| External user that has the possibility to obtain and change information on the website using GET and POST HTTP requests.| External User|
|Paypal Sandbox API| Allows the user to use PayPal as a payment method to buy products onthe website.| Paypal Email and Password |
|Google Authentication API | Allows the user to sign in with their own google account into the website.| Google Email and Password|

###### Table 1: Actor's description and examples

## 2. User Stories

### 2.1. User

| Identifier | Name| Priority | Description|
| ---------- | -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|US01|Search Product|High| As an user, I want to search for a specific product by name, so that I can easily access the product I'm looking for.|
|US02|Search Filters|High| As an user, I want to restrict categories, genres and platforms of a search's results, so that I can search for results of my interest.|
|US03|View Product|High| As a user, I want to view products details, so that I can buy the product I desire.|
|US04|View Shopping Cart|High| As an user, I want to view my shopping cart content anywhere in the website, so that I can checkout and manage it content.|
|US05|Browse|High| As an user, I want to browse the website for products, genres, categories and platforms so that I can see the all the information I pretend.|
|US06|Sort Search Results|Medium| As an user, I want to sort the list of products by price, date of release, popularity, so that I can more easily find desired products.|
|US07|View Seller Reviews|Medium|As an user, I want to see the sellers reviews and feedback, so that I am aware if the seller is trusted.|
|US08|View Shooping Cart|Medium| As an user, I want to be able to view items of my shopping cart so that I can keep track of my order current content and price.|
|US09|Manage Shooping Cart Items|Medium| As a user, I want to be able to add and remove items from a shopping cart so that my checkout won't include any undesired item.|
|US10|View Seller Profile|Medium| As an user, I want to be able to view seller profile page, so that I can access his contact information.|
|US11|Save Shooping Cart Items|Low|As an user, I want my shopping cart to keep previously selected items, so that when I exit and comeback to the website the shopping cart remains the same.|
|US12|FAQ|Low|As a user, I want to access the FAQ page, so that I can clarify some of my questions.|
|US13|View Discounts|Low| As an user, I want to view the products that are on discount, so that I can see if a product that I am interested in has a lower price.|

###### Table 2: User's user stories

### 2.2. Unauthenticated User

|Identifier | Name | Priority | Description|
| ---------- | ---- | -------- | --- |
|US14| Sign Up | High | As an unauthenticated User, I want to be able to sign up, so that I can be an authenticated user.|
|US15| Login | High | As an unauthenticated User, I want to be able to login, so that I can have the privileges of an authenticated user.|
|US16| Sign Up Using External API |Low| As an unauthenticated User, I want to be authenticated using an google account, so that I don't have to fill the sign up form.|
|US17| Login Using External API | Low | As an unauthenticated User, I want to be authenticated using an google account, so that I don't have to fill the login form.|

###### Table 3: Unauthenticated User's user stories

### 2.3. Authenticated User

| Identifier |Name| Priority | Description|
| ---------- | ------------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|US18|Logout|High| As an authenticated user, I want to be able to logout of the website so that I'm no longer logged in.|
|US19| Account Deletion| High| As an authenticated user, I want to be able to delete my account, so that I am no longer related with the website.|
|US20|Edit Profile|High|As an authenticated user, I want to be able to manage my personal account information, so that I can update my personal information.
|US21| Purchases History|Medium| As an authenticated user, I want to see my past purchases, so that I know the details of each purchase.|
|US22| Sales History|Medium| As an authenticated user, I want to view all my past sales, so that I can see which products I have sold.|
|US23|Shopping Cart Preservation| Medium| As an authenticated user, I want the items that I had in my shopping cart before loging on preserve it state after login successful, so that I do not need to select them again.|

###### Table 4: Authenticated User's user stories

### 2.4. Active User

| Identifier |Name| Priority | Description|
| ---------- | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|US24|Sell Product|High|As an active user, I want to place an offer for a given product that I chose from the ones available in the website's database, so that I am able to sell it.|
|US25|Active Offers|Medium|As an active user, I want to see the products that I am currently selling, so that I can keep track of the offer's state.|
|US26|Update Offer|Medium|As an active user, I want to update my product's price, so that I can better compete with other sellers.|
|US27|Exclude Offer|Medium|As an active user, I want to remove a previously published offer, so that I am no longer selling the product.|
|US28|Checkout Cart|Medium| As a active user, I want to be able to checkout my cart, so that I buy all the items in the shopping cart at once.|
|US29|Reply to Reports|Low|As an active user, I want to be able to reply to reports made against me, so that I can handle the situation and explain my motives to buyer and administrator.|
|US30|Batch Sell|Low| As an active user, I want to sell multiple keys of a product at the same time, so that selling multiple keys for the same product is much quicker and easier.|
|US31|Product Discount|Low|As an active user, I want to make discounts to my offers, so that it lowers the offers' price during a period of time.|
|US32|Transactions using Paypal|Low| As a active user, I want to be able to make transactions using PayPal, so that I use a secure payment method.|

###### Table 5: Active User's user stories

### 2.5. Buyer

| Identifier |Name| Priority | Description|
| ---------- | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|US33|Transaction Feedback|High| As a buyer, I want to be able to give feedback to the Seller of a product I bought.|
|US34|Report Transaction Problem|Medium|As a buyer, I want to be able to report a problem with a key I bought, so that the seller and administrators are made aware of the situation.|

###### Table 6: Buyer's user stories

### 2.6 Banned User
| Identifier | Name| Priority | Description|
| ---------- | ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|US35|Unban appeal|Low| As a banned user, I want to appeal to the administrator of the website, so that my ban can be lifted.|

###### Table 7: Banned User's user stories

### 2.7. Administrator

|Identifier | Name| Priority | Description|
| ---------- | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
|US36|Add Products| High | As an admin, I want to be able to add products to the database, so that I can keep the product's list always updated. |
|US37|Admin Login | High | As an admin, I want to be able to sign in, so that I get administrative privileges|
|US38|Admin Sign Out | High | As an admin, I want to be able to sign out, so that I'm no longer logged in.|
|US39|Product Search | Medium| As an admin, I want to be able to search for games by name, so that I can quickly access them.|
|US40|User Search | Medium| As an admin, I want to be able to search for users by name, so that I can quickly access them.|
|US41|User Ban| Medium| As an admin, I want to be able to block users, so that I can keep scammers away from the website|
|US42|Product Edit| Medium| As an admin, I want to be able to edit products in the database, so that the I can change each product information.|
|US43|Product Delete| Medium| As an admin, I want to be able to delete products in the database, so that that a faulty product entry in the database is removed.|
|US44|Access to Users' Reports|Medium| As an admin, I want to able to manage reports from users, so that I am able to take action and make the commmunity happier.|
|US45|Review Delete|Low|As an admin, I want to be able to delete offensive reviews, so that I can keep the order and respect on the website.|
|US46|Manage Game Categories|Low|As an admin, I want to be able to add, edit and remove a product category, so that I can better specify a game's category.|
|US47|Manage Gaming Platforms|Low|As an admin, I want to be able to add, edit and remove a gaming platform, so that I can better specify a game's platform.|
|US48|Manage Game Genres|Low|As an admin, I want to be able to add, edit and remove a product genre, so that I can better specify a game's genre.|
|US49|Manage FAQ|Low| As an admin, I want to be able to add, edit and remove a question of the FAQ, so that the FAQ is kept up-to-date.|
|US50|Check Transactions|Low|As an admin, I want to be able to see all transactions, so that I can keep track of the website's activity. |
|US51|Remove User Ban|Low|As an admin, I want to be able to unban a user, so that the user can buy and sell products again. |
|US52|Manage ban lift appeals|Low| As an admin, I want to be able to see all appeals made by banned users, so that I review their requests and issue a response.|

###### Table 8: Admin's user stories

### 2.8. API User

| Identifier | Name| Priority | Description|
| ---------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|US53|Search Products|Low| As an API user, I want to get a list of products that are available, so that I know which ones are available.|
|US54|Search Sellers|Low| As an API user, I want to get a list of sellers and their offers for a specific product, so that I can compare the offers of the different sellers.|
|US55|Sell a Product|Low| As an API user I want to be able to put an item on discount, so that I can sell that product.|
|US55|Buy a Product|Low| As an API user, I want to buy an offer of a product, so that I own the product.|

###### Table 9: API user's user stories

## A1. Annex: Supplementary requirements

### A1.1. Business rules

| Identifier | Name | Description|
| ---------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|BR01|Single Review| A buyer can only make one review of the seller per product transacion.|
|BR02|Seller Feedback| The seller's feedback rating consists of the average of all feedback received from all past sales.|
|BR03|User Ban| An administrator will have the option to ban an user from making transactions should he consider the user to not be trustworthy.Since the user won't be able to buy items he will not be capable of issuing future feedback to sellers, although he will still retain the possibility of reviewing past transactions. All keys on discount are automatically excluded from the website.|
|BR04|Seller Restriction| A seller cannot buy his an offer that he is currently sellling, and so he cannot make a review about himself.|
|BR05|User Account Deletion| When a user chooses to delete his account all received feedback and profile details are deleted, but all reviews given to sellers are mantained anonymously, furthermore all sold keys are maintained in the database to allow the buyers to see the keys. All keys being sold by this seller are automatically excluded from the website.|
|BR06| Product Deletion| When administrator deletes a product. If there is any trasanction completed associated with that product, the user must keep access to the bought key.|
|BR07|Age Restriction| User must be at least 18 years old to create an account.|
|BR08|Key Uniqueness| All redemption keys must be unique and so, when entered in the database and to make sure they are, they will be tested against all other keys in the database.|
|BR09|Transaction Fee| All transactions will impose a 5% fee as commission.|
|BR10|Payment Method| All transactions will be made using PayPal.|
|BR11|Offer Discount Date| When setting a discount date for a product it must be greater than the current date.|
|BR12|Review Date| The date of a review must be after the product's transaction date.|
|BR13|Ban Lift|Every banned user has the right to submit one appeal form to be reviewed by the administrator.|
|BR14|No Refund|There will be no possibility to ask for a refund after a successful transaction is completed.|
|BR15|Game Update Restriction|After pubishing an offer, a seller cannot change the game that he defined the keys belong to.|
|BR16|Seller Report|A report made by an user will start a conversation with seller where the administrator can also participate. Administrator will only intervene if necessary.|

###### Table 10: Business rules

### A1.2. Technical requirements
| Identifier | Name| Description|
| ---------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|TR01| **Security**| The system shall protect information from unauthorised access through the use of an authentication system and the encryption of the sensitive data stored |
|TR02| **Concurrency**| The system must be prepared to handle errors that may occur when multiple users try to buy the same product in runtime.|
|TR03| **Usability**| The system should have a pratical interface for desktop and mobile users to be easy to buy and sell. |
|TR04| Accessibility| The system must ensure that everyone can access the pages, regardless of whether they have any handicap.|
|TR05|Performance| The system should have short response time and information upload.|
|TR06|Web Application | The system should be implemented as a Web application with dynamic pages (HTML5, JavaScript, CSS3, PHP(Laravel) and Bootstrap 4.|
|TR07|Server Side Cross-Platform| The server-side system should work across multiple platforms(Linux or Windows).|
|TR08|User Side Browser Compatibility|The website should render in the most popular browsers(Chrome,Mozilla or Opera).|
|TR09|Database|The PostgreSQL 9.4 database management system must be used.|
|TR10|Scalability| The system must be prepared to handle an increase in the number of visitors, offers and transactions.|
|TR11|Ethics| The system must respect the ethical principles in software development. Furthermore data privacy must be guaranteed as well as a community free of offensive reviews.|

###### Table 11: Technical Requirements

The most important technical requirements for this project are:
* **Security** - Since all products sold on the website are redemption keys a security failure will potentially lead to a catastrophic loss of revenue and costumer trust.
* **Robustness** - It is important for the website to be able to handle runtime errors, such as when 2 costumers try to buy the same offer at almost the same time so that they don't get the same key which can only be used once by only one of them.
* **Usability** - The website should very simple and easy to use so customers can make purchase and sell products without any type of delay independently of the device they access it from.

### A1.3. Restrictions

| Identifier | Name | Description|
| ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
|C01| Deadline | The system should be ready to be used at the end of the second semester|

###### Table 12: Restrictions

## Revision history

First submission date: 2020/02/26

First revision changes: 2020/03/18
* Added new row to the actors tree by adding active user and removed seller;
* Moved user stories from buyer and seller to user, authenticated user and active user;
* Changed name and priority of most user stories to a more informative name;
* Added user story about cart preservation (US21);
* Added user story to administrator about shearching users;
* Clarified the user story about admin deleting games;
* Removed obvious/not needed Business Rules;

***
## Team: 43
* José Guerra, [e-mail] (Editor)
* Luís Ramos, [e-mail]
* Martim Silva, [e-mail]
* Ruben Almeida, [e-mail]