Merge pull request #2 from sebastiansj70/feature/antifraud

Feature/antifraud

.gitignore

@@ -70,7 +70,8 @@ typings/
 
 # dotenv environment variables file
 .env
-.env.test
+apps/anti-fraud/.env
+apps/transactions/.env
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache

README.md

@@ -1,82 +1,137 @@
-# Yape Code Challenge :rocket:
-
-Our code challenge will let you marvel us with your Jedi coding skills :smile:. 
-
-Don't forget that the proper way to submit your work is to fork the repo and create a PR :wink: ... have fun !!
+# Proyecto de Transacciones y Antifraude
+
+## Descripción del Proyecto
+Este proyecto consiste en dos microservicios que trabajan juntos para procesar transacciones y detectar fraudes. El servicio de transacciones permite a los usuarios crear transacciones financieras, mientras que el servicio de antifraude monitorea las transacciones y marca aquellas que puedan ser fraudulentas.
+
+## Tecnologías Utilizadas
+- **Node.js**
+- **TypeScript**
+- **Kafka** (para la comunicación entre microservicios)
+- **PostgreSQL** (base de datos)
+- **Docker** (para contenedorización de los servicios)
+- **Jest** (para pruebas unitarias)
+
+## Requisitos
+- Tener Docker instalado y en funcionamiento.
+- Tener `docker-compose` para manejar los contenedores.
+- Opcional: Postman o cURL para realizar pruebas en la API.
+
+## Instalación y Configuración
+1. Clona el repositorio:
+   ```bash
+   git clone https://github.com/usuario/proyecto-transacciones-antifraude.git
+   cd proyecto-transacciones-antifraude
+   ```
+2. configuracion:
+    ## Configuración del Archivo .env
+
+- Para configurar el archivo `.env` para el módulo de **Transacciones**, sigue estos pasos:
+
+1. Navega a la carpeta `apps/transactions`.
+2. Crea un archivo `.env` en la carpeta `apps/transactions`.
+3. Copia el contenido del archivo `.env.example` y pégalo en el nuevo archivo `.env`.
+4. Rellena los valores de las variables de entorno según sea necesario:
+
+```bash
+# Database Configuration
+DB_TYPE=postgres
+DB_HOST=your_database_host_here  # Ejemplo: postgres
+DB_PORT=5432
+DB_USERNAME=your_db_username_here  # Ejemplo: postgres
+DB_PASSWORD=your_db_password_here  # Ejemplo: 123456
+DB_DATABASE=your_db_name_here  # Ejemplo: postgres
+DB_SYNCHRONIZE=true  # Cambiar a false en producción si no es necesario sincronizar
+DB_LOGGING=false  # Cambiar a true si se necesita logging de consultas SQL
+
+# Kafka Configuration
+KAFKA_BROKER=your_kafka_broker_here  # Ejemplo: kafka:29092
+
+# Kafka Topics
+KAFKA_TOPIC_TRANSACTIONS=your_transactions_topic_here  # Ejemplo: transactions
+KAFKA_TOPIC_UPDATE=your_update_topic_here  # Ejemplo: antifraud-transactions-status
+
+# Transaction Module Configuration
+KAFKA_CLIENT_ID_TRANSACTIONS=your_client_id_here  # Ejemplo: transactions-service
+KAFKA_GROUP_ID_TRANSACTIONS=your_group_id_here  # Ejemplo: transactions-consumers
+```
 
