La intensión del proyecto es crear una API para calcular el sueldo de los jugadores de Resuelve FC.
El proyecto esta realizado con el siguiente stack:
- VCS: git (github)
- Spring Boot: framework web para construir aplicaciones reactivas y MVC usando la JVM
- Groovy: lenguaje dinámico que extiende la JVM inspirado en Ruby
La forma de trabajar esta fuertemente inspirada en Gitflow (https://danielkummer.github.io/git-flow-cheatsheet/), creando Issues en el repositorio de Github (https://github.com/Itaqua/reto-rtd/issues?q=is%3Aissue+is%3Aclosed) y de ahi se van creando ramas (branches) de trabajo donde se van creando los commits que al final se crea un Pull Request que se une con la rama principal (main).
Por ejemplo, los primeros issues son crear el placeholder del proyecto, despues la integración continua (CI) y posteriormente implementar las Pruebas de las reglas del negocio que serán posteriormente implementadas.
Además de esto, se crearón actions (https://github.com/Itaqua/reto-rtd/actions) para que cada vez que se agrega mergea o se agrega un cambio en la rama principal, se solicita hacer un build automático y liberación eh Heroku: https://reto-rtd.herokuapp.com/
Para ejecutar este proyecto se debe de tener la maquina virtual de Java versión 8.0 o superior, esta se puede instalar de varias formas dependiendo del sistema en el que se este trabajando.
// Otra forma es utilizando Docker, como se verá mas adelante en la sección correspondiente
Si se tiene un sistema Linux o Mac y experiencia usando package managers, se recomienda usar SDKMAN (https://sdkman.io/) que permite una fácil gestoria de recursos de la JVM entre distintas versiones.
En caso de sistemas Windows o para una instalación más limpia, se recomienda usar adoptopenjdk que es un empaquetador de versiones de Java administrado por la comunidad: https://adoptopenjdk.net/installation.html
El proyecto utiliza un Sistema de control de Versiones utilizando git a través de Github.
Para instalar la herramienta, siga el proceso de instalación y descarga de la herramienta que requiera:
Obtener el codigo desde el repositorio de Github:
git clone git@github.com:Itaqua/reto-rtd.git
LA aplicación es un clásico MVC que actualmente solo utiliza la parte de los controladores para responder a las llamadas HTTP y los servicios como una la abstración de la lógica de negocio agnostica al los metodos de ejecución.
main/
groovy/com/rtd/fc/
controllers
FC.groovy
services
PayrollService.groovy
FCApplication.groovy
resources
static
app.css
index.html
application.properties
test/groovy/com/rtd/fc/service
PayrollServiceTest.groovy
build.gradle
El controller/FC.groovy es el que contiene el endpoint para responder a las llamadas POST al API.
El services/PayrollService.groovy contiene la lógica de negocio para la ejecución de los servicios.
FCApplication.groovy es el punto de inicio de la aplicación inyectando los servicios utilizando Injectión de Dependencias (DI).
resources/static contiene archivos estaticos servidos por la aplicación, como la forma para probar el API.
application.properties no se usa en este momento, pero es para proporcionar distintas configuraciones y hasta perfiles de configuración.
PAyrolServiceTest contiene los test unitarios donde se documenta y comprueba las reglas de negocio.
build.gradle es el build file, algo así como un make (o package.json para los mas jovenes) para construir la aplicación.
Para correr la aplicación, se realiza utilizando el sistema de empaquetado llamado Gradle:
./gradlew bootRun
La aplicación se ejecuta por defecto en el puerto 8080, asi que para acceder a ella se puede ir a la dirección:
ó en Heroku
https://reto-rtd.herokuapp.com/
Este desplegara una Forma que se puede usar para probar la aplicación.
o también enviando los datos por medío del endpoint /fc/salaries (y el host objetivo), por ejemplo: http://localhost:8080fc/salaries
Puede consultar la sección de Postman para más información.
La aplicación se puede empaquetar en un fat jar (paquete con todas sus dependencias) usando el comando:
./gradlew build
esto generará el archivo en build/lib por ejemplo fc-0.0.1-SNAPSHOT.jar
este archivo puede posteriormente ejecutarse usando la JVM con el siguiente comando:
java -jar fc-0.0.1-SNAPSHOT.jar
Para terminar la aplicación basta con pulsar [Ctrl]+C
La aplicación puede correrse dentro de un contenedor, contiene un archivo Dockerfile para crear una imagen que contenga la aplicación, y también un docker-compose.yml para iniciar la aplicación.
El proceso para ejecutarlo es de la siguiente forma:
Primero se hace el build de la aplicación:
./gradlew build
y de ahi se arranca la aplicación utilizando Docker-compose:
docker-compose up
ewsto inicia la aplicación con un seguimiento al registro de eventos para salir de la aplicación basta teclear [Ctrl]+ C, tambien se puede arrancar utilizando la bandera -d que lo arranca como un Daemon
docker-compose up -d
Para terminar la aplicación basta que se de el comando down al docker compose:
docker-compose down
se incluye una colección de Postman para poder invocar la aplicación de forma local o llamando al servicio que está en Heroku: Resuelve.postman_collection.json
solo se tiene que importar el archivo dentro de Postman.
Otra forma es utilizando el comando curl como el siguiente ejemplo:
url --location --request POST 'http://localhost:8080/fc/salaries' \
--header 'Content-Type: application/json' \
--data-raw '{
"jugadores" : [
{
"nombre":"Juan Perez",
"nivel":"C",
"goles":10,
"sueldo":50000,
"bono":25000,
"sueldo_completo":null,
"equipo":"rojo"
},
{
"nombre":"EL Cuauh",
"nivel":"Cuauh",
"goles":30,
"sueldo":100000,
"bono":30000,
"sueldo_completo":null,
"equipo":"azul"
},
{
"nombre":"Cosme Fulanito",
"nivel":"A",
"goles":7,
"sueldo":20000,
"bono":10000,
"sueldo_completo":null,
"equipo":"azul"
},
{
"nombre":"El Rulo",
"nivel":"B",
"goles":9,
"sueldo":30000,
"bono":15000,
"sueldo_completo":null,
"equipo":"rojo"
}
]
}'