Cómo crear un complemento de Classroom

Esta es la primera explicación de la serie de explicaciones de complementos de Classroom.

En esta explicación, sentarás las bases para desarrollar una aplicación web y publicarla como un complemento de Classroom. En los próximos pasos de la explicación, se expande esta app.

En esta explicación, completarás lo siguiente:

• Crea un proyecto de Google Cloud nuevo para tu app web.
• Crea una app web de esqueleto con marcadores de posición de botones de acceso.
• Publica una ficha de Play Store privada de Google Workspace Marketplace para tu app web.

Cuando termines, puedes instalar el complemento y cargarlo en el iframe de complementos de Classroom.

Importante: Antes de seguir estas explicaciones, lee la guía de configuración del proyecto y completa los pasos del 1 al 8 del recorrido del desarrollador.

Requisitos previos

Elige un idioma para ver los requisitos previos adecuados:

Python

Nuestro ejemplo de Python utiliza el framework de Flask. Puedes descargar el código fuente completo para todas las explicaciones en la página Descripción general. El código para esta explicación en particular se puede encontrar en el directorio /flask/01-basic-app/.

Si es necesario, instala Python 3.7+ y asegúrate de que pip esté disponible.

python -m ensurepip --upgrade

También te recomendamos configurar y activar un nuevo entorno virtual de Python.

python3 -m venv .classroom-addon-env
source .classroom-addon-env/bin/activate

Cada subdirectorio de explicación en los ejemplos descargados contiene un requirements.txt. Puedes instalar rápidamente las bibliotecas requeridas con pip. Usa los siguientes comandos para instalar las bibliotecas necesarias para esta explicación.

cd flask/01-basic-app
pip install -r requirements.txt

Node.js

Nuestro ejemplo de Node.js usa el framework Express. Puedes descargar el código fuente completo de todas las explicaciones desde la página Descripción general.

Si es necesario, instala NodeJS v16.13+.

Instala los módulos de nodo obligatorios con npm.

npm install

Java

Nuestro ejemplo de Java usa el framework de Spring Boot. Puedes descargar el código fuente completo de todas las explicaciones en la página Descripción general.

Instala Java 11+ si aún no lo tienes instalado en tu máquina.

Las aplicaciones de Spring Boot pueden usar Gradle o Maven para controlar las compilaciones y administrar las dependencias. En este ejemplo, se incluye el wrapper de Maven que garantiza una compilación exitosa sin que debas instalar Maven.

Para poder ejecutar el ejemplo proporcionado, ejecuta los siguientes comandos en el directorio en el que descargaste el proyecto y asegúrate de tener los requisitos previos para ejecutarlo.

java --version
./mvnw --version

O en Windows:

java -version
mvnw.cmd --version

Configura un proyecto de Google Cloud

Los proyectos de Google Cloud controlan el acceso a la API de Classroom y los métodos de autenticación necesarios. Las siguientes instrucciones te guiarán a través de los pasos mínimos para crear y configurar un proyecto nuevo para usar con tu complemento.

Crea el proyecto

Para crear un proyecto de Google Cloud nuevo, visita la página de creación de proyectos. Puedes asignarle cualquier nombre al proyecto nuevo. Haz clic en Crear.

El proyecto nuevo tarda unos minutos en crearse por completo. Una vez hecho esto, asegúrate de seleccionar el proyecto; puedes elegirlo en el menú desplegable del selector de proyectos, en la parte superior de la pantalla, o hacer clic en SELECCIONAR PROYECTO en el menú de notificaciones de la parte superior derecha.

Importante: Asegúrate de haber seleccionado el proyecto correcto antes de continuar.

Conecta el SDK de Google Workspace Marketplace al proyecto de Google Cloud

Ve al navegador de la Biblioteca de API. Busca Google Workspace Marketplace SDK. Deberías ver que el SDK aparece en la lista de resultados.

Selecciona la tarjeta del SDK de Google Workspace Marketplace y, luego, haz clic en Habilitar.

Configura el SDK de Google Workspace Marketplace

Google Workspace Marketplace proporciona la ficha a través de la cual los usuarios y administradores instalan tu complemento. Configura la pantalla de consentimiento de OAuth y la configuración de la app y la ficha de Play Store del SDK de Marketplace para continuar.

Pantalla de consentimiento de OAuth

