✨ Add Trello-Nodes

packages/nodes-base/credentials/TrelloApi.credentials.ts

@@ -0,0 +1,30 @@
+import {
+	ICredentialType,
+	NodePropertyTypes,
+} from 'n8n-workflow';
+
+
+export class TrelloApi implements ICredentialType {
+	name = 'trelloApi';
+	displayName = 'Trello API';
+	properties = [
+		{
+			displayName: 'API Key',
+			name: 'apiKey',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},
+		{
+			displayName: 'API Token',
+			name: 'apiToken',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},
+		{
+			displayName: 'OAuth Secret',
+			name: 'oauthSecret',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},
+	];
+}

packages/nodes-base/nodes/Trello/GenericFunctions.ts

@@ -0,0 +1,51 @@
+import {
+	IExecuteFunctions,
+	IHookFunctions,
+	ILoadOptionsFunctions,
+} from 'n8n-core';
+
+import { OptionsWithUri } from 'request';
+import { IDataObject } from 'n8n-workflow';
+
+
+/**
+ * Make an API request to Trello
+ *
+ * @param {IHookFunctions} this
+ * @param {string} method
+ * @param {string} url
+ * @param {object} body
+ * @returns {Promise<any>}
+ */
+export async function apiRequest(this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions, method: string, endpoint: string, body: object, query?: IDataObject): Promise<any> { // tslint:disable-line:no-any
+	const credentials = this.getCredentials('trelloApi');
+
+	if (credentials === undefined) {
+		throw new Error('No credentials got returned!');
+	}
+
+	query = query || {};
+
+	query.key = credentials.apiKey;
+	query.token = credentials.apiToken;
+
+	const options: OptionsWithUri = {
+		headers: {
+		},
+		method,
+		body,
+		qs: query,
+		uri: `https://api.trello.com/1/${endpoint}`,
+		json: true,
+	};
+
+	try {
+		return await this.helpers.request!(options);
+	} catch (error) {
+		if (error.statusCode === 401) {
+			throw new Error('The Trello credentials are not valid!');
+		}
+
+		throw error;
+	}
+}

packages/nodes-base/nodes/Trello/TrelloTrigger.node.ts

