Projeto Sistema de Pagamentos

README.md

@@ -1,39 +1,80 @@
-# 🚀 Venha participar do nosso time campeão!
+# Sistema de Pagamentos!
 
-Ao conhecer uma pessoa que está aplicando para a Incentive.me gostamos de ter uma conversa sobre código. Afinal, escrever, ler e discutir sobre código faz parte da nossa rotina diária de trabalho.
+Projeto para o desafio técnico da empresa Incentive.me. O projeto escolhido foi o Sistema de Pagamentos, o resultado você pode acessar em: 
+https://payment-system-oseias.vercel.app/
 
-Você pode implementar o projeto usando qualquer linguagem de sua preferência. Lembre-se: use a linguagem com a qual você tem mais familiaridade.
+# Api
 
-## O que vamos avaliar?
+## Descrição
 
-- Comunicação na revisão do código;
-- Argumentos sobre desafios enfrentados e escolhas realizadas na implementação;
-- Código bem escrito, limpo e coeso;
-- Arquitetura e princípios de desenvolvimento;
-- Documentação (README.md) com instruções claras para reproduzir o projeto;
-- Uso adequado de versionamento do código em git;
-- Uso de testes automatizados;
-- Deploy da aplicação;
-- O design da API RESTful é implementado, usando corretamente os verbos HTTP e o código de status apropriado;
-- Uso adequado de HTML5, CSS3 e JavaScript em um front-end minimamente estruturado;
+A api foi desenvolvida em NodeJS seguindo a filosofia de design Clean Architecture, onde são abastraídas e separadas as responsabilidades em cada camada. 
 
-Caso você não se sinta confortável com algum desses itens, tudo bem, apenas nos fale sobre isso, ok? O objetivo aqui não é te fazer perder tempo com algo irrelevante. Nosso objetivo aqui é ter um código sobre o qual podemos conversar. Como você deve ter notado, a gente preza muito por colaboração, trabalho em time e comunicação. O objetivo aqui é ter, minimamente, essa experiência com você.
+#### Bibliotecas Utilizadas
 
-Respeite o seu nível de conhecimento e experiência, o importante é você saber dizer o motivo das suas escolhas. Se você tiver qualquer dúvida, por favor, entre em contato com a gente. Estamos disponíveis para te ajudar a finalizar esse processo.
+- Express, nodemon e sucrase
+- dotenv, cors
+- JsonWebToken, uuid e Bcrypt
+- mysql2
 
-# Opções de projetos
 
-A seguir seguem algumas ideias de projetos que você pode implementar:
+### Instalação da Api
 
