Merge pull request #225 from ExtremTechniker/feature/224-gsheets

Add nodecg-io-gsheets service

Author: hlxid

README.md

@@ -19,6 +19,7 @@ nodecg-io is the successor of [ChatOverflow](https://github.com/codeoverflow-org
 -   [x] Android (using adb)
 -   [x] CurseForge
 -   [x] Discord
+-   [x] Google Sheets (gsheets)
 -   [x] IntelliJ IDEs
 -   [x] IRC (Internet Relay Chat)
 -   [x] MIDI Input

nodecg-io-gsheets/extension/index.ts

@@ -0,0 +1,86 @@
+import { NodeCG } from "nodecg/types/server";
+import { Result, emptySuccess, success, error, ServiceBundle } from "nodecg-io-core";
+import { google, sheets_v4 } from "googleapis";
+import type { Credentials } from "google-auth-library/build/src/auth/credentials";
+import type { OAuth2Client } from "google-auth-library/build/src/auth/oauth2client";
+import * as express from "express";
+import opn = require("open");
+
+interface GSheetsServiceConfig {
+    clientID: string;
+    clientSecret: string;
+    refreshToken?: string;
+}
+
+export type GSheetsServiceClient = sheets_v4.Sheets;
+
+module.exports = (nodecg: NodeCG) => {
+    new GSheetsService(nodecg, "gsheets", __dirname, "../gsheets-schema.json").register();
+};
+
+class GSheetsService extends ServiceBundle<GSheetsServiceConfig, GSheetsServiceClient> {
+    async validateConfig(_config: GSheetsServiceConfig): Promise<Result<void>> {
+        return emptySuccess();
+    }
+
+    async createClient(config: GSheetsServiceConfig): Promise<Result<GSheetsServiceClient>> {
+        const auth = new google.auth.OAuth2({
+            clientId: config.clientID,
+            clientSecret: config.clientSecret,
+            redirectUri: "http://localhost:9090/nodecg-io-gsheets/oauth2callback",
+        });
+        if (config.refreshToken) {
+            this.nodecg.log.info("Re-using saved refresh token.");
+            auth.setCredentials({
+                refresh_token: config.refreshToken,
+            });
+        } else {
+            this.nodecg.log.info("No refresh token found. Starting auth flow to get one...");
+            auth.setCredentials(await this.initialAuth(auth));
+            if (auth.credentials.refresh_token) {
+                config.refreshToken = auth.credentials.refresh_token;
+            }
+        }
+
+        // Save refresh tokens so they can be used next time to get a access token again
+        auth.on("tokens", (tokens) => {
+            if (tokens.refresh_token) {
+                config.refreshToken = tokens.refresh_token;
+            }
+        });
+
+        const client = new sheets_v4.Sheets({ auth });
+        return success(client);
+    }
+
+    private initialAuth(auth: OAuth2Client): Promise<Credentials> {
+        const authUrl = auth.generateAuthUrl({
+            access_type: "offline",
+            scope: "https://www.googleapis.com/auth/spreadsheets",
+            prompt: "consent",
+        });
+
+        return new Promise((resolve, reject) => {
+            const router: express.Router = express.Router();
+
+            router.get("/nodecg-io-gsheets/oauth2callback", async (req, res) => {
+                try {
+                    const params = req.query;
+                    res.end("<script>open(location, '_self').close();</script>");
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    const { tokens } = await auth.getToken(params.code!.toString());
+                    resolve(tokens);
+                } catch (e) {
+                    reject(error(e));
+                }
+            });
+
+            this.nodecg.mount(router);
+            opn(authUrl, { wait: false }).then((cp) => cp.unref());
+        });
+    }
+
+    stopClient(_client: GSheetsServiceClient): void {
+        // Cannot stop client
+    }
+}

nodecg-io-gsheets/gsheets-schema.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "clientID": {
+            "type": "string",
+            "description": "The oauth client id https://console.cloud.google.com/apis/credentials/oauthclient"
+        },
+        "clientSecret": {
+            "type": "string",
+            "description": "The oauth client secret https://console.cloud.google.com/apis/credentials/oauthclient"
+        },
+        "refreshToken": {
+            "type": "string",
+            "description": "Token that allows the client to refresh access tokens. This is set automatically after first login, you don't need to set it."
+        }
+    },
+    "required": ["clientID", "clientSecret"]
+}

