This project is an HTTP server REST API implementation

• Creating a registration service that receives an email and a password.
• Allowing login into the server with an email and a password.
• Allowing logged in users to create and update trading operations.

• Architecture
  • Technology Stack
  • Database Diagram Model
• Environment
  • File Descriptions
  • API Endpoints
• Installation
• Usage
• Bugs
• Authors
• License

This project was developed on Ubuntu 20.04 LTS using python 3.8.10 with flask framework, connecting to a MySQL Database.

• app.py contains the entry point of the API.
• config.py contains the configuration settings for the API.
• DB_stock_log_V3.sql contains the database configured for this project (data not included).
• models/ contains classes used for this project.
• routes/ contains endpoints implemented for the API:
• routes/auth_blueprint.py implemented routes to create users and login.
• routes/index_blueprint.py implemented routes to test authorization and welcome the user to the API.
• routes/user_blueprint.py implemented routes to read and update users.
• routes/trade_blueprint.py implemented routes to create, read and udpate users.
• security/ contains functions used to encrypt and decrypt tokens to identify users for this project.
• validators/ contains functions used to validate request parameters.
• schemas/ contains methods to serialize and deserialize the data.
• templates/ contains html files used to show users and trades.
• documentation/ contains files used for document endpoints of the API.
• documentation/collections directory contains files used for use the API.
• documentation/images contains images used in the readme.md file.

This is the list of available endpoints for this project.

Index

Authentication

User

Trade

1. Clone this repository

$   git clone "https://github.com/jcgonzalezb/stock_trading_log.git"

2. Access the 'stock_trading_log' directory:

$   cd stock_trading_log

3. As a good practice, I suggest you create a virtual environment, e.g.

$   python3 -m venv myenv

4. Activate the new environment

$   source myenv/bin/activate

5. Install the requirements

$   pip install -r requirements.txt

6. Run the program

$   python3 app.py

Now you are running the API and it is ready to create requests locally and test functionality, e.g.

 * Serving Flask app 'config' (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: on
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 262-635-844

7. To test the API, copy the IP address from your console, e.g. http://127.0.0.1:5000 and go to Usage

8. When you have done, terminate the app process with Ctrl+c and deactivate the venv.

$ deactivate

Load the postman collection in the collections folder into your postman account to test each endpoint.

This example shows how to update the name of a user.

1. Go to http://127.0.0.1:5000/login/, set in the authorization section the username (email) and password assigned to a user. Then, set the HTTP method to POST and make click on the send buttom. The server will return an access token you'll need to try the endpoints. At the end, make copy of the access token.

2. Go to http://127.0.0.1:5000/users/update, set in the authorization section the username (email) and password assigned to the same user, click on Headers to insert the token previouesly created and click on Body to insert the JSON body with the new name of the user. The app would not be allowed to update more user information other than the name.

3. SET the HTTP method to PATCH and and make click on the send buttom. The app will show the following mssage: "The user has been updated!". The user name has been updated successfully. To confirm the update, go to http://127.0.0.1:5000/users/profile.

No known bugs at this time.

• Alejandra Hincapie Cortés

• Juan Camilo González

Public Domain. No copy write protection.