feat(alerting): Add basic send mode implementation

Author: PythonGermany

alerting/alert/type.go

@@ -110,6 +110,9 @@ const (
 	// TypeTelegram is the Type for the telegram alerting provider
 	TypeTelegram Type = "telegram"
 
+	// TypeThreemaGateway is the Type for the threema-gateway alerting provider
+	TypeThreemaGateway Type = "threema-gateway"
+
 	// TypeTwilio is the Type for the twilio alerting provider
 	TypeTwilio Type = "twilio"
 

alerting/config.go

@@ -41,6 +41,7 @@ import (
 	"github.com/TwiN/gatus/v5/alerting/provider/teams"
 	"github.com/TwiN/gatus/v5/alerting/provider/teamsworkflows"
 	"github.com/TwiN/gatus/v5/alerting/provider/telegram"
+	"github.com/TwiN/gatus/v5/alerting/provider/threemagateway"
 	"github.com/TwiN/gatus/v5/alerting/provider/twilio"
 	"github.com/TwiN/gatus/v5/alerting/provider/vonage"
 	"github.com/TwiN/gatus/v5/alerting/provider/webex"
@@ -156,6 +157,9 @@ type Config struct {
 	// Telegram is the configuration for the telegram alerting provider
 	Telegram *telegram.AlertProvider `yaml:"telegram,omitempty"`
 
+	// ThreemaGateway is the configuration for the threema-gatway alerting provider
+	ThreemaGateway *threemagateway.AlertProvider `yaml:"threema-gateway,omitempty"`
+
 	// Twilio is the configuration for the twilio alerting provider
 	Twilio *twilio.AlertProvider `yaml:"twilio,omitempty"`
 

alerting/provider/provider.go

@@ -37,6 +37,7 @@ import (
 	"github.com/TwiN/gatus/v5/alerting/provider/teams"
 	"github.com/TwiN/gatus/v5/alerting/provider/teamsworkflows"
 	"github.com/TwiN/gatus/v5/alerting/provider/telegram"
+	"github.com/TwiN/gatus/v5/alerting/provider/threemagateway"
 	"github.com/TwiN/gatus/v5/alerting/provider/twilio"
 	"github.com/TwiN/gatus/v5/alerting/provider/webex"
 	"github.com/TwiN/gatus/v5/alerting/provider/zapier"
@@ -126,6 +127,7 @@ var (
 	_ AlertProvider = (*teams.AlertProvider)(nil)
 	_ AlertProvider = (*teamsworkflows.AlertProvider)(nil)
 	_ AlertProvider = (*telegram.AlertProvider)(nil)
+	_ AlertProvider = (*threemagateway.AlertProvider)(nil)
 	_ AlertProvider = (*twilio.AlertProvider)(nil)
 	_ AlertProvider = (*webex.AlertProvider)(nil)
 	_ AlertProvider = (*zapier.AlertProvider)(nil)
@@ -167,6 +169,7 @@ var (
 	_ Config[teams.Config]          = (*teams.Config)(nil)
 	_ Config[teamsworkflows.Config] = (*teamsworkflows.Config)(nil)
 	_ Config[telegram.Config]       = (*telegram.Config)(nil)
+	_ Config[threemagateway.Config] = (*threemagateway.Config)(nil)
 	_ Config[twilio.Config]         = (*twilio.Config)(nil)
 	_ Config[webex.Config]          = (*webex.Config)(nil)
 	_ Config[zapier.Config]         = (*zapier.Config)(nil)

alerting/provider/threemagateway/recipient.go

@@ -0,0 +1,94 @@
+package threemagateway
+
+import (
+	"encoding"
+	"errors"
+	"fmt"
+	"strings"
+)
+
+// TODO#1464: Add tests
+
+const (
+	defaultRecipientType = RecipientTypeId
+)
+
+var (
+	ErrInvalidRecipientFormat = errors.New("recipient must be in the format '[<type>:]<value>'")
+	ErrInvalidRecipientType   = fmt.Errorf("invalid recipient type, must be one of: %v", joinKeys(validRecipientTypes, ", "))
+	validRecipientTypes       = map[string]RecipientType{
+		"id":    RecipientTypeId,
+		"phone": RecipientTypePhone,
+		"email": RecipientTypeEmail,
+	}
+)
+
+type RecipientType int
+
+const (
+	RecipientTypeInvalid RecipientType = iota
+	RecipientTypeId
+	RecipientTypePhone
+	RecipientTypeEmail
+)
+
+func parseRecipientType(s string) RecipientType {
+	if val, ok := validRecipientTypes[s]; ok {
+		return val
+	}
+	return RecipientTypeInvalid
+}
+
+type Recipient struct {
+	Value string        `yaml:"-"`
+	Type  RecipientType `yaml:"-"`
+}
+
+var _ encoding.TextUnmarshaler = (*Recipient)(nil)
+var _ encoding.TextMarshaler = (*Recipient)(nil)
+
+func (r *Recipient) UnmarshalText(text []byte) error {
+	parts := strings.Split(string(text), ":")
+	switch {
+	case len(parts) > 2:
+		return ErrInvalidRecipientFormat
+	case len(parts) == 2:
+		if r.Type = parseRecipientType(parts[0]); r.Type == RecipientTypeInvalid {
+			return ErrInvalidRecipientType
+		}
+		r.Value = parts[1]
+	default:
+		r.Type = defaultRecipientType
+		r.Value = parts[0]
+	}
+	return nil
+}
+
+func (r Recipient) MarshalText() ([]byte, error) {
+	return []byte(r.Value), nil
+}
+
+func (r *Recipient) Validate() error {
+	if len(r.Value) == 0 {
+		return ErrInvalidRecipientFormat
+	}
+	switch r.Type {
+	case RecipientTypeId:
+		if err := validateThreemaId(r.Value); err != nil {
+			return err
+		}
+	case RecipientTypePhone:
+		// Basic validation for phone number # TODO#1464: improve phone number validation
+		if !strings.HasPrefix(r.Value, "+") || len(r.Value) < 8 {
+			return errors.New("invalid phone number format")
+		}
+	case RecipientTypeEmail:
+		// Basic validation for email address // TODO#1464: improve email validation
+		if !strings.Contains(r.Value, "@") {
+			return errors.New("invalid email address format")
+		}
+	default:
+		return ErrInvalidRecipientType
+	}
+	return nil
+}