Service implementation

README.md

@@ -1,58 +1,72 @@
-# Desafio Python Moniari
+# stock-price-tracker
 
-## Descrição
+## Project Overview
 
-Este projeto foi desenvolvido para avaliar suas habilidades com tecnologias de back-end, focando em Python, APIs REST, e arquitetura de serviços desacoplados.
+This project demonstrates a backend split into microservices made with Python, a frontend made with TypeScript, utilizing Test-Driven Development (TDD) and Clean Architecture principles.
 
-## Tarefa
+## Running the Project
 
-O desafio consiste em criar uma API simples utilizando Python (**FastAPI**), que permita aos usuários consultar cotações de ações.
-O projeto é dividido em dois serviços distintos:
+To run the project using Docker, execute the following command:
+```sh
+docker compose up --build
+```
 
-- Uma API voltada para o usuário final, que processa solicitações de usuários registrados em busca de informações sobre cotações de ações.
-- Um serviço interno agregador de cotações, responsável por consultar APIs externas para buscar as cotações solicitadas pelos usuários.
+## Services
 
-## Requisitos Mínimos
+### Api Service
 
-### Serviço de API
+- **Description**: Acts as the main entry point to the backend.
+- **Documentation**: [http://localhost:80/docs](http://localhost:80/docs)
+- **Routes**:
+  - `/login`: Route to login.
+  - `/stock?q={name}`: Route to get stock data by name.
 
-- Os endpoints deste serviço devem exigir **autenticação**, não permitindo solicitações anônimas. Cada solicitação deve ser autenticada utilizando Basic Authentication (exemplo: `Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==` onde o token é a conversão em Base64 de username:senha).
+### Stock Service
 
-- Ao receber uma solicitação de cotação de ação (através do endpoint dedicado no serviço de API), se a ação for encontrada, o serviço deve registrar no console o usuário requisitante e a ação solicitada.
+- **Description**: Processes and sends stock data.
+- **Documentation**: [http://localhost:81/docs](http://localhost:81/docs)
+- **Routes**:
+  - `/stock?symbol={name}`: Route to consult the stock by name.
 
-- A resposta do serviço de API deve seguir o formato: `GET /stock?q=aapl.us`
+### Auth Service
 
-```python
-{
-  "simbolo": "AAPL.US",
-  "nome_da_empresa": "APPLE",
-  "cotacao": 123
-}
-```
+- **Description**: Handles token generation and authentication.
+- **Documentation**: [http://localhost:82/docs](http://localhost:82/docs)
+- **Routes**:
+  - `/login`: Route to generate a token.
+  - `/validate-token`: Route to authenticate a token.
+
+### Log Service
 
-O valor da cotação deve ser extraído do campo `close` retornado pelo serviço de cotações.
+- **Description**: Responsible for logging information about the other services into files located in its logs directory.
+- **Documentation**: [http://localhost:83/docs](http://localhost:83/docs)
+- **Routes**:
+  - `/log`: Route to receive the logs.
 
-- Todas as respostas dos endpoints devem ser em formato JSON.
+## Frontend Web
 
-### Serviço de Cotações
+- **URL**: [http://localhost:3000](http://localhost:3000)
+
+## Frontend Mobile
+
+To run the frontend mobile version, enter the frontend-mobile folder and run the following commands:
+```sh
+npm install
+npm run android
+```
 
-- Considerando que este serviço é interno, solicitações para seus endpoints não requerem autenticação.
-- Ao receber uma solicitação de cotação, este serviço deve consultar uma API externa para obter as informações necessárias. Para este desafio, utilize a seguinte API: `https://stooq.com/q/l/?s={codigo_da_acao}&f=sd2t2ohlcvn&h&e=csv`.
-- O `{codigo_da_acao}` deve ser substituído pelo código da ação desejada pelo usuário.
-- Uma lista de códigos de ações disponíveis pode ser encontrada em: https://stooq.com/t/?i=518
+## Diagrams
 
-### Mecanismo de Log
+### Backend Microservices Architecture
+![Backend Microservices Architecture](diagrams/backend/microservices.png)
 
-- Ambos os serviços, **Serviço de API** e **Serviço de Cotações**, devem implementar um **mecanismo de log** que registre as operações realizadas.
-- Os logs gerados por ambos os serviços devem ser armazenados em uma pasta denominada `logs` dentro do diretório do projeto.
-- Os arquivos de log devem ter a extensão `.log`.
-- É importante que os logs incluam informações detalhadas sobre as solicitações processadas, incluindo timestamp, tipo de solicitação, dados da solicitação (se aplicável) e quaisquer mensagens de erro ou alertas gerados durante o processamento.
+### Frontend Login Architecture
+![Frontend Login Architecture](diagrams/frontend/login.png)
 
-## Arquitetura
+### Frontend Get Stock Data Architecture
+![Frontend Get Stock Data Architecture](diagrams/frontend/get-stock-data.png)
 
-![Diagrama de Arquitetura](arquitetura.png)
+## Author
 
-1. Um usuário solicita a cotação atual de uma ação da Apple: `GET /stock?q=aapl.us`
-2. O serviço de API encaminha a solicitação para o serviço de cotações para obter as informações necessárias.
-3. O serviço de cotações consulta a API externa, processa a resposta e retorna as informações para o serviço de API.
-4. As informações são formatadas e enviadas de volta ao usuário.
+Douglas Volcato  
+[GitHub](https://github.com/DouglasVolcato)

api_service/.env.example

@@ -0,0 +1,5 @@
+PROJECT_NAME="Api Service"
+API_VERSION="1.0.0"
+STOCK_SERVICE_URL="http://stock_service:81"
+AUTH_SERVICE_URL="http://auth_service:82"
+LOG_SERVICE_URL="http://log_service:83"

api_service/Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3.9
+
+WORKDIR /code
+
+COPY ./requirements.txt /code/requirements.txt
+
+RUN pip install --upgrade pip
+RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
+
+COPY . /code/
+
+CMD ["sh", "-c", "fastapi run main.py --port 80"]

api_service/controllers/login_controller.py

@@ -0,0 +1,11 @@
+from dtos.login_dto import LoginDto
+
+class LoginController:
+    def __init__(self, auth_service, make_login_request_validator):
+        self.__auth_service = auth_service
+        self.__make_login_request_validator = make_login_request_validator
+
+    def execute(self, request: LoginDto):
+        if not self.__make_login_request_validator.validate(request):
+            return False
+        return self.__auth_service.create_token(request.username, request.password)

api_service/controllers/stock_controller.py

@@ -0,0 +1,15 @@
+class StockController:
+    def __init__(self, stock_service, get_stock_request_validator):
+        self.__stock_service = stock_service
+        self.__get_stock_request_validator = get_stock_request_validator
+
+    def execute(self, symbol):
+        if not self.__get_stock_request_validator.validate(symbol):
+            return False
+        stock = self.__stock_service.get_stock(symbol)
+        if not stock:
+            return False
+        price = stock["cotacao"]
+        if price == 'N/D':
+            return False
+        return stock

api_service/dtos/login_dto.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+class LoginDto(BaseModel):
+  username: str
+  password: str

api_service/factories/controllers/login_controller_factory.py

@@ -0,0 +1,8 @@
+from validators.make_login_request_validator import MakeLoginRequestValidator
+from gateways.auth_service_gateway import AuthServiceGateway
+from controllers.login_controller import LoginController
+
+def makeLoginControllerFactory():
+    auth_service = AuthServiceGateway()
+    make_login_request_validator = MakeLoginRequestValidator()
+    return LoginController(auth_service,make_login_request_validator)

api_service/factories/controllers/stock_controller_factory.py

@@ -0,0 +1,8 @@
+from validators.get_stock_request_validator import GetStockRequestValidator
+from gateways.stock_service_gateway import StockServiceGateway
+from controllers.stock_controller import StockController
+
+def makeStockControllerFactory():
+    stock_service = StockServiceGateway()
+    make_stock_request_validator = GetStockRequestValidator()
+    return StockController(stock_service,make_stock_request_validator)

api_service/factories/middlewares/user_auth_middleware_factory.py

@@ -0,0 +1,6 @@
+from gateways.auth_service_gateway import AuthServiceGateway
+from middlewares.user_auth_middleware import UserAuthMiddleware
+
+def makeUserAuthMiddlewareFactory():
+    auth_service = AuthServiceGateway()
+    return UserAuthMiddleware(auth_service)

api_service/gateways/auth_service_gateway.py

@@ -0,0 +1,30 @@
+
+import requests
+import os
+
+class AuthServiceGateway:
+    def __init__(self):
+        self.__auth_service_url = os.getenv("AUTH_SERVICE_URL")
+
+    def validate_token(self, token):
+        try:
+            if not token.startswith('Basic '):
+                return False
+            formated_token = token.replace('Basic ', '') 
+            response = requests.get(f"{self.__auth_service_url}/validate-token?token={formated_token}")
+            if response.status_code == 200:
+                return True
+            else:
+                return False
+        except Exception as e:
+            return False
+
+    def create_token(self, username, password):
+        try:
+            response = requests.post(f"{self.__auth_service_url}/login", json={"username": username, "password": password})
+            if response.status_code == 200:
+                return response.json().get("token")
+            else:
+                return False
+        except Exception as e:
+            return False

api_service/gateways/file_log_builder_adapter.py

@@ -0,0 +1,21 @@
+import requests
+import json
+import os
+
+class FileLogBuilderGateway:
+    def __init__(self, title):
+        self.__auth_service_url = os.getenv("LOG_SERVICE_URL")
+        self.__title = title
+
+    def log(self, message):
+        try:
+            response = requests.post(
+                f"{self.__auth_service_url}/log", json={"title": self.__title, "message": message}
+            )
+            if response.status_code == 200:
+                return True
+            else:
+                return False
+        except Exception as e:
+            print(e)
+            return False

api_service/gateways/stock_service_gateway.py

@@ -0,0 +1,12 @@
+import requests
+import os
+
+class StockServiceGateway:
+    def __init__(self):
+        self.__stock_service_url = os.getenv("STOCK_SERVICE_URL")
+
+    def get_stock(self, symbol):
+        response = requests.get(f"{self.__stock_service_url}/stock?symbol={symbol}")
+        if response.status_code != 200:
+            return False
+        return response.json()