diff --git a/packages/backend/src/apps/google-forms/assets/favicon.svg b/packages/backend/src/apps/google-forms/assets/favicon.svg new file mode 100644 index 00000000..5413d433 --- /dev/null +++ b/packages/backend/src/apps/google-forms/assets/favicon.svg @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/packages/backend/src/apps/google-forms/auth/generate-auth-url.ts b/packages/backend/src/apps/google-forms/auth/generate-auth-url.ts new file mode 100644 index 00000000..ea89f8a4 --- /dev/null +++ b/packages/backend/src/apps/google-forms/auth/generate-auth-url.ts @@ -0,0 +1,24 @@ +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 searchParams = new URLSearchParams({ + client_id: $.auth.data.clientId as string, + redirect_uri: redirectUri, + prompt: 'select_account', + scope: authScope.join(' '), + response_type: 'code', + access_type: 'offline', + }); + + const url = `https://accounts.google.com/o/oauth2/v2/auth?${searchParams.toString()}`; + + await $.auth.set({ + url, + }); +} diff --git a/packages/backend/src/apps/google-forms/auth/index.ts b/packages/backend/src/apps/google-forms/auth/index.ts new file mode 100644 index 00000000..90d9686e --- /dev/null +++ b/packages/backend/src/apps/google-forms/auth/index.ts @@ -0,0 +1,51 @@ +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/google-forms/connections/add', + placeholder: null, + description: + 'When asked to input an OAuth callback or redirect URL in Github OAuth, enter the URL above.', + docUrl: 'https://automatisch.io/docs/github#oauth-redirect-url', + clickToCopy: true, + }, + { + key: 'clientId', + label: 'Client ID', + type: 'string' as const, + required: true, + readOnly: false, + value: null, + placeholder: null, + description: null, + docUrl: 'https://automatisch.io/docs/google-forms#client-id', + clickToCopy: false, + }, + { + key: 'clientSecret', + label: 'Client Secret', + type: 'string' as const, + required: true, + readOnly: false, + value: null, + placeholder: null, + description: null, + docUrl: 'https://automatisch.io/docs/google-forms#client-secret', + clickToCopy: false, + }, + ], + + generateAuthUrl, + verifyCredentials, + isStillVerified, + refreshToken, +}; diff --git a/packages/backend/src/apps/google-forms/auth/is-still-verified.ts b/packages/backend/src/apps/google-forms/auth/is-still-verified.ts new file mode 100644 index 00000000..c46fa18b --- /dev/null +++ b/packages/backend/src/apps/google-forms/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.resourceName; +}; + +export default isStillVerified; diff --git a/packages/backend/src/apps/google-forms/auth/refresh-token.ts b/packages/backend/src/apps/google-forms/auth/refresh-token.ts new file mode 100644 index 00000000..17d0c4cc --- /dev/null +++ b/packages/backend/src/apps/google-forms/auth/refresh-token.ts @@ -0,0 +1,26 @@ +import { URLSearchParams } from 'node:url'; +import { IGlobalVariable } from '@automatisch/types'; +import authScope from '../common/auth-scope'; + +const refreshToken = async ($: IGlobalVariable) => { + const params = new URLSearchParams({ + client_id: $.auth.data.clientId as string, + client_secret: $.auth.data.clientSecret as string, + grant_type: 'refresh_token', + refresh_token: $.auth.data.refreshToken as string, + }); + + const { data } = await $.http.post( + 'https://oauth2.googleapis.com/token', + params.toString() + ); + + await $.auth.set({ + accessToken: data.access_token, + expiresIn: data.expires_in, + scope: authScope.join(' '), + tokenType: data.token_type, + }); +}; + +export default refreshToken; diff --git a/packages/backend/src/apps/google-forms/auth/verify-credentials.ts b/packages/backend/src/apps/google-forms/auth/verify-credentials.ts new file mode 100644 index 00000000..124e73c1 --- /dev/null +++ b/packages/backend/src/apps/google-forms/auth/verify-credentials.ts @@ -0,0 +1,57 @@ +import { IField, IGlobalVariable } from '@automatisch/types'; +import getCurrentUser from '../common/get-current-user'; + +type TUser = { + displayName: string; + metadata: { + primary: boolean; + }; +}; + +type TEmailAddress = { + value: string; + metadata: { + primary: boolean; + }; +}; + +const verifyCredentials = async ($: IGlobalVariable) => { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field: IField) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value as string; + const { data } = await $.http.post(`https://oauth2.googleapis.com/token`, { + client_id: $.auth.data.clientId, + client_secret: $.auth.data.clientSecret, + code: $.auth.data.code, + grant_type: 'authorization_code', + redirect_uri: redirectUri, + }); + + await $.auth.set({ + accessToken: data.access_token, + tokenType: data.token_type, + }); + + const currentUser = await getCurrentUser($); + + const { displayName } = currentUser.names.find( + (name: TUser) => name.metadata.primary + ); + const { value: email } = currentUser.emailAddresses.find( + (emailAddress: TEmailAddress) => emailAddress.metadata.primary + ); + + await $.auth.set({ + clientId: $.auth.data.clientId, + clientSecret: $.auth.data.clientSecret, + scope: $.auth.data.scope, + idToken: data.id_token, + expiresIn: data.expires_in, + refreshToken: data.refresh_token, + resourceName: currentUser.resourceName, + screenName: `${displayName} - ${email}`, + }); +}; + +export default verifyCredentials; diff --git a/packages/backend/src/apps/google-forms/common/add-auth-header.ts b/packages/backend/src/apps/google-forms/common/add-auth-header.ts new file mode 100644 index 00000000..12bb4a62 --- /dev/null +++ b/packages/backend/src/apps/google-forms/common/add-auth-header.ts @@ -0,0 +1,11 @@ +import { TBeforeRequest } from '@automatisch/types'; + +const addAuthHeader: TBeforeRequest = ($, requestConfig) => { + if (requestConfig.headers && $.auth.data?.accessToken) { + requestConfig.headers.Authorization = `${$.auth.data.tokenType} ${$.auth.data.accessToken}`; + } + + return requestConfig; +}; + +export default addAuthHeader; diff --git a/packages/backend/src/apps/google-forms/common/auth-scope.ts b/packages/backend/src/apps/google-forms/common/auth-scope.ts new file mode 100644 index 00000000..397255c3 --- /dev/null +++ b/packages/backend/src/apps/google-forms/common/auth-scope.ts @@ -0,0 +1,9 @@ +const authScope: string[] = [ + 'https://www.googleapis.com/auth/forms.body.readonly', + 'https://www.googleapis.com/auth/forms.responses.readonly', + 'https://www.googleapis.com/auth/drive.readonly', + 'https://www.googleapis.com/auth/userinfo.email', + 'profile', +]; + +export default authScope; diff --git a/packages/backend/src/apps/google-forms/common/get-current-user.ts b/packages/backend/src/apps/google-forms/common/get-current-user.ts new file mode 100644 index 00000000..724fe1ac --- /dev/null +++ b/packages/backend/src/apps/google-forms/common/get-current-user.ts @@ -0,0 +1,10 @@ +import { IGlobalVariable } from '@automatisch/types'; + +const getCurrentUser = async ($: IGlobalVariable) => { + const { data: currentUser } = await $.http.get( + 'https://people.googleapis.com/v1/people/me?personFields=names,emailAddresses' + ); + return currentUser; +}; + +export default getCurrentUser; diff --git a/packages/backend/src/apps/google-forms/dynamic-data/index.ts b/packages/backend/src/apps/google-forms/dynamic-data/index.ts new file mode 100644 index 00000000..cb6cd053 --- /dev/null +++ b/packages/backend/src/apps/google-forms/dynamic-data/index.ts @@ -0,0 +1,3 @@ +import listForms from './list-forms'; + +export default [listForms]; diff --git a/packages/backend/src/apps/google-forms/dynamic-data/list-forms/index.ts b/packages/backend/src/apps/google-forms/dynamic-data/list-forms/index.ts new file mode 100644 index 00000000..8acd0298 --- /dev/null +++ b/packages/backend/src/apps/google-forms/dynamic-data/list-forms/index.ts @@ -0,0 +1,34 @@ +import { IGlobalVariable, IJSONObject } from '@automatisch/types'; + +export default { + name: 'List forms', + key: 'listForms', + + async run($: IGlobalVariable) { + const forms: { + data: IJSONObject[]; + } = { + data: [], + }; + + const params = { + q: `mimeType='application/vnd.google-apps.form'`, + spaces: 'drive', + pageToken: undefined as unknown as string, + }; + + do { + const { data } = await $.http.get(`https://www.googleapis.com/drive/v3/files`, { params }); + params.pageToken = data.nextPageToken; + + for (const file of data.files) { + forms.data.push({ + value: file.id, + name: file.name, + }); + } + } while (params.pageToken); + + return forms; + }, +}; diff --git a/packages/backend/src/apps/google-forms/index.d.ts b/packages/backend/src/apps/google-forms/index.d.ts new file mode 100644 index 00000000..e69de29b diff --git a/packages/backend/src/apps/google-forms/index.ts b/packages/backend/src/apps/google-forms/index.ts new file mode 100644 index 00000000..2114432f --- /dev/null +++ b/packages/backend/src/apps/google-forms/index.ts @@ -0,0 +1,20 @@ +import defineApp from '../../helpers/define-app'; +import addAuthHeader from './common/add-auth-header'; +import auth from './auth'; +import triggers from './triggers'; +import dynamicData from './dynamic-data'; + +export default defineApp({ + name: 'Google Forms', + key: 'google-forms', + baseUrl: 'https://docs.google.com/forms', + apiBaseUrl: 'https://forms.googleapis.com', + iconUrl: '{BASE_URL}/apps/google-forms/assets/favicon.svg', + authDocUrl: 'https://automatisch.io/docs/apps/google-forms/connection', + primaryColor: '673AB7', + supportsConnections: true, + beforeRequest: [addAuthHeader], + auth, + triggers, + dynamicData, +}); diff --git a/packages/backend/src/apps/google-forms/triggers/index.ts b/packages/backend/src/apps/google-forms/triggers/index.ts new file mode 100644 index 00000000..7c035992 --- /dev/null +++ b/packages/backend/src/apps/google-forms/triggers/index.ts @@ -0,0 +1,3 @@ +import newFormResponses from './new-form-responses'; + +export default [newFormResponses]; diff --git a/packages/backend/src/apps/google-forms/triggers/new-form-responses/index.ts b/packages/backend/src/apps/google-forms/triggers/new-form-responses/index.ts new file mode 100644 index 00000000..187229a5 --- /dev/null +++ b/packages/backend/src/apps/google-forms/triggers/new-form-responses/index.ts @@ -0,0 +1,33 @@ +import defineTrigger from '../../../../helpers/define-trigger'; +import newFormResponses from './new-form-responses'; + +export default defineTrigger({ + name: 'New Form Responses', + key: 'newFormResponses', + pollInterval: 15, + description: 'Triggers when a new form response is submitted.', + arguments: [ + { + label: 'Form', + key: 'formId', + type: 'dropdown' as const, + required: true, + description: 'Pick a form to receive form responses.', + variables: false, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listForms', + }, + ], + }, + }, + ], + + async run($) { + await newFormResponses($); + }, +}); diff --git a/packages/backend/src/apps/google-forms/triggers/new-form-responses/new-form-responses.ts b/packages/backend/src/apps/google-forms/triggers/new-form-responses/new-form-responses.ts new file mode 100644 index 00000000..97c6fae8 --- /dev/null +++ b/packages/backend/src/apps/google-forms/triggers/new-form-responses/new-form-responses.ts @@ -0,0 +1,28 @@ +import { IGlobalVariable } from '@automatisch/types'; + +const newResponses = async ($: IGlobalVariable) => { + const params = { + pageToken: undefined as unknown as string, + }; + + do { + const pathname = `/v1/forms/${$.step.parameters.formId}/responses`; + const { data } = await $.http.get(pathname, { params }); + params.pageToken = data.nextPageToken; + + if (data.responses?.length) { + for (const formResponse of data.responses) { + const dataItem = { + raw: formResponse, + meta: { + internalId: formResponse.responseId, + }, + }; + + $.pushTriggerItem(dataItem); + } + } + } while (params.pageToken); +}; + +export default newResponses; diff --git a/packages/web/src/components/AddAppConnection/index.tsx b/packages/web/src/components/AddAppConnection/index.tsx index e1581b3b..bf5c3b7b 100644 --- a/packages/web/src/components/AddAppConnection/index.tsx +++ b/packages/web/src/components/AddAppConnection/index.tsx @@ -116,7 +116,11 @@ export default function AddAppConnection( sx={{ mt: 1, fontWeight: 500, wordBreak: 'break-all' }} > {error.message} - {error.details && 
{JSON.stringify(error.details, null, 2)}
} + {error.details && ( + 
+              {JSON.stringify(error.details, null, 2)}
+
+ )} )} diff --git a/packages/web/src/components/TestSubstep/index.tsx b/packages/web/src/components/TestSubstep/index.tsx index b7c3c764..f76f2f3a 100644 --- a/packages/web/src/components/TestSubstep/index.tsx +++ b/packages/web/src/components/TestSubstep/index.tsx @@ -32,7 +32,7 @@ function serializeErrors(graphQLErrors: any) { return { ...error, message: ( - 
+          
             {JSON.stringify(JSON.parse(error.message as string), null, 2)}
           

         ),