feat(reddit): add reddit integration

packages/backend/src/apps/reddit/assets/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" class="_1O4jTk-dZ-VIxsCuYB6OR8 " width="40"  height="48" ><g><circle fill="#FF4500" cx="10" cy="10" r="10"></circle><path fill="#FFFFFF" d="M16.67,10A1.46,1.46,0,0,0,14.2,9a7.12,7.12,0,0,0-3.85-1.23L11,4.65,13.14,5.1a1,1,0,1,0,.13-0.61L10.82,4a0.31,0.31,0,0,0-.37.24L9.71,7.71a7.14,7.14,0,0,0-3.9,1.23A1.46,1.46,0,1,0,4.2,11.33a2.87,2.87,0,0,0,0,.44c0,2.24,2.61,4.06,5.83,4.06s5.83-1.82,5.83-4.06a2.87,2.87,0,0,0,0-.44A1.46,1.46,0,0,0,16.67,10Zm-10,1a1,1,0,1,1,1,1A1,1,0,0,1,6.67,11Zm5.81,2.75a3.84,3.84,0,0,1-2.47.77,3.84,3.84,0,0,1-2.47-.77,0.27,0.27,0,0,1,.38-0.38A3.27,3.27,0,0,0,10,14a3.28,3.28,0,0,0,2.09-.61A0.27,0.27,0,1,1,12.48,13.79Zm-0.18-1.71a1,1,0,1,1,1-1A1,1,0,0,1,12.29,12.08Z"></path></g></svg>

packages/backend/src/apps/reddit/auth/generate-auth-url.ts

@@ -0,0 +1,26 @@
+import { IField, IGlobalVariable } from '@automatisch/types';
+import { URLSearchParams } from 'url';
+import authScope from '../common/auth-scope';
+
+export default async function generateAuthUrl($: IGlobalVariable) {
+  const oauthRedirectUrlField = $.app.auth.fields.find(
+    (field: IField) => field.key == 'oAuthRedirectUrl'
+  );
+  const redirectUri = oauthRedirectUrlField.value as string;
+  const state = Math.random().toString() as string;
+  const searchParams = new URLSearchParams({
+    client_id: $.auth.data.clientId as string,
+    response_type: 'code',
+    redirect_uri: redirectUri,
+    duration: 'permanent',
+    scope: authScope.join(' '),
+    state,
+  });
+
+  const url = `https://www.reddit.com/api/v1/authorize?${searchParams.toString()}`;
+
+  await $.auth.set({
+    url,
+    originalState: state,
+  });
+}

packages/backend/src/apps/reddit/auth/index.ts