nodecg-io-gsheets/package.json

@@ -0,0 +1,44 @@
+{
+    "name": "nodecg-io-gsheets",
+    "version": "0.2.0",
+    "description": "Allow to control Google Sheets.",
+    "homepage": "https://nodecg.io",
+    "author": {
+        "name": "ExtremTechniker",
+        "url": "https://github.com/ExtremTechniker"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/codeoverflow-org/nodecg-io.git",
+        "directory": "nodecg-io-gsheets"
+    },
+    "main": "extension",
+    "scripts": {
+        "build": "tsc -b",
+        "watch": "tsc -b -w",
+        "clean": "tsc -b --clean"
+    },
+    "keywords": [
+        "nodecg-io",
+        "nodecg-bundle"
+    ],
+    "nodecg": {
+        "compatibleRange": "^1.1.1",
+        "bundleDependencies": {
+            "nodecg-io-core": "^0.2.0"
+        }
+    },
+    "license": "MIT",
+    "devDependencies": {
+        "@types/node": "^14.14.33",
+        "nodecg": "^1.8.1",
+        "typescript": "^4.2.3"
+    },
+    "dependencies": {
+        "@types/gapi": "^0.0.39",
+        "express": "^4.17.1",
+        "googleapis": "^67.1.1",
+        "nodecg-io-core": "^0.2.0",
+        "open": "^8.0.2"
+    }
+}

nodecg-io-gsheets/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "extends": "../tsconfig.common.json"
+}

samples/gsheets/extension/index.ts

@@ -0,0 +1,28 @@
+import { NodeCG } from "nodecg/types/server";
+import { GSheetsServiceClient } from "nodecg-io-gsheets";
+import { requireService } from "nodecg-io-core";
+
+module.exports = function (nodecg: NodeCG) {
+    nodecg.log.info("Sample bundle for Google Sheets started");
+
+    const gsheets = requireService<GSheetsServiceClient>(nodecg, "gsheets");
+
+    gsheets?.onAvailable(async (client) => {
+        try {
+            const data = await client.spreadsheets.values.get(
+                {
+                    spreadsheetId: "<ID>", //Spreadsheet ID, URL is formatted https://docs.google.de/spreadsheets/d/<ID>/edit
+                    range: "<tableSheetName>", //The sheet name, witch will used to get the data.
+                },
+                undefined,
+            );
+            data.data.values = data.data.values?.filter((e) => !(!e[0] || 0 === e[0].length)); // filter out rows when column A is a empty String
+            nodecg.log.info(data.data);
+        } catch (error) {
+            nodecg.log.error("Could it be, that you haven't specified the spreadsheetId and the range?");
+            nodecg.log.error(error);
+        }
+    });
+
+    gsheets?.onUnavailable(() => nodecg.log.info("GSheets client has been unset."));
+};

samples/gsheets/package.json

@@ -0,0 +1,24 @@
+{
+    "name": "gsheets",
+    "version": "0.2.0",
+    "private": true,
+    "nodecg": {
+        "compatibleRange": "^1.1.1",
+        "bundleDependencies": {
+            "nodecg-io-gsheets": "^0.2.0"
+        }
+    },
+    "scripts": {
+        "build": "tsc -b",
+        "watch": "tsc -b -w",
+        "clean": "tsc -b --clean"
+    },
+    "license": "MIT",
+    "dependencies": {
+        "@types/node": "^14.14.33",
+        "nodecg": "^1.8.1",
+        "typescript": "^4.2.3",
+        "nodecg-io-core": "^0.2.0",
+        "nodecg-io-gsheets": "^0.2.0"
+    }
+}

samples/gsheets/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "extends": "../../tsconfig.common.json"
+}