1
0
Fork 0

Adding upstream version 0.8.9.

Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-05-22 10:16:14 +02:00
parent 3b2c48b5e4
commit c0c4addb85
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
285 changed files with 25880 additions and 0 deletions

106
pkg/services/ifttt/ifttt.go Normal file
View file

@ -0,0 +1,106 @@
package ifttt
import (
"bytes"
"context"
"errors"
"fmt"
"net/http"
"net/url"
"github.com/nicholas-fedor/shoutrrr/pkg/format"
"github.com/nicholas-fedor/shoutrrr/pkg/services/standard"
"github.com/nicholas-fedor/shoutrrr/pkg/types"
)
// apiURLFormat defines the IFTTT webhook URL template.
const (
apiURLFormat = "https://maker.ifttt.com/trigger/%s/with/key/%s"
)
// ErrSendFailed indicates a failure to send an IFTTT event notification.
var (
ErrSendFailed = errors.New("failed to send IFTTT event")
ErrUnexpectedStatus = errors.New("got unexpected response status code")
)
// Service sends notifications to an IFTTT webhook.
type Service struct {
standard.Standard
Config *Config
pkr format.PropKeyResolver
}
// Initialize configures the service with a URL and logger.
func (service *Service) Initialize(configURL *url.URL, logger types.StdLogger) error {
service.SetLogger(logger)
service.Config = &Config{
UseMessageAsValue: DefaultMessageValue,
}
service.pkr = format.NewPropKeyResolver(service.Config)
if err := service.Config.setURL(&service.pkr, configURL); err != nil {
return err
}
return nil
}
// GetID returns the identifier for this service.
func (service *Service) GetID() string {
return Scheme
}
// Send delivers a notification message to an IFTTT webhook.
func (service *Service) Send(message string, params *types.Params) error {
config := service.Config
if err := service.pkr.UpdateConfigFromParams(config, params); err != nil {
return fmt.Errorf("updating config from params: %w", err)
}
payload, err := createJSONToSend(config, message, params)
if err != nil {
return err
}
for _, event := range config.Events {
apiURL := service.createAPIURLForEvent(event)
if err := doSend(payload, apiURL); err != nil {
return fmt.Errorf("%w: event %q: %w", ErrSendFailed, event, err)
}
}
return nil
}
// createAPIURLForEvent builds an IFTTT webhook URL for a specific event.
func (service *Service) createAPIURLForEvent(event string) string {
return fmt.Sprintf(apiURLFormat, event, service.Config.WebHookID)
}
// doSend executes an HTTP POST request to send the payload to the IFTTT webhook.
func doSend(payload []byte, postURL string) error {
req, err := http.NewRequestWithContext(
context.Background(),
http.MethodPost,
postURL,
bytes.NewBuffer(payload),
)
if err != nil {
return fmt.Errorf("creating HTTP request: %w", err)
}
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
return fmt.Errorf("sending HTTP request to IFTTT webhook: %w", err)
}
defer res.Body.Close()
if res.StatusCode < 200 || res.StatusCode >= 300 {
return fmt.Errorf("%w: %s", ErrUnexpectedStatus, res.Status)
}
return nil
}

View file