-- [Problem](#problem)
-- [Tech Stack](#tech_stack)
-- [Send us your challenge](#send_us_your_challenge)
+- Para configurar el archivo `.env` para el módulo de **Anti-Fraude**, sigue estos pasos:
 
-# Problem
+1. Navega a la carpeta `apps/anti-fraud`.
+2. Crea un archivo `.env` en la carpeta `apps/anti-fraud`.
+3. Copia el contenido del archivo `.env.example` y pégalo en el nuevo archivo `.env`.
+4. Rellena los valores de las variables de entorno según sea necesario:
 
-Every time a financial transaction is created it must be validated by our anti-fraud microservice and then the same service sends a message back to update the transaction status.
-For now, we have only three transaction statuses:
+```bash
+# Kafka Configuration
+KAFKA_BROKER=your_kafka_broker_here  # Ejemplo: kafka:29092
 
-<ol>
-  <li>pending</li>
-  <li>approved</li>
-  <li>rejected</li>  
-</ol>
+# Kafka Topics
+KAFKA_TOPIC_TRANSACTIONS=your_transactions_topic_here  # Ejemplo: transactions
+KAFKA_TOPIC_UPDATE=your_update_topic_here  # Ejemplo: antifraud-transactions-status
 
-Every transaction with a value greater than 1000 should be rejected.
+# Anti-Fraud Module Configuration
+KAFKA_CLIENT_ID_ANTI_FRAUD=your_client_id_here  # Ejemplo: anti-fraud-service
+KAFKA_GROUP_ID_ANTI_FRAUD=your_group_id_here  # Ejemplo: anti-fraud-consumers
 
-```mermaid
-  flowchart LR
-    Transaction -- Save Transaction with pending Status --> transactionDatabase[(Database)]
-    Transaction --Send transaction Created event--> Anti-Fraud
-    Anti-Fraud -- Send transaction Status Approved event--> Transaction
-    Anti-Fraud -- Send transaction Status Rejected event--> Transaction
-    Transaction -- Update transaction Status event--> transactionDatabase[(Database)]
 ```
 
-# Tech Stack
+3. Levanta los servicios utilizando Docker:
+   ```bash
+   docker-compose up --build
+   ```
 
-<ol>
-  <li>Node. You can use any framework you want (i.e. Nestjs with an ORM like TypeOrm or Prisma) </li>
-  <li>Any database</li>
-  <li>Kafka</li>    
-</ol>
+Esto levantará los siguientes contenedores:
+- **PostgreSQL** en el puerto `5433`
+- **Kafka** en el puerto `29092`
+- **Microservicio de Transacciones** en el puerto `3000`
+- **Microservicio de Antifraude**
 
-We do provide a `Dockerfile` to help you get started with a dev environment.
+## Uso de la API de Transacciones
+Una vez que los contenedores estén en funcionamiento, puedes crear una transacción enviando una solicitud `POST` a la siguiente ruta:
 
-You must have two resources:
-
-1. Resource to create a transaction that must containt:
+`POST http://localhost:3000/api/transactions/create`
 
+Con el siguiente cuerpo de ejemplo:
 ```json
 {
-  "accountExternalIdDebit": "Guid",
-  "accountExternalIdCredit": "Guid",
-  "tranferTypeId": 1,
-  "value": 120
+    "accountExternalIdDebit": "Guid",
+    "accountExternalIdCredit": "Guid",
+    "transferTypeId": 1,
+    "value": 3100
 }
 ```
 
-2. Resource to retrieve a transaction
-
-```json
-{
-  "transactionExternalId": "Guid",
-  "transactionType": {
-    "name": ""
-  },
-  "transactionStatus": {
-    "name": ""
-  },
-  "value": 120,
-  "createdAt": "Date"
-}
+Puedes hacer la solicitud desde Postman o utilizando `cURL`:
+```bash
+curl -X POST http://localhost:3000/api/transactions/create \
+   -H "Content-Type: application/json" \
+   -d '{
+    "accountExternalIdDebit": "Guid",
+    "accountExternalIdCredit": "Guid",
+    "transferTypeId": 1,
+    "value": 3100
+}'
 ```
 
-## Optional
+## Ejecución de Pruebas
+Cada microservicio tiene sus propias pruebas unitarias que puedes ejecutar de la siguiente manera:
 
-You can use any approach to store transaction data but you should consider that we may deal with high volume scenarios where we have a huge amount of writes and reads for the same data at the same time. How would you tackle this requirement?
+### Pruebas del Servicio de Transacciones
+```bash
+cd apps/transactions
+npm run test
+```
+
+### Pruebas del Servicio de Antifraude
+```bash
+cd apps/anti-fraud
+npm run test
+```
 
-You can use Graphql;
+## Notas Adicionales
+- El servicio de transacciones se conecta a una base de datos PostgreSQL, que está en un contenedor. Si deseas ver los datos almacenados, puedes usar `pgAdmin` configurando la conexión con el host `localhost` y el puerto `5433`.
+- Kafka se usa para la comunicación entre los microservicios de transacciones y antifraude.
 
-# Send us your challenge
 
-When you finish your challenge, after forking a repository, you **must** open a pull request to our repository. There are no limitations to the implementation, you can follow the programming paradigm, modularization, and style that you feel is the most appropriate solution.
 
-If you have any questions, please let us know.

apps/anti-fraud/.env.example

@@ -0,0 +1,10 @@
+# Kafka Configuration
+KAFKA_BROKER=your_kafka_broker_here  
+
+# Kafka Topics
+KAFKA_TOPIC_TRANSACTIONS=your_transactions_topic_here 
+KAFKA_TOPIC_UPDATE=your_update_topic_here 
+
+# Configuración del Módulo de Transacciones
+KAFKA_CLIENT_ID_TRANSACTIONS=your_client_id_here 
+KAFKA_GROUP_ID_TRANSACTIONS=your_group_id_here  

apps/anti-fraud/Dockerfile

@@ -0,0 +1,11 @@
+
+FROM node:18-alpine
+WORKDIR /app/apps/anti-fraud
+
+COPY apps/anti-fraud/package*.json ./
+RUN npm install --include=dev
+COPY apps/anti-fraud/.env ./
+COPY apps/anti-fraud/tsconfig.json ./
+
+COPY apps/anti-fraud ./
+CMD ["npm", "run", "dev:anti-fraud"]

jest.config.js → apps/anti-fraud/jest.config.ts

@@ -1,5 +1,5 @@
-module.exports = {
+export default {
     preset: 'ts-jest',
     testEnvironment: 'node',
     testPathIgnorePatterns: ['/node_modules/', '/dist/'],
-};
+  };