forked from kitwalker12/gosparkpost
-
Notifications
You must be signed in to change notification settings - Fork 0
/
events.go
294 lines (252 loc) · 7 KB
/
events.go
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
// Package events defines a struct for each type of event and provides various other helper functions.
package events
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"strconv"
"time"
)
// Event is a generic event.
type Event interface {
EventType() string
}
// Events is a list of generic events. Useful for decoding events from API webhooks.
type Events []Event
var (
ErrNotImplemented = errors.New("not implemented")
)
// ValidEventType returns true if the event name parameter is valid.
func ValidEventType(eventType string) bool {
if _, ok := EventForName(eventType).(*Unknown); ok {
return false
}
return true
}
// EventForName returns a struct matching the passed-in type.
func EventForName(eventType string) Event {
switch eventType {
case "bounce":
return &Bounce{}
case "click":
return &Click{}
case "creation":
return &Creation{}
case "delay":
return &Delay{}
case "delivery":
return &Delivery{}
case "generation_failure":
return &GenerationFailure{}
case "generation_rejection":
return &GenerationRejection{}
case "injection":
return &Injection{}
case "list_unsubscribe":
return &ListUnsubscribe{}
case "link_unsubscribe":
return &LinkUnsubscribe{}
case "open":
return &Open{}
case "out_of_band":
return &OutOfBand{}
case "policy_rejection":
return &PolicyRejection{}
case "spam_complaint":
return &SpamComplaint{}
case "relay_delivery":
return &RelayDelivery{}
case "relay_injection":
return &RelayInjection{}
case "relay_message":
return &RelayMessage{}
case "relay_permfail":
return &RelayPermfail{}
case "relay_rejection":
return &RelayRejection{}
case "relay_tempfail":
return &RelayTempfail{}
case "sms_status":
return &SMSStatus{}
}
return &Unknown{}
}
func ParseRawJSONEvents(rawEvents []json.RawMessage) ([]Event, error) {
events := []Event{}
// Each item is event data in raw JSON.
for _, rawEvent := range rawEvents {
var typeLookup EventCommon
if err := json.Unmarshal(rawEvent, &typeLookup); err != nil {
typeLookup.Type = "unknown"
}
event := EventForName(typeLookup.EventType())
if e, ok := event.(*Unknown); ok {
e.EventCommon.Type = typeLookup.EventType()
e.RawJSON = rawEvent
e.Error = ErrNotImplemented
events = append(events, e)
continue
}
// Unmarshal into specic event object.
if err := json.Unmarshal(rawEvent, &event); err != nil {
event = &Unknown{
EventCommon: EventCommon{Type: typeLookup.EventType()},
RawJSON: rawEvent,
Error: err,
}
}
events = append(events, event)
}
return events, nil
}
func (events *Events) UnmarshalJSON(data []byte) error {
// Parse raw events from Event Webhook ("msys"-wrapped array of events).
rawEvents, err := parseRawJSONEventsFromWebhook(data)
if err != nil {
// Parse raw events from Event Samples ("results" object with array of events).
rawEvents, err = parseRawJSONEventsFromSamples(data)
if err != nil {
return err
}
}
*events, err = ParseRawJSONEvents(rawEvents)
if err != nil {
return err
}
return nil
}
func parseRawJSONEventsFromWebhook(data []byte) ([]json.RawMessage, error) {
var rawEvents []json.RawMessage
// These "msys"-wrapped events are being sent on Webhooks.
var msysEventWrappers []struct {
MsysEventWrapper map[string]json.RawMessage `json:"msys"`
}
if err := json.Unmarshal(data, &msysEventWrappers); err != nil {
return nil, err
}
for _, wrapper := range msysEventWrappers {
for _, rawEvent := range wrapper.MsysEventWrapper {
rawEvents = append(rawEvents, rawEvent)
}
}
return rawEvents, nil
}
func parseRawJSONEventsFromSamples(data []byte) ([]json.RawMessage, error) {
// Object with array of events is being sent on Events Samples.
var resultsWrapper struct {
RawEvents []json.RawMessage `json:"results"`
}
if err := json.Unmarshal(data, &resultsWrapper); err != nil {
return nil, err
}
return resultsWrapper.RawEvents, nil
}
func ECLog(e Event) string {
// XXX: this feels like the wrong way; can't figure out the right way
switch e.(type) {
case *Bounce:
b := e.(*Bounce)
return b.ECLog()
case *Delay:
d := e.(*Delay)
return d.ECLog()
case *Delivery:
d := e.(*Delivery)
return d.ECLog()
case *Injection:
i := e.(*Injection)
return i.ECLog()
case *OutOfBand:
o := e.(*OutOfBand)
return o.ECLog()
}
return ""
}
type ECLogger interface {
ECLog() string
}
// EventCommon contains fields common to all types of Event objects
type EventCommon struct {
Type string `json:"type"`
}
func (e EventCommon) EventType() string { return e.Type }
type Unknown struct {
EventCommon
RawJSON json.RawMessage
Error error
}
func (e *Unknown) EventType() string { return "unknown" }
func (e *Unknown) String() string {
return fmt.Sprintf("Unknown event (type %q): %v\n%s", e.EventCommon.EventType(), e.Error, e.RawJSON)
}
func (e *Unknown) UnmarshalJSON(data []byte) error {
return nil
}
type Timestamp time.Time
func (t Timestamp) String() string {
return time.Time(t).String()
}
func (t *Timestamp) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprint(time.Time(*t).Unix())), nil
}
func (t *Timestamp) UnmarshalJSON(data []byte) error {
// Trim quotes.
data = bytes.Trim(data, `"`)
// Timestamps coming from Webhook Events are Unix timestamps.
unix, err := strconv.ParseInt(string(data), 10, 64)
if err == nil {
*t = Timestamp(time.Unix(unix, 0))
return nil
}
// Timestamps coming from Event Samples are in this RFC 3339-like format.
customTime, err := time.Parse("2006-01-02T15:04:05.000-07:00", string(data))
if err != nil {
return err
}
*t = Timestamp(customTime)
return nil
}
type GeoIP struct {
Country string `json:"country"`
Region string `json:"region"`
City string `json:"city"`
Latitude LatLong `json:"latitude"`
Longitude LatLong `json:"longitude"`
}
// The API inconsistently returns float or string. We need a custom unmarshaller.
type LatLong float32
func (v *LatLong) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprint("%v", v)), nil
}
func (v *LatLong) UnmarshalJSON(data []byte) error {
// Trim quotes if the API returns string.
data = bytes.Trim(data, `"`)
// Parse the actual value.
value, err := strconv.ParseFloat(string(data), 32)
if err != nil {
return err
}
*v = LatLong(value)
return nil
}
type Creation struct {
EventCommon
Accepted string `json:"accepted_rcpts"`
CampaignID string `json:"campaign_id"`
CustomerID string `json:"customer_id"`
InjectionMethod string `json:"inj_method"`
NodeName string `json:"node_name"`
Metadata interface{} `json:"rcpt_meta"`
Tags []string `json:"rcpt_tags"`
Submitted string `json:"submitted_rcpts"`
TemplateID string `json:"template_id"`
TemplateVersion string `json:"template_version"`
Timestamp Timestamp `json:"timestamp"`
TransmissionID string `json:"transmission_id"`
UserID string `json:"user_id"`
}
func (c *Creation) String() string {
return fmt.Sprintf("%s CT %s (%s, %s)",
c.Timestamp, c.TransmissionID, c.Submitted, c.Accepted)
}