@@ -0,0 +1,220 @@
+import {
+	IHookFunctions,
+	IWebhookFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+	INodeTypeDescription,
+	INodeType,
+	IWebhookResonseData,
+} from 'n8n-workflow';
+
+import {
+	apiRequest,
+} from './GenericFunctions';
+
+import { createHmac } from 'crypto';
+
+
+export class TrelloTrigger implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Trello Trigger',
+		name: 'trelloTrigger',
+		icon: 'file:trello.png',
+		group: ['trigger'],
+		version: 1,
+		description: 'Starts the workflow when Trello events occure.',
+		defaults: {
+			name: 'Trello Trigger',
+			color: '#026aa7',
+		},
+		inputs: [],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'trelloApi',
+				required: true,
+			},
+		],
+		webhooks: [
+			{
+				name: 'setup',
+				httpMethod: 'GET',
+				reponseMode: 'onReceived',
+				path: 'webhook',
+			},
+			{
+				name: 'default',
+				httpMethod: 'POST',
+				reponseMode: 'onReceived',
+				path: 'webhook',
+			},
+		],
+		properties: [
+			{
+				displayName: 'Model ID',
+				name: 'id',
+				type: 'string',
+				default: '',
+				placeholder: '4d5ea62fd76aa1136000000c',
+				required: true,
+				description: 'ID of the model of which to subscribe to events',
+			},
+		],
+
+	};
+
+	// @ts-ignore (because of request)
+	webhookMethods = {
+		default: {
+			async checkExists(this: IHookFunctions): Promise<boolean> {
+				if (this.getWebhookName() === 'setup') {
+					// Is setup-webhook which only gets used once when
+					// the webhook gets created so nothing to do.
+					return true;
+				}
+
+				const webhookData = this.getWorkflowStaticData('node');
+
+				if (webhookData.webhookId === undefined) {
+					// No webhook id is set so no webhook can exist
+					return false;
+				}
+
+				const credentials = this.getCredentials('trelloApi');
+
+				if (credentials === undefined) {
+					throw new Error('No credentials got returned!');
+				}
+
+				// Webhook got created before so check if it still exists
+				const endpoint = `tokens/${credentials.apiToken}/webhooks/${webhookData.webhookId}`;
+
+				const responseData = await apiRequest.call(this, 'GET', endpoint, {});
+
+				if (responseData.data === undefined) {
+					return false;
+				}
+
+				for (const existingData of responseData.data) {
+					if (existingData.id === webhookData.webhookId) {
+						// The webhook exists already
+						return true;
+					}
+				}
+
+				return false;
+			},
+			async create(this: IHookFunctions): Promise<boolean> {
+				if (this.getWebhookName() === 'setup') {
+					// Is setup-webhook which only gets used once when
+					// the webhook gets created so nothing to do.
+					return true;
+				}
+
+				const webhookUrl = this.getNodeWebhookUrl('default');
+
+				const credentials = this.getCredentials('trelloApi');
+				if (credentials === undefined) {
+					throw new Error('No credentials got returned!');
+				}
+
+				const idModel = this.getNodeParameter('id') as string;
+
+				const endpoint = `tokens/${credentials.apiToken}/webhooks`;
+
+				const body = {
+					description: `n8n Webhook - ${idModel}`,
+					callbackURL: webhookUrl,
+					idModel,
+				};
+
+				const responseData = await apiRequest.call(this, 'POST', endpoint, body);
+
+				if (responseData.id === undefined) {
+					// Required data is missing so was not successful
+					return false;
+				}
+
+				const webhookData = this.getWorkflowStaticData('node');
+				webhookData.webhookId = responseData.id as string;
+
+				return true;
+			},
+			async delete(this: IHookFunctions): Promise<boolean> {
+				if (this.getWebhookName() === 'setup') {
+					// Is setup-webhook which only gets used once when
+					// the webhook gets created so nothing to do.
+					return true;
+				}
+
+				const webhookData = this.getWorkflowStaticData('node');
+
+				if (webhookData.webhookId !== undefined) {
+					const credentials = this.getCredentials('trelloApi');
+					if (credentials === undefined) {
+						throw new Error('No credentials got returned!');
+					}
+
+					const endpoint = `tokens/${credentials.apiToken}/webhooks/${webhookData.webhookId}`;
+
+					const body = {};
+
+					try {
+						await apiRequest.call(this, 'DELETE', endpoint, body);
+					} catch (e) {
+						return false;
+					}
+
+					// Remove from the static workflow data so that it is clear
+					// that no webhooks are registred anymore
+					delete webhookData.webhookId;
+				}
+
+				return true;
+			},
+		},
+	};
+
+
+
+	async webhook(this: IWebhookFunctions): Promise<IWebhookResonseData> {
+		const webhookName = this.getWebhookName();
+
+		if (webhookName === 'setup') {
+			// Is a create webhook confirmation request
+			const res = this.getResponseObject();
+			res.status(200).end();
+			return {
+				noWebhookResponse: true,
+			};
+		}
+
+		const bodyData = this.getBodyData();
+
+		const credentials = this.getCredentials('trelloApi');
+
+		if (credentials === undefined) {
+			throw new Error('No credentials got returned!');
+		}
+
+		// TODO: Check why that does not work as expected even though it gets done as described
+		//       https://developers.trello.com/page/webhooks
+		// // Check if the request is valid
+		// const headerData = this.getHeaderData() as IDataObject;
+		// const webhookUrl = this.getNodeWebhookUrl('default');
+		// const checkContent = JSON.stringify(bodyData) + webhookUrl;
+		// const computedSignature = createHmac('sha1', credentials.oauthSecret as string).update(checkContent).digest('base64');
+		// if (headerData['x-trello-webhook'] !== computedSignature) {
+		// 	// Signature is not valid so ignore call
+		// 	return {};
+		// }
+
+		return {
+			workflowData: [
+				this.helpers.returnJsonArray(bodyData),
+			],
+		};
+	}
+}

packages/nodes-base/package.json

@@ -41,6 +41,7 @@
             "dist/credentials/Redis.credentials.js",
             "dist/credentials/SlackApi.credentials.js",
             "dist/credentials/Smtp.credentials.js",
+            "dist/credentials/TrelloApi.credentials.js",
             "dist/credentials/TwilioApi.credentials.js"
         ],
         "nodes": [
@@ -84,6 +85,8 @@
             "dist/nodes/Slack/Slack.node.js",
             "dist/nodes/SpreadsheetFile.node.js",
             "dist/nodes/Start.node.js",
+            "dist/nodes/Trello/Trello.node.js",
+            "dist/nodes/Trello/TrelloTrigger.node.js",
             "dist/nodes/Twilio/Twilio.node.js",
             "dist/nodes/WriteBinaryFile.node.js",
             "dist/nodes/Webhook.node.js"