feat: DA provider (not tested)

Author: YSX7

apis/settings_test.go

@@ -85,6 +85,7 @@ func TestSettingsList(t *testing.T) {
 				`"patreonAuth":{`,
 				`"mailcowAuth":{`,
 				`"bitbucketAuth":{`,
+				`"donationalertsAuth":{`,
 				`"planningcenterAuth":{`,
 				`"secret":"******"`,
 				`"clientSecret":"******"`,
@@ -172,6 +173,7 @@ func TestSettingsSet(t *testing.T) {
 				`"patreonAuth":{`,
 				`"mailcowAuth":{`,
 				`"bitbucketAuth":{`,
+				`"donationalertsAuth":{`,
 				`"planningcenterAuth":{`,
 				`"secret":"******"`,
 				`"clientSecret":"******"`,
@@ -246,6 +248,7 @@ func TestSettingsSet(t *testing.T) {
 				`"patreonAuth":{`,
 				`"mailcowAuth":{`,
 				`"bitbucketAuth":{`,
+				`"donationalertsAuth":{`,
 				`"planningcenterAuth":{`,
 				`"secret":"******"`,
 				`"clientSecret":"******"`,

models/settings/settings.go

@@ -67,6 +67,7 @@ type Settings struct {
 	MailcowAuth        AuthProviderConfig `form:"mailcowAuth" json:"mailcowAuth"`
 	BitbucketAuth      AuthProviderConfig `form:"bitbucketAuth" json:"bitbucketAuth"`
 	PlanningcenterAuth AuthProviderConfig `form:"planningcenterAuth" json:"planningcenterAuth"`
+	DonationAlertsAuth AuthProviderConfig `form:"donationalertsAuth" json:"donationalertsAuth"`
 }
 
 // New creates and returns a new default Settings instance.
@@ -204,6 +205,9 @@ func New() *Settings {
 		PlanningcenterAuth: AuthProviderConfig{
 			Enabled: false,
 		},
+		DonationAlertsAuth: AuthProviderConfig{
+			Enabled: false,
+		},
 	}
 }
 
@@ -251,6 +255,7 @@ func (s *Settings) Validate() error {
 		validation.Field(&s.MailcowAuth),
 		validation.Field(&s.BitbucketAuth),
 		validation.Field(&s.PlanningcenterAuth),
+		validation.Field(&s.DonationAlertsAuth),
 	)
 }
 
@@ -321,6 +326,7 @@ func (s *Settings) RedactClone() (*Settings, error) {
 		&clone.MailcowAuth.ClientSecret,
 		&clone.BitbucketAuth.ClientSecret,
 		&clone.PlanningcenterAuth.ClientSecret,
+		&clone.DonationAlertsAuth.ClientSecret,
 	}
 
 	// mask all sensitive fields
@@ -365,6 +371,7 @@ func (s *Settings) NamedAuthProviderConfigs() map[string]AuthProviderConfig {
 		auth.NameMailcow:        s.MailcowAuth,
 		auth.NameBitbucket:      s.BitbucketAuth,
 		auth.NamePlanningcenter: s.PlanningcenterAuth,
+		auth.NameDonationAlerts: s.DonationAlertsAuth,
 	}
 }
 

models/settings/settings_test.go

