forked from pocketbase/pocketbase
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[pocketbase#887] added Spotify OAuth2 provider
- Loading branch information
Showing
35 changed files
with
121 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,6 +41,8 @@ func TestSettingsValidate(t *testing.T) { | |
s.TwitterAuth.ClientId = "" | ||
s.MicrosoftAuth.Enabled = true | ||
s.MicrosoftAuth.ClientId = "" | ||
s.SpotifyAuth.Enabled = true | ||
s.SpotifyAuth.ClientId = "" | ||
|
||
// check if Validate() is triggering the members validate methods. | ||
err := s.Validate() | ||
|
@@ -66,6 +68,7 @@ func TestSettingsValidate(t *testing.T) { | |
`"discordAuth":{`, | ||
`"twitterAuth":{`, | ||
`"microsoftAuth":{`, | ||
`"spotifyAuth":{`, | ||
} | ||
|
||
errBytes, _ := json.Marshal(err) | ||
|
@@ -108,6 +111,8 @@ func TestSettingsMerge(t *testing.T) { | |
s2.TwitterAuth.ClientId = "twitter_test" | ||
s2.MicrosoftAuth.Enabled = true | ||
s2.MicrosoftAuth.ClientId = "microsoft_test" | ||
s2.SpotifyAuth.Enabled = true | ||
s2.SpotifyAuth.ClientId = "spotify_test" | ||
|
||
if err := s1.Merge(s2); err != nil { | ||
t.Fatal(err) | ||
|
@@ -176,6 +181,7 @@ func TestSettingsRedactClone(t *testing.T) { | |
s1.DiscordAuth.ClientSecret = "test123" | ||
s1.TwitterAuth.ClientSecret = "test123" | ||
s1.MicrosoftAuth.ClientSecret = "test123" | ||
s1.SpotifyAuth.ClientSecret = "test123" | ||
|
||
s2, err := s1.RedactClone() | ||
if err != nil { | ||
|
@@ -187,7 +193,7 @@ func TestSettingsRedactClone(t *testing.T) { | |
t.Fatal(err) | ||
} | ||
|
||
expected := `{"meta":{"appName":"test123","appUrl":"http://localhost:8090","hideControls":false,"senderName":"Support","senderAddress":"[email protected]","verificationTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eThank you for joining us at {APP_NAME}.\u003c/p\u003e\n\u003cp\u003eClick on the button below to verify your email address.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eVerify\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Verify your {APP_NAME} email","actionUrl":"{APP_URL}/_/#/auth/confirm-verification/{TOKEN}"},"resetPasswordTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eClick on the button below to reset your password.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eReset password\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\u003ci\u003eIf you didn't ask to reset your password, you can ignore this email.\u003c/i\u003e\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Reset your {APP_NAME} password","actionUrl":"{APP_URL}/_/#/auth/confirm-password-reset/{TOKEN}"},"confirmEmailChangeTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eClick on the button below to confirm your new email address.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eConfirm new email\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\u003ci\u003eIf you didn't ask to change your email address, you can ignore this email.\u003c/i\u003e\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Confirm your {APP_NAME} new email address","actionUrl":"{APP_URL}/_/#/auth/confirm-email-change/{TOKEN}"}},"logs":{"maxDays":5},"smtp":{"enabled":false,"host":"smtp.example.com","port":587,"username":"","password":"******","tls":true},"s3":{"enabled":false,"bucket":"","region":"","endpoint":"","accessKey":"","secret":"******","forcePathStyle":false},"adminAuthToken":{"secret":"******","duration":1209600},"adminPasswordResetToken":{"secret":"******","duration":1800},"recordAuthToken":{"secret":"******","duration":1209600},"recordPasswordResetToken":{"secret":"******","duration":1800},"recordEmailChangeToken":{"secret":"******","duration":1800},"recordVerificationToken":{"secret":"******","duration":604800},"emailAuth":{"enabled":false,"exceptDomains":null,"onlyDomains":null,"minPasswordLength":0},"googleAuth":{"enabled":false,"clientSecret":"******"},"facebookAuth":{"enabled":false,"clientSecret":"******"},"githubAuth":{"enabled":false,"clientSecret":"******"},"gitlabAuth":{"enabled":false,"clientSecret":"******"},"discordAuth":{"enabled":false,"clientSecret":"******"},"twitterAuth":{"enabled":false,"clientSecret":"******"},"microsoftAuth":{"enabled":false,"clientSecret":"******"}}` | ||
expected := `{"meta":{"appName":"test123","appUrl":"http://localhost:8090","hideControls":false,"senderName":"Support","senderAddress":"[email protected]","verificationTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eThank you for joining us at {APP_NAME}.\u003c/p\u003e\n\u003cp\u003eClick on the button below to verify your email address.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eVerify\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Verify your {APP_NAME} email","actionUrl":"{APP_URL}/_/#/auth/confirm-verification/{TOKEN}"},"resetPasswordTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eClick on the button below to reset your password.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eReset password\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\u003ci\u003eIf you didn't ask to reset your password, you can ignore this email.\u003c/i\u003e\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Reset your {APP_NAME} password","actionUrl":"{APP_URL}/_/#/auth/confirm-password-reset/{TOKEN}"},"confirmEmailChangeTemplate":{"body":"\u003cp\u003eHello,\u003c/p\u003e\n\u003cp\u003eClick on the button below to confirm your new email address.\u003c/p\u003e\n\u003cp\u003e\n \u003ca class=\"btn\" href=\"{ACTION_URL}\" target=\"_blank\" rel=\"noopener\"\u003eConfirm new email\u003c/a\u003e\n\u003c/p\u003e\n\u003cp\u003e\u003ci\u003eIf you didn't ask to change your email address, you can ignore this email.\u003c/i\u003e\u003c/p\u003e\n\u003cp\u003e\n Thanks,\u003cbr/\u003e\n {APP_NAME} team\n\u003c/p\u003e","subject":"Confirm your {APP_NAME} new email address","actionUrl":"{APP_URL}/_/#/auth/confirm-email-change/{TOKEN}"}},"logs":{"maxDays":5},"smtp":{"enabled":false,"host":"smtp.example.com","port":587,"username":"","password":"******","tls":true},"s3":{"enabled":false,"bucket":"","region":"","endpoint":"","accessKey":"","secret":"******","forcePathStyle":false},"adminAuthToken":{"secret":"******","duration":1209600},"adminPasswordResetToken":{"secret":"******","duration":1800},"recordAuthToken":{"secret":"******","duration":1209600},"recordPasswordResetToken":{"secret":"******","duration":1800},"recordEmailChangeToken":{"secret":"******","duration":1800},"recordVerificationToken":{"secret":"******","duration":604800},"emailAuth":{"enabled":false,"exceptDomains":null,"onlyDomains":null,"minPasswordLength":0},"googleAuth":{"enabled":false,"clientSecret":"******"},"facebookAuth":{"enabled":false,"clientSecret":"******"},"githubAuth":{"enabled":false,"clientSecret":"******"},"gitlabAuth":{"enabled":false,"clientSecret":"******"},"discordAuth":{"enabled":false,"clientSecret":"******"},"twitterAuth":{"enabled":false,"clientSecret":"******"},"microsoftAuth":{"enabled":false,"clientSecret":"******"},"spotifyAuth":{"enabled":false,"clientSecret":"******"}}` | ||
|
||
if encodedStr := string(encoded); encodedStr != expected { | ||
t.Fatalf("Expected\n%v\ngot\n%v", expected, encodedStr) | ||
|
@@ -205,6 +211,7 @@ func TestNamedAuthProviderConfigs(t *testing.T) { | |
s.DiscordAuth.ClientId = "discord_test" | ||
s.TwitterAuth.ClientId = "twitter_test" | ||
s.MicrosoftAuth.ClientId = "microsoft_test" | ||
s.SpotifyAuth.ClientId = "spotify_test" | ||
|
||
result := s.NamedAuthProviderConfigs() | ||
|
||
|
@@ -213,7 +220,7 @@ func TestNamedAuthProviderConfigs(t *testing.T) { | |
t.Fatal(err) | ||
} | ||
|
||
expected := `{"discord":{"enabled":false,"clientId":"discord_test"},"facebook":{"enabled":false,"clientId":"facebook_test"},"github":{"enabled":false,"clientId":"github_test"},"gitlab":{"enabled":true,"clientId":"gitlab_test"},"google":{"enabled":false,"clientId":"google_test"},"microsoft":{"enabled":false,"clientId":"microsoft_test"},"twitter":{"enabled":false,"clientId":"twitter_test"}}` | ||
expected := `{"discord":{"enabled":false,"clientId":"discord_test"},"facebook":{"enabled":false,"clientId":"facebook_test"},"github":{"enabled":false,"clientId":"github_test"},"gitlab":{"enabled":true,"clientId":"gitlab_test"},"google":{"enabled":false,"clientId":"google_test"},"microsoft":{"enabled":false,"clientId":"microsoft_test"},"spotify":{"enabled":false,"clientId":"spotify_test"},"twitter":{"enabled":false,"clientId":"twitter_test"}}` | ||
|
||
if encodedStr := string(encoded); encodedStr != expected { | ||
t.Fatalf("Expected the same serialization, got \n%v", encodedStr) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
package auth | ||
|
||
import ( | ||
"golang.org/x/oauth2" | ||
"golang.org/x/oauth2/spotify" | ||
) | ||
|
||
var _ Provider = (*Spotify)(nil) | ||
|
||
// NameSpotify is the unique name of the Spotify provider. | ||
const NameSpotify string = "spotify" | ||
|
||
// Spotify allows authentication via Spotify OAuth2. | ||
type Spotify struct { | ||
*baseProvider | ||
} | ||
|
||
// NewSpotifyProvider creates a new Spotify provider instance with some defaults. | ||
func NewSpotifyProvider() *Spotify { | ||
return &Spotify{&baseProvider{ | ||
scopes: []string{"user-read-private", "user-read-email"}, | ||
authUrl: spotify.Endpoint.AuthURL, | ||
tokenUrl: spotify.Endpoint.TokenURL, | ||
userApiUrl: "https://api.spotify.com/v1/me", | ||
}} | ||
} | ||
|
||
// FetchAuthUser returns an AuthUser instance based on the Spotify's user api. | ||
func (p *Spotify) FetchAuthUser(token *oauth2.Token) (*AuthUser, error) { | ||
// https://developer.spotify.com/documentation/web-api/reference/#/operations/get-current-users-profile | ||
rawData := struct { | ||
Id string `json:"id"` | ||
Name string `json:"display_name"` | ||
Email string `json:"email"` | ||
Images []struct { | ||
Url string `json:"url"` | ||
} `json:"images"` | ||
}{} | ||
|
||
if err := p.FetchRawUserData(token, &rawData); err != nil { | ||
return nil, err | ||
} | ||
|
||
user := &AuthUser{ | ||
Id: rawData.Id, | ||
Name: rawData.Name, | ||
Email: rawData.Email, | ||
} | ||
if len(rawData.Images) > 0 { | ||
user.AvatarUrl = rawData.Images[0].Url | ||
} | ||
|
||
return user, nil | ||
} |
2 changes: 1 addition & 1 deletion
2
ui/dist/assets/AuthMethodsDocs.eae43462.js → ui/dist/assets/AuthMethodsDocs.c1281d2c.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
ui/dist/assets/AuthRefreshDocs.7509da38.js → ui/dist/assets/AuthRefreshDocs.9e6993e7.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.