@ -0,0 +1,107 @@
package ifttt
import (
"errors"
"fmt"
"net/url"
"github.com/nicholas-fedor/shoutrrr/pkg/format"
"github.com/nicholas-fedor/shoutrrr/pkg/services/standard"
"github.com/nicholas-fedor/shoutrrr/pkg/types"
)
const (
Scheme = "ifttt" // Scheme identifies this service in configuration URLs.
DefaultMessageValue = 2 // Default value field (1-3) for the notification message
DisabledValue = 0 // Value to disable title assignment
MinValueField = 1 // Minimum valid value field (Value1)
MaxValueField = 3 // Maximum valid value field (Value3)
MinLength = 1 // Minimum length for required fields like Events and WebHookID
)
var (
ErrInvalidMessageValue = errors.New(
"invalid value for messagevalue: only values 1-3 are supported",
)
ErrInvalidTitleValue = errors.New(
"invalid value for titlevalue: only values 1-3 or 0 (for disabling) are supported",
)
ErrTitleMessageConflict = errors.New("titlevalue cannot use the same number as messagevalue")
ErrMissingEvents = errors.New("events missing from config URL")
ErrMissingWebhookID = errors.New("webhook ID missing from config URL")
)
// Config holds settings for the IFTTT notification service.
type Config struct {
standard.EnumlessConfig
WebHookID string `required:"true" url:"host"`
Events []string `required:"true" key:"events"`
Value1 string ` key:"value1" optional:""`
Value2 string ` key:"value2" optional:""`
Value3 string ` key:"value3" optional:""`
UseMessageAsValue uint8 ` key:"messagevalue" default:"2" desc:"Sets the corresponding value field to the notification message"`
UseTitleAsValue uint8 ` key:"titlevalue" default:"0" desc:"Sets the corresponding value field to the notification title"`
Title string ` key:"title" default:"" desc:"Notification title, optionally set by the sender"`
}
// GetURL generates a URL from the current configuration values.
func (config *Config) GetURL() *url.URL {
resolver := format.NewPropKeyResolver(config)
return config.getURL(&resolver)
}
// SetURL updates the configuration from a URL representation.
func (config *Config) SetURL(url *url.URL) error {
resolver := format.NewPropKeyResolver(config)
return config.setURL(&resolver, url)
}
func (config *Config) getURL(resolver types.ConfigQueryResolver) *url.URL {
return &url.URL{
Host: config.WebHookID,
Path: "/",
Scheme: Scheme,
RawQuery: format.BuildQuery(resolver),
}
}
func (config *Config) setURL(resolver types.ConfigQueryResolver, url *url.URL) error {
if config.UseMessageAsValue == DisabledValue {
config.UseMessageAsValue = DefaultMessageValue
}
config.WebHookID = url.Hostname()
for key, vals := range url.Query() {
if err := resolver.Set(key, vals[0]); err != nil {
return fmt.Errorf("setting config property %q from URL query: %w", key, err)
}
}
if config.UseMessageAsValue > MaxValueField || config.UseMessageAsValue < MinValueField {
return ErrInvalidMessageValue
}
if config.UseTitleAsValue > MaxValueField {
return ErrInvalidTitleValue
}
if config.UseTitleAsValue != DisabledValue &&
config.UseTitleAsValue == config.UseMessageAsValue {
return ErrTitleMessageConflict
}
if url.String() != "ifttt://dummy@dummy.com" {
if len(config.Events) < MinLength {
return ErrMissingEvents
}
if len(config.WebHookID) < MinLength {
return ErrMissingWebhookID
}
}
return nil
}

View file

@ -0,0 +1,61 @@
package ifttt
import (
"encoding/json"
"fmt"
"github.com/nicholas-fedor/shoutrrr/pkg/types"
)
// ValueFieldOne represents the Value1 field in the IFTTT payload.
const (
ValueFieldOne = 1 // Represents Value1 field
ValueFieldTwo = 2 // Represents Value2 field
ValueFieldThree = 3 // Represents Value3 field
)
// jsonPayload represents the notification payload sent to the IFTTT webhook API.
type jsonPayload struct {
Value1 string `json:"value1"`
Value2 string `json:"value2"`
Value3 string `json:"value3"`
}
// createJSONToSend generates a JSON payload for the IFTTT webhook API.
func createJSONToSend(config *Config, message string, params *types.Params) ([]byte, error) {
payload := jsonPayload{
Value1: config.Value1,
Value2: config.Value2,
Value3: config.Value3,
}
if params != nil {
if value, found := (*params)["value1"]; found {
payload.Value1 = value
}
if value, found := (*params)["value2"]; found {
payload.Value2 = value
}
if value, found := (*params)["value3"]; found {
payload.Value3 = value
}
}
switch config.UseMessageAsValue {
case ValueFieldOne:
payload.Value1 = message
case ValueFieldTwo:
payload.Value2 = message
case ValueFieldThree:
payload.Value3 = message
}
jsonBytes, err := json.Marshal(payload)
if err != nil {
return nil, fmt.Errorf("marshaling IFTTT payload to JSON: %w", err)
}
return jsonBytes, nil
}

View file

