File: notifiarr_example_test.go

package info (click to toggle)
golang-github-nicholas-fedor-shoutrrr 0.12.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,680 kB
  • sloc: sh: 74; makefile: 58
file content (326 lines) | stat: -rw-r--r-- 8,573 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
package notifiarr

import (
	"fmt"
	"io"
	"log"
	"net/url"

	"github.com/jarcoal/httpmock"

	"github.com/nicholas-fedor/shoutrrr/pkg/types"
)

// Example demonstrates basic notification sending to Notifiarr.
func Example() {
	// Activate HTTP mocking for the example
	httpmock.Activate()

	defer httpmock.DeactivateAndReset()

	// Mock a successful Notifiarr API response
	httpmock.RegisterResponder(
		"POST",
		"https://notifiarr.com/api/v1/notification/passthrough/test-api-key",
		httpmock.NewStringResponder(200, `{"success": true}`),
	)

	// Create and initialize the service
	service := &Service{}
	serviceURL, _ := url.Parse("notifiarr://test-api-key")

	err := service.Initialize(serviceURL, log.New(io.Discard, "", 0))
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Send a notification
	err = service.Send("Hello from Notifiarr!", nil)
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Output: Notification sent successfully
	fmt.Println("Notification sent successfully")
}

// Example_eventID demonstrates sending a notification with an event ID for message updates.
func Example_eventID() {
	// Activate HTTP mocking for the example
	httpmock.Activate()

	defer httpmock.DeactivateAndReset()

	// Mock a successful Notifiarr API response
	httpmock.RegisterResponder(
		"POST",
		"https://notifiarr.com/api/v1/notification/passthrough/test-api-key",
		httpmock.NewStringResponder(200, `{"success": true}`),
	)

	// Create and initialize the service
	service := &Service{}
	serviceURL, _ := url.Parse("notifiarr://test-api-key")

	err := service.Initialize(serviceURL, log.New(io.Discard, "", 0))
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Send a notification with event ID and title
	params := types.Params{
		"id":    "alert-123",
		"title": "System Alert",
	}

	err = service.Send("Server CPU usage is high", &params)
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Output: Notification with event ID sent successfully
	fmt.Println("Notification with event ID sent successfully")
}

// Example_discordMentions demonstrates Discord mention parsing from message content.
func Example_discordMentions() {
	// Activate HTTP mocking for the example
	httpmock.Activate()

	defer httpmock.DeactivateAndReset()

	// Mock a successful Notifiarr API response
	httpmock.RegisterResponder(
		"POST",
		"https://notifiarr.com/api/v1/notification/passthrough/test-api-key",
		httpmock.NewStringResponder(200, `{"success": true}`),
	)

	// Create and initialize the service
	service := &Service{}
	serviceURL, _ := url.Parse("notifiarr://test-api-key")

	err := service.Initialize(serviceURL, log.New(io.Discard, "", 0))
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Send a notification with Discord mentions
	message := "Alert for <@123456789> and role <@&987654321>"

	err = service.Send(message, nil)
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Output: Notification with mentions sent successfully
	fmt.Println("Notification with mentions sent successfully")
}

// Example_imageThumbnail demonstrates sending a notification with a thumbnail image.
func Example_imageThumbnail() {
	// Activate HTTP mocking for the example
	httpmock.Activate()

	defer httpmock.DeactivateAndReset()

	// Mock a successful Notifiarr API response
	httpmock.RegisterResponder(
		"POST",
		"https://notifiarr.com/api/v1/notification/passthrough/test-api-key",
		httpmock.NewStringResponder(200, `{"success": true}`),
	)

	// Create and initialize the service with thumbnail
	service := &Service{}
	serviceURL, _ := url.Parse("notifiarr://test-api-key?thumbnail=https://example.com/alert.png")

	err := service.Initialize(serviceURL, log.New(io.Discard, "", 0))
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Send a notification
	err = service.Send("System alert with thumbnail", nil)
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Output: Notification with thumbnail sent successfully
	fmt.Println("Notification with thumbnail sent successfully")
}