-- [Cliente para o GitHub](https://github.com/incentive-me/projeto-selecao/blob/master/projects/GITHUB.md);
-- [Sistema de pagamentos](https://github.com/incentive-me/projeto-selecao/blob/master/projects/PAGAMENTOS.md).
-- **Projeto open source próprio**: Se você tiver algum projeto pronto, que tenha relação com desenvolvimento Web, você pode apresentá-lo na entrevista. Conte-nos sobre suas motivações ao criá-lo, os desafios técnicos e não técnicos enfretados etc. O objetivo aqui é poupar seu tempo
-e evitar que você tenha que criar outro projeto, caso já tenha um.
+Faça um fork do projeto. Entre no diretório ./api e digite o comando:
+```bash
+$ yarn install
+```
 
-# Como compartilhar o projeto conosco
+Após instalar as dependências do projeto, crie um arquivo .env e coloque as variáveis de ambiente conforme o arquivo .env-example.
 
-1. Apague este README.md e adicione informações que achar relevante como configurar o projeto, contendo os comandos que devem ser executados para executar ele e os testes;
-2. Abra um PR apontando para a branch master deste repositório;
-3. Escreva qualquer consideração na descrição do PR e faça qualquer comentário que achar pertinente no código.
+Você precisará criar um banco de dados mysql para rodar o projeto, para isso separei um arquivo db_mysql.sql como exemplo de relacionamentos das tabelas.
 
-**OBS.:** Caso queira nos mostra um projeto open source próprio, abra uma issue nesse repositório aqui, colocando links e informações sobre o seu projeto de forma que possamos avaliá-lo.
+Com isso pronto rode o comando: 
+
+```bash
+$ yarn build
+```
+
+Após o buid, rode o comando para iniciar o servidor: 
+
+```bash
+$ yarn start
+```
+
+A api estará rodando localmente na porta http://localhost:3001/
+
+# Frontend
+
+O frontend foi desenvolvido, conforme a sugestão, em ReactJS. 
+
+#### Bibliotecas Utilizadas
+
+- React-router-dom, axios
+- MaterialUI 
+- Redux 
+
+### Instalação do Frontend
+
+Entre no diretório .frontend-payment-system e rode o comando: 
+
+```bash
+$ yarn install
+```
+
+Após instalar as dependências, entre no diretório ./src/utils/http.ts e altere a variável baseUrl para o endereço local: 
+
+```js
+export const baseUrl: string = "http://localhost:5173/"
+```
+
+Após isso estamos prontos para inicializar com o seguinte comando: 
+
+```bash
+$ yarn dev
+```
+
+O frontend já estará funcionando e rodando localmente na porta http://localhost:5173
+
+## Sobre mim
+
+Sou Oséias Costa, desenvolvedor fullstack. Caso tiver dúvidas me coloco a disposição para ajudar. Me chame no linkedin: 
+https://www.linkedin.com/in/oseias-costa/

api/.env-example

@@ -0,0 +1,10 @@
+
+# Put the remote mysql database keys here
+DB_HOST = "00.000.000.00"
+DB_USERNAME = "db_usename"
+DB_PASSWORD = "db_password"
+DB_NAME = "db_name",
+
+
+# choose a secret key for jwt
+SECRETJWT = "0000"

api/.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+    "parser": "@typescript-eslint/parser",
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "plugins": ["@typescript-eslint"],
+    "extends": [
+        "plugin:@typescript-eslint/recommended", 
+        "standard-with-typescript",
+        "prettier/@typescript-eslint"
+    ],
+
+    "overrides": [
+        {
+            "env": {
+                "node": true
+            },
+            "files": [
+                ".eslintrc.{js,cjs}"
+            ],
+            "parserOptions": {
+                "sourceType": "script"
+            }
+        }
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "rules": {
+    }
+}

api/.gitignore

@@ -0,0 +1,7 @@
+node_modules
+.env
+.yarn
+./dist
+/dist
+/build
+/coverage

api/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

api/application/__tests__/balance.spec.ts

@@ -0,0 +1,84 @@
+import BalanceRepository from "../../infra/repository/balance.repository"
+import { BalanceUseCase } from "../balance.usecase"
+
+jest.mock("../../infra/repository/balance.repository")
+
+export const userInfo = {
+    id: 'a5dcb5d7-f74c-4d41-ac7c-dba6bf54be2f',
+    email: '[email protected]',
+    iat: 1705089085,
+    exp: 1705096285
+  }
+
+const balance = {
+        "id": "2819c519-b515-4b6f-976d-2af0a8e54dec",
+        "balanceName": "teste",
+        "initialValue": 50,
+        "valueUsed": 0,
+        "totalValue": 50,
+        "userId": "a5dcb5d7-f74c-4d41-ac7c-dba6bf54be2f",
+        "description": "1234"
+}
+
+const RepoMock = BalanceRepository as jest.Mock<BalanceRepository>;
+const usecase = balanceUseCase()
+
+function balanceUseCase(){
+    const BalanceRepository = new RepoMock() as jest.Mocked<BalanceRepository>
+    const balanceUseCase = new BalanceUseCase(BalanceRepository)
+    return balanceUseCase
+}
+
+describe("should create balance", () => {
+    let amount: number
+
+    it("should throw if balance name is empty", async () => {
+        const t = usecase.CreateBalance(userInfo, "", 1000, "Descript")
+
+        await expect(t).rejects.toThrow("Balance Name is required")
+    })
+
+    it("should throw if balance amount is empty", async ()=> {     
+        const t = usecase.CreateBalance(userInfo, "Oséias", amount, "")
+
+        await expect(t).rejects.toThrow("Balance Amount is required")
+    })
+})
+
+// describe('Should get all balances', () => {
+//     const balances: Balance[] = []
+//     const usecase = balanceUseCase()
+
+//     it('Should call GetAllBalances', async () => {
+//         const t = await usecase.GetAllBalances(userInfo)
+
+//         await expect(t).resolves.toBe(balances)
+//     })
+// })
+
+describe('Should update balance Name', () => {
+    let id: string
+
+    it('Should more then 3 letters', async () => {
+        const t = usecase.UpdateBalanceName(balance, "Ze")
+
+        await expect(t).rejects.toThrow("The balance name is not valid")
+    })
+
+    it('Should have id', async ()=> {
+        const t = usecase.UpdateBalanceName({...balance, id: id}, "Oseias")
+
+        await expect(t).rejects.toThrow("Balance Id not found")
+    })
+})
+
+describe('Should delete balance', () => {
+    let id: string
+
+    it("Should have id", async () => {
+        const t = usecase.DeleteBalance(id)
+
+        await expect(t).rejects.toThrow("Id not found")
+    })
+})
+

api/application/balance.usecase.ts

@@ -0,0 +1,92 @@
+import { Balance, BalanceInterface } from "../domain/balance.entity";
+import { v4 as uuid } from 'uuid'
+import { UserInfo } from "../domain/user.entity";
+import BalanceRepository from "../infra/repository/balance.repository";
+
+export class BalanceUseCase implements BalanceInterface {
+    constructor(private balanceRepo: BalanceRepository){
+        this.balanceRepo = balanceRepo
+    }
+
+    async CreateBalance(userInfo: UserInfo, balanceName: string, amount: number, description: string): Promise<Balance | Error> {
+        const newId = uuid();
+
+        const verifyParams = BalanceUseCase.validateBalance(userInfo, balanceName, amount)
+        if (!verifyParams) {
+            throw Error("Balance invalid")
+        }
+
+        const newBalance: Balance = {
+            id: newId,
+            userId: userInfo.id,
+            balanceName: balanceName,
+            description: description,
+            initialValue: amount,
+            totalValue: amount,
+            valueUsed: 0
+        } 
+
+        const saveDb = await this.balanceRepo.CreateBalanceRepo(newBalance)
+
+        return newBalance
+    }
+
+    async GetAllBalances(userInfo: UserInfo): Promise<Balance | Error> {
+        const getBalances = await this.balanceRepo.GetAllBalances(userInfo)
+        return getBalances
+    }
+
+    async DeleteBalance(id: string): Promise<boolean | Error> {
+        if (!id){
+            throw Error("Id not found")
+        }
+
+        const verifyBalance = await this.balanceRepo.GetBalanceById(id)
+
+        if(verifyBalance.valueUsed !== 0){
+            throw Error("There are linked balances")
+        }
+
+        const deleteRepo = await this.balanceRepo.DeleteBalances(id)
+        if (deleteRepo) {
+            return true
+        }
+
+        return false
+    }
+
+
+    async UpdateBalanceName(balance: Balance, newName: string): Promise<Balance | Error> {
+        if (newName.length < 3){
+            throw Error("The balance name is not valid")
+        }
+
+        if (!balance.id){
+            throw Error("Balance Id not found")
+        }
+
+        const updateName = await this.balanceRepo.UpdateNameBalance(balance, newName)
+        if (updateName.affectedRows === 1) {
+            return { ...balance, balanceName: newName}
+        }
+
+        throw Error("Balance name not update")
+    }
+
+    static validateBalance(userInfo: UserInfo, balanceName: string, amount: number): boolean | Error {
+        if (!userInfo.id){
+            throw Error("Id not found")
+        }
+
+        if (!balanceName){
+            throw Error("Balance Name is required")
+        }
+
+        if (!amount){
+            throw Error("Balance Amount is required")
+        }
+        return true
+
+    } 
+
+}