mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-17 10:02:05 +00:00
✨ Add Reddit Node (#1345)
* Set up initial scaffolding and auth * Add grant type to credentials * Add Account operations and OAuth2 request * Add post submission functionality * Refactor resources into resource descriptions * Refactor request for no auth URL * Refactor submission description for consistency * Add listing resource * Refactor My Account resource into details * Add request for all items * Add listings for specific subreddits * Fix minor linting details * Add subreddit resource * Add All-Reddit and Subreddit resource descriptions * Adjust display options for credentials * Add subreddit search functionality * Clean up auth parameter * Add user resource with GET endpoint * Add user description * Add submission search and commenting functionality * Clean up logging and comments * Fix minor details * Fix casing in properties * Add dividers to execute() method * Refactor per feedback * Remove unused description * Add punctuation to property descriptions * Fix resources indentation * Add resource dividers * Remove deprecated sidebar option * Make subreddit:get responses consistent * Remove returnAll and limit from subreddit:get * Flatten user:get response for about * Rename comment target property * Remove best property from post:getAll * Enrich subreddit search by keyword operation * Remove unneeded scopes * Add endpoint documentation * Add scaffolding for post comment * Add all operations for postComment resource * Add all operations for post resource * Refactor subreddit:getAll * Fix postComment:getAll * Flatten responses for profile:get * ⚡ Improvements * Fix response traversal for postComment:add * Flatten response for postComment:reply * Fix subreddit:getAll with keyword search * Fix pagination to enforce limit * Wrap unauthenticated API call in try-catch block * Add 404 error for empty array responses * Revert "Fix pagination to enforce limit" This reverts commit 72548d952378a2f899517522b5ba4950a940c6e4. * Turn user:get (gilded) into listing * ⚡ Small improvement * ⚡ Improve Reddit-Node Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
This commit is contained in:
Iván Ovejero
425
packages/nodes-base/nodes/Reddit/Reddit.node.ts
Normal file
425
packages/nodes-base/nodes/Reddit/Reddit.node.ts
Normal file
@@ -0,0 +1,425 @@
|
||||
import {
|
||||
IExecuteFunctions,
|
||||
} from 'n8n-core';
|
||||
|
||||
import {
|
||||
IDataObject,
|
||||
INodeExecutionData,
|
||||
INodeType,
|
||||
INodeTypeDescription,
|
||||
} from 'n8n-workflow';
|
||||
|
||||
import {
|
||||
handleListing,
|
||||
redditApiRequest,
|
||||
} from './GenericFunctions';
|
||||
|
||||
import {
|
||||
postCommentFields,
|
||||
postCommentOperations,
|
||||
} from './PostCommentDescription';
|
||||
|
||||
import {
|
||||
postFields,
|
||||
postOperations,
|
||||
} from './PostDescription';
|
||||
|
||||
import {
|
||||
profileFields,
|
||||
profileOperations,
|
||||
} from './ProfileDescription';
|
||||
|
||||
import {
|
||||
subredditFields,
|
||||
subredditOperations,
|
||||
} from './SubredditDescription';
|
||||
|
||||
import {
|
||||
userFields,
|
||||
userOperations,
|
||||
} from './UserDescription';
|
||||
|
||||
export class Reddit implements INodeType {
|
||||
description: INodeTypeDescription = {
|
||||
displayName: 'Reddit',
|
||||
name: 'reddit',
|
||||
icon: 'file:reddit.svg',
|
||||
group: ['transform'],
|
||||
version: 1,
|
||||
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
||||
description: 'Consume the Reddit API',
|
||||
defaults: {
|
||||
name: 'Reddit',
|
||||
color: '#ff5700',
|
||||
},
|
||||
inputs: ['main'],
|
||||
outputs: ['main'],
|
||||
credentials: [
|
||||
{
|
||||
name: 'redditOAuth2Api',
|
||||
required: true,
|
||||
displayOptions: {
|
||||
show: {
|
||||
resource: [
|
||||
'postComment',
|
||||
'post',
|
||||
'profile',
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
properties: [
|
||||
{
|
||||
displayName: 'Resource',
|
||||
name: 'resource',
|
||||
type: 'options',
|
||||
options: [
|
||||
{
|
||||
name: 'Post',
|
||||
value: 'post',
|
||||
},
|
||||
{
|
||||
name: 'Post Comment',
|
||||
value: 'postComment',
|
||||
},
|
||||
{
|
||||
name: 'Profile',
|
||||
value: 'profile',
|
||||
},
|
||||
{
|
||||
name: 'Subreddit',
|
||||
value: 'subreddit',
|
||||
},
|
||||
{
|
||||
name: 'User',
|
||||
value: 'user',
|
||||
},
|
||||
],
|
||||
default: 'post',
|
||||
description: 'Resource to consume',
|
||||
},
|
||||
...postCommentOperations,
|
||||
...postCommentFields,
|
||||
...profileOperations,
|
||||
...profileFields,
|
||||
...subredditOperations,
|
||||
...subredditFields,
|
||||
...postOperations,
|
||||
...postFields,
|
||||
...userOperations,
|
||||
...userFields,
|
||||
],
|
||||
};
|
||||
|
||||
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
||||
const items = this.getInputData();
|
||||
|
||||
const resource = this.getNodeParameter('resource', 0) as string;
|
||||
const operation = this.getNodeParameter('operation', 0) as string;
|
||||
|
||||
let responseData;
|
||||
const returnData: IDataObject[] = [];
|
||||
|
||||
for (let i = 0; i < items.length; i++) {
|
||||
|
||||
// *********************************************************************
|
||||
// post
|
||||
// *********************************************************************
|
||||
|
||||
if (resource === 'post') {
|
||||
|
||||
if (operation === 'create') {
|
||||
// ----------------------------------
|
||||
// post: create
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#POST_api_submit
|
||||
|
||||
const qs: IDataObject = {
|
||||
title: this.getNodeParameter('title', i),
|
||||
sr: this.getNodeParameter('subreddit', i),
|
||||
kind: this.getNodeParameter('kind', i),
|
||||
};
|
||||
|
||||
qs.kind === 'self'
|
||||
? qs.text = this.getNodeParameter('text', i)
|
||||
: qs.url = this.getNodeParameter('url', i);
|
||||
|
||||
if (qs.url) {
|
||||
qs.resubmit = this.getNodeParameter('resubmit', i);
|
||||
}
|
||||
|
||||
responseData = await redditApiRequest.call(this, 'POST', 'api/submit', qs);
|
||||
|
||||
responseData = responseData.json.data;
|
||||
|
||||
} else if (operation === 'delete') {
|
||||
// ----------------------------------
|
||||
// post: delete
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#POST_api_del
|
||||
|
||||
const postTypePrefix = 't3_';
|
||||
|
||||
const qs: IDataObject = {
|
||||
id: postTypePrefix + this.getNodeParameter('postId', i),
|
||||
};
|
||||
|
||||
await redditApiRequest.call(this, 'POST', 'api/del', qs);
|
||||
|
||||
responseData = { success: true };
|
||||
|
||||
} else if (operation === 'get') {
|
||||
// ----------------------------------
|
||||
// post: get
|
||||
// ----------------------------------
|
||||
|
||||
const subreddit = this.getNodeParameter('subreddit', i);
|
||||
const postId = this.getNodeParameter('postId', i) as string;
|
||||
const endpoint = `r/${subreddit}/comments/${postId}.json`;
|
||||
|
||||
responseData = await redditApiRequest.call(this, 'GET', endpoint, {});
|
||||
responseData = responseData[0].data.children[0].data;
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
// ----------------------------------
|
||||
// post: getAll
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#GET_hot
|
||||
// https://www.reddit.com/dev/api/#GET_new
|
||||
// https://www.reddit.com/dev/api/#GET_rising
|
||||
// https://www.reddit.com/dev/api/#GET_{sort}
|
||||
|
||||
const subreddit = this.getNodeParameter('subreddit', i);
|
||||
let endpoint = `r/${subreddit}.json`;
|
||||
|
||||
const { category } = this.getNodeParameter('filters', i) as { category: string };
|
||||
if (category) {
|
||||
endpoint = `r/${subreddit}/${category}.json`;
|
||||
}
|
||||
|
||||
responseData = await handleListing.call(this, i, endpoint);
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'postComment') {
|
||||
|
||||
// *********************************************************************
|
||||
// postComment
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'create') {
|
||||
// ----------------------------------
|
||||
// postComment: create
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#POST_api_comment
|
||||
|
||||
const postTypePrefix = 't3_';
|
||||
|
||||
const qs: IDataObject = {
|
||||
text: this.getNodeParameter('commentText', i),
|
||||
thing_id: postTypePrefix + this.getNodeParameter('postId', i),
|
||||
};
|
||||
|
||||
responseData = await redditApiRequest.call(this, 'POST', 'api/comment', qs);
|
||||
responseData = responseData.json.data.things[0].data;
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
// ----------------------------------
|
||||
// postComment: getAll
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/r/{subrreddit}/comments/{postId}.json
|
||||
|
||||
const subreddit = this.getNodeParameter('subreddit', i);
|
||||
const postId = this.getNodeParameter('postId', i) as string;
|
||||
const endpoint = `r/${subreddit}/comments/${postId}.json`;
|
||||
|
||||
responseData = await handleListing.call(this, i, endpoint);
|
||||
|
||||
} else if (operation === 'delete') {
|
||||
// ----------------------------------
|
||||
// postComment: delete
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#POST_api_del
|
||||
|
||||
const commentTypePrefix = 't1_';
|
||||
|
||||
const qs: IDataObject = {
|
||||
id: commentTypePrefix + this.getNodeParameter('commentId', i),
|
||||
};
|
||||
|
||||
await redditApiRequest.call(this, 'POST', 'api/del', qs);
|
||||
|
||||
responseData = { success: true };
|
||||
|
||||
} else if (operation === 'reply') {
|
||||
// ----------------------------------
|
||||
// postComment: reply
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#POST_api_comment
|
||||
|
||||
const commentTypePrefix = 't1_';
|
||||
|
||||
const qs: IDataObject = {
|
||||
text: this.getNodeParameter('replyText', i),
|
||||
thing_id: commentTypePrefix + this.getNodeParameter('commentId', i),
|
||||
};
|
||||
|
||||
responseData = await redditApiRequest.call(this, 'POST', 'api/comment', qs);
|
||||
responseData = responseData.json.data.things[0].data;
|
||||
}
|
||||
|
||||
} else if (resource === 'profile') {
|
||||
// *********************************************************************
|
||||
// pprofile
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'get') {
|
||||
// ----------------------------------
|
||||
// profile: get
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#GET_api_v1_me
|
||||
// https://www.reddit.com/dev/api/#GET_api_v1_me_karma
|
||||
// https://www.reddit.com/dev/api/#GET_api_v1_me_prefs
|
||||
// https://www.reddit.com/dev/api/#GET_api_v1_me_trophies
|
||||
// https://www.reddit.com/dev/api/#GET_prefs_{where}
|
||||
|
||||
const endpoints: { [key: string]: string } = {
|
||||
identity: 'me',
|
||||
blockedUsers: 'me/blocked',
|
||||
friends: 'me/friends',
|
||||
karma: 'me/karma',
|
||||
prefs: 'me/prefs',
|
||||
trophies: 'me/trophies',
|
||||
};
|
||||
|
||||
const details = this.getNodeParameter('details', i) as string;
|
||||
const endpoint = `api/v1/${endpoints[details]}`;
|
||||
responseData = await redditApiRequest.call(this, 'GET', endpoint, {});
|
||||
|
||||
if (details === 'identity') {
|
||||
responseData = responseData.features;
|
||||
} else if (details === 'friends') {
|
||||
responseData = responseData.data.children;
|
||||
if (!responseData.length) {
|
||||
throw new Error('Reddit error response [404]: Not Found');
|
||||
}
|
||||
} else if (details === 'karma') {
|
||||
responseData = responseData.data;
|
||||
if (!responseData.length) {
|
||||
throw new Error('Reddit error response [404]: Not Found');
|
||||
}
|
||||
} else if (details === 'trophies') {
|
||||
responseData = responseData.data.trophies.map((trophy: IDataObject) => trophy.data);
|
||||
}
|
||||
}
|
||||
|
||||
} else if (resource === 'subreddit') {
|
||||
|
||||
// *********************************************************************
|
||||
// subreddit
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'get') {
|
||||
// ----------------------------------
|
||||
// subreddit: get
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#GET_r_{subreddit}_about
|
||||
// https://www.reddit.com/dev/api/#GET_r_{subreddit}_about_rules
|
||||
|
||||
const subreddit = this.getNodeParameter('subreddit', i);
|
||||
const content = this.getNodeParameter('content', i) as string;
|
||||
const endpoint = `r/${subreddit}/about/${content}.json`;
|
||||
|
||||
responseData = await redditApiRequest.call(this, 'GET', endpoint, {});
|
||||
|
||||
if (content === 'rules') {
|
||||
responseData = responseData.rules;
|
||||
} else if (content === 'about') {
|
||||
responseData = responseData.data;
|
||||
}
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
// ----------------------------------
|
||||
// subreddit: getAll
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#GET_api_trending_subreddits
|
||||
// https://www.reddit.com/dev/api/#POST_api_search_subreddits
|
||||
// https://www.reddit.com/r/subreddits.json
|
||||
|
||||
const filters = this.getNodeParameter('filters', i) as IDataObject;
|
||||
|
||||
if (filters.trending) {
|
||||
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
|
||||
const endpoint = 'api/trending_subreddits.json';
|
||||
responseData = await redditApiRequest.call(this, 'GET', endpoint, {});
|
||||
responseData = responseData.subreddit_names.map((name: string) => ({ name }));
|
||||
if (returnAll === false) {
|
||||
const limit = this.getNodeParameter('limit', 0) as number;
|
||||
responseData = responseData.splice(0, limit);
|
||||
}
|
||||
|
||||
} else if (filters.keyword) {
|
||||
const qs: IDataObject = {};
|
||||
qs.query = filters.keyword;
|
||||
|
||||
const endpoint = 'api/search_subreddits.json';
|
||||
responseData = await redditApiRequest.call(this, 'POST', endpoint, qs);
|
||||
|
||||
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
|
||||
|
||||
if (returnAll === false) {
|
||||
const limit = this.getNodeParameter('limit', 0) as number;
|
||||
responseData = responseData.subreddits.splice(0, limit);
|
||||
}
|
||||
} else {
|
||||
const endpoint = 'r/subreddits.json';
|
||||
responseData = await handleListing.call(this, i, endpoint);
|
||||
}
|
||||
}
|
||||
|
||||
} else if (resource === 'user') {
|
||||
// *********************************************************************
|
||||
// user
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// user: get
|
||||
// ----------------------------------
|
||||
|
||||
// https://www.reddit.com/dev/api/#GET_user_{username}_{where}
|
||||
|
||||
const username = this.getNodeParameter('username', i) as string;
|
||||
const details = this.getNodeParameter('details', i) as string;
|
||||
const endpoint = `user/${username}/${details}.json`;
|
||||
|
||||
responseData = details === 'about'
|
||||
? await redditApiRequest.call(this, 'GET', endpoint, {})
|
||||
: await handleListing.call(this, i, endpoint);
|
||||
|
||||
if (details === 'about') {
|
||||
responseData = responseData.data;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Array.isArray(responseData)
|
||||
? returnData.push(...responseData)
|
||||
: returnData.push(responseData);
|
||||
}
|
||||
|
||||
return [this.helpers.returnJsonArray(returnData)];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user