Usuarios

Este es el servicio de usuarios de Back-End de bookBnB. Contiene la lógica vinculada a la administración y autenticación de usuarios.

Ambientes

Se encuentra desplegado en un ambiente productivo y otro interno del equipo de desarrollo para testing:

Dado que la aplicación se encuentra dockerizada la instalación es tan sencilla como:

$ git clone git@github.com:BookBnB/users-service.git
$ cd users-service
$ docker-compose up -d

Luego para conectarse a la app:

$ docker-compose exec app bash

Para crear una imagen de docker con el estado actual de la aplicación se debe ejecutar:

$ docker/build_production_image.sh

Esto creará una imagen con el tag users-service:latest.

Luego para desplegar la imagen en Heroku:

$ docker/heroku_push.sh

Es necesario que para ello se encuentre configurada la variable de ambiente $TRAVIS_BRANCH indicando la rama que se desea desplegar.

Para ejecutar la aplicación:

$ ./run.sh

Para ejecutar los tests:

$ python -m pytest tests

Se deben configurar las siguientes variables de ambiente:

variable	descripción
DATABASE_URL	Url de conexión a la base de datos
SECRET_KEY	Clave random para generar tokens
BACKOFFICE_URL	Url del front-end del backoffice
SESSION_TOKEN_DURATION	Duración del token de sesión
GOOGLE_CLIENT_ID	Id de aplicación de Google
MAIL_USERNAME	Dirección email para recuperación de contraseña
MAIL_PASSWORD	Contraseña del email de recuperación
MAIL_DEFAULT_SENDER	Dirección default de donde enviar correos de recuperación
MAIL_SERVER	Dirección del servidor SMTP (Default: smtp.google.com)
MAIL_PORT	Puerto del servidor SMTP (Default: 465)
MAIL_USE_SSL	Indica si usar SSL al comunicarse con el servidor SMTP (Default: True)

El proyecto fue testeado a través del módulo pytest, logrando una cobertura mayor al 90%. Se puede ver el detalle de los reportes en codecov.

Puede consultarse la especificación OpenApi en api.json o utilizando swagger en api-docs.