/
property.go
346 lines (287 loc) · 10.4 KB
/
property.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
package papi
import (
"context"
"errors"
"fmt"
"net/http"
"net/url"
"github.com/akamai/AkamaiOPEN-edgegrid-golang/v5/pkg/edgegriderr"
validation "github.com/go-ozzo/ozzo-validation/v4"
)
type (
// Properties contains operations available on Property resource
Properties interface {
// GetProperties lists properties available for the current contract and group
//
// https://techdocs.akamai.com/property-mgr/reference/get-products
GetProperties(ctx context.Context, r GetPropertiesRequest) (*GetPropertiesResponse, error)
// CreateProperty creates a new property from scratch or bases one on another property's rule tree and optionally its set of assigned hostnames
//
// https://techdocs.akamai.com/property-mgr/reference/post-properties
CreateProperty(ctx context.Context, params CreatePropertyRequest) (*CreatePropertyResponse, error)
// GetProperty gets a specific property
//
// https://techdocs.akamai.com/property-mgr/reference/get-property
GetProperty(ctx context.Context, params GetPropertyRequest) (*GetPropertyResponse, error)
// RemoveProperty removes a specific property, which you can only do if none of its versions are currently active
//
// https://techdocs.akamai.com/property-mgr/reference/delete-property
RemoveProperty(ctx context.Context, params RemovePropertyRequest) (*RemovePropertyResponse, error)
}
// PropertyCloneFrom optionally identifies another property instance to clone when making a POST request to create a new property
PropertyCloneFrom struct {
CloneFromVersionEtag string `json:"cloneFromVersionEtag,omitempty"`
CopyHostnames bool `json:"copyHostnames,omitempty"`
PropertyID string `json:"propertyId"`
Version int `json:"version"`
}
// Property contains configuration data to apply to edge content.
Property struct {
AccountID string `json:"accountId"`
AssetID string `json:"assetId"`
ContractID string `json:"contractId"`
GroupID string `json:"groupId"`
LatestVersion int `json:"latestVersion"`
Note string `json:"note"`
ProductID string `json:"productId"`
ProductionVersion *int `json:"productionVersion,omitempty"`
PropertyID string `json:"propertyId"`
PropertyName string `json:"propertyName"`
RuleFormat string `json:"ruleFormat"`
StagingVersion *int `json:"stagingVersion,omitempty"`
}
// PropertiesItems is an array of properties
PropertiesItems struct {
Items []*Property `json:"items"`
}
// GetPropertiesRequest is the argument for GetProperties
GetPropertiesRequest struct {
ContractID string
GroupID string
}
// GetPropertiesResponse is the response for GetProperties
GetPropertiesResponse struct {
Properties PropertiesItems `json:"properties"`
}
// CreatePropertyRequest is passed to CreateProperty
CreatePropertyRequest struct {
ContractID string
GroupID string
Property PropertyCreate
}
// PropertyCreate represents a POST /property request body
PropertyCreate struct {
CloneFrom *PropertyCloneFrom `json:"cloneFrom,omitempty"`
ProductID string `json:"productId"`
PropertyName string `json:"propertyName"`
RuleFormat string `json:"ruleFormat,omitempty"`
}
// CreatePropertyResponse is returned by CreateProperty
CreatePropertyResponse struct {
Response
PropertyID string
PropertyLink string `json:"propertyLink"`
}
// GetPropertyRequest is the argument for GetProperty
GetPropertyRequest struct {
ContractID string
GroupID string
PropertyID string
}
// GetPropertyResponse is the response for GetProperty
GetPropertyResponse struct {
Response
Properties PropertiesItems `json:"properties"`
Property *Property `json:"-"`
}
// RemovePropertyRequest is the argument for RemoveProperty
RemovePropertyRequest struct {
PropertyID string
ContractID string
GroupID string
}
// RemovePropertyResponse is the response for GetProperties
RemovePropertyResponse struct {
Message string `json:"message"`
}
)
// Validate validates GetPropertiesRequest
func (v GetPropertiesRequest) Validate() error {
return validation.Errors{
"ContractID": validation.Validate(v.ContractID, validation.Required),
"GroupID": validation.Validate(v.GroupID, validation.Required),
}.Filter()
}
// Validate validates CreatePropertyRequest
func (v CreatePropertyRequest) Validate() error {
errs := validation.Errors{
"ContractID": validation.Validate(v.ContractID, validation.Required),
"GroupID": validation.Validate(v.GroupID, validation.Required),
"Property": validation.Validate(v.Property),
}
return edgegriderr.ParseValidationErrors(errs)
}
// Validate validates PropertyCreate
func (p PropertyCreate) Validate() error {
return validation.Errors{
"ProductID": validation.Validate(p.ProductID, validation.Required),
"PropertyName": validation.Validate(p.PropertyName, validation.Required),
"CloneFrom": validation.Validate(p.CloneFrom),
}.Filter()
}
// Validate validates PropertyCloneFrom
func (c PropertyCloneFrom) Validate() error {
return validation.Errors{
"PropertyID": validation.Validate(c.PropertyID),
"Version": validation.Validate(c.Version),
}.Filter()
}
// Validate validates GetPropertyRequest
func (v GetPropertyRequest) Validate() error {
return validation.Errors{
"PropertyID": validation.Validate(v.PropertyID, validation.Required),
}.Filter()
}
// Validate validates RemovePropertyRequest
func (v RemovePropertyRequest) Validate() error {
return validation.Errors{
"PropertyID": validation.Validate(v.PropertyID, validation.Required),
}.Filter()
}
var (
// ErrGetProperties represents error when fetching properties fails
ErrGetProperties = errors.New("fetching properties")
// ErrGetProperty represents error when fetching property fails
ErrGetProperty = errors.New("fetching property")
// ErrCreateProperty represents error when creating property fails
ErrCreateProperty = errors.New("creating property")
// ErrRemoveProperty represents error when removing property fails
ErrRemoveProperty = errors.New("removing property")
)
func (p *papi) GetProperties(ctx context.Context, params GetPropertiesRequest) (*GetPropertiesResponse, error) {
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%s: %w: %s", ErrGetProperties, ErrStructValidation, err)
}
var rval GetPropertiesResponse
logger := p.Log(ctx)
logger.Debug("GetProperties")
uri := fmt.Sprintf(
"/papi/v1/properties?contractId=%s&groupId=%s",
params.ContractID,
params.GroupID)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, fmt.Errorf("%w: failed to create request: %s", ErrGetProperties, err)
}
resp, err := p.Exec(req, &rval)
if err != nil {
return nil, fmt.Errorf("%w: request failed: %s", ErrGetProperties, err)
}
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("%s: %w", ErrGetProperties, p.Error(resp))
}
return &rval, nil
}
func (p *papi) CreateProperty(ctx context.Context, params CreatePropertyRequest) (*CreatePropertyResponse, error) {
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%s: %w:\n%s", ErrCreateProperty, ErrStructValidation, err)
}
logger := p.Log(ctx)
logger.Debug("CreateProperty")
uri := fmt.Sprintf(
"/papi/v1/properties?contractId=%s&groupId=%s",
params.ContractID,
params.GroupID)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, nil)
if err != nil {
return nil, fmt.Errorf("%w: failed to create request: %s", ErrCreateProperty, err)
}
var rval CreatePropertyResponse
resp, err := p.Exec(req, &rval, params.Property)
if err != nil {
return nil, fmt.Errorf("%w: request failed: %s", ErrCreateProperty, err)
}
if resp.StatusCode != http.StatusCreated {
return nil, fmt.Errorf("%s: %w", ErrCreateProperty, p.Error(resp))
}
id, err := ResponseLinkParse(rval.PropertyLink)
if err != nil {
return nil, fmt.Errorf("%s: %w: %s", ErrCreateProperty, ErrInvalidResponseLink, err)
}
rval.PropertyID = id
return &rval, nil
}
func (p *papi) GetProperty(ctx context.Context, params GetPropertyRequest) (*GetPropertyResponse, error) {
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%s: %w: %s", ErrGetProperty, ErrStructValidation, err)
}
var rval GetPropertyResponse
logger := p.Log(ctx)
logger.Debug("GetProperty")
uri, err := url.Parse(fmt.Sprintf(
"/papi/v1/properties/%s",
params.PropertyID),
)
if err != nil {
return nil, fmt.Errorf("%w: failed to parse url: %s", ErrGetProperty, err)
}
q := uri.Query()
if params.GroupID != "" {
q.Add("groupId", params.GroupID)
}
if params.ContractID != "" {
q.Add("contractId", params.ContractID)
}
uri.RawQuery = q.Encode()
req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri.String(), nil)
if err != nil {
return nil, fmt.Errorf("%w: failed to create request: %s", ErrGetProperty, err)
}
resp, err := p.Exec(req, &rval)
if err != nil {
return nil, fmt.Errorf("%w: request failed: %s", ErrGetProperty, err)
}
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("%s: %w", ErrGetProperty, p.Error(resp))
}
if len(rval.Properties.Items) == 0 {
return nil, fmt.Errorf("%s: %w: PropertyID: %s", ErrGetProperty, ErrNotFound, params.PropertyID)
}
rval.Property = rval.Properties.Items[0]
return &rval, nil
}
func (p *papi) RemoveProperty(ctx context.Context, params RemovePropertyRequest) (*RemovePropertyResponse, error) {
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("%s: %w: %s", ErrRemoveProperty, ErrStructValidation, err)
}
var rval RemovePropertyResponse
logger := p.Log(ctx)
logger.Debug("RemoveProperty")
uri, err := url.Parse(fmt.Sprintf(
"/papi/v1/properties/%s",
params.PropertyID),
)
if err != nil {
return nil, fmt.Errorf("%w: failed parse url: %s", ErrRemoveProperty, err)
}
q := uri.Query()
if params.GroupID != "" {
q.Add("groupId", params.GroupID)
}
if params.ContractID != "" {
q.Add("contractId", params.ContractID)
}
uri.RawQuery = q.Encode()
req, err := http.NewRequestWithContext(ctx, http.MethodDelete, uri.String(), nil)
if err != nil {
return nil, fmt.Errorf("%w: failed to create request: %s", ErrRemoveProperty, err)
}
resp, err := p.Exec(req, &rval)
if err != nil {
return nil, fmt.Errorf("%w: request failed: %s", ErrRemoveProperty, err)
}
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("%s: %w", ErrRemoveProperty, p.Error(resp))
}
return &rval, nil
}