Sequelize Blog Homework

Descripción

En esta homework vamos a construir un Blog al estilo Wikipedia en el cual podremos crear nuevas páginas con su contenido asociado y luego consultarlas, modificarlas o eliminarlas. Adicionalmente se mantendrá un registro de todos aquellos usuarios que hayan creado alguna página en el Blog.

Configuración inicial

Ejecutar npm install desde la carpeta "XXXXX"
Configurar la base de datos de postgres para poder correr el proyecto correctamente:

Verificar que se encuentre instalado postgres en su máquina
Crear la base de datos denominada henryblog que se utilizará en esta homework ejecutando el siguiente comando: createdb henryblog

Ejecutar npm start para correr el servidor y acceder a http://localhost:1337/ para visualizar el Blog

Instrucciones

Creación de modelos de Sequelize

Dentro del modelo de la base de datos que vamos a utilizar en este ejercicio debemos generar las entidades Page y User descriptas debajo.

User

La entidad User va a correponder a aquellos usuarios que participen del Blog generando nuevas páginas, por lo que tendrán que contener los siguientes campos:

name*: Nombre completo del usuario
email*: Email del usuario (Debe ser único)

Esquema

Para llevar adelante esta tarea será necesario modificar el archivo index.js de la carpeta models:

const Page = db.define('page', {
  // Tu código acá:

});

const User = db.define('users', {
  // Tu código acá:

})

Dentro de Page y User deberán incluirse los campos correspondientes para cada uno identificando su tipo de dato. En este link podrán encontrar un ejemplo de cómo definir los esquemas y la variedad de tipos de datos aceptados por Sequelize.

Los campos que contienen un asterísco deben ser obligatorios, por lo que será necesario la utilización de la opción allowNull en dichos casos

Hooks

Es importante aclarar que el campo urlTitle debería ser una versión válida de URL para el campo title por lo que deberías hacer que se genere automáticamente a partir del título ingresado por el usuario. Por ejemplo si el usuario ingresa como título de la página: "Henry Sequelize Example", el urlTitle debería generarse sólo como "Henry_Sequelize_Example".

Por lo tanto deben realizarse las siguientes validaciónes para el campo urlTitle:

No debe contener caracteres no alfanuméricos
Los espacios deben ser sustituidos por guiones bajos

Para eso deberán utilizar regexes y el método replace de Strings.

Implementar está función a partir de un beforeValidate hook en el archivo index.js de la carpeta models para la entidad Page. Acá pueden encontrar información sobre cómo implementar los hooks.

Vinculación

Luego de haber creado los campos para cada entidad de la base de datos tenemos que relacionarlos entre sí, ya que cada usuario (User) va a poder crear una o más páginas (Page). Por lo tanto dentro del mismo archivo index.js de la carpeta models también debemos agregar como se realcionan estas dos entidades.

Las distintas opciones que ofrece Sequelize para ello son:

hasOne
belongsTo
hasMany
belongsToMany

Para más detalles sobre cada una de ellas pueden consultar el siguiente link

En nuestro caso, las que corresponden utilizar son:

Page.belongsTo: ya que cada página estará asociada a un usuario en particular
User.hasMany: ya que cada usuario puede crear múltiples páginas

Route getter

Adicionalmente necesitamos definir una ruta para cada página que se cree en el Blog para poder acceder luego a su contenido. Para ello queremos que se genere dicha ruta concatenando /wiki/ con el campo urlTitle de cáda página. Por ejemplo una Page cuyo urlTitle sea 'henry-Prep' debería tener una ruta asociada igual a /wiki/henry-Prep.

Para estos casos Sequelize tiene getters los cuales nos permiten crear campos virtuales que no son almacenados en la base de datos sino que se crean cada vez que realizamos una consulta.

Aquí podrán encontrar detalles de cómo implementarlos. En nuestro caso debemos hacerlo dentro del campo que hemos definido como urlTitle.

Routes

Ahora necesitaremos modificar las rutas de Express para manejar los request tanto de creación como obtención de datos desde nuestro esquema:

GET /wiki/: Obtiene todas las páginas creadas
GET /wiki/:urlTitle : Obtiene todos los datos de una página en particular cuyo urlTitle corresponda con el indicado
POST /wiki/: Agrega una nueva página a la base de datos
GET /users/: Obtiene todos los usuarios
GET /users/:id : Obtiene los datos del usuario cuyo id corresponda con el indicado

