diff --git a/packages/backend/src/apps/strava/actions/create-totals-and-stats-report/index.ts b/packages/backend/src/apps/strava/actions/create-totals-and-stats-report/index.ts new file mode 100644 index 00000000..dd755fce --- /dev/null +++ b/packages/backend/src/apps/strava/actions/create-totals-and-stats-report/index.ts @@ -0,0 +1,15 @@ +import defineAction from '../../../../helpers/define-action'; + +export default defineAction({ + name: 'Create totals and stats report', + key: 'createTotalsAndStatsReport', + description: 'Create a report with recent, year to date, and all time stats of your activities', + + async run($) { + const { data } = await $.http.get(`/v3/athletes/${$.auth.data.athleteId}/stats`); + + $.setActionItem({ + raw: data, + }); + }, +}); diff --git a/packages/backend/src/apps/strava/actions/index.ts b/packages/backend/src/apps/strava/actions/index.ts new file mode 100644 index 00000000..df9e1d5c --- /dev/null +++ b/packages/backend/src/apps/strava/actions/index.ts @@ -0,0 +1,3 @@ +import createTotalsAndStatsReport from "./create-totals-and-stats-report"; + +export default [createTotalsAndStatsReport]; diff --git a/packages/backend/src/apps/strava/assets/favicon.svg b/packages/backend/src/apps/strava/assets/favicon.svg new file mode 100644 index 00000000..ddd7c855 --- /dev/null +++ b/packages/backend/src/apps/strava/assets/favicon.svg @@ -0,0 +1,6 @@ + \ No newline at end of file diff --git a/packages/backend/src/apps/strava/auth/generate-auth-url.ts b/packages/backend/src/apps/strava/auth/generate-auth-url.ts new file mode 100644 index 00000000..185a1ad1 --- /dev/null +++ b/packages/backend/src/apps/strava/auth/generate-auth-url.ts @@ -0,0 +1,20 @@ +import { URLSearchParams } from 'node:url'; +import { IField, IGlobalVariable } from '@automatisch/types'; + +export default async function createAuthData($: 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, + approval_prompt: 'force', + response_type: 'code', + scope: 'read_all,profile:read_all,activity:read_all,activity:write', + }); + + await $.auth.set({ + url: `${$.app.baseUrl}/oauth/authorize?${searchParams}`, + }); +} diff --git a/packages/backend/src/apps/strava/auth/index.ts b/packages/backend/src/apps/strava/auth/index.ts new file mode 100644 index 00000000..df7d9b0d --- /dev/null +++ b/packages/backend/src/apps/strava/auth/index.ts @@ -0,0 +1,48 @@ +import generateAuthUrl from './generate-auth-url'; +import verifyCredentials from './verify-credentials'; +import isStillVerified from './is-still-verified'; +import refreshToken from './refresh-token'; + +export default { + fields: [ + { + key: 'oAuthRedirectUrl', + label: 'OAuth Redirect URL', + type: 'string' as const, + required: true, + readOnly: true, + value: '{WEB_APP_URL}/app/strava/connections/add', + placeholder: null, + description: + 'When asked to input an OAuth callback or redirect URL in Strava OAuth, 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, +}; diff --git a/packages/backend/src/apps/strava/auth/is-still-verified.ts b/packages/backend/src/apps/strava/auth/is-still-verified.ts new file mode 100644 index 00000000..d36919f2 --- /dev/null +++ b/packages/backend/src/apps/strava/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 user = await getCurrentUser($); + return !!user; +}; + +export default isStillVerified; diff --git a/packages/backend/src/apps/strava/auth/refresh-token.ts b/packages/backend/src/apps/strava/auth/refresh-token.ts new file mode 100644 index 00000000..6f5b623f --- /dev/null +++ b/packages/backend/src/apps/strava/auth/refresh-token.ts @@ -0,0 +1,26 @@ +import { IGlobalVariable } from '@automatisch/types'; + +const refreshToken = async ($: IGlobalVariable) => { + const params = { + 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( + '/v3/oauth/token', + null, + { params } + ); + + await $.auth.set({ + accessToken: data.access_token, + expiresIn: data.expires_in, + expiresAt: data.expires_at, + tokenType: data.token_type, + refreshToken: data.refresh_token, + }); +}; + +export default refreshToken; diff --git a/packages/backend/src/apps/strava/auth/verify-credentials.ts b/packages/backend/src/apps/strava/auth/verify-credentials.ts new file mode 100644 index 00000000..ea539036 --- /dev/null +++ b/packages/backend/src/apps/strava/auth/verify-credentials.ts @@ -0,0 +1,25 @@ +import { IGlobalVariable } from '@automatisch/types'; + +const verifyCredentials = async ($: IGlobalVariable) => { + const params = { + client_id: $.auth.data.clientId as string, + client_secret: $.auth.data.clientSecret as string, + code: $.auth.data.code as string, + grant_type: 'authorization_code', + }; + const { data } = await $.http.post( + '/v3/oauth/token', + null, + { params } + ); + + await $.auth.set({ + accessToken: data.access_token, + refreshToken: data.refresh_token, + tokenType: data.token_type, + athleteId: data.athlete.id, + screenName: `${data.athlete.firstname} ${data.athlete.lastname}`, + }); +}; + +export default verifyCredentials; diff --git a/packages/backend/src/apps/strava/common/add-auth-header.ts b/packages/backend/src/apps/strava/common/add-auth-header.ts new file mode 100644 index 00000000..2420110a --- /dev/null +++ b/packages/backend/src/apps/strava/common/add-auth-header.ts @@ -0,0 +1,13 @@ +import { TBeforeRequest } from '@automatisch/types'; + +const addAuthHeader: TBeforeRequest = ($, requestConfig) => { + const { accessToken, tokenType } = $.auth.data; + + if (accessToken && tokenType) { + requestConfig.headers.Authorization = `${tokenType} ${accessToken}`; + } + + return requestConfig; +}; + +export default addAuthHeader; diff --git a/packages/backend/src/apps/strava/common/get-current-user.ts b/packages/backend/src/apps/strava/common/get-current-user.ts new file mode 100644 index 00000000..0765be96 --- /dev/null +++ b/packages/backend/src/apps/strava/common/get-current-user.ts @@ -0,0 +1,10 @@ +import { IGlobalVariable, IJSONObject } from '@automatisch/types'; + +const getCurrentUser = async ($: IGlobalVariable): Promise => { + const response = await $.http.get('/v3/athlete'); + const currentUser = response.data; + + return currentUser; +}; + +export default getCurrentUser; diff --git a/packages/backend/src/apps/strava/index.d.ts b/packages/backend/src/apps/strava/index.d.ts new file mode 100644 index 00000000..e69de29b diff --git a/packages/backend/src/apps/strava/index.ts b/packages/backend/src/apps/strava/index.ts new file mode 100644 index 00000000..83706fbb --- /dev/null +++ b/packages/backend/src/apps/strava/index.ts @@ -0,0 +1,18 @@ +import defineApp from '../../helpers/define-app'; +import addAuthHeader from './common/add-auth-header'; +import actions from './actions'; +import auth from './auth'; + +export default defineApp({ + name: 'Strava', + key: 'strava', + iconUrl: '{BASE_URL}/apps/strava/assets/favicon.svg', + authDocUrl: 'https://automatisch.io/docs/connections/strava', + supportsConnections: true, + baseUrl: 'https://www.strava.com', + apiBaseUrl: 'https://www.strava.com/api', + primaryColor: 'fc4c01', + beforeRequest: [addAuthHeader], + auth, + actions, +}); diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index 85915902..6e204aca 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -206,6 +206,15 @@ export default defineConfig({ { text: 'Connection', link: '/apps/spotify/connection' }, ], }, + { + text: 'Strava', + collapsible: true, + collapsed: true, + items: [ + { text: 'Actions', link: '/apps/strava/actions' }, + { text: 'Connection', link: '/apps/strava/connection' }, + ], + }, { text: 'Stripe', collapsible: true, diff --git a/packages/docs/pages/apps/strava/actions.md b/packages/docs/pages/apps/strava/actions.md new file mode 100644 index 00000000..1bd2ff94 --- /dev/null +++ b/packages/docs/pages/apps/strava/actions.md @@ -0,0 +1,12 @@ +--- +favicon: /favicons/strava.svg +items: + - name: Create Totals and Stats Report + desc: Creates a report with recent, year to date, and all time stats of your activities. +--- + + + + diff --git a/packages/docs/pages/apps/strava/connection.md b/packages/docs/pages/apps/strava/connection.md new file mode 100644 index 00000000..0060fc06 --- /dev/null +++ b/packages/docs/pages/apps/strava/connection.md @@ -0,0 +1,14 @@ +# Strava + +:::info +This page explains the steps you need to follow to set up the Strava connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +1. Go to the [link](https://www.strava.com/settings/api) to create an app on Strava API. +1. Click on **Upload** button to upload your APP icon. +1. Click on **Edit** button. +1. Copy **OAuth Redirect URL** from Automatisch and paste it in **Authorization Callback Domain** +1. Click on **Save** button. +1. Copy **Client ID** from Strava and paste it in **Client ID** field on Automatisch. +1. Copy **Client Secret** from Strava and paste it in **Client Secret** field on Automatisch. +1. Now, you can start using the Strava connection with Automatisch. diff --git a/packages/docs/pages/guide/available-apps.md b/packages/docs/pages/guide/available-apps.md index 1909c0f4..b0127ae8 100644 --- a/packages/docs/pages/guide/available-apps.md +++ b/packages/docs/pages/guide/available-apps.md @@ -24,6 +24,7 @@ Following integrations are currently supported by Automatisch. - [Slack](/apps/slack/actions) - [SMTP](/apps/smtp/actions) - [Spotify](/apps/spotify/actions) +- [Strava](/apps/strava/actions) - [Stripe](/apps/stripe/triggers) - [Telegram](/apps/telegram-bot/actions) - [Todoist](/apps/todoist/triggers) diff --git a/packages/docs/pages/public/favicons/strava.svg b/packages/docs/pages/public/favicons/strava.svg new file mode 100644 index 00000000..ddd7c855 --- /dev/null +++ b/packages/docs/pages/public/favicons/strava.svg @@ -0,0 +1,6 @@ + \ No newline at end of file