@@ -0,0 +1,48 @@
+import generateAuthUrl from './generate-auth-url';
+import verifyCredentials from './verify-credentials';
+import refreshToken from './refresh-token';
+import isStillVerified from './is-still-verified';
+
+export default {
+  fields: [
+    {
+      key: 'oAuthRedirectUrl',
+      label: 'OAuth Redirect URL',
+      type: 'string' as const,
+      required: true,
+      readOnly: true,
+      value: '{WEB_APP_URL}/app/reddit/connections/add',
+      placeholder: null,
+      description:
+        'When asked to input a redirect URL in Reddit, enter the URL above.',
+      clickToCopy: true,
+    },
+    {
+      key: 'clientId',
+      label: 'Client ID',
+      type: 'string' as const,
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+    {
+      key: 'clientSecret',
+      label: 'Client Secret',
+      type: 'string' as const,
+      required: true,
+      readOnly: false,
+      value: null,
+      placeholder: null,
+      description: null,
+      clickToCopy: false,
+    },
+  ],
+
+  generateAuthUrl,
+  verifyCredentials,
+  isStillVerified,
+  refreshToken,
+};

packages/backend/src/apps/reddit/auth/is-still-verified.ts

@@ -0,0 +1,9 @@
+import { IGlobalVariable } from '@automatisch/types';
+import getCurrentUser from '../common/get-current-user';
+
+const isStillVerified = async ($: IGlobalVariable) => {
+  const currentUser = await getCurrentUser($);
+  return !!currentUser.id;
+};
+
+export default isStillVerified;

packages/backend/src/apps/reddit/auth/refresh-token.ts

@@ -0,0 +1,29 @@
+import { URLSearchParams } from 'node:url';
+import { IGlobalVariable } from '@automatisch/types';
+
+const refreshToken = async ($: IGlobalVariable) => {
+  const headers = {
+    Authorization: `Basic ${Buffer.from(
+      $.auth.data.clientId + ':' + $.auth.data.clientSecret
+    ).toString('base64')}`,
+  };
+  const params = new URLSearchParams({
+    grant_type: 'refresh_token',
+    refresh_token: $.auth.data.refreshToken as string,
+  });
+
+  const { data } = await $.http.post(
+    'https://www.reddit.com/api/v1/access_token',
+    params.toString(),
+    { headers }
+  );
+
+  await $.auth.set({
+    accessToken: data.access_token,
+    expiresIn: data.expires_in,
+    scope: data.scope,
+    tokenType: data.token_type,
+  });
+};
+
+export default refreshToken;

packages/backend/src/apps/reddit/auth/verify-credentials.ts

@@ -0,0 +1,48 @@
+import { IField, IGlobalVariable } from '@automatisch/types';
+import getCurrentUser from '../common/get-current-user';
+import { URLSearchParams } from 'url';
+
+const verifyCredentials = async ($: IGlobalVariable) => {
+  if ($.auth.data.originalState !== $.auth.data.state) {
+    throw new Error(`The 'state' parameter does not match.`);
+  }
+  const oauthRedirectUrlField = $.app.auth.fields.find(
+    (field: IField) => field.key == 'oAuthRedirectUrl'
+  );
+  const redirectUri = oauthRedirectUrlField.value as string;
+  const headers = {
+    Authorization: `Basic ${Buffer.from(
+      $.auth.data.clientId + ':' + $.auth.data.clientSecret
+    ).toString('base64')}`,
+  };
+  const params = new URLSearchParams({
+    grant_type: 'authorization_code',
+    code: $.auth.data.code as string,
+    redirect_uri: redirectUri,
+  });
+
+  const { data } = await $.http.post(
+    'https://www.reddit.com/api/v1/access_token',
+    params.toString(),
+    { headers }
+  );
+
+  await $.auth.set({
+    accessToken: data.access_token,
+    tokenType: data.token_type,
+  });
+
+  const currentUser = await getCurrentUser($);
+  const screenName = currentUser?.name;
+
+  await $.auth.set({
+    clientId: $.auth.data.clientId,
+    clientSecret: $.auth.data.clientSecret,
+    scope: $.auth.data.scope,
+    expiresIn: data.expires_in,
+    refreshToken: data.refresh_token,
+    screenName,
+  });
+};
+
+export default verifyCredentials;

packages/backend/src/apps/reddit/common/add-auth-header.ts

@@ -0,0 +1,11 @@
+import { TBeforeRequest } from '@automatisch/types';
+
+const addAuthHeader: TBeforeRequest = ($, requestConfig) => {
+  if ($.auth.data?.accessToken) {
+    requestConfig.headers.Authorization = `${$.auth.data.tokenType} ${$.auth.data.accessToken}`;
+  }
+
+  return requestConfig;
+};
+
+export default addAuthHeader;

packages/backend/src/apps/reddit/common/auth-scope.ts

@@ -0,0 +1,3 @@
+const authScope: string[] = ['identity', 'read', 'account', 'submit'];
+
+export default authScope;

packages/backend/src/apps/reddit/common/get-current-user.ts

@@ -0,0 +1,8 @@
+import { IGlobalVariable } from '@automatisch/types';
+
+const getCurrentUser = async ($: IGlobalVariable) => {
+  const { data: currentUser } = await $.http.get('/api/v1/me');
+  return currentUser;
+};
+
+export default getCurrentUser;

packages/backend/src/apps/reddit/index.ts

@@ -0,0 +1,16 @@
+import defineApp from '../../helpers/define-app';
+import addAuthHeader from './common/add-auth-header';
+import auth from './auth';
+
+export default defineApp({
+  name: 'Reddit',
+  key: 'reddit',
+  baseUrl: 'https://www.reddit.com',
+  apiBaseUrl: 'https://oauth.reddit.com',
+  iconUrl: '{BASE_URL}/apps/reddit/assets/favicon.svg',
+  authDocUrl: 'https://automatisch.io/docs/apps/reddit/connection',
+  primaryColor: 'FF4500',
+  supportsConnections: true,
+  beforeRequest: [addAuthHeader],
+  auth,
+});

packages/docs/pages/.vitepress/config.js

@@ -289,6 +289,12 @@ export default defineConfig({
             { text: 'Connection', link: '/apps/pushover/connection' },
           ],
         },
+        {
+          text: 'Reddit',
+          collapsible: true,
+          collapsed: true,
+          items: [{ text: 'Connection', link: '/apps/reddit/connection' }],
+        },
         {
           text: 'Remove.bg',
           collapsible: true,

packages/docs/pages/apps/reddit/connection.md

@@ -0,0 +1,15 @@
+# Reddit
+
+:::info
+This page explains the steps you need to follow to set up the Reddit
+connection in Automatisch. If any of the steps are outdated, please let us know!
+:::
+
+1. Go to [Reddit apps page](https://www.reddit.com/prefs/apps).
+2. Click on the **"are you a developer? create an app..."** button in order to create an app.
+3. Fill the **Name** field and choose **web app**.
+4. Copy **OAuth Redirect URL** from Automatisch to **redirect uri** field.
+5. Click on the **create app** button.
+6. Copy the client id below **web app** text to the `Client ID` field on Automatisch.
+7. Copy the **secret** value to the `Client Secret` field on Automatisch.
+8. Start using Reddit integration with Automatisch!

packages/docs/pages/public/favicons/reddit.svg

@@ -0,0 +1 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" class="_1O4jTk-dZ-VIxsCuYB6OR8 " width="40"  height="48" ><g><circle fill="#FF4500" cx="10" cy="10" r="10"></circle><path fill="#FFFFFF" d="M16.67,10A1.46,1.46,0,0,0,14.2,9a7.12,7.12,0,0,0-3.85-1.23L11,4.65,13.14,5.1a1,1,0,1,0,.13-0.61L10.82,4a0.31,0.31,0,0,0-.37.24L9.71,7.71a7.14,7.14,0,0,0-3.9,1.23A1.46,1.46,0,1,0,4.2,11.33a2.87,2.87,0,0,0,0,.44c0,2.24,2.61,4.06,5.83,4.06s5.83-1.82,5.83-4.06a2.87,2.87,0,0,0,0-.44A1.46,1.46,0,0,0,16.67,10Zm-10,1a1,1,0,1,1,1,1A1,1,0,0,1,6.67,11Zm5.81,2.75a3.84,3.84,0,0,1-2.47.77,3.84,3.84,0,0,1-2.47-.77,0.27,0.27,0,0,1,.38-0.38A3.27,3.27,0,0,0,10,14a3.28,3.28,0,0,0,2.09-.61A0.27,0.27,0,1,1,12.48,13.79Zm-0.18-1.71a1,1,0,1,1,1-1A1,1,0,0,1,12.29,12.08Z"></path></g></svg>