Los template de las rutas ya se encuentran creados dentro de la carpeta routes solo es necesario modificarlos donde se indica

Sequelize Query

Para obtener datos de la base de datos creada por Sequelize debemos utilizar su modelo de consulta que podemos encontrar explicado en detalle en los siguientes dos links:

GET /wiki/

Modificar el archivo index.js de la carpeta routes y utilizar el método findAll de Sequelize para obtener todas las páginas creadas hasta el momento. Luego con la respuesta renderizar el index pasándole como argumento la respuesta de la consulta realizada.

router.get('/', function(req, res){
  // Modificar para renderizar todas las páginas creadas que se encuentren
  // dento de la base de datos
  // Tu código acá:

  // 1. Utilizar Page.findAll()
  // 2. Capturar la respuesta con lo ya visto en Express (Utilizar then())
  // 3. Renderizar la página "index" usando res.render('index', {pages}) (Donde {pages} es la respuesta del request)

  res.render('index');
})

GET /wiki/:urlTitle

Modificar el archivo wiki.js de la carpeta routes y utilizar el método findOne de Sequelize para obtener una página en particular (La que coincida con el urlTitle indicado). Luego con la respuesta renderizar el wikipage pasándole como argumento la respuesta de la consulta realizada.

router.get('/:urlTitle', function(req, res) {
  // Modificar para que cuando se seleccione un "Page" en particular se muestren
  // los datos asociados al mismo
  // Tu código acá:

  // 1. Utilizar Page.findOne() pasándole como parámetro el urlTitle
  // 2. Capturar la respuesta utilizando then()
  // 3. Renderizar la página "wikipage" usando res.render('wikipage', {page}) (Donde {page} es la respuesta del request)

  res.render('wikipage');
})

POST /wiki/

Modificar el archivo wiki.js de la carpeta routes y utilizar el método create de Sequelize para crear y gurdar un nuevo registro dentro de la tabla de páginas. Una vez creada exitosamente redirigir hacia la pantalla de la página recientemente creada.

router.post('/', function(req, res, next) {
  // Modificar para que cuando se clickee el botón de "SUBMIT" se cree un nuevo post
  // tomando los datos desde el form y agregándolo a la base de datos
  // Tu código acá:

  // 1. Utilizar el método findOrCreate para obtener el usuario o crear uno nuevo en el caso de que no exista
  // 2. Capturar la respuesta del punto 1 con then() y a partir de ella y de los datos almacenados en `req`
  //    crear una nueva página utilizando el método `create`
  // 3. Capturar la respuesta del punto 2 con then() y redirigir hacía la pantalla cuyo URL obtendremos de 'page.urlTitle'
  res.render('index');
});

GET /users/

Modificar el archivo users.js de la carpeta routes y utilizar el método findAll de Sequelize para obtener todos los usuarios creados hasta el momento. Luego con la respuesta renderizar el users pasándole como argumento la respuesta de la consulta realizada.

router.get('/', function(req, res, next){
  // Modificar para renderizar todas los usuarios que se encuentren
  // dento de la base de datos
  // Tu código acá:

  // 1. Utilizar User.findAll()
  // 2. Capturar la respuesta con then()
  // 3. Renderizar la página "users" usando res.render('users', {users}) (Donde {users} es la respuesta del request)

  res.render('users');
});

GET /users/:id

Modificar el archivo users.js de la carpeta routes y utilizar el método findById de Sequelize para obtener un usuario en particular (El que coincida con el ID indicado). Luego con la respuesta renderizar el unUsuarioEnParticular pasándole como argumento la respuesta de la consulta realizada.

router.get('/:id', function(req, res){
  // Modificar para renderizar los datos del usuario seleccionado
  // Tu código acá:

  // 1. Utilizar User.findById() pasándole como parámetro el id
  // 2. Capturar la respuesta utilizando then()
  // 3. Renderizar la página "unUsuarioEnParticular" usando res.render('unUsuarioEnParticular', {user}) (Donde {user} es la respuesta del request)

  res.render('unUsuarioEnParticular');
});

Franverri/wiki-express-sequelize