Move auth functions to auth.ts (google#154)

Including: REDIRECT_URI_OOB oauth2Client getAPICredentials authorizeWithLocalHost authorizeWithoutLocalHost Signed-off-by: campionfellin <[email protected]>
GPCsolutions · Apr 30, 2018 · 22e0925 · 22e0925
1 parent 6a52dde
commit 22e0925
Show file tree

Hide file tree

Showing 2 changed files with 98 additions and 92 deletions.
diff --git a/index.ts b/index.ts
@@ -24,24 +24,22 @@ import 'connect';
 import * as del from 'del';
 import * as fs from 'fs';
 import { google } from 'googleapis';
-import * as http from 'http';
 import * as mkdirp from 'mkdirp';
-import { OAuth2Client } from 'google-auth-library';
 const open = require('open');
 const path = require('path');
 import * as pluralize from 'pluralize';
 const commander = require('commander');
 const readMultipleFiles = require('read-multiple-files');
 import * as recursive from 'recursive-readdir';
-import * as url from 'url';
-const readline = require('readline');
 const logging = require('@google-cloud/logging');
 const chalk = require('chalk');
 const { prompt } = require('inquirer');
 import { DOT, PROJECT_NAME, PROJECT_MANIFEST_BASENAME, ClaspSettings,
     ProjectSettings, DOTFILE, spinner, logError, ERROR, getScriptURL,
     getProjectSettings, getFileType, getAPIFileType, checkIfOnline,
     saveProjectId, manifestExists } from './src/utils.js';
+import { oauth2Client, getAPICredentials,
+    authorizeWithLocalhost, authorizeWithoutLocalhost } from './src/auth.js';
 
 // An Apps Script API File
 interface AppsScriptFile {
@@ -59,21 +57,13 @@ interface FilesCallback {
   ) : void;
 }
 
-// API settings
-// @see https://developers.google.com/oauthplayground/
-const REDIRECT_URI_OOB = 'urn:ietf:wg:oauth:2.0:oob';
-const oauth2Client = new OAuth2Client({
-  clientId: '1072944905499-vm2v2i5dvn0a0d2o4ca36i1vge8cvbn0.apps.googleusercontent.com',
-  clientSecret: 'v6V3fKV_zWU7iw1DrpO1rknX',
-  redirectUri: 'http://localhost',
-});
 const script = google.script({
   version: 'v1',
   auth: oauth2Client,
 });
 
 // Log messages (some logs take required params)
-const LOG = {
+export const LOG = {
   AUTH_CODE: 'Enter the code from that page here: ',
   AUTH_PAGE_SUCCESSFUL: `Logged in! You may close this page.`, // HTML Redirect Page
   AUTH_SUCCESSFUL: `Saved the credentials to ${DOT.RC.PATH}. You may close the page.`,
@@ -109,24 +99,6 @@ const LOG = {
   VERSION_NUM: (numVersions: number) => `~ ${numVersions} ${pluralize('Version', numVersions)} ~`,
 };
 
-/**
- * Loads the Apps Script API credentials for the CLI.
- * Required before every API call.
- * @param {Function} cb The callback
- * @param {boolean} isLocal If we should load local API credentials for this clasp project.
- */
-function getAPICredentials(cb: (rc: ClaspSettings | void) => void, isLocal?: boolean) {
-  const dotfile = isLocal ? DOTFILE.RC_LOCAL : DOTFILE.RC;
-  dotfile.read().then((rc: ClaspSettings) => {
-    oauth2Client.setCredentials(rc);
-    cb(rc);
-  }).catch((err: object) => {
-    console.error('Could not read API credentials. Error:');
-    console.error(err);
-    process.exit(-1);
-  });
-}
-
 /**
  * Requests authorization to manage Apps Script projects.
  * @param {boolean} useLocalhost True if a local HTTP server should be run
@@ -160,67 +132,6 @@ function authorize(useLocalhost: boolean, writeToOwnKey: boolean) {
     .catch((err: string) => console.error(ERROR.ACCESS_TOKEN + err));
 }
 
-/**
- * Requests authorization to manage Apps Scrpit projects. Spins up
- * a temporary HTTP server to handle the auth redirect.
- *
- * @param {Object} opts OAuth2 options TODO formalize options
- * @return {Promise} Promise resolving with the authorization code
- */
-function authorizeWithLocalhost(opts: any): Promise<string> {
-  return new Promise((res: Function, rej: Function) => {
-    const server = http.createServer((req: http.ServerRequest, resp: http.ServerResponse) => {
-      const urlParts = url.parse(req.url || '', true);
-      if (urlParts.query.code) {
-        res(urlParts.query.code);
-      } else {
-        rej(urlParts.query.error);
-      }
-      resp.end(LOG.AUTH_PAGE_SUCCESSFUL);
-      setTimeout(() => { // TODO Remove hack to shutdown server.
-        process.exit();
-      }, 1000);
-    });
-
-    server.listen(0, () => {
-      oauth2Client.redirectUri = `http://localhost:${server.address().port}`;
-      const authUrl = oauth2Client.generateAuthUrl(opts);
-      console.log(LOG.AUTHORIZE(authUrl));
-      open(authUrl);
-    });
-  });
-}
-
-/**
- * Requests authorization to manage Apps Scrpit projects. Requires the
- * user to manually copy/paste the authorization code. No HTTP server is
- * used.
- *
- * @param {Object} opts OAuth2 options
- * @return {Promise} Promise resolving with the authorization code
- */
-
-function authorizeWithoutLocalhost(opts: any): Promise<string> {
-  oauth2Client.redirectUri = REDIRECT_URI_OOB;
-  const authUrl = oauth2Client.generateAuthUrl(opts);
-  console.log(LOG.AUTHORIZE(authUrl));
-
-  return new Promise((res, rej) => {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-    rl.question(LOG.AUTH_CODE, (code: string) => {
-      if (code && code.length) {
-        res(code);
-      } else {
-        rej("No authorization code entered.");
-      }
-      rl.close();
-    });
-  });
-}
-
 /**
  * Recursively finds all files that are part of the current project, and those that are ignored
  * by .claspignore and calls the passed callback function with the file lists.

diff --git a/src/auth.ts b/src/auth.ts
@@ -0,0 +1,95 @@
+import { OAuth2Client } from 'google-auth-library';
+import { ClaspSettings, DOTFILE } from './utils.js';
+import * as http from 'http';
+import * as url from 'url';
+const open = require('open');
+const readline = require('readline');
+//Just for now, until it moves into /src/commands.ts
+import { LOG } from '../index.js';
+
+// API settings
+// @see https://developers.google.com/oauthplayground/
+export const REDIRECT_URI_OOB = 'urn:ietf:wg:oauth:2.0:oob';
+export const oauth2Client = new OAuth2Client({
+  clientId: '1072944905499-vm2v2i5dvn0a0d2o4ca36i1vge8cvbn0.apps.googleusercontent.com',
+  clientSecret: 'v6V3fKV_zWU7iw1DrpO1rknX',
+  redirectUri: 'http://localhost',
+});
+
+/**
+ * Loads the Apps Script API credentials for the CLI.
+ * Required before every API call.
+ * @param {Function} cb The callback
+ * @param {boolean} isLocal If we should load local API credentials for this clasp project.
+ */
+export function getAPICredentials(cb: (rc: ClaspSettings | void) => void, isLocal?: boolean) {
+    const dotfile = isLocal ? DOTFILE.RC_LOCAL : DOTFILE.RC;
+    dotfile.read().then((rc: ClaspSettings) => {
+      oauth2Client.setCredentials(rc);
+      cb(rc);
+    }).catch((err: object) => {
+      console.error('Could not read API credentials. Error:');
+      console.error(err);
+      process.exit(-1);
+    });
+  }
+
+/**
+ * Requests authorization to manage Apps Scrpit projects. Spins up
+ * a temporary HTTP server to handle the auth redirect.
+ *
+ * @param {Object} opts OAuth2 options TODO formalize options
+ * @return {Promise} Promise resolving with the authorization code
+ */
+export function authorizeWithLocalhost(opts: any): Promise<string> {
+    return new Promise((res: Function, rej: Function) => {
+      const server = http.createServer((req: http.ServerRequest, resp: http.ServerResponse) => {
+        const urlParts = url.parse(req.url || '', true);
+        if (urlParts.query.code) {
+          res(urlParts.query.code);
+        } else {
+          rej(urlParts.query.error);
+        }
+        resp.end(LOG.AUTH_PAGE_SUCCESSFUL);
+        setTimeout(() => { // TODO Remove hack to shutdown server.
+          process.exit();
+        }, 1000);
+      });
+
+      server.listen(0, () => {
+        oauth2Client.redirectUri = `http://localhost:${server.address().port}`;
+        const authUrl = oauth2Client.generateAuthUrl(opts);
+        console.log(LOG.AUTHORIZE(authUrl));
+        open(authUrl);
+      });
+    });
+  }
+
+/**
+ * Requests authorization to manage Apps Script projects. Requires the
+ * user to manually copy/paste the authorization code. No HTTP server is
+ * used.
+ *
+ * @param {Object} opts OAuth2 options
+ * @return {Promise} Promise resolving with the authorization code
+ */
+export function authorizeWithoutLocalhost(opts: any): Promise<string> {
+    oauth2Client.redirectUri = REDIRECT_URI_OOB;
+    const authUrl = oauth2Client.generateAuthUrl(opts);
+    console.log(LOG.AUTHORIZE(authUrl));
+
+    return new Promise((res, rej) => {
+      const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+      });
+      rl.question(LOG.AUTH_CODE, (code: string) => {
+        if (code && code.length) {
+          res(code);
+        } else {
+          rej("No authorization code entered.");
+        }
+        rl.close();
+      });
+    });
+  }