A mixin class for Jupyterhub deployments that uses a Google docs spreadsheet for whitelisting

jupyterhub-google-sheets.py

import csv
import subprocess

from tornado import gen, AsyncHTTPClient


@gen.coroutine
def get_whitelist(sheets_url, usernames_field):
    # Get CSV from sheet
    client = AsyncHTTPClient()
    resp = yield client.fetch(sheets_url)
    raw_csv = resp.body.decode('utf-8', 'replace').split('\n')

    reader = csv.reader(raw_csv)

    # Extract column index of usernames
    headers = next(reader)
    try:
        username_column = headers.index(usernames_field)
    except ValueError:
        raise ValueError('header field "{}" not found in sheet {}'
                         .format(usernames_field, sheets_url))

    usernames = [row[username_column] for row in reader]
    return usernames


class SheetWhitelister:

    sheets_url = 'https://docs.google.com/spreadsheets/d/xxxxxx'
    usernames_column = 'Github username'

    @gen.coroutine
    def check_whitelist(self, username):
        if super().check_whitelist(username):
            return True
        try:
            whitelist = yield get_whitelist(self.sheets_url,
                                            self.usernames_column)
            self.log.info('Retrieved users from spreadsheet: {}'
                          .format(whitelist))
            self.whitelist.update(whitelist)
        except Exception:
            self.log.error('Failed to fetch usernames from spreadsheet',
                           exc_info=True)
        return (username in self.whitelist)