🔀 Merge branch 'feature/toggl-trigger' of https://github.com/RicardoE105/n8n into RicardoE105-feature/toggl-trigger

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

@@ -0,0 +1,24 @@
+import {
+	ICredentialType,
+	NodePropertyTypes,
+} from 'n8n-workflow';
+
+
+export class TogglApi implements ICredentialType {
+	name = 'togglApi';
+	displayName = 'Toggl API';
+	properties = [
+		{
+			displayName: 'Username',
+			name: 'username',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},
+		{
+			displayName: 'Password',
+			name: 'password',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},
+	];
+}

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

@@ -0,0 +1,46 @@
+import { OptionsWithUri } from 'request';
+
+import {
+	IExecuteFunctions,
+	IHookFunctions,
+	ILoadOptionsFunctions,
+	IExecuteSingleFunctions,
+	ITriggerFunctions,
+	BINARY_ENCODING,
+	getLoadOptionsFunctions
+} from 'n8n-core';
+
+import {
+	IDataObject,
+} from 'n8n-workflow';
+
+export async function togglApiRequest(this: ITriggerFunctions | IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, query?: IDataObject, uri?: string): Promise<any> { // tslint:disable-line:no-any
+	const credentials = this.getCredentials('togglApi');
+	if (credentials === undefined) {
+		throw new Error('No credentials got returned!');
+	}
+	const headerWithAuthentication = Object.assign({},
+		{ Authorization: ` Basic ${Buffer.from(`${credentials.username}:${credentials.password}`).toString(BINARY_ENCODING)}` });
+
+	const options: OptionsWithUri = {
+		headers: headerWithAuthentication,
+		method,
+		qs: query,
+		uri: uri || `https://www.toggl.com/api/v8${resource}`,
+		body,
+		json: true
+	};
+	if (Object.keys(options.body).length === 0) {
+		delete options.body;
+	}
+	try {
+		return await this.helpers.request!(options);
+	} catch (error) {
+		const errorMessage = error.response.body.message || error.response.body.Message;
+
+		if (errorMessage !== undefined) {
+			throw errorMessage;
+		}
+		throw error.response.body;
+	}
+}

packages/nodes-base/nodes/Toggl/TogglTrigger.node.ts

