From f08d8c9375224929cdbffae26badc8d94c3c665a Mon Sep 17 00:00:00 2001 From: Tanay Pant Date: Mon, 19 Oct 2020 19:57:50 +0200 Subject: [PATCH] :sparkles: Add Google Books node --- .../GoogleBooksOAuth2Api.credentials.ts | 25 ++ .../nodes/Google/Books/GenericFunctions.ts | 127 ++++++ .../nodes/Google/Books/GoogleBooks.node.ts | 404 ++++++++++++++++++ .../nodes/Google/Books/googlebooks.svg | 37 ++ packages/nodes-base/package.json | 2 + 5 files changed, 595 insertions(+) create mode 100644 packages/nodes-base/credentials/GoogleBooksOAuth2Api.credentials.ts create mode 100644 packages/nodes-base/nodes/Google/Books/GenericFunctions.ts create mode 100644 packages/nodes-base/nodes/Google/Books/GoogleBooks.node.ts create mode 100644 packages/nodes-base/nodes/Google/Books/googlebooks.svg diff --git a/packages/nodes-base/credentials/GoogleBooksOAuth2Api.credentials.ts b/packages/nodes-base/credentials/GoogleBooksOAuth2Api.credentials.ts new file mode 100644 index 0000000000..d7453334b7 --- /dev/null +++ b/packages/nodes-base/credentials/GoogleBooksOAuth2Api.credentials.ts @@ -0,0 +1,25 @@ +import { + ICredentialType, + NodePropertyTypes, +} from 'n8n-workflow'; + +const scopes = [ + 'https://www.googleapis.com/auth/books', +]; + +export class GoogleBooksOAuth2Api implements ICredentialType { + name = 'googleBooksOAuth2Api'; + extends = [ + 'googleOAuth2Api', + ]; + displayName = 'Google Books OAuth2 API'; + documentationUrl = 'google'; + properties = [ + { + displayName: 'Scope', + name: 'scope', + type: 'hidden' as NodePropertyTypes, + default: scopes.join(' '), + }, + ]; +} diff --git a/packages/nodes-base/nodes/Google/Books/GenericFunctions.ts b/packages/nodes-base/nodes/Google/Books/GenericFunctions.ts new file mode 100644 index 0000000000..9961eb995f --- /dev/null +++ b/packages/nodes-base/nodes/Google/Books/GenericFunctions.ts @@ -0,0 +1,127 @@ +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 { // 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://www.googleapis.com/books/${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.requestOAuth2.call(this, 'googleBooksOAuth2Api', options); + } + } catch (error) { + if (error.response && error.response.body && error.response.body.message) { + // Try to return the error prettier + throw new Error(`Google Books 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 { // 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 { + //https://developers.google.com/identity/protocols/oauth2/service-account#httprest + + const scopes = [ + 'https://www.googleapis.com/auth/books', + ]; + + 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); +} diff --git a/packages/nodes-base/nodes/Google/Books/GoogleBooks.node.ts b/packages/nodes-base/nodes/Google/Books/GoogleBooks.node.ts new file mode 100644 index 0000000000..a534f91b2b --- /dev/null +++ b/packages/nodes-base/nodes/Google/Books/GoogleBooks.node.ts @@ -0,0 +1,404 @@ + +import { + IExecuteFunctions, +} from 'n8n-core'; + +import { + INodeExecutionData, + INodeType, + INodeTypeDescription, +} from 'n8n-workflow'; + +import { + googleApiRequest, +} from './GenericFunctions'; + +export interface IGoogleAuthCredentials { + email: string; + privateKey: string; +} + +export class GoogleBooks implements INodeType { + description: INodeTypeDescription = { + displayName: 'Google Books', + name: 'googleBooks', + icon: 'file:googlebooks.svg', + group: ['input', 'output'], + version: 1, + description: 'Read data from Google Books', + defaults: { + name: 'Google Books', + color: '#0aa55c', + }, + inputs: ['main'], + outputs: ['main'], + credentials: [ + { + name: 'googleApi', + required: true, + displayOptions: { + show: { + authentication: [ + 'serviceAccount', + ], + }, + }, + }, + { + name: 'googleBooksOAuth2Api', + required: true, + displayOptions: { + show: { + authentication: [ + 'oAuth2', + ], + }, + }, + }, + ], + properties: [ + { + displayName: 'Authentication', + name: 'authentication', + type: 'options', + options: [ + { + name: 'Service Account', + value: 'serviceAccount', + }, + { + name: 'OAuth2', + value: 'oAuth2', + }, + ], + default: 'serviceAccount', + }, + { + displayName: 'Resource', + name: 'resource', + type: 'options', + options: [ + { + name: 'Bookshelf', + value: 'bookshelf', + description: 'This resource allows you to view bookshelf metadata as well as to modify the contents of a bookshelf', + }, + { + name: 'My Library', + value: 'library', + description: 'This resource allows you to view and modify the contents of an authenticated users own bookshelf', + }, + { + name: 'Volume', + value: 'volume', + description: 'This resource is used to perform a search or listing the contents of a bookshelf and to retrieve volumes from another users public bookshelves', + }, + ], + default: 'bookshelf', + description: 'The resource to operate on', + }, + { + displayName: 'Operation', + name: 'operation', + type: 'options', + options: [ + { + name: 'Get', + value: 'getShelf', + description: 'Retrieve a specific bookshelf resource for the specified user', + }, + { + name: 'List', + value: 'listShelves', + description: 'Retrieve a list of public bookshelf resource for the specified user', + }, + { + name: 'Get volumes', + value: 'getVolumes', + description: 'Retrieve volumes in a specific bookshelf for the specified user', + }, + ], + displayOptions: { + show: { + resource: [ + 'bookshelf', + ], + }, + }, + default: 'getShelf', + description: 'The operation to perform', + }, + { + displayName: 'Operation', + name: 'operation', + type: 'options', + options: [ + { + name: 'Add Volume', + value: 'addVolume', + description: 'Adds a volume to a bookshelf', + }, + { + name: 'Clear Volumes', + value: 'clearVolumes', + description: 'Clear all volumes from a bookshelf', + }, + { + name: 'Get', + value: 'getMyShelf', + description: 'Retrieve metadata for a specific bookshelf belonging to the authenticated user', + }, + { + name: 'List', + value: 'listMyShelves', + description: 'Retrieve a list of bookshelves belonging to the authenticated user', + }, + { + name: 'Move Volume', + value: 'moveVolume', + description: 'Move a volume within a bookshelf', + }, + { + name: 'Remove Volume', + value: 'removeVolume', + description: 'Remove a volume from a bookshelf', + }, + { + name: 'List Volumes', + value: 'listVolumes', + description: 'Get volume information for volumes on a bookshelf', + }, + ], + displayOptions: { + show: { + resource: [ + 'library', + ], + }, + }, + default: 'addVolume', + description: 'The operation to perform', + }, + { + displayName: 'Operation', + name: 'operation', + type: 'options', + options: [ + { + name: 'Get', + value: 'getVolume', + description: 'Retrieve a Volume resource based on ID', + }, + { + name: 'List', + value: 'bookSearch', + description: 'Perform a book search', + }, + ], + displayOptions: { + show: { + resource: [ + 'volume', + ], + }, + }, + default: 'getVolume', + description: 'The operation to perform', + }, + + // ---------------------------------- + // All + // ---------------------------------- + { + displayName: 'Search Query', + name: 'searchQuery', + type: 'string', + description: 'Full-text search query string', + default: '', + required: true, + displayOptions: { + show: { + operation: [ + 'bookSearch', + ], + resource: [ + 'volume', + ], + }, + }, + }, + { + displayName: 'User ID', + name: 'userId', + type: 'string', + description: 'ID of user', + default: '', + required: true, + displayOptions: { + show: { + operation: [ + 'getShelf', + 'listShelves', + 'getVolumes', + ], + resource: [ + 'bookshelf', + ], + }, + }, + }, + { + displayName: 'Bookshelf ID', + name: 'shelfId', + type: 'string', + description: 'ID of the bookshelf', + default: '', + required: true, + displayOptions: { + show: { + operation: [ + 'getShelf', + 'getVolumes', + 'addVolume', + 'clearVolumes', + 'getMyShelf', + 'moveVolume', + 'removeVolume', + 'listVolumes', + ], + resource: [ + 'bookshelf', + 'library', + ], + }, + }, + }, + { + displayName: 'Volume ID', + name: 'volumeId', + type: 'string', + description: 'ID of the volume', + default: '', + required: true, + displayOptions: { + show: { + operation: [ + 'getVolume', + 'addVolume', + 'moveVolume', + 'removeVolume', + ], + resource: [ + 'bookshelf', + 'library', + 'volume', + ], + }, + }, + }, + { + displayName: 'Volume Position', + name: 'volumePosition', + type: 'string', + description: 'Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on) ', + default: '', + required: true, + displayOptions: { + show: { + operation: [ + 'moveVolume', + ], + resource: [ + 'library', + ], + }, + }, + }, + ], + }; + + + async execute(this: IExecuteFunctions): Promise { + const items = this.getInputData(); + const length = items.length as unknown as number; + + const resource = this.getNodeParameter('resource', 0) as string; + const operation = this.getNodeParameter('operation', 0) as string; + const responseData = []; + + for (let i=0; i < length; i++) { + if (resource === 'volume') { + if (operation === 'getVolume') { + const volumeId = this.getNodeParameter('volumeId', i) as string; + + const response = await googleApiRequest.call(this, 'GET', `v1/volumes/${volumeId}`, {}); + responseData.push(response); + } else if (operation === 'bookSearch') { + const searchQuery = this.getNodeParameter('searchQuery', i) as string; + + const response = await googleApiRequest.call(this, 'GET', `v1/volumes?q=${searchQuery}`, {}); + responseData.push(response); + } + } else if (resource === 'bookshelf') { + if (operation === 'getShelf') { + const userId = this.getNodeParameter('userId', i) as string; + const shelfId = this.getNodeParameter('shelfId', i) as string; + + const response = await googleApiRequest.call(this, 'GET', `v1/users/${userId}/bookshelves/${shelfId}`, {}); + responseData.push(response); + } else if (operation === 'listShelves') { + const userId = this.getNodeParameter('userId', i) as string; + + const response = await googleApiRequest.call(this, 'GET', `v1/users/${userId}/bookshelves`, {}); + responseData.push(response); + } else if (operation === 'getVolumes') { + const userId = this.getNodeParameter('userId', i) as string; + const shelfId = this.getNodeParameter('shelfId', i) as string; + + const response = await googleApiRequest.call(this, 'GET', `v1/users/${userId}/bookshelves/${shelfId}/volumes`, {}); + responseData.push(response); + } + } else if (resource === 'library') { + if (operation === 'addVolume') { + const shelfId = this.getNodeParameter('shelfId', i) as string; + const volumeId = this.getNodeParameter('volumeId', i) as string; + + const response = await googleApiRequest.call(this, 'POST', `v1/mylibrary/bookshelves/${shelfId}/addVolume`, {volumeId}); + responseData.push(response); + } else if (operation === 'clearVolumes') { + const shelfId = this.getNodeParameter('shelfId', i) as string; + + const response = await googleApiRequest.call(this, 'POST', `v1/mylibrary/bookshelves/${shelfId}/clearVolumes`, {}); + responseData.push(response); + } else if (operation === 'getMyShelf') { + const shelfId = this.getNodeParameter('shelfId', i) as string; + + const response = await googleApiRequest.call(this, 'GET', `v1/mylibrary/bookshelves/${shelfId}`, {}); + responseData.push(response); + } else if (operation === 'listMyShelves') { + const response = await googleApiRequest.call(this, 'GET', `v1/mylibrary/bookshelves`, {}); + responseData.push(response); + } else if (operation === 'moveVolume') { + const shelfId = this.getNodeParameter('shelfId', i) as string; + const volumeId = this.getNodeParameter('volumeId', i) as string; + const volumePosition = this.getNodeParameter('volumePosition', i) as string; + + const response = await googleApiRequest.call(this, 'POST', `v1/mylibrary/bookshelves/${shelfId}/moveVolume`, {shelfId, volumeId, volumePosition}); + responseData.push(response); + } else if (operation === 'removeVolume') { + const shelfId = this.getNodeParameter('shelfId', i) as string; + const volumeId = this.getNodeParameter('volumeId', i) as string; + + const response = await googleApiRequest.call(this, 'POST', `v1/mylibrary/bookshelves/${shelfId}/removeVolume`, {shelfId, volumeId}); + responseData.push(response); + } else if (operation === 'listVolumes') { + const shelfId = this.getNodeParameter('shelfId', i) as string; + + const response = await googleApiRequest.call(this, 'GET', `v1/mylibrary/bookshelves/${shelfId}/volumes`, {}); + responseData.push(response); + } + } + } + return [this.helpers.returnJsonArray(responseData)]; + } +} diff --git a/packages/nodes-base/nodes/Google/Books/googlebooks.svg b/packages/nodes-base/nodes/Google/Books/googlebooks.svg new file mode 100644 index 0000000000..752d18d549 --- /dev/null +++ b/packages/nodes-base/nodes/Google/Books/googlebooks.svg @@ -0,0 +1,37 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/packages/nodes-base/package.json b/packages/nodes-base/package.json index 7822f86a66..a79d5b0a5b 100644 --- a/packages/nodes-base/package.json +++ b/packages/nodes-base/package.json @@ -75,6 +75,7 @@ "dist/credentials/GitlabOAuth2Api.credentials.js", "dist/credentials/GmailOAuth2Api.credentials.js", "dist/credentials/GoogleApi.credentials.js", + "dist/credentials/GoogleBooksOAuth2Api.credentials.js", "dist/credentials/GoogleCalendarOAuth2Api.credentials.js", "dist/credentials/GoogleContactsOAuth2Api.credentials.js", "dist/credentials/GoogleDriveOAuth2Api.credentials.js", @@ -264,6 +265,7 @@ "dist/nodes/Github/GithubTrigger.node.js", "dist/nodes/Gitlab/Gitlab.node.js", "dist/nodes/Gitlab/GitlabTrigger.node.js", + "dist/nodes/Google/Books/GoogleBooks.node.js", "dist/nodes/Google/Calendar/GoogleCalendar.node.js", "dist/nodes/Google/Contacts/GoogleContacts.node.js", "dist/nodes/Google/Drive/GoogleDrive.node.js",