-
Notifications
You must be signed in to change notification settings - Fork 2
/
collections.go
302 lines (245 loc) · 8.99 KB
/
collections.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
package outline
import (
"context"
"fmt"
"github.com/ioki-mobility/go-outline/internal/common"
"github.com/rsjethani/rsling"
)
// CollectionsClient exposes CRUD operations around the collections resource.
type CollectionsClient struct {
sl *rsling.Sling
}
func newCollectionsClient(sl *rsling.Sling) *CollectionsClient {
return &CollectionsClient{sl: sl}
}
// DocumentStructure gives access to id's document structure.
// API Reference: https://www.getoutline.com/developers#tag/Collections/paths/~1collections.documents/post
func (cl *CollectionsClient) DocumentStructure(id CollectionID) *CollectionsDocumentStructureClient {
return newCollectionsDocumentStructureClient(cl.sl, id)
}
func (cl *CollectionsClient) Get(id CollectionID) *CollectionsGetClient {
return newCollectionsGetClient(cl.sl, id)
}
func (cl *CollectionsClient) List() *CollectionsListClient {
return newCollectionListClient(cl.sl)
}
// Create returns a client for creating a collection.
// API reference: https://www.getoutline.com/developers#tag/Collections/paths/~1collections.create/post
func (cl *CollectionsClient) Create(name string) *CollectionsCreateClient {
return newCollectionsCreateClient(cl.sl, name)
}
// Update returns a client for updating a collection.
// API reference: https://www.getoutline.com/developers#tag/Collections/paths/~1collections.update/post
func (cl *CollectionsClient) Update(id CollectionID) *CollectionsUpdateClient {
return newCollectionsUpdateClient(cl.sl, id)
}
type CollectionsDocumentStructureClient struct {
sl *rsling.Sling
}
func newCollectionsDocumentStructureClient(sl *rsling.Sling, id CollectionID) *CollectionsDocumentStructureClient {
data := struct {
ID CollectionID `json:"id"`
}{ID: id}
copy := sl.New()
copy.Post(common.CollectionsStructureEndpoint()).BodyJSON(&data)
return &CollectionsDocumentStructureClient{sl: copy}
}
type DocumentStructure []DocumentSummary
// Do makes the actual request for getting the collection's document structure.
func (cl *CollectionsDocumentStructureClient) Do(ctx context.Context) (DocumentStructure, error) {
success := &struct {
Data DocumentStructure `json:"data"`
}{}
br, err := request(ctx, cl.sl, success)
if err != nil {
return nil, fmt.Errorf("failed making HTTP request: %w", err)
}
if br != nil {
return nil, fmt.Errorf("bad response: %w", &apiError{br: *br})
}
return success.Data, nil
}
type CollectionsGetClient struct {
sl *rsling.Sling
}
func newCollectionsGetClient(sl *rsling.Sling, id CollectionID) *CollectionsGetClient {
data := struct {
ID CollectionID `json:"id"`
}{ID: id}
copy := sl.New()
copy.Post(common.CollectionsGetEndpoint()).BodyJSON(&data)
return &CollectionsGetClient{sl: copy}
}
// Do makes the actual request for fetching said collection info.
func (cl *CollectionsGetClient) Do(ctx context.Context) (*Collection, error) {
success := &struct {
Data *Collection `json:"data"`
}{}
br, err := request(ctx, cl.sl, success)
if err != nil {
return nil, fmt.Errorf("failed making HTTP request: %w", err)
}
if br != nil {
return nil, fmt.Errorf("bad response: %w", &apiError{br: *br})
}
return success.Data, nil
}
type CollectionsListClient struct {
sl *rsling.Sling
}
func newCollectionListClient(sl *rsling.Sling) *CollectionsListClient {
copy := sl.New()
copy.Post(common.CollectionsListEndpoint())
return &CollectionsListClient{sl: copy}
}
// CollectionsListFn is the type of function called by [CollectionsListClient.Do] for every new collection it finds.
type CollectionsListFn func(*Collection, error) (bool, error)
// Do makes the actual request for listing all collections. If the request is successful then fn is called sequentially
// with every collection received. But if there is some error/bad response then fn is called with the error. If fn
// returns false then the whole process is aborted otherwise the request is retried. NOTE: Policies if any returned are
// ignored as of now. Later if we find them important then we can include them too.
func (cl *CollectionsListClient) Do(ctx context.Context, fn CollectionsListFn) error {
success := &struct {
Data []*Collection `json:"data"`
Pagination pagination `json:"pagination"`
}{}
params := &paginationQueryParams{}
for {
// Create a fresh copy of original request for every page then set query parameters accordingly.
copy := cl.sl.New().QueryStruct(params)
// Make the request and see if there is an error/bad response. If there is one then give fn the error ask for
// its intention. If fn still wants to continue then we abort further processing in current iteration and
// basically retry the same request again.
br, err := request(ctx, copy, success)
if err != nil {
err = fmt.Errorf("failed making HTTP request: %w", err)
}
if br != nil {
err = fmt.Errorf("bad response: %w", &apiError{br: *br})
}
if err != nil {
if ok, e := fn(nil, err); !ok {
return e
}
continue
}
// If we are here then it means there was no error/bad response while fetching current page
// so let's iterate over page items.
for _, col := range success.Data {
if ok, e := fn(col, nil); !ok {
return e
}
}
// If there is more than one item in current list then there could be more items remaining to be fetched. In
// that case we adjust offset for next request. If there are no items or just a single item in the list that
// means there are no more items to be fetched, and we are done.
if len(success.Data) <= 1 {
return nil
}
params.Offset += len(success.Data)
}
}
// collectionsCreateParams represents the Outline Collections.create parameters
type collectionsCreateParams struct {
Name string `json:"name"`
Description string `json:"description,omitempty"`
Permission string `json:"permission,omitempty"`
Color string `json:"color,omitempty"`
Private bool `json:"private,omitempty"`
}
type CollectionsCreateClient struct {
sl *rsling.Sling
params collectionsCreateParams
}
func newCollectionsCreateClient(sl *rsling.Sling, name string) *CollectionsCreateClient {
copy := sl.New()
params := collectionsCreateParams{Name: name}
return &CollectionsCreateClient{sl: copy, params: params}
}
func (cl *CollectionsCreateClient) Description(desc string) *CollectionsCreateClient {
cl.params.Description = desc
return cl
}
func (cl *CollectionsCreateClient) PermissionRead() *CollectionsCreateClient {
cl.params.Permission = "read"
return cl
}
func (cl *CollectionsCreateClient) PermissionReadWrite() *CollectionsCreateClient {
cl.params.Permission = "read_write"
return cl
}
func (cl *CollectionsCreateClient) Color(color string) *CollectionsCreateClient {
cl.params.Color = color
return cl
}
func (cl *CollectionsCreateClient) Private(private bool) *CollectionsCreateClient {
cl.params.Private = private
return cl
}
// Do make the actual request to create a collection.
func (cl *CollectionsCreateClient) Do(ctx context.Context) (*Collection, error) {
cl.sl.Post(common.CollectionsCreateEndpoint()).BodyJSON(&cl.params)
success := &struct {
Data *Collection `json:"data"`
}{}
br, err := request(ctx, cl.sl, success)
if err != nil {
return nil, fmt.Errorf("failed making HTTP request: %w", err)
}
if br != nil {
return nil, fmt.Errorf("bad response: %w", &apiError{br: *br})
}
return success.Data, nil
}
// collectionsUpdateParams represents the Outline Collections.update parameters
type collectionsUpdateParams struct {
ID CollectionID `json:"id"`
Name string `json:"name"`
Permission string `json:"permission,omitempty"`
Description string `json:"description,omitempty"`
Color string `json:"color,omitempty"`
}
type CollectionsUpdateClient struct {
sl *rsling.Sling
params collectionsUpdateParams
}
func newCollectionsUpdateClient(sl *rsling.Sling, id CollectionID) *CollectionsUpdateClient {
copy := sl.New()
params := collectionsUpdateParams{ID: id}
return &CollectionsUpdateClient{sl: copy, params: params}
}
func (cl *CollectionsUpdateClient) Name(name string) *CollectionsUpdateClient {
cl.params.Name = name
return cl
}
func (cl *CollectionsUpdateClient) PermissionRead() *CollectionsUpdateClient {
cl.params.Permission = "read"
return cl
}
func (cl *CollectionsUpdateClient) PermissionReadWrite() *CollectionsUpdateClient {
cl.params.Permission = "read_write"
return cl
}
func (cl *CollectionsUpdateClient) Color(color string) *CollectionsUpdateClient {
cl.params.Color = color
return cl
}
func (cl *CollectionsUpdateClient) Description(desc string) *CollectionsUpdateClient {
cl.params.Description = desc
return cl
}
// Do makes the actual request for updating the collection.
func (cl *CollectionsUpdateClient) Do(ctx context.Context) (*Collection, error) {
cl.sl.Post(common.CollectionsUpdateEndpoint()).BodyJSON(&cl.params)
success := &struct {
Data *Collection `json:"data"`
}{}
br, err := request(ctx, cl.sl, success)
if err != nil {
return nil, fmt.Errorf("failed making HTTP request: %w", err)
}
if br != nil {
return nil, fmt.Errorf("bad response: %w", &apiError{br: *br})
}
return success.Data, nil
}