Laboratorio 6: Servicios Web

Objetivos

Durante esta práctica, los alumnos serán capaces de:

Utilizar Node para escribir un cliente de consola para un servicio web REST con un formato de datos de respuesta en XML.

Esta actividad promueve las siguientes habilidades, valores y actitudes: análisis y síntesis, capacidad de resolver problemas, creatividad, y uso eficiente de la informática y las telecomunicaciones.

Introducción

Un servicio web es un método de comunicación entre dos dispositivos a través de la web.

Según la W3C, los servicios Web son^[1]:

... un conjunto de aplicaciones o de tecnologías con capacidad para interoperar en la Web. Estas aplicaciones o tecnologías intercambian datos entre sí con el objetivo de ofrecer unos servicios. Los proveedores ofrecen sus servicios como procedimientos remotos y los usuarios solicitan un servicio llamando a estos procedimientos a través de la Web.

Estos servicios proporcionan mecanismos de comunicación estándares entre diferentes aplicaciones, que interactúan entre sí para presentar información dinámica al usuario.

^[1] Guía Breve de Servicios Web

En esta práctica utilizaremos un estilo arquitectónico conocido como REST (Representational State Transfer) para escribir un cliente de un servicio Web. REST define un modelo conceptual que permite efectuar llamadas a un servicio mediante el uso de los métodos de HTTP (GET, PUT, POST y DELETE) según corresponda semánticamente. Para los fines de esta práctica solo usaremos el método GET.

El servicio Web que utilizaremos es el Yahoo! Weather RSS Feed. La documentación correspondiente detalla la manera de utilizarlo. De manera resumida, se utiliza un URL como el siguiente para obtener la información del clima de una cierta localidad:

http://weather.yahooapis.com/forecastrss?w=localidad&u=c

El parámetro w debe ser un identificador WOEID (Where on Earth IDentifier) del sitio del que se desea conocer su información climatológica. Por ejemplo, el WOEID de Atizapán de Zaragoza es 112625. El parámetro u indica que las unidades de temperatura del resultado deben estar en grados Celsius.

Usando curl desde la línea de comando se puede ver el funcionamiento general de este servicio Web:

curl "http://weather.yahooapis.com/forecastrss?w=112625&u=c"

El resultado es un documento XML que cumple con la especificación RSS 2.0. La estructura de este documento se describe completamente en la documentación provista por Yahoo!.

Usando Node se puede escribir un cliente que consuma un servicio Web usando los módulos http y xml2js:

'use strict';

var http = require('http');
var xml2js = require('xml2js');

var options = {
    host: 'weather.yahooapis.com',
    path: '/forecastrss?w=112625&u=c',
    method: 'GET'
};

function processXmlDocument(xmlStr) {
    xml2js.parseString(xmlStr, function (err, xmlObject) {
        if (err) {
            console.log(err);
        } else {
            console.log(xmlObject);
        }
    });
}

var req = http.request(options, function (res) {
    var body = [];
    res.on('data', function (chunk) {
        body.push(chunk);
    });
    res.on('end', function () {
        processXmlDocument(body.join(''));
    });
});

req.on('error', function (e) {
    console.log('Error: Problems with request. ' + e.message);
});

req.end();

La función processXmlDocument se encarga de parsear y crear el objeto de XML correspondiente. Dicho objeto ahora puede ser manipulado usando las mismas técnicas que se usaron en la práctica del Laboratorio de XML.

Descripción de la actividad

NOTA IMPORTANTE: Las actividades de la práctica se pueden elaborar de manera individual o en parejas. El reporte de la práctica de laboratorio debe ser desarrollado de manera individual.

Crea un directorio llamado lab6. Escribe un script de Node, llamado clima.js, y colócalo en el directorio recién creado. Dicho script debe recibir de la línea de comando un número de identificador WOEID y desplegar en la consola la información actualizada correspondiente tal como se muestra a continuación.

Por ejemplo, si el usuario teclea en la terminal lo siguiente:

node clima.js 112625

La salida esperada debe ser parecida a esto:

WOEID: 112625
City: Atizapan de Zaragoza
Country: Mexico
Latitude: 19.56
Longitude: -99.25
Weather Condition: Mostly Cloudy
Temperature: 24° C
Sunrise: 6:46 am
Sunset: 6:45 pm
Humidity: 21%
Visibility: 12.87 km
Forecast for: Tue, 12 Mar 2013
    Partly Cloudy
    low: 9° C
    high: 27° C
Forecast for: Wed, 13 Mar 2013
    Partly Cloudy
    low: 7° C
    high: 23° C
Publication date: Tue, 12 Mar 2013 12:40 pm CST

Nota 1: Se debe imprimir un mensaje de error si no se proporciona el WOEID desde la línea de comando o si éste no es válido.

Nota 2: El arreglo process.argv se puede utilizar desde un script de Node para obtener los argumentos de la línea de comando.

Nota 3: Utiliza el sitio WOEID Lookup para encontrar el WOEID de cualquier ciudad de tu interés.

¿Qué se debe entregar?

Para entregar tu trabajo individual, sigue las siguientes instrucciones:

Escribe el reporte de la práctica tal como se detalla en el documento Reportes de laboratorio. El nombre del archivo fuente de AsciiDoc debe ser reporte_lab6_A0MMMMMMM.txt, en donde A0MMMMMMM corresponde a tu matrícula. A partir del código fuente de AsciiDoc debes generar el archivo HTML correspondiente. Dicho archivo se debe llamar reporte_lab6_A0MMMMMMM.html. Coloca ambos archivos dentro del directorio lab6.
Crea un archivo tarball con todo el contenido del directorio lab6. Nombra a este archivo lab6.tgz. Este archivo se puede crear desde la línea de comando tecleando lo siguiente (asegúrate que te encuentres en el mismo nivel que el directorio lab6):
```
tar czf lab6.tgz lab6
```
Usando el Sistema de Entrega de Tareas Automatizado (SETA), entrega el archivo tarball.

Fecha límite: Martes, Marzo 19.

Evaluación

Esta actividad será evaluada usando los siguientes criterios:

50%	Implementación de los requerimientos.
50%	Reporte de la práctica de laboratorio.
DA	El programa y/o reporte es un plagio.

Desarrollo de aplicaciones distribuidas