// Example_colorCustomization demonstrates sending a notification with custom color.
func Example_colorCustomization() {
	// Activate HTTP mocking for the example
	httpmock.Activate()

	defer httpmock.DeactivateAndReset()

	// Mock a successful Notifiarr API response
	httpmock.RegisterResponder(
		"POST",
		"https://notifiarr.com/api/v1/notification/passthrough/test-api-key",
		httpmock.NewStringResponder(200, `{"success": true}`),
	)

	// Create and initialize the service with color
	service := &Service{}
	serviceURL, _ := url.Parse("notifiarr://test-api-key?color=16711680") // Red color

	err := service.Initialize(serviceURL, log.New(io.Discard, "", 0))
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Send a notification
	err = service.Send("Red alert notification", nil)
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Output: Colored notification sent successfully
	fmt.Println("Colored notification sent successfully")
}

// Example_urlParameterConfiguration demonstrates configuring notifications via URL parameters.
func Example_urlParameterConfiguration() {
	// Activate HTTP mocking for the example
	httpmock.Activate()

	defer httpmock.DeactivateAndReset()

	// Mock a successful Notifiarr API response
	httpmock.RegisterResponder(
		"POST",
		"https://notifiarr.com/api/v1/notification/passthrough/test-api-key",
		httpmock.NewStringResponder(200, `{"success": true}`),
	)

	// Create and initialize the service with multiple parameters
	service := &Service{}
	serviceURL, _ := url.Parse(
		"notifiarr://test-api-key?channel=123456789012345678&thumbnail=https://example.com/icon.png&image=https://example.com/image.png&color=65280",
	)

	err := service.Initialize(serviceURL, log.New(io.Discard, "", 0))
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Send a notification
	err = service.Send("Fully configured notification with image", nil)
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Output: Fully configured notification with image sent successfully
	fmt.Println("Fully configured notification with image sent successfully")
}

// Example_imageAndThumbnail demonstrates sending a notification with both image and thumbnail URLs.
func Example_imageAndThumbnail() {
	// Activate HTTP mocking for the example
	httpmock.Activate()

	defer httpmock.DeactivateAndReset()

	// Mock a successful Notifiarr API response
	httpmock.RegisterResponder(
		"POST",
		"https://notifiarr.com/api/v1/notification/passthrough/test-api-key",
		httpmock.NewStringResponder(200, `{"success": true}`),
	)

	// Create and initialize the service with both image and thumbnail
	service := &Service{}
	serviceURL, _ := url.Parse(
		"notifiarr://test-api-key?thumbnail=https://example.com/thumbnail.png&image=https://example.com/full-image.png",
	)

	err := service.Initialize(serviceURL, log.New(io.Discard, "", 0))
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Send a notification
	err = service.Send("Notification with both thumbnail and full image", nil)
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Output: Notification with image and thumbnail sent successfully
	fmt.Println("Notification with image and thumbnail sent successfully")
}

// Example_advancedTextFields demonstrates sending a notification with advanced text fields including icon, content, and footer.
func Example_advancedTextFields() {
	// Activate HTTP mocking for the example
	httpmock.Activate()

	defer httpmock.DeactivateAndReset()

	// Mock a successful Notifiarr API response
	httpmock.RegisterResponder(
		"POST",
		"https://notifiarr.com/api/v1/notification/passthrough/test-api-key",
		httpmock.NewStringResponder(200, `{"success": true}`),
	)

	// Create and initialize the service
	service := &Service{}
	serviceURL, _ := url.Parse("notifiarr://test-api-key")

	err := service.Initialize(serviceURL, log.New(io.Discard, "", 0))
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Send a notification with advanced text fields
	params := types.Params{
		"title":   "System Status Update",
		"icon":    "https://example.com/icon.png",
		"content": "Detailed content about the system status",
		"footer":  "Generated by Monitoring System v2.1",
	}

	err = service.Send("System is running normally", &params)
	if err != nil {
		fmt.Println("Error:", err)

		return
	}

	// Output: Notification with advanced text fields sent successfully
	fmt.Println("Notification with advanced text fields sent successfully")
}