diff --git a/packages/backend/src/apps/google-tasks/assets/favicon.svg b/packages/backend/src/apps/google-tasks/assets/favicon.svg new file mode 100644 index 00000000..1de5d7ab --- /dev/null +++ b/packages/backend/src/apps/google-tasks/assets/favicon.svg @@ -0,0 +1,16 @@ + + + + + + + + + diff --git a/packages/backend/src/apps/google-tasks/auth/generate-auth-url.js b/packages/backend/src/apps/google-tasks/auth/generate-auth-url.js new file mode 100644 index 00000000..c972ae16 --- /dev/null +++ b/packages/backend/src/apps/google-tasks/auth/generate-auth-url.js @@ -0,0 +1,23 @@ +import { URLSearchParams } from 'url'; +import authScope from '../common/auth-scope.js'; + +export default async function generateAuthUrl($) { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value; + const searchParams = new URLSearchParams({ + client_id: $.auth.data.clientId, + 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-tasks/auth/index.js b/packages/backend/src/apps/google-tasks/auth/index.js new file mode 100644 index 00000000..eefda57c --- /dev/null +++ b/packages/backend/src/apps/google-tasks/auth/index.js @@ -0,0 +1,48 @@ +import generateAuthUrl from './generate-auth-url.js'; +import verifyCredentials from './verify-credentials.js'; +import refreshToken from './refresh-token.js'; +import isStillVerified from './is-still-verified.js'; + +export default { + fields: [ + { + key: 'oAuthRedirectUrl', + label: 'OAuth Redirect URL', + type: 'string', + required: true, + readOnly: true, + value: '{WEB_APP_URL}/app/google-tasks/connections/add', + placeholder: null, + description: + 'When asked to input a redirect URL in Google Cloud, enter the URL above.', + clickToCopy: true, + }, + { + key: 'clientId', + label: 'Client ID', + type: 'string', + required: true, + readOnly: false, + value: null, + placeholder: null, + description: null, + clickToCopy: false, + }, + { + key: 'clientSecret', + label: 'Client Secret', + type: 'string', + required: true, + readOnly: false, + value: null, + placeholder: null, + description: null, + clickToCopy: false, + }, + ], + + generateAuthUrl, + verifyCredentials, + isStillVerified, + refreshToken, +}; diff --git a/packages/backend/src/apps/google-tasks/auth/is-still-verified.js b/packages/backend/src/apps/google-tasks/auth/is-still-verified.js new file mode 100644 index 00000000..68f4d7db --- /dev/null +++ b/packages/backend/src/apps/google-tasks/auth/is-still-verified.js @@ -0,0 +1,8 @@ +import getCurrentUser from '../common/get-current-user.js'; + +const isStillVerified = async ($) => { + const currentUser = await getCurrentUser($); + return !!currentUser.resourceName; +}; + +export default isStillVerified; diff --git a/packages/backend/src/apps/google-tasks/auth/refresh-token.js b/packages/backend/src/apps/google-tasks/auth/refresh-token.js new file mode 100644 index 00000000..f706ffa7 --- /dev/null +++ b/packages/backend/src/apps/google-tasks/auth/refresh-token.js @@ -0,0 +1,25 @@ +import { URLSearchParams } from 'node:url'; +import authScope from '../common/auth-scope.js'; + +const refreshToken = async ($) => { + const params = new URLSearchParams({ + client_id: $.auth.data.clientId, + client_secret: $.auth.data.clientSecret, + grant_type: 'refresh_token', + refresh_token: $.auth.data.refreshToken, + }); + + 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-tasks/auth/verify-credentials.js b/packages/backend/src/apps/google-tasks/auth/verify-credentials.js new file mode 100644 index 00000000..a636b72c --- /dev/null +++ b/packages/backend/src/apps/google-tasks/auth/verify-credentials.js @@ -0,0 +1,42 @@ +import getCurrentUser from '../common/get-current-user.js'; + +const verifyCredentials = async ($) => { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value; + 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) => name.metadata.primary + ); + const { value: email } = currentUser.emailAddresses.find( + (emailAddress) => 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-tasks/common/add-auth-header.js b/packages/backend/src/apps/google-tasks/common/add-auth-header.js new file mode 100644 index 00000000..02477aa4 --- /dev/null +++ b/packages/backend/src/apps/google-tasks/common/add-auth-header.js @@ -0,0 +1,9 @@ +const addAuthHeader = ($, requestConfig) => { + if ($.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-tasks/common/auth-scope.js b/packages/backend/src/apps/google-tasks/common/auth-scope.js new file mode 100644 index 00000000..030adb80 --- /dev/null +++ b/packages/backend/src/apps/google-tasks/common/auth-scope.js @@ -0,0 +1,7 @@ +const authScope = [ + 'https://www.googleapis.com/auth/tasks', + 'https://www.googleapis.com/auth/userinfo.email', + 'https://www.googleapis.com/auth/userinfo.profile', +]; + +export default authScope; diff --git a/packages/backend/src/apps/google-tasks/common/get-current-user.js b/packages/backend/src/apps/google-tasks/common/get-current-user.js new file mode 100644 index 00000000..2663ad20 --- /dev/null +++ b/packages/backend/src/apps/google-tasks/common/get-current-user.js @@ -0,0 +1,8 @@ +const getCurrentUser = async ($) => { + 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-tasks/index.js b/packages/backend/src/apps/google-tasks/index.js new file mode 100644 index 00000000..9b23d099 --- /dev/null +++ b/packages/backend/src/apps/google-tasks/index.js @@ -0,0 +1,16 @@ +import defineApp from '../../helpers/define-app.js'; +import addAuthHeader from './common/add-auth-header.js'; +import auth from './auth/index.js'; + +export default defineApp({ + name: 'Google Tasks', + key: 'google-tasks', + baseUrl: 'https://calendar.google.com/calendar/u/0/r/tasks', + apiBaseUrl: 'https://tasks.googleapis.com', + iconUrl: '{BASE_URL}/apps/google-tasks/assets/favicon.svg', + authDocUrl: 'https://automatisch.io/docs/apps/google-tasks/connection', + primaryColor: '0066DA', + supportsConnections: true, + beforeRequest: [addAuthHeader], + auth, +}); diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index 04d3fdcf..15dfc3fd 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -169,6 +169,14 @@ export default defineConfig({ { text: 'Connection', link: '/apps/google-sheets/connection' }, ], }, + { + text: 'Google Tasks', + collapsible: true, + collapsed: true, + items: [ + { text: 'Connection', link: '/apps/google-tasks/connection' }, + ], + }, { text: 'HTTP Request', collapsible: true, @@ -305,7 +313,7 @@ export default defineConfig({ collapsed: true, items: [ { text: 'Actions', link: '/apps/removebg/actions' }, - { text: 'Connection', link: '/apps/removebg/connection' } + { text: 'Connection', link: '/apps/removebg/connection' }, ], }, { diff --git a/packages/docs/pages/apps/google-tasks/connection.md b/packages/docs/pages/apps/google-tasks/connection.md new file mode 100644 index 00000000..c09c62df --- /dev/null +++ b/packages/docs/pages/apps/google-tasks/connection.md @@ -0,0 +1,28 @@ +# Google Tasks + +:::info +This page explains the steps you need to follow to set up the Google Tasks +connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +1. Go to the [Google Cloud Console](https://console.cloud.google.com) to create a project. +2. Click on the project drop-down menu at the top of the page, and click on the **New Project** button. +3. Enter a name for your project and click on the **Create** button. +4. Go to [API Library](https://console.cloud.google.com/apis/library) in Google Cloud console. +5. Search for **Google Tasks API** in the search bar and click on it. +6. Click on the **Enable** button to enable the API. +7. Repeat steps 5 and 6 for the **People API**. +8. Go to [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) in Google Cloud console. +9. Select **External** here for starting your app in testing mode at first. Click on the **Create** button. +10. Fill **App Name**, **User Support Email**, and **Developer Contact Information**. Click on the **Save and Continue** button. +11. Skip adding or removing scopes and click on the **Save and Continue** button. +12. Click on the **Add Users** button and add a test email because only test users can access the app while publishing status is set to "Testing". +13. Click on the **Save and Continue** button and now you have configured the consent screen. +14. Go to [Credentials](https://console.cloud.google.com/apis/credentials) in Google Cloud console. +15. Click on the **Create Credentials** button and select the **OAuth client ID** option. +16. Select the application type as **Web application** and fill the **Name** field. +17. Copy **OAuth Redirect URL** from Automatisch to **Authorized redirect URIs** field, and click on the **Create** button. +18. Copy the **Your Client ID** value from the following popup to the `Client ID` field on Automatisch. +19. Copy the **Your Client Secret** value from the following popup to the `Client Secret` field on Automatisch. +20. Click **Submit** button on Automatisch. +21. Congrats! Start using your new Google Tasks connection within the flows. diff --git a/packages/docs/pages/public/favicons/google-tasks.svg b/packages/docs/pages/public/favicons/google-tasks.svg new file mode 100644 index 00000000..1de5d7ab --- /dev/null +++ b/packages/docs/pages/public/favicons/google-tasks.svg @@ -0,0 +1,16 @@ + + + + + + + + +