Cómo crear un complemento de Classroom

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

En esta explicación, sentarás las bases para desarrollar una aplicación web y publicarla como complemento de Classroom. Los pasos futuros de la explicación expandirán esta app.

En el transcurso de esta explicación, completarás las siguientes tareas:

• Crea un proyecto de Google Cloud nuevo para tu complemento.
• Crea una app web de base con botones de acceso de marcador de posición.
• Publica una ficha de Google Workspace Marketplace para tu complemento.

Cuando termines, podrás instalar el complemento y cargarlo en el iframe de complementos de Classroom.

Requisitos previos

Elige un idioma para ver los requisitos previos correspondientes:

python -m ensurepip --upgrade

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

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

npm install

java --version
./mvnw --version

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. En las siguientes instrucciones, se describen los pasos mínimos para crear y configurar un proyecto nuevo para usarlo con tu complemento.

Crea el proyecto

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

El proyecto nuevo tardará unos minutos en crearse por completo. Cuando termines, 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 SELECT PROJECT en el menú de notificaciones en la parte superior derecha.

Cómo adjuntar el SDK de Google Workspace Marketplace al proyecto de Google Cloud

Navega al navegador de la Biblioteca de API. Busca Google Workspace Marketplace SDK. Deberías ver el SDK 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 los administradores instalan tu complemento. Para continuar, configura la configuración de la app y la ficha de Play Store del SDK de Marketplace, y la pantalla de consentimiento de OAuth.

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 Public o Private.

  • La configuración pública está destinada a las apps que, en algún momento, se lanzarán a los usuarios finales. Una app pública debe pasar por un proceso de aprobación antes de publicarse para los usuarios finales, pero puedes especificar los usuarios que pueden instalarla y probarla como borrador. Este es un estado previo a la publicación que te permitirá probar y desarrollar tu complemento antes de enviarlo para su aprobación.
  • La configuración privada es adecuada para pruebas y desarrollo internos. Solo los usuarios del mismo dominio en el que se creó el proyecto pueden instalar una app privada. Por lo tanto, debes configurar la visibilidad como privada solo si el proyecto se creó en un dominio con una suscripción a Google Workspace for Education. De lo contrario, los usuarios de prueba no podrán iniciar los complementos de Classroom.

• Establece Configuración de la instalación en Admin Only install si quieres restringir la instalación a los administradores de dominios.

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

• Los prefijos de URI de archivos adjuntos permitidos se usan para validar los URIs establecidos en AddOnAttachment con los métodos courses.*.addOnAttachments.create y courses.*.addOnAttachments.patch. La validación es una concordancia literal de prefijo de cadena y, por el momento, no permite el uso de comodines. Agrega al menos el dominio raíz de tu servidor de contenido, como https://localhost:5000/ o https://cdn.myedtech.com/.

• Agrega los mismos Alcances de OAuth que se proporcionaron en la pantalla de consentimiento de OAuth en el paso anterior.

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

Ficha de Play Store

Navega a la página Store Listing 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 y descripciones para la aplicación. Estos aparecerán en la página de la ficha de Google Workspace Marketplace de tu complemento. Haz clic en Listo para guardar.
• Elige una categoría para tu complemento.
• En Recursos gráficos, proporciona imágenes para los campos obligatorios. Se pueden cambiar más adelante y pueden ser marcadores de posición por ahora.
• En Vínculos de asistencia, proporciona las URLs solicitadas. Estos pueden ser marcadores de posición si configuras la visibilidad de la app como Privada en el paso anterior.

Si configuraste la visibilidad de la app como Privada en el paso anterior, haz clic en PUBLICAR. Tu app estará disponible de inmediato para instalarse. Si configuras la visibilidad de la app como Pública, agrega direcciones de correo electrónico en el área Verificadores de borrador para los usuarios de prueba y haz clic en Guardar borrador.

Pantalla de consentimiento de OAuth

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

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

• Establece Tipo de usuario en Externo. Haga clic en Crear.
• En la página siguiente, completa los detalles de la app y la información de contacto requeridos. Proporciona los dominios que alojan tu app en Dominios autorizados. Haz clic en GUARDAR Y CONTINUAR.

• Agrega los Permisos de OAuth que requiera tu app 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 está incluido)
  • https://www.googleapis.com/auth/userinfo.profile (ya está 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 alcance de la API de Google que tu app requiera de los usuarios finales.

  Haz clic en GUARDAR Y CONTINUAR.

• Incluye 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.

Cómo instalar 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, elige Instalar.

Compila una app web básica

Configura una aplicación web de esqueleto con dos rutas. Los pasos de la explicación que se incluyen más adelante expandirán esta aplicación, así que, por ahora, solo crea una página de destino para el complemento /addon-discovery y una página de índice simulada / para nuestro "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. Estos demuestran un método para dirigir al usuario de forma segura a una pestaña nueva para la autorización en la siguiente explicación.

Crea una secuencia de comandos de utilidad

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

/**
 *   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, 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 /.

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

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.")

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."

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)

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

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

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

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

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

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

/** 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

Inicia el servidor. Luego, accede a Google Classroom como uno de los usuarios de prueba de profesor. Navega a la pestaña Trabajo en clase y crea una nueva Tarea. Selecciona tu complemento en el selector de Complementos. Se abre el iframe 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! Ya puedes continuar con el siguiente paso: hacer que los usuarios accedan con el SSO de Google.