@@ -82,6 +82,8 @@ func TestSettingsValidate(t *testing.T) {
 	s.BitbucketAuth.ClientId = ""
 	s.PlanningcenterAuth.Enabled = true
 	s.PlanningcenterAuth.ClientId = ""
+	s.DonationAlertsAuth.Enabled = true
+	s.DonationAlertsAuth.ClientId = ""
 
 	// check if Validate() is triggering the members validate methods.
 	err := s.Validate()
@@ -127,6 +129,7 @@ func TestSettingsValidate(t *testing.T) {
 		`"mailcowAuth":{`,
 		`"bitbucketAuth":{`,
 		`"planningcenterAuth":{`,
+		`"donationAlertsAuth":{`,
 	}
 
 	errBytes, _ := json.Marshal(err)
@@ -208,6 +211,8 @@ func TestSettingsMerge(t *testing.T) {
 	s2.BitbucketAuth.ClientId = "bitbucket_test"
 	s2.PlanningcenterAuth.Enabled = true
 	s2.PlanningcenterAuth.ClientId = "planningcenter_test"
+	s2.DonationAlertsAuth.Enabled = true
+	s2.DonationAlertsAuth.ClientId = "donationalerts_test"
 
 	if err := s1.Merge(s2); err != nil {
 		t.Fatal(err)
@@ -302,6 +307,7 @@ func TestSettingsRedactClone(t *testing.T) {
 	s1.MailcowAuth.ClientSecret = testSecret
 	s1.BitbucketAuth.ClientSecret = testSecret
 	s1.PlanningcenterAuth.ClientSecret = testSecret
+	s1.DonationAlertsAuth.ClientSecret = testSecret
 
 	s1Bytes, err := json.Marshal(s1)
 	if err != nil {
@@ -364,6 +370,7 @@ func TestNamedAuthProviderConfigs(t *testing.T) {
 	s.MailcowAuth.ClientId = "mailcow_test"
 	s.BitbucketAuth.ClientId = "bitbucket_test"
 	s.PlanningcenterAuth.ClientId = "planningcenter_test"
+	s.DonationAlertsAuth.ClientId = "donationalerts_test"
 
 	result := s.NamedAuthProviderConfigs()
 
@@ -399,6 +406,7 @@ func TestNamedAuthProviderConfigs(t *testing.T) {
 		`"mailcow":{"enabled":false,"clientId":"mailcow_test"`,
 		`"bitbucket":{"enabled":false,"clientId":"bitbucket_test"`,
 		`"planningcenter":{"enabled":false,"clientId":"planningcenter_test"`,
+		`"donationalerts":{"enabled":false,"clientId":"donationalerts_test"`,
 	}
 	for _, p := range expectedParts {
 		if !strings.Contains(encodedStr, p) {

tools/auth/auth.go

@@ -158,6 +158,8 @@ func NewProviderByName(name string) (Provider, error) {
 		return NewBitbucketProvider(), nil
 	case NamePlanningcenter:
 		return NewPlanningcenterProvider(), nil
+	case NameDonationAlerts:
+		return NewDonationAlertsProvider(), nil
 	default:
 		return nil, errors.New("Missing provider " + name)
 	}

tools/auth/auth_test.go

@@ -243,4 +243,13 @@ func TestNewProviderByName(t *testing.T) {
 	if _, ok := p.(*auth.Planningcenter); !ok {
 		t.Error("Expected to be instance of *auth.Planningcenter")
 	}
+
+	// donationalerts
+	p, err = auth.NewProviderByName(auth.NameDonationAlerts)
+	if err != nil {
+		t.Errorf("Expected nil, got error %v", err)
+	}
+	if _, ok := p.(*auth.DonationAlerts); !ok {
+		t.Error("Expected to be instance of *auth.DonationAlerts")
+	}
 }

tools/auth/donationalerts.go

@@ -0,0 +1,77 @@
+package auth
+
+import (
+	"context"
+	"encoding/json"
+	"strconv"
+
+	"github.com/pocketbase/pocketbase/tools/types"
+	"golang.org/x/oauth2"
+)
+
+var _ Provider = (*DonationAlerts)(nil)
+
+// NameDonationAlerts is the unique name of the Donation Alerts provider.
+const NameDonationAlerts string = "donationalerts"
+
+// Donation Alerts  allows authentication via Discord OAuth2.
+type DonationAlerts struct {
+	*baseProvider
+}
+
+// NewDiscordProvider creates a new Discord provider instance with some defaults.
+func NewDonationAlertsProvider() *DonationAlerts {
+	// https://www.donationalerts.com/apidoc#authorization
+	return &DonationAlerts{&baseProvider{
+		ctx:         context.Background(),
+		displayName: "Donation Alerts",
+		pkce:        true,
+		scopes:      []string{"oauth-user-show"},
+		authUrl:     "https://www.donationalerts.com/oauth/authorize",
+		tokenUrl:    "https://www.donationalerts.com/oauth/token",
+		userApiUrl:  "https://www.donationalerts.com/api/v1/user/oauth",
+	}}
+}
+
+// FetchAuthUser returns an AuthUser instance from Discord's user api.
+//
+// API reference:  https://discord.com/developers/docs/resources/user#user-object
+func (p *DonationAlerts) FetchAuthUser(token *oauth2.Token) (*AuthUser, error) {
+	data, err := p.FetchRawUserData(token)
+	if err != nil {
+		return nil, err
+	}
+
+	rawUser := map[string]any{}
+	if err := json.Unmarshal(data, &rawUser); err != nil {
+		return nil, err
+	}
+
+	extracted := struct {
+		Data struct {
+			Id          int    `json:"id"`
+			UniqueName  string `json:"code"`
+			Name        string `json:"name"`
+			Avatar      string `json:"avatar"`
+			Email       string `json:"email"`
+			SocketToken string `json:"socket_connection_token"`
+		} `json:"data"`
+	}{}
+	if err := json.Unmarshal(data, &extracted); err != nil {
+		return nil, err
+	}
+
+	user := &AuthUser{
+		Id:           strconv.Itoa(extracted.Data.Id),
+		Name:         extracted.Data.UniqueName,
+		Username:     extracted.Data.Name,
+		AvatarUrl:    extracted.Data.Avatar,
+		RawUser:      rawUser,
+		AccessToken:  token.AccessToken,
+		RefreshToken: token.RefreshToken,
+	}
+
+	user.Expiry, _ = types.ParseDateTime(token.Expiry)
+
+	return user, nil
+}

ui/public/images/oauth2/donationalerts.svg

@@ -133,6 +133,11 @@ export default [
         title: "Planning Center",
         logo:  "planningcenter.svg",
     },
+    {
+        key: "donationalertsAuth",
+        title: "Donation Alerts",
+        logo: "donationalerts.svg",
+    },
     {
         key:   "oidcAuth",
         title: "OpenID Connect",