Todas estas tareas deberán ser realizadas por todos los miembros del equipo.

1. Lectura del artículo de Wikipedia sobre arquitectura REST: enlace.
2. Lectura del artículo de Wikipedia (inglés) sobre HATEOAS: enlace.
3. Lectura del artículo de Wikipedia (inglés) sobre JSON: enlace.
4. Lectura de la descripción del modelo de datos Collection + JSON: enlace.
5. Lectura de los ejemplos de uso de Collection + JSON: enlace.

Definición de terminado

Se han leído y comprendido los artículos propuestos.

Todas estas tareas deberán ser realizadas por todos los miembros del equipo.

1. Instalación de un entorno XAMPP (servidor Apache, PHP y MySQL) portable (archivo ZIP). Enlace
2. Lectura de este artículo sobre Composer, un gestor de dependencias para PHP: enlace.
3. Utilizando la consola de XAMPP, instalar Composer. https://getcomposer.org/doc/00-intro.md#manual-installation
4. Utilizar GIT para clonar el repositorio de la práctica dentro de la carpeta htdocs de la instalación de XAMPP.
5. Ejecutar Composer para descargar automáticamente las dependencias del proyecto. https://getcomposer.org/doc/00-intro.md#using-composer
6. Importar la base de datos en el servidor. Enlace.
7. Probar la aplicación en el entorno local.

Definición de terminado

Se ha instalado el entorno de desarrollo junto con la herramienta Composer. Se ha incorporado el código del repositorio y se ha preparado para el trabajo. Se ha probado la aplicación en el servidor local y se ha comprobado su funcionamiento. Se ha leído el artículo propuesto.

Todas estas tareas deberán ser realizadas por todos los miembros del equipo.

1. Lectura de la descripción de Travis CI: enlace.
2. Análisis del fichero travis.yml incluido en el repositorio de la práctica.

Definición de terminado

Se ha analizado el archivo travis.yml y se ha entendido su sintaxis y función. Se ha leído y comprendido el artículo propuesto.

Esta tarea será realizada por todos los grupos a la vez.

1. Introducción rápida a OpenShift.
2. Creación de una cuenta para cada grupo de trabajo en OpenShift.
3. Creación de una aplicación donde se alojará el proyecto. Para ello se creará una aplicación (Gear) Openshift PHP 5.4 con el cartucho MySQL y PHPMyAdmin.
4. Carga de la base de datos en la aplicación de OpenShift utilizando PHPMyAdmin. Entender cómo está configurado el archivo api/database.php de la aplicación mediante variables de entorno para no tener que poner las claves de acceso al servidor MySQL en el archivo.
5. Modificación del archivo travis.yml para utilizar la cuenta de OpenShift creada anteriormente. Consultar este enlace y este otro. Opcional: ver cómo encriptar la clave de OpenShift para que no aparezca de manera pública en el archivo .travis.yml. La información está disponible aquí.
6. Comprobación de que la aplicación está operativa en OpenShift.

Definición de terminado

Se ha comprendido la utilidad de OpenShift. Cada grupo ha creado una cuenta para alojar la aplicación. Se ha modificado el archivo travis.yml con la contraseña de usuario apropiada. Se ha subido la aplicación a OpenShift.

Todas estas tareas deberán ser realizadas por todos los miembros del equipo.

1. Análisis del código de servidor proporcionado en el repositorio. Familiarización con la sintaxis PHP, el framework Slim, el gestor de plantillas Twig y el ORM Eloquent.
2. Análisis del fichero .htaccess integrado en el repositorio dentro de la carpeta /api.
3. Lectura de los siguientes artículos sobre ORMs y Eloquent:
   • http://es.wikipedia.org/wiki/Mapeo_objeto-relacional
   • http://codehero.co/laravel-4-desde-cero-eloquent-orm/
   • http://laravel.com/docs/4.2/eloquent#basic-usage
   • http://laravel.com/docs/4.2/eloquent#insert-update-delete
   • http://laravel.com/docs/4.2/eloquent#timestamps
4. Prueba del código de servidor a través del navegador web. Visualización de los datos devueltos.

Definición de terminado

Se ha analizado el código del servidor y se ha comprendido su funcionamiento de manera aceptable. Se han hecho pruebas de funcionamiento con el servidor a través del navegador web. Se han leído y comprendido los artículos propuestos.

Todas estas tareas deberán ser realizadas por todos los miembros del equipo.

1. Análisis del código de cliente proporcionado en el repositorio. Se trata de un cliente genérico capaz de trabajar con datos siguiendo el modelo Collection + JSON. Al tratarse de un cliente genérico, muestra los datos de manera fija utilizando elementos <dd> y <dt> de HTML. Además, los formularios de edición y creación de elementos aparecen de una forma determinada.
2. Prueba del código de cliente a través del navegador web.

Definición de terminado

Se ha analizado el código del cliente y se ha comprendido su funcionamiento de manera aceptable. Se han hecho pruebas de funcionamiento con el cliente.

El servidor está alojado en la ruta /api. Es una aplicación basada en el formato Collection + JSON y por tanto es compatible con el cliente genérico proporcionado. Por ello, si se trabaja correctamente, el cliente funcionará sin problemas y servirá para hacer pruebas de funcionalidad.

La página principal de la API devuelve un objeto collection con enlaces a cada uno de los tipos de elementos de la biblioteca: películas, discos, libros y videojuegos. Si se sigue alguno de esos enlaces se accederá a un nuevo objeto collection que devolverá la lista de elementos correspondientes junto con otra serie de enlaces y opciones para poder:

• Crear un elemento nuevo.
• Realizar consultas sobre la lista.
• Acceder a un elemento determinado de la lista.
• Navegar a través de enlaces a otras listas o elementos relacionados.

Al acceder a un elemento determinado se accederá a otro objeto collection que devolverá los datos del elemento correspondiente junto con otra serie de enlaces y opciones para poder:

• Realizar modificaciones sobre el elemento.
• Borrar el elemento.
• Navegar a través de enlaces a otras listas o elementos relacionados.

El modelo de datos de cada uno de los elementos se ha obtenido a partir de los modelos estandarizados en http://schema.org. Las propiedades de cada uno de los elementos son:

• Película (Movie)
  • name - Nombre de la película (texto)
  • url - URL para acceder a la película en cuestión (texto)
  • description - Descripción de la película (texto)
  • director - Director de la película (texto)
  • datePublished - Fecha de lanzamiento (fecha)
  • embedUrl - Código para incrustar el vídeo del trailer desde YouTube (texto)
• Disco (MusicAlbum)
  • name - Nombre del disco (texto)
  • url - URL para acceder al disco en cuestión (texto)
  • description - Descripción del disco (texto)
  • datePublished - Fecha de lanzamiento (fecha)
  • image - URL de la imagen de la carátula del disco (por simplicidad, esta ruta hará referencia a una imagen publicada en Internet) (texto)
  • embedUrl - Código para incrustar el audio de una de las canciones del álbum desde GrooveShark (u otro servicio como Spotify) (texto)
• Libros (Book)
  • name - Nombre del libro (texto)
  • url - URL para acceder al libro en cuestión (texto)
  • description - Descripción del libro (texto)
  • isbn - El ISBN del libro (texto)
  • datePublished - Fecha de publicación (fecha)
  • image - URL de la imagen de la portada del libro (por simplicidad, esta ruta hará referencia a una imagen publicada en Internet) (texto)
• Videojuegos (VideoGame)
  • name - Nombre del videojuego (texto)
  • url - URL para acceder al videojuego en cuestión (texto)
  • description - Descripción del videojuego (texto)
  • gamePlatform - Plataforma en la que está disponible (texto)
  • applicationSubCategory - Categoría del videojuego (plataformas, arcade,…) (texto)
  • screenshot - URL de la imagen de una pantalla del juego (por simplicidad, esta ruta hará referencia a una imagen publicada en Internet) (texto)
  • datePublished - Fecha de lanzamiento (fecha)
  • embedUrl - Código para incrustar el vídeo del trailer desde YouTube (texto)

Las tareas que hay que realizar son:

• Crear las rutas apropiadas para acceder a cada uno de los recursos (listas y elementos) ofrecidos por la aplicación: listas de películas, películas, listas de discos, discos, listas de libros, libros, listas de videojuegos y videojuegos.
• Para cada tipo de elemento habrá que crear la lógica apropiada para realizar las operaciones relacionadas (CRUD):
  • Devolver la lista de elementos.
  • Crear un nuevo elemento.
  • Modificar un elemento.
  • Borrar un elemento.
• De manera opcional, se puede añadir un test de validación siguiendo el ejemplo adjunto en el repositorio. Dicho test será ejecutado al realizar el Pull Request en GitHub por el sistema de integración continua Travis-CI.

Definición de terminado

Se ha comprobado el correcto funcionamiento de cada tipo de elemento con el cliente. Se pueden realizar las cuatro operaciones CRUD sobre cada tipo de elemento. El cliente muestra correctamente los datos en pantalla. La API está disponible en el servicio OpenShift.

Se proporciona un cliente genérico del formato de datos Collection + JSON. Dicho cliente está disponible en https://github.com/collection-json/cjlib.

El cliente utiliza tecnología AJAX para el intercambio de datos entre cliente y servidor. En este enlace de la wikipedia se explica de manera bastante clara su funcionamiento.

El objetivo que se persigue es modificar dicho cliente para que no muestre los datos de una manera genérica, sino que los muestre de manera personalizada para cada elemento. Por ejemplo, la API devuelve un código HTML para cargar el trailer de la película desde Youtube: el objetivo es que el cliente coja esa información y en lugar de mostrar el texto con ese código muestre el reproductor de Youtube. También se pueden cambiar los campos con fechas para mostrar un widget más apropiado, o cualquier otro cambio que se crea necesario.

Para ello se deberán realizar cambios en el código del cliente (archivo cjlib.js) para que identifique el tipo de datos devuelto en cada caso (si son libros, películas, videojuegos o discos) y ejecute una función JavaScript diferente para mostrar cada uno de ellos. Dichas funciones se definirán en ficheros JavaScript distintos para que cada miembro pueda trabajar de forma separada. Para mantener la compatibilidad del cliente con futuros tipos de datos distintos se mantendrá la funcionalidad original en el caso de que el tipo de elemento devuelto no coincida con ninguno de los cuatro elementos de la aplicación.

También se debe cambiar la manera en que se muestran los formularios de actualización o creación de elementos nuevos para que se muestren de distinta manera a como se hace por defecto.

Para todo ello se utilizará la librería JQuery, con posibilidad de utilizar la extensión JQuery UI.

Por último, se dará formato a la página de la aplicación. Para ello se pueden utilizar los widgets de JQuery UI, Bootstrap o CSS.

Definición de terminado

Se han realizado los cambios pedidos en el cliente. Cada tipo de elemento se muestra de manera personalizada. El cliente funciona correctamente con los cuatro tipos de elementos de la aplicación. La aplicación completa está disponible en el servicio OpenShift.