Zeep Web + Microservice Payments

Sistema API de Zeep para los pagos y guardado de las órdenes de pago de los clientes + web de Zeep.

Instrucciones de Instalación

Este documento describe los pasos necesarios para configurar el entorno de desarrollo en la PC local bajo sistemas operativos Linux utilizando Docker.

Pre instalación del Proyecto.

• Tener instalado Git.
• Tener instalado Composer.
• Tener instalado php-client php-mbstring.

Clonar Repositorio de GitHub.

[email protected]:Los-nonos/Gryffindor.git

Al utilizar SSH realizar los siguientes pasos de configuración:

https://help.github.com/articles/connecting-to-github-with-ssh/

Una vez que ya tenemos clonado nuestro repositorio realizaremos los siguientes pasos.

Si es la primera vez que clonás el repo

Instalación de los contenedores de Docker.

• Primeramente tener docker y docker-compose instalados (utilizar las guías de Digital Ocean estan bien documentadas).

1. Entrar a la carpeta de docker del proyecto. (ravenclaw/)

2. Realizar un ./start esto descargará y ejecutará todos los containers necesarios para ejecutar el servidor

nota: cuando finalize finalizar el servicio con ctrl+c

Asignación de los permisos de Laravel.

Es necesario para la correcta visualización y funcionamiento del proyecto que se asignar los permisos de Laravel:

1. Ejecutar los siguientes comandos en la consola para asignar los permisos:

no es obligatorio

    sudo chown -R 1000:33 storage/
    sudo chmod -R g+w storage/
    sudo chown -R 1000:33 bootstrap/cache
    sudo chmod -R g+w bootstrap/cache

PD: Puede suceder que en momentos al crearse archivos de Logs nuevos tengamos que reasignar los permisos al storage/ (ver como solucionar esto, muchas veces al terminar la instalación del proyecto necesitamos asignar de nuevo estos permisos).

Instalación de las dependencias.

1. Acceder al Lord Commander (Ricky Fort) ejecutando ./webapp (basicamente es nuestro bash de nginx docker-compose run --user=1000 phpnginx bash)

2. Ejecutamos ./composer.phar install

3. Esperar la instalación de dependencias de Laravel y compañía. <---- Puede tardar, dependiendo de la velocidad de conexión a internet.

Crear archivo de Enviroment

1. En nuestro terminal ejecutar cp .env.example .env
2. Este archivo contiene las credenciales de las cuentas de los servicios utilizados.

Configuración de la Base de Datos.

Ésto no es necesario, te puede traer problemas con el container mysql de zeepdocker. Pero para deployar lo vamos a necesitar, así que se deben realizar pruebas periódicas en entorno mysqlserver local y comparar resultados en workbench. Todo ésto cuando estemos en un punto avanzado del desarrollo. Me pareció importante dejarlo indicado en el readme para que se tenga en cuenta un requisito futuro que TODOS los desarrolladores involucrados en el proyecto DEBEMOS SABERLO.

Ejecución de las migraciones (Laravel)

0. Primeramente actualizar el archivo .env con los datos correspondientes de la BD:

DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=consultar
DB_USERNAME=consultar
DB_PASSWORD=consultar

1. Entramos al bash nginx del Lord Commander ubicados en el root del directorio ejecutando: ./webapp.

2. Ejecutamos dentro del bash php artisan migrate

3. Una vez terminada la ejecución ya tendremos las tablas correspondientes en nuestra base de datos apizeep.

4. Ejecutar para tener el .env completo y correcto php artisan key:generate.

5. Listo ya podemos salir del comandante.

Ultimos pasos.

1. Ya podemos entrar al sitio localhost

2. Deberíamos visualizar correctamente el sitio de bienvenida (O algun Health Check en el caso de ser API).

Arquitectura del Sistema

Respecto a la organización de capas lógicas se encuentra basado en Arquitectura Hexagonal / Ports and Adapter / Onion Architecture:

API/Presentation:

Esta es la capa propia del patrón MVC, esta es la capa correspondiente para acoplarnos al Framework, en nuestro caso Laravel

