/
envelope.go
347 lines (306 loc) · 8.54 KB
/
envelope.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
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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
package v4
import (
"fmt"
"net/http"
"github.com/envelope-zero/backend/v5/pkg/httputil"
"github.com/envelope-zero/backend/v5/pkg/models"
"github.com/gin-gonic/gin"
"golang.org/x/exp/slices"
)
// RegisterEnvelopeRoutes registers the routes for envelopes with
// the RouterGroup that is passed.
func RegisterEnvelopeRoutes(r *gin.RouterGroup) {
// Root group
{
r.OPTIONS("", OptionsEnvelopeList)
r.GET("", GetEnvelopes)
r.POST("", CreateEnvelopes)
}
// Envelope with ID
{
r.OPTIONS("/:id", OptionsEnvelopeDetail)
r.GET("/:id", GetEnvelope)
r.PATCH("/:id", UpdateEnvelope)
r.DELETE("/:id", DeleteEnvelope)
}
}
// @Summary Allowed HTTP verbs
// @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
// @Tags Envelopes
// @Success 204
// @Router /v4/envelopes [options]
func OptionsEnvelopeList(c *gin.Context) {
httputil.OptionsGetPost(c)
}
// @Summary Allowed HTTP verbs
// @Description Returns an empty response with the HTTP Header "allow" set to the allowed HTTP verbs
// @Tags Envelopes
// @Success 204
// @Failure 400 {object} httpError
// @Failure 404 {object} httpError
// @Failure 500 {object} httpError
// @Param id path string true "ID formatted as string"
// @Router /v4/envelopes/{id} [options]
func OptionsEnvelopeDetail(c *gin.Context) {
id, err := httputil.UUIDFromString(c.Param("id"))
if err != nil {
c.JSON(status(err), httpError{
Error: err.Error(),
})
return
}
err = models.DB.First(&models.Envelope{}, id).Error
if err != nil {
c.JSON(status(err), httpError{
Error: err.Error(),
})
return
}
httputil.OptionsGetPatchDelete(c)
}
// @Summary Create envelope
// @Description Creates a new envelope
// @Tags Envelopes
// @Produce json
// @Success 201 {object} EnvelopeCreateResponse
// @Failure 400 {object} EnvelopeCreateResponse
// @Failure 404 {object} EnvelopeCreateResponse
// @Failure 500 {object} EnvelopeCreateResponse
// @Param envelope body []v4.EnvelopeEditable true "Envelopes"
// @Router /v4/envelopes [post]
func CreateEnvelopes(c *gin.Context) {
var envelopes []EnvelopeEditable
// Bind data and return error if not possible
err := httputil.BindData(c, &envelopes)
if err != nil {
e := err.Error()
c.JSON(status(err), EnvelopeCreateResponse{
Error: &e,
})
return
}
// The final http status. Will be modified when errors occur
status := http.StatusCreated
r := EnvelopeCreateResponse{}
for _, editable := range envelopes {
envelope := editable.model()
err = models.DB.Create(&envelope).Error
if err != nil {
status = r.appendError(err, status)
continue
}
data := newEnvelope(c, envelope)
r.Data = append(r.Data, EnvelopeResponse{Data: &data})
}
c.JSON(status, r)
}
// @Summary Get envelopes
// @Description Returns a list of envelopes
// @Tags Envelopes
// @Produce json
// @Success 200 {object} EnvelopeListResponse
// @Failure 400 {object} EnvelopeListResponse
// @Failure 500 {object} EnvelopeListResponse
// @Router /v4/envelopes [get]
// @Param name query string false "Filter by name"
// @Param note query string false "Filter by note"
// @Param category query string false "Filter by category ID"
// @Param archived query bool false "Is the envelope archived?"
// @Param search query string false "Search for this text in name and note"
// @Param offset query uint false "The offset of the first Envelope returned. Defaults to 0."
// @Param limit query int false "Maximum number of Envelopes to return. Defaults to 50."
func GetEnvelopes(c *gin.Context) {
var filter EnvelopeQueryFilter
// The filters contain only strings, so this will always succeed
_ = c.Bind(&filter)
queryFields, setFields := httputil.GetURLFields(c.Request.URL, filter)
// Convert the QueryFilter to a Create struct
model, err := filter.model()
if err != nil {
s := err.Error()
c.JSON(status(err), EnvelopeListResponse{
Error: &s,
})
return
}
q := models.DB.
Order("envelopes.name ASC").
Where(&model, queryFields...)
q = stringFilters(models.DB, q, setFields, filter.Name, filter.Note, filter.Search)
if filter.BudgetID != "" {
budgetID, err := httputil.UUIDFromString(filter.BudgetID)
if err != nil {
s := fmt.Sprintf("Error parsing budget ID for filtering: %s", err.Error())
c.JSON(status(err), EnvelopeListResponse{
Error: &s,
})
return
}
q = q.
Joins("JOIN categories on categories.id = envelopes.category_id").
Joins("JOIN budgets on budgets.id = categories.budget_id").
Where("budgets.id = ?", budgetID)
}
// Set the offset. Does not need checking since the default is 0
q = q.Offset(int(filter.Offset))
// Default to 50 Accounts and set the limit
limit := 50
if slices.Contains(setFields, "Limit") {
limit = filter.Limit
}
q = q.Limit(limit)
var envelopes []models.Envelope
err = q.Find(&envelopes).Error
if err != nil {
s := err.Error()
c.JSON(status(err), EnvelopeListResponse{
Error: &s,
})
return
}
var count int64
err = q.Limit(-1).Offset(-1).Count(&count).Error
if err != nil {
e := err.Error()
c.JSON(status(err), EnvelopeListResponse{
Error: &e,
})
return
}
data := make([]Envelope, 0, len(envelopes))
for _, envelope := range envelopes {
data = append(data, newEnvelope(c, envelope))
}
c.JSON(http.StatusOK, EnvelopeListResponse{
Data: data,
Pagination: &Pagination{
Count: len(data),
Total: count,
Offset: filter.Offset,
Limit: limit,
},
})
}
// @Summary Get Envelope
// @Description Returns a specific Envelope
// @Tags Envelopes
// @Produce json
// @Success 200 {object} EnvelopeResponse
// @Failure 400 {object} EnvelopeResponse
// @Failure 404 {object} EnvelopeResponse
// @Failure 500 {object} EnvelopeResponse
// @Param id path string true "ID formatted as string"
// @Router /v4/envelopes/{id} [get]
func GetEnvelope(c *gin.Context) {
id, err := httputil.UUIDFromString(c.Param("id"))
if err != nil {
s := err.Error()
c.JSON(status(err), EnvelopeResponse{
Error: &s,
})
return
}
var envelope models.Envelope
err = models.DB.First(&envelope, id).Error
if err != nil {
s := err.Error()
c.JSON(status(err), EnvelopeResponse{
Error: &s,
})
return
}
data := newEnvelope(c, envelope)
c.JSON(http.StatusOK, EnvelopeResponse{Data: &data})
}
// @Summary Update envelope
// @Description Updates an existing envelope. Only values to be updated need to be specified.
// @Tags Envelopes
// @Accept json
// @Produce json
// @Success 200 {object} EnvelopeResponse
// @Failure 400 {object} EnvelopeResponse
// @Failure 404 {object} EnvelopeResponse
// @Failure 500 {object} EnvelopeResponse
// @Param id path string true "ID formatted as string"
// @Param envelope body v4.EnvelopeEditable true "Envelope"
// @Router /v4/envelopes/{id} [patch]
func UpdateEnvelope(c *gin.Context) {
id, err := httputil.UUIDFromString(c.Param("id"))
if err != nil {
s := err.Error()
c.JSON(status(err), EnvelopeResponse{
Error: &s,
})
return
}
var envelope models.Envelope
err = models.DB.First(&envelope, id).Error
if err != nil {
s := err.Error()
c.JSON(status(err), EnvelopeResponse{
Error: &s,
})
return
}
updateFields, err := httputil.GetBodyFields(c, EnvelopeEditable{})
if err != nil {
s := err.Error()
c.JSON(status(err), EnvelopeResponse{
Error: &s,
})
return
}
var data EnvelopeEditable
err = httputil.BindData(c, &data)
if err != nil {
s := err.Error()
c.JSON(status(err), EnvelopeResponse{
Error: &s,
})
return
}
err = models.DB.Model(&envelope).Select("", updateFields...).Updates(data.model()).Error
if err != nil {
s := err.Error()
c.JSON(status(err), EnvelopeResponse{
Error: &s,
})
return
}
apiResource := newEnvelope(c, envelope)
c.JSON(http.StatusOK, EnvelopeResponse{Data: &apiResource})
}
// @Summary Delete envelope
// @Description Deletes an envelope
// @Tags Envelopes
// @Success 204
// @Failure 400 {object} httpError
// @Failure 404 {object} httpError
// @Failure 500 {object} httpError
// @Param id path string true "ID formatted as string"
// @Router /v4/envelopes/{id} [delete]
func DeleteEnvelope(c *gin.Context) {
id, err := httputil.UUIDFromString(c.Param("id"))
if err != nil {
c.JSON(status(err), httpError{
Error: err.Error(),
})
return
}
var envelope models.Envelope
err = models.DB.First(&envelope, id).Error
if err != nil {
c.JSON(status(err), httpError{
Error: err.Error(),
})
return
}
err = models.DB.Delete(&envelope).Error
if err != nil {
c.JSON(status(err), httpError{
Error: err.Error(),
})
return
}
c.JSON(http.StatusNoContent, nil)
}