Add Google Books node

This commit is contained in:
Tanay Pant 2020-10-19 19:57:50 +02:00
parent 4165fad307
commit f08d8c9375
5 changed files with 595 additions and 0 deletions

View file

@ -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(' '),
},
];
}

View file

@ -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<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://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<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/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);
}

View file

@ -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<INodeExecutionData[][]> {
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)];
}
}

View file

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Generator: Adobe Illustrator 23.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="svg61" xmlns:x="http://ns.adobe.com/Extensibility/1.0/" xmlns:i="http://ns.adobe.com/AdobeIllustrator/10.0/" xmlns:graph="http://ns.adobe.com/Graphs/1.0/" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 448.7 500" enable-background="new 0 0 448.7 500" xml:space="preserve">
<metadata id="metadata58">
<rdf:RDF>
<cc:Work rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
</cc:Work>
</rdf:RDF>
<sfw xmlns="http://ns.adobe.com/SaveForWeb/1.0/">
<slices/>
<sliceSourceBounds bottomLeftOrigin="true" height="500" width="448.7" x="3451.9" y="3846"/>
</sfw>
</metadata>
<g>
<path fill="#0B5E9F" d="M428.2,221.9L49.2,6.5C33-2.6,18.5-1.7,9.7,6.8l0,0C3.4,12.8,0,22.4,0,34.9v429.9C0,477.4,3.7,487,9.7,493 l0,0c9.1,8.8,23.3,9.7,39.5,0.3l379.1-215.4C455.5,262.5,455.5,237.5,428.2,221.9z"/>
<linearGradient id="SVGID_1_" gradientUnits="userSpaceOnUse" x1="223.1684" y1="7682.2407" x2="223.1684" y2="8182.2686" gradientTransform="matrix(0.9998 0 0 -0.9998 1.2134 8180.7046)">
<stop offset="0" style="stop-color:#FFFFFF;stop-opacity:0"/>
<stop offset="1" style="stop-color:#FFFFFF;stop-opacity:0.1"/>
</linearGradient>
<path fill-rule="evenodd" clip-rule="evenodd" fill="url(#SVGID_1_)" d="M428.3,221.9l-95-54l-1.7-1.1l-0.1,0.1L49.2,6.6 c-15.7-9-29.9-8.3-38.9-0.2L8.8,7.7C3.2,13.7,0,23,0,35.1v429.7c0,12.1,3.2,21.4,9.1,27.2l0,0l-0.2,0.2c8.9,9.5,23.7,10.6,40.4,1.3 l282.2-160.5l0.1,0.1c0,0,1.7-1.1,1.8-1.1l95-54C455.5,262.5,455.5,237.2,428.3,221.9z"/>
<path opacity="0.25" fill-rule="evenodd" clip-rule="evenodd" fill="#FFFFFF" enable-background="new " d="M49.2,9.4l379,215.3 c12.3,6.9,19.2,16,20.3,25.3c0-10.1-6.7-20.3-20.3-28.1L49.2,6.6C22-9,0,4,0,35.1v2.8C0,6.8,22-5.9,49.2,9.4z"/>
<path fill="#40DCFF" d="M358.2,70.2H135.9V444l242.9-138V90.9C378.8,79.5,369.6,70.2,358.2,70.2z"/>
<linearGradient id="SVGID_2_" gradientUnits="userSpaceOnUse" x1="7121.7529" y1="-324.192" x2="7123.5923" y2="-327.4978" gradientTransform="matrix(38.316 0 0 -36.19 -272599.25 -11433.2002)">
<stop offset="0" style="stop-color:#5B7C8C;stop-opacity:0"/>
<stop offset="1" style="stop-color:#5B7C8C;stop-opacity:0.4"/>
</linearGradient>
<path fill="url(#SVGID_2_)" d="M358.2,70.2H135.9v373.6l242.9-137.9V90.9C378.8,79.5,369.6,70.2,358.2,70.2z"/>
<polygon fill="#009BF0" points="135.9,70.2 70.3,70.2 70.3,481.2 135.9,444 "/>
<path opacity="0.15" fill="#FFFFFF" enable-background="new " d="M358.2,70.2H70.3v2.3h287.9c11.4,0,20.7,6.9,20.7,18.3l0,0 C378.8,79.5,369.6,70.2,358.2,70.2z"/>
<polygon fill="#FAFAFA" points="261.1,173.3 294.9,152.4 329.9,173.3 329.9,70.2 261.1,70.2 "/>
</g>
</svg>

After

Width:  |  Height:  |  Size: 3.2 KiB

View file

@ -75,6 +75,7 @@
"dist/credentials/GitlabOAuth2Api.credentials.js", "dist/credentials/GitlabOAuth2Api.credentials.js",
"dist/credentials/GmailOAuth2Api.credentials.js", "dist/credentials/GmailOAuth2Api.credentials.js",
"dist/credentials/GoogleApi.credentials.js", "dist/credentials/GoogleApi.credentials.js",
"dist/credentials/GoogleBooksOAuth2Api.credentials.js",
"dist/credentials/GoogleCalendarOAuth2Api.credentials.js", "dist/credentials/GoogleCalendarOAuth2Api.credentials.js",
"dist/credentials/GoogleContactsOAuth2Api.credentials.js", "dist/credentials/GoogleContactsOAuth2Api.credentials.js",
"dist/credentials/GoogleDriveOAuth2Api.credentials.js", "dist/credentials/GoogleDriveOAuth2Api.credentials.js",
@ -264,6 +265,7 @@
"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/Books/GoogleBooks.node.js",
"dist/nodes/Google/Calendar/GoogleCalendar.node.js", "dist/nodes/Google/Calendar/GoogleCalendar.node.js",
"dist/nodes/Google/Contacts/GoogleContacts.node.js", "dist/nodes/Google/Contacts/GoogleContacts.node.js",
"dist/nodes/Google/Drive/GoogleDrive.node.js", "dist/nodes/Google/Drive/GoogleDrive.node.js",