From 7c049fa858a790001eb9e29b9977611cbf4dcc30 Mon Sep 17 00:00:00 2001 From: Ricardo Espinoza Date: Tue, 3 Nov 2020 17:01:38 -0500 Subject: [PATCH] :zap: Add direct message resource to Twitter (#1118) --- packages/core/src/NodeExecuteFunctions.ts | 30 +--- .../nodes/Twitter/DirectMessageDescription.ts | 98 ++++++++++ .../nodes/Twitter/GenericFunctions.ts | 109 +++++++++++- .../nodes-base/nodes/Twitter/Twitter.node.ts | 168 +++++++----------- 4 files changed, 277 insertions(+), 128 deletions(-) create mode 100644 packages/nodes-base/nodes/Twitter/DirectMessageDescription.ts diff --git a/packages/core/src/NodeExecuteFunctions.ts b/packages/core/src/NodeExecuteFunctions.ts index bf7a6cd7c9..fcca59d9fe 100644 --- a/packages/core/src/NodeExecuteFunctions.ts +++ b/packages/core/src/NodeExecuteFunctions.ts @@ -38,7 +38,7 @@ import { } from 'n8n-workflow'; import * as clientOAuth1 from 'oauth-1.0a'; -import { RequestOptions, Token } from 'oauth-1.0a'; +import { Token } from 'oauth-1.0a'; import * as clientOAuth2 from 'client-oauth2'; import { get } from 'lodash'; import * as express from 'express'; @@ -238,31 +238,13 @@ export function requestOAuth1(this: IAllExecuteFunctions, credentialsType: strin secret: oauthTokenData.oauth_token_secret as string, }; - const newRequestOptions = { - method: requestOptions.method, - data: { ...requestOptions.qs, ...requestOptions.body }, - json: requestOptions.json, - }; + //@ts-ignore + requestOptions.data = { ...requestOptions.qs, ...requestOptions.form }; - // Some RequestOptions have a URI and some have a URL - //@ts-ignores - if (requestOptions.url !== undefined) { - //@ts-ignore - newRequestOptions.url = requestOptions.url; - } else { - //@ts-ignore - newRequestOptions.url = requestOptions.uri; - } + //@ts-ignore + requestOptions.headers = oauth.toHeader(oauth.authorize(requestOptions, token)); - if (requestOptions.qs !== undefined) { - //@ts-ignore - newRequestOptions.qs = oauth.authorize(newRequestOptions as RequestOptions, token); - } else { - //@ts-ignore - newRequestOptions.form = oauth.authorize(newRequestOptions as RequestOptions, token); - } - - return this.helpers.request!(newRequestOptions) + return this.helpers.request!(requestOptions) .catch(async (error: IResponseError) => { // Unknown error so simply throw it throw error; diff --git a/packages/nodes-base/nodes/Twitter/DirectMessageDescription.ts b/packages/nodes-base/nodes/Twitter/DirectMessageDescription.ts new file mode 100644 index 0000000000..10aeae8be5 --- /dev/null +++ b/packages/nodes-base/nodes/Twitter/DirectMessageDescription.ts @@ -0,0 +1,98 @@ +import { + INodeProperties, +} from 'n8n-workflow'; + +export const directMessageOperations = [ + { + displayName: 'Operation', + name: 'operation', + type: 'options', + displayOptions: { + show: { + resource: [ + 'directMessage', + ], + }, + }, + options: [ + { + name: 'Create', + value: 'create', + description: 'Create a direct message', + }, + ], + default: 'create', + description: 'The operation to perform.', + }, +] as INodeProperties[]; + +export const directMessageFields = [ +/* -------------------------------------------------------------------------- */ +/* directMessage:create */ +/* -------------------------------------------------------------------------- */ + { + displayName: 'User ID', + name: 'userId', + type: 'string', + required: true, + default: '', + displayOptions: { + show: { + operation: [ + 'create', + ], + resource: [ + 'directMessage', + ], + }, + }, + description: 'The ID of the user who should receive the direct message.', + }, + { + displayName: 'Text', + name: 'text', + type: 'string', + typeOptions: { + alwaysOpenEditWindow: true, + }, + required: true, + default: '', + displayOptions: { + show: { + operation: [ + 'create', + ], + resource: [ + 'directMessage', + ], + }, + }, + description: 'The text of your Direct Message. URL encode as necessary. Max length of 10,000 characters.', + }, + { + displayName: 'Additional Fields', + name: 'additionalFields', + type: 'collection', + placeholder: 'Add Field', + default: {}, + displayOptions: { + show: { + operation: [ + 'create', + ], + resource: [ + 'directMessage', + ], + }, + }, + options: [ + { + displayName: 'Attachment', + name: 'attachment', + type: 'string', + default: 'data', + description: 'Name of the binary propertie which contain
data which should be added to directMessage as attachment.', + }, + ], + }, +] as INodeProperties[]; diff --git a/packages/nodes-base/nodes/Twitter/GenericFunctions.ts b/packages/nodes-base/nodes/Twitter/GenericFunctions.ts index bb2336eea5..3c1904312e 100644 --- a/packages/nodes-base/nodes/Twitter/GenericFunctions.ts +++ b/packages/nodes-base/nodes/Twitter/GenericFunctions.ts @@ -3,6 +3,7 @@ import { } from 'request'; import { + BINARY_ENCODING, IExecuteFunctions, IExecuteSingleFunctions, IHookFunctions, @@ -10,7 +11,8 @@ import { } from 'n8n-core'; import { - IDataObject, + IBinaryKeyData, + IDataObject, INodeExecutionData, } from 'n8n-workflow'; export async function twitterApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IHookFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise { // tslint:disable-line:no-any @@ -28,6 +30,9 @@ export async function twitterApiRequest(this: IExecuteFunctions | IExecuteSingle if (Object.keys(body).length === 0) { delete options.body; } + if (Object.keys(qs).length === 0) { + delete options.qs; + } //@ts-ignore return await this.helpers.requestOAuth1.call(this, 'twitterOAuth1Api', options); } catch (error) { @@ -74,3 +79,105 @@ export function chunks (buffer: Buffer, chunkSize: number) { return result; } + +export async function uploadAttachments(this: IExecuteFunctions, binaryProperties: string[], items: INodeExecutionData[], i: number) { + + const uploadUri = 'https://upload.twitter.com/1.1/media/upload.json'; + + const media: IDataObject[] = []; + + for (const binaryPropertyName of binaryProperties) { + + const binaryData = items[i].binary as IBinaryKeyData; + + if (binaryData === undefined) { + throw new Error('No binary data set. So file can not be written!'); + } + + if (!binaryData[binaryPropertyName]) { + continue; + } + + let attachmentBody = {}; + let response: IDataObject = {}; + + const isAnimatedWebp = (Buffer.from(binaryData[binaryPropertyName].data, 'base64').toString().indexOf('ANMF') !== -1); + + const isImage = binaryData[binaryPropertyName].mimeType.includes('image'); + + if (isImage && isAnimatedWebp) { + throw new Error('Animated .webp images are not supported use .gif instead'); + } + + if (isImage) { + + const attachmentBody = { + media_data: binaryData[binaryPropertyName].data, + }; + + response = await twitterApiRequest.call(this, 'POST', '', {}, {}, uploadUri, { form: attachmentBody }); + + media.push(response); + + } else { + + // https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-init + + attachmentBody = { + command: 'INIT', + total_bytes: Buffer.from(binaryData[binaryPropertyName].data, BINARY_ENCODING).byteLength, + media_type: binaryData[binaryPropertyName].mimeType, + }; + + response = await twitterApiRequest.call(this, 'POST', '', {}, {}, uploadUri, { form: attachmentBody }); + + const mediaId = response.media_id_string; + + // break the data on 5mb chunks (max size that can be uploaded at once) + + const binaryParts = chunks(Buffer.from(binaryData[binaryPropertyName].data, BINARY_ENCODING), 5242880); + + let index = 0; + + for (const binaryPart of binaryParts) { + + //https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-append + + attachmentBody = { + name: binaryData[binaryPropertyName].fileName, + command: 'APPEND', + media_id: mediaId, + media_data: Buffer.from(binaryPart).toString('base64'), + segment_index: index, + }; + + response = await twitterApiRequest.call(this, 'POST', '', {}, {}, uploadUri, { form: attachmentBody }); + + index++; + } + + //https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-finalize + + attachmentBody = { + command: 'FINALIZE', + media_id: mediaId, + }; + + response = await twitterApiRequest.call(this, 'POST', '', {}, {}, uploadUri, { form: attachmentBody }); + + // data has not been uploaded yet, so wait for it to be ready + if (response.processing_info) { + const { check_after_secs } = (response.processing_info as IDataObject); + await new Promise((resolve, reject) => { + setTimeout(() => { + resolve(); + }, (check_after_secs as number) * 1000); + }); + } + + media.push(response); + } + + return media; + } +} \ No newline at end of file diff --git a/packages/nodes-base/nodes/Twitter/Twitter.node.ts b/packages/nodes-base/nodes/Twitter/Twitter.node.ts index 4e546f135d..e242c921fe 100644 --- a/packages/nodes-base/nodes/Twitter/Twitter.node.ts +++ b/packages/nodes-base/nodes/Twitter/Twitter.node.ts @@ -1,12 +1,10 @@ import { - BINARY_ENCODING, IExecuteFunctions, ILoadOptionsFunctions, } from 'n8n-core'; import { - IBinaryKeyData, IDataObject, INodeExecutionData, INodePropertyOptions, @@ -14,21 +12,25 @@ import { INodeTypeDescription, } from 'n8n-workflow'; +import { + directMessageFields, + directMessageOperations, +} from './DirectMessageDescription'; + import { tweetFields, tweetOperations, } from './TweetDescription'; import { - chunks, twitterApiRequest, twitterApiRequestAllItems, + uploadAttachments, } from './GenericFunctions'; import { ITweet, } from './TweetInterface'; -import { isDate } from 'util'; const ISO6391 = require('iso-639-1'); @@ -59,6 +61,10 @@ export class Twitter implements INodeType { name: 'resource', type: 'options', options: [ + { + name: 'Direct Message', + value: 'directMessage', + }, { name: 'Tweet', value: 'tweet', @@ -67,6 +73,9 @@ export class Twitter implements INodeType { default: 'tweet', description: 'The resource to operate on.', }, + // DIRECT MESSAGE + ...directMessageOperations, + ...directMessageFields, // TWEET ...tweetOperations, ...tweetFields, @@ -101,6 +110,45 @@ export class Twitter implements INodeType { 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 === 'directMessage') { + //https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/new-event + if (operation === 'create') { + const userId = this.getNodeParameter('userId', i) as string; + const text = this.getNodeParameter('text', i) as string; + const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; + const body: IDataObject = { + type: 'message_create', + message_create: { + target: { + recipient_id: userId, + }, + message_data: { + text, + attachment: {}, + }, + }, + }; + + if (additionalFields.attachment) { + const attachment = additionalFields.attachment as string; + + const attachmentProperties: string[] = attachment.split(',').map((propertyName) => { + return propertyName.trim(); + }); + + const medias = await uploadAttachments.call(this, attachmentProperties, items, i); + //@ts-ignore + body.message_create.message_data.attachment = { type: 'media', media: { id: medias[0].media_id_string } }; + } else { + //@ts-ignore + delete body.message_create.message_data.attachment; + } + + responseData = await twitterApiRequest.call(this, 'POST', '/direct_messages/events/new.json', { event: body }); + + responseData = responseData.event; + } + } if (resource === 'tweet') { // https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update if (operation === 'create') { @@ -109,129 +157,43 @@ export class Twitter implements INodeType { const body: ITweet = { status: text, }; - + if (additionalFields.inReplyToStatusId) { body.in_reply_to_status_id = additionalFields.inReplyToStatusId as string; body.auto_populate_reply_metadata = true; } if (additionalFields.attachments) { - const mediaIds = []; + const attachments = additionalFields.attachments as string; - const uploadUri = 'https://upload.twitter.com/1.1/media/upload.json'; const attachmentProperties: string[] = attachments.split(',').map((propertyName) => { return propertyName.trim(); }); - for (const binaryPropertyName of attachmentProperties) { - - const binaryData = items[i].binary as IBinaryKeyData; - - if (binaryData === undefined) { - throw new Error('No binary data set. So file can not be written!'); - } - - if (!binaryData[binaryPropertyName]) { - continue; - } - - let attachmentBody = {}; - let response: IDataObject = {}; - - const isAnimatedWebp = (Buffer.from(binaryData[binaryPropertyName].data, 'base64').toString().indexOf('ANMF') !== -1); - - const isImage = binaryData[binaryPropertyName].mimeType.includes('image'); - - if (isImage && isAnimatedWebp) { - throw new Error('Animated .webp images are not supported use .gif instead'); - } - - if (isImage) { - - const attachmentBody = { - media_data: binaryData[binaryPropertyName].data, - }; - - response = await twitterApiRequest.call(this, 'POST', '', attachmentBody, {}, uploadUri); - - } else { - - // https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-init - - attachmentBody = { - command: 'INIT', - total_bytes: Buffer.from(binaryData[binaryPropertyName].data, BINARY_ENCODING).byteLength, - media_type: binaryData[binaryPropertyName].mimeType, - }; - - response = await twitterApiRequest.call(this, 'POST', '', attachmentBody, {}, uploadUri); - - const mediaId = response.media_id_string; - - // break the data on 5mb chunks (max size that can be uploaded at once) - - const binaryParts = chunks(Buffer.from(binaryData[binaryPropertyName].data, BINARY_ENCODING), 5242880); - - let index = 0; - - for (const binaryPart of binaryParts) { - - //https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-append - - attachmentBody = { - name: binaryData[binaryPropertyName].fileName, - command: 'APPEND', - media_id: mediaId, - media_data: Buffer.from(binaryPart).toString('base64'), - segment_index: index, - }; - - response = await twitterApiRequest.call(this, 'POST', '', attachmentBody, {}, uploadUri); - - index++; - } - - //https://developer.twitter.com/en/docs/media/upload-media/api-reference/post-media-upload-finalize - - attachmentBody = { - command: 'FINALIZE', - media_id: mediaId, - }; - - response = await twitterApiRequest.call(this, 'POST', '', attachmentBody, {}, uploadUri); - - // data has not been uploaded yet, so wait for it to be ready - if (response.processing_info) { - const { check_after_secs } = (response.processing_info as IDataObject); - await new Promise((resolve, reject) => { - setTimeout(() => { - resolve(); - }, (check_after_secs as number) * 1000); - }); - } - } - - mediaIds.push(response.media_id_string); - } - - body.media_ids = mediaIds.join(','); + const medias = await uploadAttachments.call(this, attachmentProperties, items, i); + + body.media_ids = (medias as IDataObject[]).map((media: IDataObject) => media.media_id_string).join(','); } if (additionalFields.possiblySensitive) { - body.possibly_sensitive = additionalFields.possibly_sensitive as boolean; + body.possibly_sensitive = additionalFields.possiblySensitive as boolean; + } + + if (additionalFields.displayCoordinates) { + body.display_coordinates = additionalFields.displayCoordinates as boolean; } if (additionalFields.locationFieldsUi) { const locationUi = additionalFields.locationFieldsUi as IDataObject; if (locationUi.locationFieldsValues) { const values = locationUi.locationFieldsValues as IDataObject; - body.lat = parseFloat(values.lalatitude as string); - body.long = parseFloat(values.lalatitude as string); + body.lat = parseFloat(values.latitude as string); + body.long = parseFloat(values.longitude as string); } } - responseData = await twitterApiRequest.call(this, 'POST', '/statuses/update.json', body); + responseData = await twitterApiRequest.call(this, 'POST', '/statuses/update.json', {}, body as unknown as IDataObject); } // https://developer.twitter.com/en/docs/tweets/search/api-reference/get-search-tweets if (operation === 'search') {