Added OAuth2 support

This commit is contained in:
ricardo 2020-05-30 15:09:04 -04:00
parent f1f09d4a03
commit bf02ae4f57
17 changed files with 305 additions and 156 deletions

View file

@ -0,0 +1,25 @@
import {
ICredentialType,
NodePropertyTypes,
} from 'n8n-workflow';
const scopes = [
'https://www.googleapis.com/auth/calendar',
'https://www.googleapis.com/auth/calendar.events',
];
export class GoogleOAuth2Api implements ICredentialType {
name = 'googleOAuth2Api';
extends = [
'oAuth2Api',
];
displayName = 'Google OAuth2 API';
properties = [
{
displayName: 'Scope',
name: 'scope',
type: 'hidden' as NodePropertyTypes,
default: scopes.join(' '),
},
];
}

View file

@ -3,11 +3,6 @@ import {
NodePropertyTypes, NodePropertyTypes,
} from 'n8n-workflow'; } from 'n8n-workflow';
const scopes = [
'https://www.googleapis.com/auth/calendar',
'https://www.googleapis.com/auth/calendar.events',
];
export class GoogleOAuth2Api implements ICredentialType { export class GoogleOAuth2Api implements ICredentialType {
name = 'googleOAuth2Api'; name = 'googleOAuth2Api';
extends = [ extends = [
@ -27,12 +22,6 @@ export class GoogleOAuth2Api implements ICredentialType {
type: 'hidden' as NodePropertyTypes, type: 'hidden' as NodePropertyTypes,
default: 'https://oauth2.googleapis.com/token', default: 'https://oauth2.googleapis.com/token',
}, },
{
displayName: 'Scope',
name: 'scope',
type: 'hidden' as NodePropertyTypes,
default: scopes.join(' '),
},
{ {
displayName: 'Auth URI Query Parameters', displayName: 'Auth URI Query Parameters',
name: 'authQueryParameters', name: 'authQueryParameters',

View file

@ -0,0 +1,26 @@
import {
ICredentialType,
NodePropertyTypes,
} from 'n8n-workflow';
const scopes = [
'https://www.googleapis.com/auth/drive',
'https://www.googleapis.com/auth/drive.file',
'https://www.googleapis.com/auth/spreadsheets',
];
export class GoogleSheetsOAuth2Api implements ICredentialType {
name = 'googleSheetsOAuth2Api';
extends = [
'googleOAuth2Api',
];
displayName = 'Google OAuth2 API';
properties = [
{
displayName: 'Scope',
name: 'scope',
type: 'hidden' as NodePropertyTypes,
default: scopes.join(' '),
},
];
}

View file

@ -50,7 +50,7 @@ export async function githubApiRequest(this: IHookFunctions | IExecuteFunctions,
const baseUrl = credentials!.server || 'https://api.github.com'; const baseUrl = credentials!.server || 'https://api.github.com';
options.uri = `${baseUrl}${endpoint}`; options.uri = `${baseUrl}${endpoint}`;
//@ts-ignore
return await this.helpers.requestOAuth.call(this, 'githubOAuth2Api', options); return await this.helpers.requestOAuth.call(this, 'githubOAuth2Api', options);
} }
} catch (error) { } catch (error) {

View file

@ -1,11 +1,15 @@
import { OptionsWithUri } from 'request'; import {
OptionsWithUri,
} from 'request';
import { import {
IExecuteFunctions, IExecuteFunctions,
IExecuteSingleFunctions, IExecuteSingleFunctions,
ILoadOptionsFunctions, ILoadOptionsFunctions,
} from 'n8n-core'; } from 'n8n-core';
import { import {
IDataObject IDataObject,
} from 'n8n-workflow'; } from 'n8n-workflow';
export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, headers: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, headers: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
@ -27,7 +31,7 @@ export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleF
delete options.body; delete options.body;
} }
//@ts-ignore //@ts-ignore
return await this.helpers.requestOAuth.call(this, 'googleOAuth2Api', options); return await this.helpers.requestOAuth.call(this, 'googleCalendarOAuth2Api', options);
} catch (error) { } catch (error) {
if (error.response && error.response.body && error.response.body.message) { if (error.response && error.response.body && error.response.body.message) {
// Try to return the error prettier // Try to return the error prettier

View file

@ -44,7 +44,7 @@ export class GoogleCalendar implements INodeType {
outputs: ['main'], outputs: ['main'],
credentials: [ credentials: [
{ {
name: 'googleOAuth2Api', name: 'googleCalendarOAuth2Api',
required: true, required: true,
}, },
], ],

View file

Before

Width:  |  Height:  |  Size: 1.8 KiB

After

Width:  |  Height:  |  Size: 1.8 KiB

View file

@ -12,7 +12,7 @@ import {
INodeType, INodeType,
} from 'n8n-workflow'; } from 'n8n-workflow';
import { getAuthenticationClient } from './GoogleApi'; import { getAuthenticationClient } from '../GoogleApi';
export class GoogleDrive implements INodeType { export class GoogleDrive implements INodeType {

View file

Before

Width:  |  Height:  |  Size: 2 KiB

After

Width:  |  Height:  |  Size: 2 KiB

View file

@ -0,0 +1,129 @@
import {
OptionsWithUri,
} from 'request';
import {
IExecuteFunctions,
IExecuteSingleFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import {
IDataObject,
} from 'n8n-workflow';
import * as moment from 'moment-timezone';
import * as jwt from 'jsonwebtoken';
export async function googleApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, headers: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const authenticationMethod = this.getNodeParameter('authentication', 0, 'serviceAccount') as string;
const options: OptionsWithUri = {
headers: {
'Content-Type': 'application/json',
},
method,
body,
qs,
uri: uri || `https://sheets.googleapis.com${resource}`,
json: true
};
try {
if (Object.keys(headers).length !== 0) {
options.headers = Object.assign({}, options.headers, headers);
}
if (Object.keys(body).length === 0) {
delete options.body;
}
if (authenticationMethod === 'serviceAccount') {
const credentials = this.getCredentials('googleApi');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
const { access_token } = await getAccessToken.call(this, credentials as IDataObject);
options.headers!.Authorization = `Bearer ${access_token}`;
//@ts-ignore
return await this.helpers.request(options);
} else {
//@ts-ignore
return await this.helpers.requestOAuth.call(this, 'googleSheetsOAuth2Api', options);
}
} catch (error) {
if (error.response && error.response.body && error.response.body.message) {
// Try to return the error prettier
throw new Error(`Google Sheet error response [${error.statusCode}]: ${error.response.body.message}`);
}
throw error;
}
}
export async function googleApiRequestAllItems(this: IExecuteFunctions | ILoadOptionsFunctions, propertyName: string ,method: string, endpoint: string, body: any = {}, query: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const returnData: IDataObject[] = [];
let responseData;
query.maxResults = 100;
do {
responseData = await googleApiRequest.call(this, method, endpoint, body, query);
query.pageToken = responseData['nextPageToken'];
returnData.push.apply(returnData, responseData[propertyName]);
} while (
responseData['nextPageToken'] !== undefined &&
responseData['nextPageToken'] !== ''
);
return returnData;
}
function getAccessToken(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, credentials: IDataObject) : Promise<IDataObject> {
//https://developers.google.com/identity/protocols/oauth2/service-account#httprest
const scopes = [
'https://www.googleapis.com/auth/drive',
'https://www.googleapis.com/auth/drive.file',
'https://www.googleapis.com/auth/spreadsheets',
];
const now = moment().unix();
const signature = jwt.sign(
{
'iss': credentials.email as string,
'sub': credentials.email as string,
'scope': scopes.join(' '),
'aud': `https://oauth2.googleapis.com/token`,
'iat': now,
'exp': now + 3600,
},
credentials.privateKey as string,
{
algorithm: 'RS256',
header: {
'kid': credentials.privateKey as string,
'typ': 'JWT',
'alg': 'RS256',
},
}
);
const options: OptionsWithUri = {
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
method: 'POST',
form: {
grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
assertion: signature,
},
uri: 'https://oauth2.googleapis.com/token',
json: true
};
//@ts-ignore
return this.helpers.request(options);
}

View file

@ -1,14 +1,20 @@
import { IDataObject } from 'n8n-workflow'; import {
import { google, sheets_v4 } from 'googleapis'; IDataObject,
import { JWT } from 'google-auth-library'; } from 'n8n-workflow';
import { getAuthenticationClient } from './GoogleApi';
import {
IExecuteFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import {
googleApiRequest,
} from './GenericFunctions';
import { import {
utils as xlsxUtils, utils as xlsxUtils,
} from 'xlsx'; } from 'xlsx';
const Sheets = google.sheets('v4'); // tslint:disable-line:variable-name
export interface ISheetOptions { export interface ISheetOptions {
scope: string[]; scope: string[];
} }
@ -46,18 +52,16 @@ export type ValueRenderOption = 'FORMATTED_VALUE' | 'FORMULA' | 'UNFORMATTED_VAL
export class GoogleSheet { export class GoogleSheet {
id: string; id: string;
credentials: IGoogleAuthCredentials; executeFunctions: IExecuteFunctions | ILoadOptionsFunctions;
scopes: string[];
constructor(spreadsheetId: string, credentials: IGoogleAuthCredentials, options?: ISheetOptions | undefined) { constructor(spreadsheetId: string, executeFunctions: IExecuteFunctions | ILoadOptionsFunctions, options?: ISheetOptions | undefined) {
// options = <SheetOptions>options || {}; // options = <SheetOptions>options || {};
if (!options) { if (!options) {
options = {} as ISheetOptions; options = {} as ISheetOptions;
} }
this.executeFunctions = executeFunctions;
this.id = spreadsheetId; this.id = spreadsheetId;
this.credentials = credentials;
this.scopes = options.scope || ['https://www.googleapis.com/auth/spreadsheets'];
} }
@ -69,37 +73,29 @@ export class GoogleSheet {
* @memberof GoogleSheet * @memberof GoogleSheet
*/ */
async clearData(range: string): Promise<object> { async clearData(range: string): Promise<object> {
const client = await this.getAuthenticationClient();
// @ts-ignore const body = {
const response = await Sheets.spreadsheets.values.clear( spreadsheetId: this.id,
{ range,
auth: client, };
spreadsheetId: this.id,
range,
}
);
return response.data; const response = await googleApiRequest.call(this.executeFunctions, 'POST', `/v4/spreadsheets/${this.id}/values/${range}:clear`, body);
return response;
} }
/** /**
* Returns the cell values * Returns the cell values
*/ */
async getData(range: string, valueRenderMode: ValueRenderOption): Promise<string[][] | undefined> { async getData(range: string, valueRenderMode: ValueRenderOption): Promise<string[][] | undefined> {
const client = await this.getAuthenticationClient();
// @ts-ignore const query = {
const response = await Sheets.spreadsheets.values.get( valueRenderOption: valueRenderMode,
{ };
auth: client,
spreadsheetId: this.id,
range,
valueRenderOption: valueRenderMode,
}
);
return response.data.values as string[][] | undefined; const response = await googleApiRequest.call(this.executeFunctions, 'GET', `/v4/spreadsheets/${this.id}/values/${range}`, {}, query);
return response.values as string[][] | undefined;
} }
@ -107,39 +103,29 @@ export class GoogleSheet {
* Returns the sheets in a Spreadsheet * Returns the sheets in a Spreadsheet
*/ */
async spreadsheetGetSheets() { async spreadsheetGetSheets() {
const client = await this.getAuthenticationClient();
// @ts-ignore const query = {
const response = await Sheets.spreadsheets.get( fields: 'sheets.properties',
{ };
auth: client,
spreadsheetId: this.id,
fields: 'sheets.properties'
}
);
return response.data; const response = await googleApiRequest.call(this.executeFunctions, 'GET', `/v4/spreadsheets/${this.id}`, {}, query);
return response;
} }
/** /**
* Sets values in one or more ranges of a spreadsheet. * Sets values in one or more ranges of a spreadsheet.
*/ */
async spreadsheetBatchUpdate(requests: sheets_v4.Schema$Request[]) { // tslint:disable-line:no-any async spreadsheetBatchUpdate(requests: IDataObject[]) { // tslint:disable-line:no-any
const client = await this.getAuthenticationClient();
// @ts-ignore const body = {
const response = await Sheets.spreadsheets.batchUpdate( requests
{ };
auth: client,
spreadsheetId: this.id,
requestBody: {
requests,
},
}
);
return response.data; const response = await googleApiRequest.call(this.executeFunctions, 'POST', `/v4/spreadsheets/${this.id}:batchUpdate`, body);
return response;
} }
@ -147,21 +133,15 @@ export class GoogleSheet {
* Sets the cell values * Sets the cell values
*/ */
async batchUpdate(updateData: ISheetUpdateData[], valueInputMode: ValueInputOption) { async batchUpdate(updateData: ISheetUpdateData[], valueInputMode: ValueInputOption) {
const client = await this.getAuthenticationClient();
// @ts-ignore const body = {
const response = await Sheets.spreadsheets.values.batchUpdate( data: updateData,
{ valueInputOption: valueInputMode,
auth: client, };
spreadsheetId: this.id,
valueInputOption: valueInputMode,
resource: {
data: updateData,
},
}
);
return response.data; const response = await googleApiRequest.call(this.executeFunctions, 'POST', `/v4/spreadsheets/${this.id}/values:batchUpdate`, body);
return response;
} }
@ -169,23 +149,15 @@ export class GoogleSheet {
* Sets the cell values * Sets the cell values
*/ */
async setData(range: string, data: string[][], valueInputMode: ValueInputOption) { async setData(range: string, data: string[][], valueInputMode: ValueInputOption) {
const client = await this.getAuthenticationClient();
// @ts-ignore const body = {
const response = await Sheets.spreadsheets.values.update( valueInputOption: valueInputMode,
{ values: data,
// @ts-ignore };
auth: client,
spreadsheetId: this.id,
range,
valueInputOption: valueInputMode,
resource: {
values: data
}
}
);
return response.data; const response = await googleApiRequest.call(this.executeFunctions, 'POST', `/v4/spreadsheets/${this.id}/values/${range}`, body);
return response;
} }
@ -193,33 +165,21 @@ export class GoogleSheet {
* Appends the cell values * Appends the cell values
*/ */
async appendData(range: string, data: string[][], valueInputMode: ValueInputOption) { async appendData(range: string, data: string[][], valueInputMode: ValueInputOption) {
const client = await this.getAuthenticationClient();
// @ts-ignore const body = {
const response = await Sheets.spreadsheets.values.append( range,
{ values: data,
auth: client, };
spreadsheetId: this.id,
range,
valueInputOption: valueInputMode,
resource: {
values: data
}
}
);
return response.data; const query = {
valueInputOption: valueInputMode,
};
const response = await googleApiRequest.call(this.executeFunctions, 'POST', `/v4/spreadsheets/${this.id}/values/${range}:append`, body, query);
return response;
} }
/**
* Returns the authentication client needed to access spreadsheet
*/
async getAuthenticationClient(): Promise<JWT> {
return getAuthenticationClient(this.credentials.email, this.credentials.privateKey, this.scopes);
}
/** /**
* Returns the given sheet data in a strucutred way * Returns the given sheet data in a strucutred way
*/ */
@ -505,5 +465,4 @@ export class GoogleSheet {
return setData; return setData;
} }
} }

View file

@ -1,6 +1,8 @@
import { sheets_v4 } from 'googleapis';
import { IExecuteFunctions } from 'n8n-core'; import {
IExecuteFunctions,
} from 'n8n-core';
import { import {
IDataObject, IDataObject,
ILoadOptionsFunctions, ILoadOptionsFunctions,
@ -12,7 +14,6 @@ import {
import { import {
GoogleSheet, GoogleSheet,
IGoogleAuthCredentials,
ILookupValues, ILookupValues,
ISheetUpdateData, ISheetUpdateData,
IToDelete, IToDelete,
@ -30,7 +31,7 @@ export class GoogleSheets implements INodeType {
description: 'Read, update and write data to Google Sheets', description: 'Read, update and write data to Google Sheets',
defaults: { defaults: {
name: 'Google Sheets', name: 'Google Sheets',
color: '#995533', color: '#0aa55c',
}, },
inputs: ['main'], inputs: ['main'],
outputs: ['main'], outputs: ['main'],
@ -38,9 +39,43 @@ export class GoogleSheets implements INodeType {
{ {
name: 'googleApi', name: 'googleApi',
required: true, required: true,
} displayOptions: {
show: {
authentication: [
'serviceAccount',
],
},
},
},
{
name: 'googleSheetsOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: [
'oauth2',
],
},
},
},
], ],
properties: [ properties: [
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
name: 'Service Account',
value: 'serviceAccount',
},
{
name: 'OAuth2',
value: 'oauth2',
},
],
default: 'serviceAccount',
},
{ {
displayName: 'Operation', displayName: 'Operation',
name: 'operation', name: 'operation',
@ -541,18 +576,7 @@ export class GoogleSheets implements INodeType {
async getSheets(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> { async getSheets(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const spreadsheetId = this.getCurrentNodeParameter('sheetId') as string; const spreadsheetId = this.getCurrentNodeParameter('sheetId') as string;
const credentials = this.getCredentials('googleApi'); const sheet = new GoogleSheet(spreadsheetId, this);
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
const googleCredentials = {
email: credentials.email,
privateKey: credentials.privateKey,
} as IGoogleAuthCredentials;
const sheet = new GoogleSheet(spreadsheetId, googleCredentials);
const responseData = await sheet.spreadsheetGetSheets(); const responseData = await sheet.spreadsheetGetSheets();
if (responseData === undefined) { if (responseData === undefined) {
@ -579,18 +603,8 @@ export class GoogleSheets implements INodeType {
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> { async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const spreadsheetId = this.getNodeParameter('sheetId', 0) as string; const spreadsheetId = this.getNodeParameter('sheetId', 0) as string;
const credentials = this.getCredentials('googleApi');
if (credentials === undefined) { const sheet = new GoogleSheet(spreadsheetId, this);
throw new Error('No credentials got returned!');
}
const googleCredentials = {
email: credentials.email,
privateKey: credentials.privateKey,
} as IGoogleAuthCredentials;
const sheet = new GoogleSheet(spreadsheetId, googleCredentials);
const operation = this.getNodeParameter('operation', 0) as string; const operation = this.getNodeParameter('operation', 0) as string;
@ -638,7 +652,7 @@ export class GoogleSheets implements INodeType {
// delete // delete
// ---------------------------------- // ----------------------------------
const requests: sheets_v4.Schema$Request[] = []; const requests: IDataObject[] = [];
const toDelete = this.getNodeParameter('toDelete', 0) as IToDelete; const toDelete = this.getNodeParameter('toDelete', 0) as IToDelete;

View file

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View file

@ -57,7 +57,9 @@
"dist/credentials/GithubOAuth2Api.credentials.js", "dist/credentials/GithubOAuth2Api.credentials.js",
"dist/credentials/GitlabApi.credentials.js", "dist/credentials/GitlabApi.credentials.js",
"dist/credentials/GoogleApi.credentials.js", "dist/credentials/GoogleApi.credentials.js",
"dist/credentials/GoogleCalendarOAuth2Api.credentials.js",
"dist/credentials/GoogleOAuth2Api.credentials.js", "dist/credentials/GoogleOAuth2Api.credentials.js",
"dist/credentials/GoogleSheetsOAuth2Api.credentials.js",
"dist/credentials/GumroadApi.credentials.js", "dist/credentials/GumroadApi.credentials.js",
"dist/credentials/HarvestApi.credentials.js", "dist/credentials/HarvestApi.credentials.js",
"dist/credentials/HelpScoutOAuth2Api.credentials.js", "dist/credentials/HelpScoutOAuth2Api.credentials.js",
@ -180,9 +182,9 @@
"dist/nodes/Github/GithubTrigger.node.js", "dist/nodes/Github/GithubTrigger.node.js",
"dist/nodes/Gitlab/Gitlab.node.js", "dist/nodes/Gitlab/Gitlab.node.js",
"dist/nodes/Gitlab/GitlabTrigger.node.js", "dist/nodes/Gitlab/GitlabTrigger.node.js",
"dist/nodes/Google/GoogleCalendar.node.js", "dist/nodes/Google/Calendar/GoogleCalendar.node.js",
"dist/nodes/Google/GoogleDrive.node.js", "dist/nodes/Google/Drive/GoogleDrive.node.js",
"dist/nodes/Google/GoogleSheets.node.js", "dist/nodes/Google/Sheet/GoogleSheets.node.js",
"dist/nodes/GraphQL/GraphQL.node.js", "dist/nodes/GraphQL/GraphQL.node.js",
"dist/nodes/Gumroad/GumroadTrigger.node.js", "dist/nodes/Gumroad/GumroadTrigger.node.js",
"dist/nodes/Harvest/Harvest.node.js", "dist/nodes/Harvest/Harvest.node.js",
@ -316,6 +318,7 @@
"gm": "^1.23.1", "gm": "^1.23.1",
"googleapis": "~50.0.0", "googleapis": "~50.0.0",
"imap-simple": "^4.3.0", "imap-simple": "^4.3.0",
"jsonwebtoken": "^8.5.1",
"lodash.get": "^4.4.2", "lodash.get": "^4.4.2",
"lodash.set": "^4.3.2", "lodash.set": "^4.3.2",
"lodash.unset": "^4.5.2", "lodash.unset": "^4.5.2",