@spawm/resource

Libreria encargada de obtener información desde un servicio web haciendo uso de una arquitectura REST.

Instalación

Mediante node se puede instalar con el comando npm i @spawm/resource o manualmente haciendo uso del CDN.

Uso

Para utilizar un recurso basta con instanciar un objeto de la clase Resource.

import Resource from '@spawm/resource';

const user = new Resource('response.json');

Ya con el objeto se pueden invocar sus métodos get, post, put, delete, patch o send, este último se usa para crear una petición personalizada (TRACE, OPTIONS, HEAD, CONNECT). Hasta el momento no existe mucha diferencia con el uso de fetch y es acá donde cabe recordar que Resource es una clase y como tal la podemos usar para aprovechar todas las caracteristicas de la programación orientada a objetos; como por ejemplo la herencia.

class ServerConnection extends Resource {
  constructor(path) {
    super('http://localhost:8080/' + path);
    this.headers = {
      Authorization: "Basic YWxhZGRpbjpvcGVuc2VzYW1l"
    }
  }
}

A parte de sobrescribir propiedades como observamos en el ejemplo anterior mediante herencia también es posible utilizar un sistema de inversión de control para usar un solo objeto durante todo el ciclo de vida de la aplicación. Cabe resaltar el uso de web workers para enviar peticiones, esto hace que toda petición realizada con Resource se realice en segundo plano.

Métodos

• get: El método get solicita una representación de un recurso específico. Las peticiones que usan el método GET sólo deben recuperar datos. Solo acepta como parametro un objeto que convertira en el query string.

• post: El método post se utiliza para enviar una entidad a un recurso en específico, causando a menudo un cambio en el estado o efectos secundarios en el servidor. Recibe dos objetos como paramteros, el primero es el que se enviara dentro del cuerpo del mansaje y el segundo opcional un query string.

• put: El modo put reemplaza todas las representaciones actuales del recurso de destino con la carga útil de la petición. Recibe dos objetos como paramteros, el primero es el que se enviara dentro del cuerpo del mansaje y el segundo opcional un query string.

• delete: El método delete borra un recurso en específico. Solo acepta como parametro un objeto que convertira en el query string.

• patch: El método patch es utilizado para aplicar modificaciones parciales a un recurso. Recibe dos objetos como paramteros, el primero es el que se enviara dentro del cuerpo del mansaje y el segundo opcional un query string.

• send: El método send es el principal y por el cual pasan todas las peticiones que se deben realizar al servidor, podemos pensar en los anteriores métodos como alias de este. Recibe tres parametros, el primero es un setring con el nombre del método por el cual se envia la petición, el segundo el objeto que se enviara en el cuerpo de la petición y el último el query string, igualmente como objeto javascript.

• add: El método add no envía peticiones al servidor, su función es crear un nuevo recurso sobreescribiendo las propiedades del recurso que llama el método; el nuevo recurso no puede volver a lllamar al método add. Por ejemplo un recurso /posts/1 podría tener una url /posts/1/comments donde se listan los comentarios del post, para esta situcación tendriamos el siguiente caso:

const Resource = new Resource('/posts/{id}');
// Carga todos los recursos
resource.get().then(res => console.log(res));
//carga solo el recurso 1
resource.get({ id: 1 }).then(res => console.log(res));
//carga los comentarios del recurso 1
resource.add({path: '/comments'}).get({ id: 1 });

Como podemos observar el método add recibe un objeto como parametro el cual tiene las propiedades path, headers, redirect y type; para los dos primero el nuevo recurso extendera la propiedad, es decir concatera la parte del path que hace falta y agregara los headers que se envian, miestras que para los últimos dos directamente reemplazara las propiedades.

Evitando los interceptores

Otra funcionalidad de la programación oriendata a objetos que podemos usar es el polimorfismo, lo cual nos permite modificar peticiones o respuestas; tareas delegadas en la mayoria de casos a intecptores.

Como se meciono anteriormente send es el método principal y sobre el cual se realizan todas las peticiones al servidor y este puede ser sobre escrito por herencia como vimos en el pasado ejemplo.

class ServerConnection extends Resource {
  async send(method, body, query) {
    const response = await super.send(method, body, query);
    response.at = new Date();
    return reponse;
  }
}