@ -0,0 +1,335 @@
package ifttt_test
import (
"encoding/json"
"errors"
"fmt"
"io"
"log"
"net/http"
"os"
"testing"
"github.com/jarcoal/httpmock"
"github.com/onsi/ginkgo/v2"
"github.com/onsi/gomega"
"github.com/nicholas-fedor/shoutrrr/internal/testutils"
"github.com/nicholas-fedor/shoutrrr/pkg/services/ifttt"
"github.com/nicholas-fedor/shoutrrr/pkg/types"
)
// TestIFTTT runs the Ginkgo test suite for the IFTTT package.
func TestIFTTT(t *testing.T) {
gomega.RegisterFailHandler(ginkgo.Fail)
ginkgo.RunSpecs(t, "Shoutrrr IFTTT Suite")
}
var (
service *ifttt.Service
logger *log.Logger
envTestURL string
_ = ginkgo.BeforeSuite(func() {
service = &ifttt.Service{}
logger = testutils.TestLogger()
envTestURL = os.Getenv("SHOUTRRR_IFTTT_URL")
})
)
var _ = ginkgo.Describe("the IFTTT service", func() {
ginkgo.When("running integration tests", func() {
ginkgo.It("sends a message successfully with a valid ENV URL", func() {
if envTestURL == "" {
ginkgo.Skip("No integration test ENV URL was set")
return
}
serviceURL := testutils.URLMust(envTestURL)
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = service.Send("This is an integration test", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
})
ginkgo.Describe("the service", func() {
ginkgo.BeforeEach(func() {
service = &ifttt.Service{}
service.SetLogger(logger)
})
ginkgo.It("returns the correct service identifier", func() {
gomega.Expect(service.GetID()).To(gomega.Equal("ifttt"))
})
})
ginkgo.When("parsing the configuration URL", func() {
ginkgo.BeforeEach(func() {
service = &ifttt.Service{}
service.SetLogger(logger)
})
ginkgo.It("returns an error if no arguments are supplied", func() {
serviceURL := testutils.URLMust("ifttt://")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("returns an error if no webhook ID is given", func() {
serviceURL := testutils.URLMust("ifttt:///?events=event1")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("returns an error if no events are given", func() {
serviceURL := testutils.URLMust("ifttt://dummyID")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("returns an error when an invalid query key is given", func() { // Line 54
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&badquery=foo")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("returns an error if message value is above 3", func() {
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&messagevalue=8")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("returns an error if message value is below 1", func() { // Line 60
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&messagevalue=0")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It(
"does not return an error if webhook ID and at least one event are given",
func() {
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
},
)
ginkgo.It("returns an error if titlevalue is invalid", func() { // Line 78
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&titlevalue=4")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).
To(gomega.MatchError("invalid value for titlevalue: only values 1-3 or 0 (for disabling) are supported"))
})
ginkgo.It("returns an error if titlevalue equals messagevalue", func() { // Line 82
serviceURL := testutils.URLMust(
"ifttt://dummyID/?events=event1&messagevalue=2&titlevalue=2",
)
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).
To(gomega.MatchError("titlevalue cannot use the same number as messagevalue"))
})
})
ginkgo.When("serializing a config to URL", func() {
ginkgo.BeforeEach(func() {
service = &ifttt.Service{}
service.SetLogger(logger)
})
ginkgo.When("given multiple events", func() {
ginkgo.It("returns an URL with all events comma-separated", func() {
configURL := testutils.URLMust("ifttt://dummyID/?events=foo%2Cbar%2Cbaz")
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
resultURL := service.Config.GetURL().String()
gomega.Expect(resultURL).To(gomega.Equal(configURL.String()))
})
})
ginkgo.When("given values", func() {
ginkgo.It("returns an URL with all values", func() {
configURL := testutils.URLMust(
"ifttt://dummyID/?events=event1&value1=v1&value2=v2&value3=v3",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
resultURL := service.Config.GetURL().String()
gomega.Expect(resultURL).To(gomega.Equal(configURL.String()))
})
})
})
ginkgo.Describe("sending a message", func() {
ginkgo.BeforeEach(func() {
httpmock.Activate()
service = &ifttt.Service{}
service.SetLogger(logger)
})
ginkgo.AfterEach(func() {
httpmock.DeactivateAndReset()
})
ginkgo.It("errors if the response code is not 200-299", func() {
configURL := testutils.URLMust("ifttt://dummy/?events=foo")
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://maker.ifttt.com/trigger/foo/with/key/dummy",
httpmock.NewStringResponder(404, ""),
)
err = service.Send("hello", nil)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("does not error if the response code is 200", func() {
configURL := testutils.URLMust("ifttt://dummy/?events=foo")
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://maker.ifttt.com/trigger/foo/with/key/dummy",
httpmock.NewStringResponder(200, ""),
)
err = service.Send("hello", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("returns an error if params update fails", func() { // Line 55
configURL := testutils.URLMust("ifttt://dummy/?events=event1")
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
params := types.Params{"messagevalue": "invalid"}
err = service.Send("hello", &params)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.DescribeTable("sets message to correct value field based on messagevalue",
func(messageValue int, expectedField string) { // Lines 30, 32, 34
configURL := testutils.URLMust(
fmt.Sprintf("ifttt://dummy/?events=event1&messagevalue=%d", messageValue),
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://maker.ifttt.com/trigger/event1/with/key/dummy",
func(req *http.Request) (*http.Response, error) {
body, err := io.ReadAll(req.Body)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
var payload jsonPayload
err = json.Unmarshal(body, &payload)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
switch expectedField {
case "Value1":
gomega.Expect(payload.Value1).To(gomega.Equal("hello"))
gomega.Expect(payload.Value2).To(gomega.Equal(""))
gomega.Expect(payload.Value3).To(gomega.Equal(""))
case "Value2":
gomega.Expect(payload.Value1).To(gomega.Equal(""))
gomega.Expect(payload.Value2).To(gomega.Equal("hello"))
gomega.Expect(payload.Value3).To(gomega.Equal(""))
case "Value3":
gomega.Expect(payload.Value1).To(gomega.Equal(""))
gomega.Expect(payload.Value2).To(gomega.Equal(""))
gomega.Expect(payload.Value3).To(gomega.Equal("hello"))
}
return httpmock.NewStringResponse(200, ""), nil
},
)
err = service.Send("hello", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
},
ginkgo.Entry("messagevalue=1 sets Value1", 1, "Value1"),
ginkgo.Entry("messagevalue=2 sets Value2", 2, "Value2"),
ginkgo.Entry("messagevalue=3 sets Value3", 3, "Value3"),
)
ginkgo.It("overrides Value2 with params when messagevalue is 1", func() { // Line 36
configURL := testutils.URLMust("ifttt://dummy/?events=event1&messagevalue=1")
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://maker.ifttt.com/trigger/event1/with/key/dummy",
func(req *http.Request) (*http.Response, error) {
body, err := io.ReadAll(req.Body)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
var payload jsonPayload
err = json.Unmarshal(body, &payload)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(payload.Value1).To(gomega.Equal("hello"))
gomega.Expect(payload.Value2).To(gomega.Equal("y"))
gomega.Expect(payload.Value3).To(gomega.Equal(""))
return httpmock.NewStringResponse(200, ""), nil
},
)
params := types.Params{
"value2": "y",
}
err = service.Send("hello", &params)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("overrides payload values with params", func() { // Lines 17, 21, 25
configURL := testutils.URLMust(
"ifttt://dummy/?events=event1&value1=a&value2=b&value3=c&messagevalue=2",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://maker.ifttt.com/trigger/event1/with/key/dummy",
func(req *http.Request) (*http.Response, error) {
body, err := io.ReadAll(req.Body)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
var payload jsonPayload
err = json.Unmarshal(body, &payload)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(payload.Value1).To(gomega.Equal("x"))
gomega.Expect(payload.Value2).To(gomega.Equal("hello"))
gomega.Expect(payload.Value3).To(gomega.Equal("z"))
return httpmock.NewStringResponse(200, ""), nil
},
)
params := types.Params{
"value1": "x",
// "value2": "y", // Omitted to let message override
"value3": "z",
}
err = service.Send("hello", &params)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("should fail with multiple events when one errors", func() {
configURL := testutils.URLMust("ifttt://dummy/?events=event1,event2")
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://maker.ifttt.com/trigger/event1/with/key/dummy",
httpmock.NewStringResponder(200, ""),
)
httpmock.RegisterResponder(
"POST",
"https://maker.ifttt.com/trigger/event2/with/key/dummy",
httpmock.NewStringResponder(404, "Not Found"),
)
err = service.Send("Test message", nil)
gomega.Expect(err).To(gomega.MatchError(
`failed to send IFTTT event: event "event2": got unexpected response status code: 404 Not Found`,
))
})
ginkgo.It("should fail with network error", func() {
configURL := testutils.URLMust("ifttt://dummy/?events=event1")
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://maker.ifttt.com/trigger/event1/with/key/dummy",
httpmock.NewErrorResponder(errors.New("network failure")),
)
err = service.Send("Test message", nil)
gomega.Expect(err).To(gomega.MatchError(
`failed to send IFTTT event: event "event1": sending HTTP request to IFTTT webhook: Post "https://maker.ifttt.com/trigger/event1/with/key/dummy": network failure`,
))
})
})
})
type jsonPayload struct {
Value1 string `json:"value1"`
Value2 string `json:"value2"`
Value3 string `json:"value3"`
}