Module 3 Capstone - TEnmo

Congratulations—you've landed a job with TEnmo, whose product is an online payment service for transferring "TE bucks" between friends. However, they don't have a product yet. You've been tasked with writing a RESTful API server and command-line application.

Use cases

Required Use Cases

You should attempt to complete all of the following required use cases.

[COMPLETE] As a user of the system, I need to be able to register myself with a username and password.
1. A new registered user starts with an initial balance of 1,000 TE Bucks.
2. The ability to register has been provided in your starter code.
[COMPLETE] As a user of the system, I need to be able to log in using my registered username and password.
1. Logging in returns an Authentication Token. I need to include this token with all my subsequent interactions with the system outside of registering and logging in.
2. The ability to log in has been provided in your starter code.
As an authenticated user of the system, I need to be able to see my Account Balance.
As an authenticated user of the system, I need to be able to send a transfer of a specific amount of TE Bucks to a registered user.
1. I should be able to choose from a list of users to send TE Bucks to.
2. A transfer includes the User IDs of the from and to users and the amount of TE Bucks.
3. The receiver's account balance is increased by the amount of the transfer.
4. The sender's account balance is decreased by the amount of the transfer.
5. I can't send more TE Bucks than I have in my account.
6. A Sending Transfer has an initial status of "approve."
As an authenticated user of the system, I need to be able to see transfers I have sent or received.
As an authenticated user of the system, I need to be able to retrieve the details of any transfer based upon the transfer ID.

Optional Use Cases

If you complete all of the required use cases and are looking for additional challenge, complete as many of the following optional use cases as you can.

As an authenticated user of the system, I need to be able to request a transfer of a specific amount of TE Bucks from another registered user.
1. I should be able to choose from a list of users to request TE Bucks from.
2. A transfer includes the User IDs of the from and to users and the amount of TE Bucks.
3. A Request Transfer has an initial status of "pending."
4. No account balance changes until the request is approved.
5. The transfer request should appear in both users' list of transfers (use case #5).
As an authenticated user of the system, I need to be able to see my "pending" transfers.
As an authenticated user of the system, I need to be able to either approve or reject a Request Transfer.
1. I can't "approve" a given Request Transfer for more TE Bucks than I have in my account.
2. The Request Transfer status is "approved" if I approve, or "rejected" if I reject the request.
3. If the transfer is approved, the requester's account balance is increased by the amount of the request.
4. If the transfer is approved, the requestee's account balance is decreased by the amount of the request.
5. If the transfer is rejected, no account balance changes.

Sample screens

Use Case 3 - Current balance

Your current account balance is: $9999.99

Use Case 4 - Send TE Bucks

-------------------------------------------
Users
ID          Name
-------------------------------------------
313         Bernice
54          Larry
---------

Enter ID of user you are sending to (0 to cancel):
Enter amount:

Use Case 5 - View transfers

-------------------------------------------
Transfers
ID          From/To                 Amount
-------------------------------------------
23          From: Bernice          $ 903.14
79          To:    Larry           $  12.55
---------
Please enter transfer ID to view details (0 to cancel): "

Use Case 6 - Transfer details

--------------------------------------------
Transfer Details
--------------------------------------------
 Id: 23
 From: Bernice
 To: Me Myselfandi
 Type: Send
 Status: Approved
 Amount: $903.14

Use Case 7 - Requesting TE Bucks

-------------------------------------------
Users
ID          Name
-------------------------------------------
313         Bernice
54          Larry
---------

Enter ID of user you are requesting from (0 to cancel):
Enter amount:

Use Case 8 - Pending requests

-------------------------------------------
Pending Transfers
ID          To                     Amount
-------------------------------------------
88          Bernice                $ 142.56
147         Larry                  $  10.17
---------
Please enter transfer ID to approve/reject (0 to cancel): "

Use Case 9 - Approve or reject pending transfer

1: Approve
2: Reject
0: Don't approve or reject
---------
Please choose an option:

Database Schema

Users table

The users table stores the login information for users of the system.

Field	Description
`user_id`	Unique identifier of the user
`username`	String that identifies the name of the user; used as part of the login process
`password_hash`	Hashed version of the user's password
`salt`	String that helps hash the password

Accounts table

The accounts table stores the accounts of users in the system.

Field	Description
`account_id`	Unique identifier of the account
`user_id`	Foreign key to the `users` table; identifies user who owns account
`balance`	The amount of TE bucks currently in the account

Transfer types table

The transfer_types table stores the types of transfers that are possible.

Field	Description
`transfer_type_id`	Unique identifier of the transfer type
`transfer_type_desc`	String description of the transfer type

There are two types of transfers:

`transfer_type_id`	`transfer_type_desc`	Purpose
1	Request	Identifies transfer where a user requests money from another user
2	Send	Identifies transfer where a user sends money to another user

Transfer statuses table

The transfer_statuses table stores the statuses of transfers that are possible.

Field	Description
`transfer_status_id`	Unique identifier of the transfer status
`transfer_status_desc`	String description of the transfer status

There are three statuses of transfers:

`transfer_status_id`	`transfer_status_desc`	Purpose
1	Pending	Identifies transfer that hasn't occurred yet and requires approval from the other user
2	Approved	Identifies transfer that has been approved and occurred
3	Rejected	Identifies transfer that wasn't approved

Transfers table

The transfer table stores the transfers of TE bucks.

Field	Description
`transfer_id`	Unique identifier of the transfer
`transfer_type_id`	Foreign key to the `transfer_types` table; identifies type of transfer
`transfer_status_id`	Foreign key to the `transfer_statuses` table; identifies status of transfer
`account_from`	Foreign key to the `accounts` table; identifies the account that the funds are being taken from
`account_to`	Foreign key to the `accounts` table; identifies the account that the funds are going to
`amount`	Amount of the transfer

How to set up the database

In the database folder, you'll find the database creation script tenmo.sql. Open this in SQL Server Management Studio and execute it.

Authentication

The user registration and authentication functionality for the system has already been implemented. If you review the login code in Program.cs, you'll notice that after a successful authentication, the user is stored in UserService, which is a helper class to keep track of the logged in user and provide information about them.

There's also a method called UserService.GetToken() that returns the authorization token—meaning JWT—of the logged in user. When the use cases above refer to an "authenticated user", this means a request that includes the token.

Set startup projects

Since both the client and server applications are included in the solution, you'll have to configure the solution to run both projects simultaneously. In Visual Studio, right-click the solution and select "properties." In the window that appears, select "Multiple startup projects" and set both "TenmoClient" and "TenmoServer" to have the action Start.# TEnmo-Capstone

PrestonRamsay/TEnmo-Capstone