La pantalla de consentimiento de OAuth aparece cuando los usuarios autorizan tu app por primera vez. Les solicita que les permitan acceder a su información personal y de la cuenta, según lo establecido en los alcances que habilites.

Ve a la página de creación de la pantalla de consentimiento de OAuth. Proporciona la siguiente información:

• Configura el Tipo de usuario como Externo. Haga clic en Crear.
• En la página siguiente, completa los detalles obligatorios de la app y la información de contacto. Proporciona los dominios que alojen la app en Dominios autorizados. Haz clic en GUARDAR Y CONTINUAR.

• Agrega los permisos de OAuth que requiera tu aplicación web. Consulta la guía de configuración de OAuth para obtener un análisis detallado de los alcances y su propósito.

  Debes solicitar al menos uno de los siguientes permisos para que Google envíe el parámetro de consulta login_hint. Puedes encontrar una explicación más detallada de este comportamiento en nuestra guía de configuración de OAuth:

  • https://www.googleapis.com/auth/userinfo.email (ya incluido)
  • https://www.googleapis.com/auth/userinfo.profile (ya incluido)

  Los siguientes permisos son específicos de los complementos de Classroom:

  • https://www.googleapis.com/auth/classroom.addons.teacher
  • https://www.googleapis.com/auth/classroom.addons.student

  También incluye cualquier otro permiso de la API de Google que tu app requiera de los usuarios finales.

  Haz clic en GUARDAR Y CONTINUAR.

• Enumera las direcciones de correo electrónico de las cuentas de prueba en la página Usuarios de prueba. Haz clic en GUARDAR Y CONTINUAR.

Confirma que la configuración sea correcta y, luego, regresa al panel.

Configuración de la app

Navega a la página Configuración de la app del SDK de Marketplace. Proporcione la siguiente información:

• Establece la Visibilidad de la app en Private. Esta configuración es apropiada para fines de prueba y desarrollo, y es la opción adecuada para estas explicaciones. Elige Public solo si estás listo para que el complemento lo use el público en general.

  Advertencia: Comprueba que la configuración de Visibilidad de la app sea correcta antes de guardar. Una vez configurada, no puedes cambiar la visibilidad de la app. Debes crear un proyecto de Google Cloud nuevo para configurar otra visibilidad de la app.

• Establece Installation Settings en Admin Only install si deseas restringir la instalación solo a los administradores de dominio.

• En Integración de apps, selecciona Complemento de Classroom. Se te solicita el URI de configuración de archivos adjuntos seguro. Esta es la URL que esperas que se cargue cuando un usuario abra tu complemento. Para los fines de esta explicación, debería ser https://<your domain>/addon-discovery.

• Los prefijos de URI de archivos adjuntos permitidos se usan para validar los URI establecidos en AddOnAttachment mediante los métodos courses.*.addOnAttachments.create y courses.*.addOnAttachments.patch. La validación es una coincidencia de prefijo de string literal y no permite el uso de comodines en este momento. Puedes dejarlas vacías por ahora.

• Agrega los mismos permisos de OAuth que los proporcionados en tu pantalla de consentimiento de OAuth en el paso anterior.

  Advertencia: Tu complemento no se puede publicar si la configuración de la app especifica permisos diferentes a los que aparecen en la pantalla de consentimiento de OAuth.

• Completa los campos según corresponda para tu organización en Vínculos para desarrolladores.

Ficha de Play Store

Navega a la página Ficha de Play Store del SDK de Marketplace. Proporcione la siguiente información:

• En Detalles de la app, agrega un idioma o expande el menú desplegable junto al idioma que ya aparece en la lista. Proporciona un nombre de la aplicación y descripciones, que aparecerán en la página de la ficha de Play Store de Google Workspace Marketplace de tu complemento. Haz clic en Listo para guardar los cambios.
• Elige una Categoría para tu complemento.
• En Recursos gráficos, proporciona imágenes para los campos obligatorios. Estos se pueden cambiar más adelante y pueden ser marcadores de posición si configuras la visibilidad de la app como Privada en el paso anterior.
• En Vínculos de asistencia, proporciona las URLs solicitadas. Estas pueden ser marcadores de posición si configuraste la visibilidad de la app como Privada en el paso anterior.

Haz clic en PUBLICAR para guardar la configuración. Si configuraste la visibilidad de la app como Privada en el paso anterior, tu app estará disponible de inmediato para su instalación. Si configuras la visibilidad de la app como Pública, el equipo de Marketplace enviará tu app para que la revise antes de que esté disponible para su instalación.