@@ -0,0 +1,275 @@
+import { ITriggerFunctions } from 'n8n-core';
+import {
+	INodeType,
+	INodeTypeDescription,
+	ITriggerResponse,
+	IDataObject,
+} from 'n8n-workflow';
+
+import { CronJob } from 'cron';
+import * as moment from 'moment';
+import { togglApiRequest } from './GenericFunctions';
+
+export class TogglTrigger implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'Toggl',
+		name: 'Toggl',
+		icon: 'file:toggl.png',
+		group: ['trigger'],
+		version: 1,
+		description: 'Starts the workflow when Toggl events occure',
+		defaults: {
+			name: 'Toggl',
+			color: '#00FF00',
+		},
+		credentials: [
+			{
+				name: 'togglApi',
+				required: true,
+			}
+		],
+		inputs: [],
+		outputs: ['main'],
+		properties: [
+			{
+				displayName: 'Event',
+				name: 'event',
+				type: 'options',
+				options: [
+					{
+						name: 'New Time Entry',
+						value: 'newTimeEntry',
+					}
+				],
+				required: true,
+				default: 'newTimeEntry',
+			},
+			{
+				displayName: 'Mode',
+				name: 'mode',
+				type: 'options',
+				options: [
+					{
+						name: 'Every Minute',
+						value: 'everyMinute'
+					},
+					{
+						name: 'Every Hour',
+						value: 'everyHour'
+					},
+					{
+						name: 'Every Day',
+						value: 'everyDay'
+					},
+					{
+						name: 'Every Week',
+						value: 'everyWeek'
+					},
+					{
+						name: 'Every Month',
+						value: 'everyMonth'
+					},
+					{
+						name: 'Custom',
+						value: 'custom'
+					},
+				],
+				default: 'everyDay',
+				description: 'How often to trigger.',
+			},
+			{
+				displayName: 'Hour',
+				name: 'hour',
+				type: 'number',
+				typeOptions: {
+					minValue: 0,
+					maxValue: 23,
+				},
+				displayOptions: {
+					hide: {
+						mode: [
+							'custom',
+							'everyHour',
+							'everyMinute'
+						],
+					},
+				},
+				default: 14,
+				description: 'The hour of the day to trigger (24h format).',
+			},
+			{
+				displayName: 'Minute',
+				name: 'minute',
+				type: 'number',
+				typeOptions: {
+					minValue: 0,
+					maxValue: 59,
+				},
+				displayOptions: {
+					hide: {
+						mode: [
+							'custom',
+							'everyMinute'
+						],
+					},
+				},
+				default: 0,
+				description: 'The minute of the day to trigger.',
+			},
+			{
+				displayName: 'Day of Month',
+				name: 'dayOfMonth',
+				type: 'number',
+				displayOptions: {
+					show: {
+						mode: [
+							'everyMonth',
+						],
+					},
+				},
+				typeOptions: {
+					minValue: 1,
+					maxValue: 31,
+				},
+				default: 1,
+				description: 'The day of the month to trigger.',
+			},
+			{
+				displayName: 'Weekday',
+				name: 'weekday',
+				type: 'options',
+				displayOptions: {
+					show: {
+						mode: [
+							'everyWeek',
+						],
+					},
+				},
+				options: [
+					{
+						name: 'Monday',
+						value: '1',
+					},
+					{
+						name: 'Tuesday',
+						value: '2',
+					},
+					{
+						name: 'Wednesday',
+						value: '3',
+					},
+					{
+						name: 'Thursday',
+						value: '4',
+					},
+					{
+						name: 'Friday',
+						value: '5',
+					},
+					{
+						name: 'Saturday',
+						value: '6',
+					},
+					{
+						name: 'Sunday',
+						value: '0',
+					},
+				],
+				default: '1',
+				description: 'The weekday to trigger.',
+			},
+			{
+				displayName: 'Cron Expression',
+				name: 'cronExpression',
+				type: 'string',
+				displayOptions: {
+					show: {
+						mode: [
+							'custom',
+						],
+					},
+				},
+				default: '* * * * * *',
+				description: 'Use custom cron expression. Values and ranges as follows:<ul><li>Seconds: 0-59</li><li>Minutes: 0 - 59</li><li>Hours: 0 - 23</li><li>Day of Month: 1 - 31</li><li>Months: 0 - 11 (Jan - Dec)</li><li>Day of Week: 0 - 6 (Sun - Sat)</li></ul>',
+			},
+		]
+	};
+
+	async trigger(this: ITriggerFunctions): Promise<ITriggerResponse> {
+		const webhookData = this.getWorkflowStaticData('node');
+		const mode = this.getNodeParameter('mode') as string;
+		const event = this.getNodeParameter('event') as string;
+		// Get all the trigger times
+		let cronTime;
+		let endpoint: string;
+		//let parameterName: string;
+		if (mode === 'custom') {
+			const cronExpression = this.getNodeParameter('cronExpression') as string;
+			cronTime = cronExpression as string;
+		}
+		if (mode === 'everyMinute') {
+			cronTime = `* * * * *`;
+		}
+		if (mode === 'everyHour') {
+			const minute = this.getNodeParameter('minute') as string;
+			cronTime = `${minute} * * * *`;
+		}
+		if (mode === 'everyDay') {
+			const hour = this.getNodeParameter('hour') as string;
+			const minute = this.getNodeParameter('minute') as string;
+			cronTime = `${minute} ${hour} * * *`;
+		}
+		if (mode === 'everyWeek') {
+			const weekday = this.getNodeParameter('weekday') as string;
+			const hour = this.getNodeParameter('hour') as string;
+			const minute = this.getNodeParameter('minute') as string;
+			cronTime = `${minute} ${hour} * * ${weekday}`;
+		}
+		if (mode === 'everyMonth') {
+			const dayOfMonth = this.getNodeParameter('dayOfMonth') as string;
+			const hour = this.getNodeParameter('hour') as string;
+			const minute = this.getNodeParameter('minute') as string;
+			cronTime = `${minute} ${hour} ${dayOfMonth} * *`;
+		}
+		if (event === 'newTimeEntry') {
+			endpoint = '/time_entries';
+		}
+
+		const executeTrigger = async () => {
+			const qs: IDataObject = {};
+			let timeEntries = [];
+			qs.start_date = webhookData.lastTimeChecked;
+			qs.end_date = moment().format();
+			try {
+				timeEntries = await togglApiRequest.call(this, 'GET', endpoint, {}, qs);
+			} catch (err) {
+				throw new Error(`Toggl Trigger Error: ${err}`);
+			}
+			if (Array.isArray(timeEntries) && timeEntries.length !== 0) {
+				this.emit([this.helpers.returnJsonArray(timeEntries)]);
+			}
+			webhookData.lastTimeChecked = qs.end_date;
+		};
+
+		const timezone = this.getTimezone();
+
+		// Start the cron-jobs
+		const cronJob = new CronJob(cronTime as string, executeTrigger, undefined, true, timezone);
+
+		// Stop the cron-jobs
+		async function closeFunction() {
+			cronJob.stop();
+		}
+
+		async function manualTriggerFunction() {
+			executeTrigger();
+		}
+		if (webhookData.lastTimeChecked === undefined) {
+			webhookData.lastTimeChecked = moment().format();
+		}
+		return {
+			closeFunction,
+			manualTriggerFunction,
+		};
+	}
+}

packages/nodes-base/package.json

@@ -73,6 +73,7 @@
             "dist/credentials/MandrillApi.credentials.js",
             "dist/credentials/TodoistApi.credentials.js",
             "dist/credentials/TypeformApi.credentials.js",
+            "dist/credentials/TogglApi.credentials.js",
             "dist/credentials/VeroApi.credentials.js"
         ],
         "nodes": [
@@ -155,7 +156,8 @@
             "dist/nodes/Trello/Trello.node.js",
             "dist/nodes/Trello/TrelloTrigger.node.js",
             "dist/nodes/Twilio/Twilio.node.js",
-            "dist/nodes/Typeform/TypeformTrigger.node.js",
+			"dist/nodes/Typeform/TypeformTrigger.node.js",
+			"dist/nodes/Toggl/TogglTrigger.node.js",
             "dist/nodes/Vero/Vero.node.js",
             "dist/nodes/WriteBinaryFile.node.js",
             "dist/nodes/Webhook.node.js",