En el siguiente repositorio se reutilizará el código del repositorio Aminmboankod/Gilded-Rose-Kata (para más información readme) para completar el proyecto de final del segundo trimestre de curso del grado superior intensivo de desarrollo de aplicaciones web que consiste en lo siguiente:
clone https://github.com/Aminmboankod/Flask-API-REST-Ollivanders
Crear archivo tar.gz que contiene el proyecto
python3 setup.py sdist
pip3 install -r requirements.txt
Para arrancar el proyecto en un contenedor Docker:
sudo docker build -t ollivanders-api-image .
docker run -p 5000:5000 ollivanders-api-image
Ten en cuenta que la aplicación se despliega en un contenedor Docker, por ello es importante que tengas en cuenta que en el dockerfile se importan 5 variables de entorno:
ENV FIND=$FIND
ENV UPDATEONE=$UPDATEONE
ENV KEY=$KEY
ENV DELETE=$DELETE
ENV INSERT=$INSERT
Estas variables se deben de haber creado en el entorno virtual en el que quieras ejecutar la aplicación.
Si ejecutas la aplicación flask en el equipo local y te notifica que no se puede ejecutar porque otro programa está en ejecución en el mismo puerto puedes ejecutar el siguiente comando:
sudo lsof -i :5000
kill <pid en ejecución>
O puedes ejecutar flask en otro puerto usando el siguiente comando:
flask run --port <número_de_puerto>
Para acceder a los distintos endpoints de esta API utilizando curl, puedes utilizar los siguientes comandos:
Obtener la lista de ítems del inventario:
curl http://127.0.0.1:5000/inventario
Actualizar todos los items del inventario:
curl http://127.0.0.1:5000/actualizar
Actualizar un ítem:
curl http://127.0.0.1:5000/actualizar/<name>
Buscar un ítem por su nombre:
curl http://127.0.0.1:5000/filter/<name>
Reiniciar inventario:
curl http://127.0.0.1:5000/reiniciar
Tox es una herramienta de automatización de tareas que se utiliza comúnmente en proyectos de Python para facilitar la ejecución de pruebas, comprobaciones de estilo y otras tareas relacionadas con el proyecto.
"A continuación el enunciado del proyecto escrito por mi tutor:" @dfleta
Como la demanda de productos mágicos no para de crecer, la expansión del negocio es inevitable para sobrevivir a Amazon.
Ollivander había contratado a Dobbie -a través del programa de FP Dual DAW de Hogwarts colegio concertado- para que le hiciese una app que gestionase el inventario, pero tras los tristes aoontecimientos en los que se vió -desgraciadamente- envuelto el pobrecico elfo, no tiene a nadie que pueda modificar el código para incluir nuevos productos.
Ollivander ha contratado los servicios de la consultora en la que trabajas para que adecúe la aplicación a las nuevas necesidades del inventario, por lo que te envían "a cliente" -a la tienda- a lidiar con él y, lo que es peor, con el código spagheti que manufacturó Dobby en sus momentos de langidez infinita.
Por si no fuera suficiente, tu compañero de empresa al que enviaron a cliente antes que a ti, a acaba de irse de España porque en el extranjero le pagan por trabajar, y ha dejado tiritando el código de los casos test que intentó añadir en un día de desesperación absoluta.
- Refactoriza el código de la lógica para que sea fácil de entender, barato de modificar y no cambie el comportamiento observable del código existente.
- El código existente pasa los casos test. Asegúrate de que el tuyo también, sin modificarlos.
- Haz un evolutivo del sistema para que sea posible añadir al inventario un nuevo tipo de item llamado "Conjured". Los “Conjured” items degradan su calidad el doble de rápido que un item normal. Añade esta lógica al sistema así como los casos test que necesites.
WARNING: no alteres la clase Item o las propiedades de Items porque el colegio profesional de goblings no cree en la propiedad compartida del código y suele enviar inquisidores por la tienda de vez en cuando para chequear no dos sino tres, digo tres cosas sino cuatro, no cuatro sino cinco cosas, oh f*ck! que han de respetar su certificación de gobbling inside.
Aquí está el repo donde Dobbie publicó el código, que en realidad es el repo de Emily Bache con el kata de refactorización "Gilded Rose" para varios lenguajes: https://github.com/emilybache/GildedRose-Refactoring-Kata
Las reglas de la lógica del negocio están "explicadas" aquí: http://iamnotmyself.com/2011/02/14/refactor-this-the-gilded-rose-kata/
Aquí los casos test: https://github.com/emilybache/GildedRose-Refactoring-Kata/tree/master/texttests/ThirtyDays
- Crea una base de datos SQL que permita realizar CRUD sobre el inventario.
- El inventario inicial es el que especifica el primer caso test, el existente en el "día 0". Recuerda realizar un esquema que permita ampliarlo con el nuevo tipo de ítem "Conjured":
name, sellIn, quality
+5 Dexterity Vest, 10, 20
Aged Brie, 2, 0
Elixir of the Mongoose, 5, 7
Sulfuras, Hand of Ragnaros, 0, 80
Sulfuras, Hand of Ragnaros, -1, 80
Backstage passes to a TAFKAL80ETC concert, 15, 20
Backstage passes to a TAFKAL80ETC concert, 10, 49
Backstage passes to a TAFKAL80ETC concert, 5, 49
Conjured Mana Cake, 3, 6
Como quieres modernizar un poco el sistema de gestión de la tienda de Ollivander, decides desarrollar una app web que permita visualizar el estado del inventario, actualizar la calidad de los items y realizar operaciones básicas CRUD.
Esto supone tres capas en tu aplicación.
- Capa de presentación y frontend.
- Utilizando HTML, CSS y JS construye un pequeño sitio web para la intranet, con una interfaz de usuario/a que permita a Ollivander realizar las operaciones de la lógica.
- Capa de lógica y backend
- En el back encapsularás la lógica del negocio que has programado. Utilizarás un microframework llamado Flask para:
- Atender y responder las peticiones que lleguen a través de un navegador web con las consulas de a la base de datos.
- Construir una API REST que con al menos dos end points: un recurso devuelve el inventario y el otro la actualización del inventario. Si implementas el resto de operaciones CRUD, tendrás que añadir los end points correspondientes.
- En el back encapsularás la lógica del negocio que has programado. Utilizarás un microframework llamado Flask para:
- Acceso a datos (backend)
- Mediante Flask, escribe el código necesario de la capa de acceso a datos, que conecte las peticiones web con la base de datos, para realizar las operaciones de la lógica. Recuerda que la lógica de la aplicación ha de ser agnóstica respecto a la base de datos utilizada.
- Base de datos: reutiliza tus conocimientos de Mongo Atlas del primer trimestre, o aprovecha para implementar una base de datos relacional con MySQL.
- Pensando en introducir un flujo de trabajo de Integración Continua y Entrega Continua (CI /CD) prepararás un contenedor Docker de desarrollo y pruebas y otro contenedor docker para despliegue. De momento, con Python es suficiente tox