Instala el complemento

Ahora puedes instalar el complemento con el vínculo que se encuentra en la parte superior de la página Ficha de Play Store del SDK de Marketplace. Haz clic en la URL de la app en la parte superior de la página para ver la ficha y, luego, selecciona Instalar.

Nota: Solo puedes instalar el complemento si accediste con una cuenta que especificaste como usuario de prueba cuando configuraste la pantalla de consentimiento de OAuth.

Compila una app web básica

Configura una aplicación web de base con dos rutas. Los próximos pasos de explicación expandirán esta aplicación. Por el momento, solo debes crear una página de destino para el complemento /addon-discovery y una página de índice simulada / para el "sitio de la empresa".

Implementa estos dos extremos:

• /: Muestra un mensaje de bienvenida y un botón para cerrar la pestaña actual y el iframe del complemento.
• /addon-discovery: Muestra un mensaje de bienvenida y dos botones: uno para cerrar el iframe del complemento y otro para abrir un sitio web en una pestaña nueva.

Ten en cuenta que agregaremos botones para crear y cerrar ventanas o el iframe. En ellas, se muestra un método con el que se abre de manera segura el usuario en una pestaña nueva a fin de obtener su autorización en la siguiente explicación.

Crea un guion de utilidad

Crea un directorio static/scripts. Crea un archivo nuevo addon-utils.js. Agrega las dos funciones siguientes.

/**
 *   Opens a given destination route in a new window. This function uses
 *   window.open() so as to force window.opener to retain a reference to the
 *   iframe from which it was called.
 *   @param {string} destinationURL The endpoint to open, or "/" if none is
 *   provided.
 */
function openWebsiteInNewTab(destinationURL = '/') {
  window.open(destinationURL, '_blank');
}

/**
 *   Close the iframe by calling postMessage() in the host Classroom page. This
 *   function can be called directly when in a Classroom add-on iframe.
 *
 *   Alternatively, it can be used to close an add-on iframe in another window.
 *   For example, if an add-on iframe in Window 1 opens a link in a new Window 2
 *   using the openWebsiteInNewTab function above, you can call
 *   window.opener.closeAddonIframe() from Window 2 to close the iframe in Window
 *   1.
 */
function closeAddonIframe() {
  window.parent.postMessage({
    type: 'Classroom',
    action: 'closeIframe',
  }, '*');
};

Crea rutas

Implementa los extremos /addon-discovery y /.

Python

Configura el directorio de la aplicación

Para los fines de este ejemplo, estructura la lógica de la aplicación como un módulo de Python. Este es el directorio webapp en el ejemplo que proporcionamos.

Crea un directorio para el módulo de servidor, por ejemplo, webapp. Mueve el directorio static al directorio del módulo. Crea también un directorio template en el directorio del módulo; tus archivos HTML van aquí.

Compila el módulo del servidor*

Crea el archivo __init__.py en el directorio del módulo y agrega las siguientes importaciones y declaraciones.

from flask import Flask
import config

app = Flask(__name__)
app.config.from_object(config.Config)

# Load other module script files. This import statement refers to the
# 'routes.py' file described below.
from webapp import routes

Luego, crea un archivo para controlar las rutas de la app web. En el ejemplo que proporcionamos, este es webapp/routes.py. Implementa las dos rutas en este archivo.

from webapp import app
import flask

@app.route("/")
def index():
    return flask.render_template("index.html",
                                message="You've reached the index page.")

@app.route("/classroom-addon")
def classroom_addon():
    return flask.render_template(
        "addon-discovery.html",
        message="You've reached the addon discovery page.")

Ten en cuenta que nuestras rutas pasan una variable message a sus respectivas plantillas de Jinja. Esto es útil para identificar a qué página llegó el usuario.

Crea archivos de configuración y de inicio

En el directorio raíz de tu aplicación, crea los archivos main.py y config.py. Configura tu clave secreta en config.py.

import os

class Config(object):
    # Note: A secret key is included in the sample so that it works.
    # If you use this code in your application, replace this with a truly secret
    # key. See https://flask.palletsprojects.com/quickstart/#sessions.
    SECRET_KEY = os.environ.get(
        'SECRET_KEY') or "REPLACE ME - this value is here as a placeholder."

En el archivo main.py, importa el módulo y, luego, inicia el servidor Flask.

from webapp import app