Estructura de directorios:

• Controllers / Actions : Puede orientarse a acciones directamente donde poseen todas las operaciones correspondientes como: Crear - Leer - Actualizar - Eliminar. Son los encargados de comunicarse con la capa de Aplicacion mediante los contratos correspondientes (Commands/Queries). Estan acoplados al framework y al protocolo HTTP en este caso GET/POST/PUT/PATCH/DELETE.

Es importante para evitar el acoplamiento a nivel interno que no se envíen a los servicios directamente la Request completa, para eso existen los contratos (Commands/Queries) que son los que nos permiten según el caso de uso ver que datos son necesarios a nivel de Aplicación para lograr comunicarnos y realizar una acción determinada.

• Routes: Lugar donde colocaremos los diferentes endpoints de nuestra API y donde Laravel hace un match entre el path especificado y el Action correspondiente.

APPLICATION

• Commands: Serán los puntos de entrada a nuestra capa de aplicación, son las interfaces que conoce la capa superior (API/Presentation) para comunicarse a traves de nuestro dominio del sistema.

• Services/Handlers: Son los que orquestaran los casos de usos correspondientes al sistema, estos son los encargados de manejar los casos de uso utilizando los elementos de su misma capa o utilizando elementos del dominio correspondiente como los repositorios (contratos), entidades, servicios de dominio, Value Objects, Enums, etc.

• Results: Son las devoluciones de los handlers, si está todo correcto y no hubo ningún problema, este mismo devolverá un objeto result con los datos necesarios para el presenter, si algo falla, no se devolverá ningún objeto y lanzará una exepción

DOMAIN

Esta capa es Framework Agnostic, al igual que debería serlo la capa anterior, se caracteriza por contener toda la lógica de nuestro negocio, mediante entidades / servicios de dominio / value objects. Representa los conceptos del negocio de nuestro cliente

• Entities: Son los objetos con identidad correspondientes a nuestro dominio por ejemplo: Usuario, Producto, Reservas, etc.

• Repositorios (Contratos): Se almacenaran los contratos / interfaces correspondientes al dominio de nuestra app, pudiendo entrar aquí para desacoplar la persistencia, las interfaces de la capa de repositorios.

• Value Objects

• Enums

...

INFRASTRUCTURE

PERSISTENCE

Es la capa encargada de persistir nuestras entidades de dominio.

• Repositories: Para manejar las consultas de las entidades y la persistencia de las mismas, esta capa es la implementación de los contratos declarados en el dominio del sistema.
• Migrations: Para el correcto versionado de las tablas y que todos los devs tengamos una mayor consistencia de nuestra base de datos, ya que ejecutando estas mismas nos aseguramos que todos poseemos la misma BD.
• Seeders: Para rellenar las bases con sus tablas correspondientes.
• Mappings: Archivos para desacoplar el dominio de la persistencia, aca realizamos el mapeo que dice que tablas se manejan con que atributos del sistema. (En caso de utilizar Doctrine)

Fuentes de consulta para estas Arquitecturas, Conceptos, Buenas prácticas:

https://martinfowler.com/eaaCatalog/ (Conceptos para el ORM DataMapper vs ActiveRecord)

https://domainlanguage.com/ddd/ (Conceptos DDD como: Entidades / Value Objects / Servicios / Commands / Shared-Kernel / Repositorios)

Ese libro azul principal tiene todos los conceptos correspondientes utilizados aquí como las mejores prácticas para orientarse al dominio y crear sistemas lo más desacoplados y correctos posibles.

Un resumen de este gratuito es:

http://domainlanguage.com/wp-content/uploads/2016/05/DDD_Reference_2015-03.pdf

Inyección Dependencias / Inversión de Control

Para mantenernos sin acoplamientos y poder cumplir bien con la arquitectura se necesita de la inyección de dependencias y en general de un IoC para inversión de control, como lo nombran los Principios SOLID. Esto nos ayuda a utilizar interfaces / contratos, que quien los inyecta es alguien de infrastructra transversal que resuelve por nosotros las dependencias necesarias.