✨ Add Gotify-Node (#1135)

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

@@ -0,0 +1,31 @@
+import {
+	ICredentialType,
+	NodePropertyTypes,
+} from 'n8n-workflow';
+
+export class GotifyApi implements ICredentialType {
+	name = 'gotifyApi';
+	displayName = 'Gotify API';
+	properties = [
+		{
+			displayName: 'APP API Token',
+			name: 'appApiToken',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+			description: '(Optional) Needed for message creation',
+		},
+		{
+			displayName: 'Client API Token',
+			name: 'clientApiToken',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+			description: '(Optional) Needed for everything (delete, getAll) but message creation',
+		},
+		{
+			displayName: 'URL',
+			name: 'url',
+			type: 'string' as NodePropertyTypes,
+			default: `Host's URL`,
+		},
+	];
+}

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

@@ -0,0 +1,68 @@
+import {
+	OptionsWithUri,
+} from 'request';
+
+import {
+	IExecuteFunctions,
+	IExecuteSingleFunctions,
+	ILoadOptionsFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+} from 'n8n-workflow';
+
+export async function gotifyApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, path: string, body: any = {}, qs: IDataObject = {}, uri?: string | undefined, option = {}): Promise<any> { // tslint:disable-line:no-any
+
+	const credentials = this.getCredentials('gotifyApi') as IDataObject;
+
+	const options: OptionsWithUri = {
+		method,
+		headers: {
+			'X-Gotify-Key': (method === 'POST') ? credentials.appApiToken : credentials.clientApiToken,
+			accept: 'application/json',
+		},
+		body,
+		qs,
+		uri: uri || `${credentials.url}${path}`,
+		json: true,
+	};
+	try {
+		if (Object.keys(body).length === 0) {
+			delete options.body;
+		}
+
+		//@ts-ignore
+		return await this.helpers.request.call(this, options);
+	} catch (error) {
+	
+		if (error.response && error.response.body && error.response.body.errorDescription) {
+			const message = error.response.body.errorDescription;
+			// Try to return the error prettier
+			throw new Error(
+				`Gotify error response [${error.statusCode}]: ${message}`,
+			);
+		}
+		throw error;
+	}
+}
+
+export async function gotifyApiRequestAllItems(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;
+	let uri: string | undefined;
+	query.limit = 100;
+	do {
+		responseData = await gotifyApiRequest.call(this, method, endpoint, body, query, uri);
+		if (responseData.paging.next) {
+			uri = responseData.paging.next;
+		}
+		returnData.push.apply(returnData, responseData[propertyName]);
+	} while (
+		responseData.paging.next
+	);
+
+	return returnData;
+}

packages/nodes-base/nodes/Gotify/Gotify.node.ts