if __name__ == "__main__":
    # Run the application over HTTPs with a locally stored certificate and key.
    # Defaults to https://localhost:5000.
    app.run(
        host="localhost",
        ssl_context=("localhost.pem", "localhost-key.pem"),
        debug=True)

Node.js

Las rutas se registran en el archivo app.js con las siguientes líneas.

const websiteRouter = require('./routes/index');
const addonRouter = require('./routes/classroom-addon');

app.use('/', websiteRouter);
app.use('/addon-discovery', addonRouter);

Abre /01-basic-app/routes/index.js y revisa el código. Se llega a esta ruta cuando el usuario final visita el sitio web de la empresa. La ruta renderiza una respuesta con la plantilla de Handlebars index y le pasa un objeto de datos que contiene las variables title y message.

router.get('/', function (req, res, next) {
  res.render('index', {
    title: 'Education Technology',
    message: 'Welcome to our website!'
  });
});

Abre la segunda ruta /01-basic-app/routes/classroom-addon.js y revisa el código. Se llega a esta ruta cuando la visita del usuario final usa el complemento. Ten en cuenta que esta ruta usa la plantilla de Handlebars discovery y, además, el diseño addon.hbs para renderizar la página de manera diferente al sitio web de la empresa.

router.get('/', function (req, res, next) {
  res.render('discovery', {
    layout: 'addon.hbs',
    title: 'Education Technology Classroom add-on',
    message: `Welcome.`
  });
});

Java

En el ejemplo de código de Java, se usan módulos para empaquetar los pasos de la explicación secuencial. Dado que esta es la primera explicación, el código se encuentra en el módulo step_01_basic_app. No se espera que implementes tu proyecto con módulos. En su lugar, te sugerimos que compiles en un solo proyecto a medida que sigas cada paso de la explicación.

Crea una clase de controlador, Controller.java en este proyecto de ejemplo, para definir los extremos. En este archivo, importa la anotación @GetMapping desde la dependencia spring-boot-starter-web.

import org.springframework.web.bind.annotation.GetMapping;

Incluye la anotación del controlador del framework de Spring sobre la definición de la clase para indicar el propósito de esta.

@org.springframework.stereotype.Controller
public class Controller {

Luego, implementa las dos rutas y una ruta adicional para el manejo de errores.

/** Returns the index page that will be displayed when the add-on opens in a
*   new tab.
*   @param model the Model interface to pass error information that's
*   displayed on the error page.
*   @return the index page template if successful, or the onError method to
*   handle and display the error message.
*/
@GetMapping(value = {"/"})
public String index(Model model) {
  try {
    return "index";
  } catch (Exception e) {
    return onError(e.getMessage(), model);
  }
}

/** Returns the add-on discovery page that will be displayed when the iframe
*   is first opened in Classroom.
*   @param model the Model interface to pass error information that's
*   displayed on the error page.
*   @return the addon-discovery page.
*/
@GetMapping(value = {"/addon-discovery"})
public String addon_discovery(Model model) {
  try {
    return "addon-discovery";
  } catch (Exception e) {
    return onError(e.getMessage(), model);
  }
}

/** Handles application errors.
*   @param errorMessage message to be displayed on the error page.
*   @param model the Model interface to pass error information to display on
*   the error page.
*   @return the error page.
*/
@GetMapping(value = {"/error"})
public String onError(String errorMessage, Model model) {
  model.addAttribute("error", errorMessage);
  return "error";
}

Prueba el complemento

Importante: Si bien puedes probar tu aplicación directamente con un navegador web, debes probarla principalmente en los iframes de los complementos de Classroom. Cargar tu app web en un iframe puede producir comportamientos atípicos. Lee nuestra página de guía sobre iframe y parámetros de consulta para obtener una descripción de cada iframe. En todas las instrucciones que se proporcionan en esta explicación, se supone que el complemento se puede usar en el contexto de un iframe.

Inicia tu servidor. Luego, accede a Google Classroom como uno de tus usuarios de prueba de Teacher. Navega a la pestaña Trabajo en clase y crea una Tarea nueva. Haz clic en el botón Complementos debajo del área de texto y, luego, selecciona tu complemento. El iframe se abre y el complemento carga el URI de configuración de archivos adjuntos que especificaste en la página Configuración de la app del SDK de Marketplace.

¡Felicitaciones! Todo está listo para continuar con el siguiente paso: Acceder a los usuarios con el SSO de Google.