@@ -0,0 +1,262 @@
+import {
+	IExecuteFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+	INodeExecutionData,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+
+import {
+	gotifyApiRequest,
+	gotifyApiRequestAllItems,
+} from './GenericFunctions';
+
+export class Gotify implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Gotify',
+		name: 'gotify',
+		icon: 'file:gotify.png',
+		group: ['input'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Consume Gotify API.',
+		defaults: {
+			name: 'Gotify',
+			color: '#71c8ec',
+		},
+		inputs: ['main'],
+		outputs: ['main'],
+		credentials: [
+			{
+				name: 'gotifyApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				options: [
+					{
+						name: 'Message',
+						value: 'message',
+					},
+				],
+				default: 'message',
+				description: 'The resource to operate on.',
+			},
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				displayOptions: {
+					show: {
+						resource: [
+							'message',
+						],
+					},
+				},
+				options: [
+					{
+						name: 'Create',
+						value: 'create',
+					},
+					{
+						name: 'Delete',
+						value: 'delete',
+					},
+					{
+						name: 'Get All',
+						value: 'getAll',
+					},
+				],
+				default: 'create',
+				description: 'The resource to operate on.',
+			},
+			{
+				displayName: 'Message',
+				name: 'message',
+				type: 'string',
+				required: true,
+				displayOptions: {
+					show: {
+						resource: [
+							'message',
+						],
+						operation: [
+							'create',
+						],
+					},
+				},
+				default: '',
+				description: `The message. Markdown (excluding html) is allowed.`,
+			},
+			{
+				displayName: 'Additional Fields',
+				name: 'additionalFields',
+				type: 'collection',
+				placeholder: 'Add Field',
+				displayOptions: {
+					show: {
+						resource: [
+							'message',
+						],
+						operation: [
+							'create',
+						],
+					},
+				},
+				default: {},
+				options: [
+					{
+						displayName: 'Priority',
+						name: 'priority',
+						type: 'number',
+						default: 1,
+						description: 'The priority of the message.',
+					},
+					{
+						displayName: 'Title',
+						name: 'title',
+						type: 'string',
+						default: '',
+						description: `The title of the message.`,
+					},
+				],
+			},
+			{
+				displayName: 'Message ID',
+				name: 'messageId',
+				type: 'string',
+				required: true,
+				displayOptions: {
+					show: {
+						resource: [
+							'message',
+						],
+						operation: [
+							'delete',
+						],
+					},
+				},
+				default: '',
+				description: `The message id.`,
+			},
+			{
+				displayName: 'Return All',
+				name: 'returnAll',
+				type: 'boolean',
+				displayOptions: {
+					show: {
+						resource: [
+							'message',
+						],
+						operation: [
+							'getAll',
+						],
+					},
+				},
+				default: false,
+				description: 'If all results should be returned or only up to a given limit.',
+			},
+			{
+				displayName: 'Limit',
+				name: 'limit',
+				type: 'number',
+				default: 20,
+				displayOptions: {
+					show: {
+						resource: [
+							'message',
+						],
+						operation: [
+							'getAll',
+						],
+						returnAll: [
+							false,
+						],
+					},
+				},
+			},
+		],
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		const items = this.getInputData();
+		const returnData: IDataObject[] = [];
+		const length = (items.length as unknown) as number;
+		const qs: IDataObject = {};
+		let responseData;
+		const resource = this.getNodeParameter('resource', 0) as string;
+		const operation = this.getNodeParameter('operation', 0) as string;
+		for (let i = 0; i < length; i++) {
+			if (resource === 'message') {
+				if (operation === 'create') {
+
+					const message = this.getNodeParameter('message', i) as string;
+
+					const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
+
+					const body: IDataObject = {
+						message,
+					};
+					
+					Object.assign(body, additionalFields);
+
+					responseData = await gotifyApiRequest.call(
+						this,
+						'POST',
+						`/message`,
+						body,
+					);
+				}
+				if (operation === 'delete') {
+					const messageId = this.getNodeParameter('messageId', i) as string;
+
+					responseData = await gotifyApiRequest.call(
+						this,
+						'DELETE',
+						`/message/${messageId}`,
+					);
+					responseData = { success: true };
+				}
+
+				if (operation === 'getAll') {
+					const returnAll = this.getNodeParameter('returnAll', i) as boolean;
+
+					if (returnAll) {
+						responseData = await gotifyApiRequestAllItems.call(
+							this,
+							'messages',
+							'GET',
+							'/message',
+							{},
+							qs,
+						);
+
+					} else {
+						qs.limit = this.getNodeParameter('limit', i) as number;
+						responseData = await gotifyApiRequest.call(
+							this,
+							'GET',
+							`/message`,
+							{},
+							qs,
+						);
+						responseData = responseData.messages;
+					}
+				}
+			}
+			if (Array.isArray(responseData)) {
+				returnData.push.apply(returnData, responseData as IDataObject[]);
+			} else if (responseData !== undefined) {
+				returnData.push(responseData as IDataObject);
+			}
+		}
+		return [this.helpers.returnJsonArray(returnData)];
+	}
+}

packages/nodes-base/package.json

@@ -88,6 +88,7 @@
       "dist/credentials/GSuiteAdminOAuth2Api.credentials.js",
       "dist/credentials/GoogleTasksOAuth2Api.credentials.js",
       "dist/credentials/GoogleTranslateOAuth2Api.credentials.js",
+      "dist/credentials/GotifyApi.credentials.js",
       "dist/credentials/YouTubeOAuth2Api.credentials.js",
       "dist/credentials/GumroadApi.credentials.js",
       "dist/credentials/HarvestApi.credentials.js",
@@ -294,6 +295,7 @@
       "dist/nodes/Google/Task/GoogleTasks.node.js",
       "dist/nodes/Google/Translate/GoogleTranslate.node.js",
       "dist/nodes/Google/YouTube/YouTube.node.js",
+      "dist/nodes/Gotify/Gotify.node.js",
       "dist/nodes/GraphQL/GraphQL.node.js",
       "dist/nodes/Gumroad/GumroadTrigger.node.js",
       "dist/nodes/HackerNews/HackerNews.node.js",