forked from zambien/go-apigee-edge
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apigee_edge.go
409 lines (347 loc) · 10.6 KB
/
apigee_edge.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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
// Package apigee provides a client for administering Apigee Edge.
package apigee
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"log"
"net/http"
"net/http/httputil"
"net/url"
"os"
"path"
"reflect"
"github.com/bgentry/go-netrc/netrc"
"github.com/google/go-querystring/query"
"github.com/sethgrid/pester"
)
const (
libraryVersion = "0.1.0"
defaultBaseURL = "https://api.enterprise.apigee.com/"
userAgent = "go-apigee-edge/" + libraryVersion
appJSON = "application/json"
octetStream = "application/octet-stream"
)
// EdgeClient manages communication with Apigee Edge V1 Admin API.
type EdgeClient struct {
// HTTP client used to communicate with the Edge API.
client pester.Client
auth *EdgeAuth
debug bool
// Base URL for API requests.
BaseURL *url.URL
// User agent for client
UserAgent string
// Services used for communicating with the API
Proxies ProxiesService
TargetServers TargetServersService
Products ProductsService
Developers DeveloperService
Companies CompanyService
CompanyApps CompanyAppService
DeveloperApps DeveloperAppService
SharedFlows SharedFlowService
// Account AccountService
// Actions ActionsService
// Domains DomainsService
// DropletActions DropletActionsService
// Images ImagesService
// ImageActions ImageActionsService
// Keys KeysService
// Regions RegionsService
// Sizes SizesService
// FloatingIPs FloatingIPsService
// FloatingIPActions FloatingIPActionsService
// Storage StorageService
// StorageActions StorageActionsService
// Tags TagsService
// Optional function called after every successful request made to the DO APIs
onRequestCompleted RequestCompletionCallback
}
// RequestCompletionCallback defines the type of the request callback function
type RequestCompletionCallback func(*http.Request, *http.Response)
// ListOptions holds optional parameters to various List methods
type ListOptions struct {
// to ask for expanded results
Expand bool `url:"expand"`
}
// wrap the standard http.Response returned from Apigee Edge. (why?)
type Response struct {
*http.Response
}
// An ErrorResponse reports the error caused by an API request
type ErrorResponse struct {
// HTTP response that caused this error
Response *http.Response
// Error message - maybe the json for this is "fault"
Message string `json:"message"`
}
func addOptions(s string, opt interface{}) (string, error) {
v := reflect.ValueOf(opt)
if v.Kind() == reflect.Ptr && v.IsNil() {
return s, nil
}
origURL, err := url.Parse(s)
if err != nil {
return s, err
}
origValues := origURL.Query()
newValues, err := query.Values(opt)
if err != nil {
return s, err
}
for k, v := range newValues {
origValues[k] = v
}
origURL.RawQuery = origValues.Encode()
return origURL.String(), nil
}
type EdgeClientOptions struct {
pesterClient *pester.Client
// Optional. The Admin base URL. For example, if using OPDK this might be
// http://192.168.10.56:8080 . It defaults to https://api.enterprise.apigee.com
MgmtUrl string
// Specify the Edge organization name.
Org string
// Required. Authentication information for the Edge Management server.
Auth *EdgeAuth
// Optional. Warning: if set to true, HTTP Basic Auth base64 blobs will appear in output.
Debug bool
}
// EdgeAuth holds information about how to authenticate to the Edge Management server.
type EdgeAuth struct {
// Optional. The path to the .netrc file that holds credentials for the Edge Management server.
// By default, this is ${HOME}/.netrc . If you specify a Password, this option is ignored.
NetrcPath string
// Optional. The username to use when authenticating to the Edge Management server.
// Ignored if you specify a NetrcPath.
Username string
// Optional. Used if you explicitly specify a Password.
Password string
// Optional. Access token used for OAuth
AccessToken string
}
func retrieveAuthFromNetrc(netrcPath, host string) (*EdgeAuth, error) {
if netrcPath == "" {
netrcPath = os.ExpandEnv("${HOME}/.netrc")
}
n, e := netrc.ParseFile(netrcPath)
if e != nil {
fmt.Printf("while parsing .netrc, error:\n%#v\n", e)
return nil, e
}
machine := n.FindMachine(host) // eg, "api.enterprise.apigee.com"
if machine == nil || machine.Password == "" {
msg := fmt.Sprintf("while scanning %s, cannot find machine:%s", netrcPath, host)
return nil, errors.New(msg)
}
auth := &EdgeAuth{Username: machine.Login, Password: machine.Password}
return auth, nil
}
// NewEdgeClient returns a new EdgeClient.
func NewEdgeClient(o *EdgeClientOptions) (*EdgeClient, error) {
pesterClient := o.pesterClient
if o.pesterClient == nil {
pesterClient = pester.New()
}
pesterClient.MaxRetries = 5
pesterClient.Backoff = pester.LinearBackoff //n seconds where n is the retry number
mgmtUrl := o.MgmtUrl
if o.MgmtUrl == "" {
mgmtUrl = defaultBaseURL
}
baseURL, err := url.Parse(mgmtUrl)
if err != nil {
return nil, err
}
baseURL.Path = path.Join(baseURL.Path, "v1/o/", o.Org, "/")
c := &EdgeClient{client: *pesterClient, BaseURL: baseURL, UserAgent: userAgent}
c.Proxies = &ProxiesServiceOp{client: c}
c.TargetServers = &TargetServersServiceOp{client: c}
c.Products = &ProductsServiceOp{client: c}
c.Developers = &DeveloperServiceOp{client: c}
c.Companies = &CompanyServiceOp{client: c}
c.CompanyApps = &CompanyAppServiceOp{client: c}
c.DeveloperApps = &DeveloperAppServiceOp{client: c}
c.SharedFlows = &SharedFlowServiceOp{client: c}
var e error = nil
if o.Auth == nil {
c.auth, e = retrieveAuthFromNetrc("", baseURL.Host)
} else if o.Auth.AccessToken != "" {
c.auth = &EdgeAuth{AccessToken: o.Auth.AccessToken}
} else if o.Auth.Password == "" {
c.auth, e = retrieveAuthFromNetrc(o.Auth.NetrcPath, baseURL.Host)
} else {
c.auth = &EdgeAuth{Username: o.Auth.Username, Password: o.Auth.Password}
}
if e != nil {
return nil, e
}
if o.Debug {
c.debug = true
c.onRequestCompleted = func(req *http.Request, resp *http.Response) {
debugDump(httputil.DumpResponse(resp, true))
}
}
return c, nil
}
// NewRequest creates an API request. A relative URL can be provided in urlStr,
// which will be resolved to the BaseURL of the Client. Relative URLS should
// always be specified without a preceding slash. If specified, the value
// pointed to by body is JSON encoded and included in as the request body.
func (c *EdgeClient) NewRequest(method, urlStr string, body interface{}, contentTypeOverride string) (*http.Request, error) {
rel, err := url.Parse(urlStr)
ctype := ""
if err != nil {
return nil, err
}
u := c.BaseURL.ResolveReference(rel)
u.Path = path.Join(c.BaseURL.Path, rel.Path)
fmt.Printf("u: %#v\n", u)
var req *http.Request
if body != nil {
switch body.(type) {
default:
ctype = appJSON
buf := new(bytes.Buffer)
err := json.NewEncoder(buf).Encode(body)
if err != nil {
return nil, err
}
req, err = http.NewRequest(method, u.String(), buf)
case io.Reader:
ctype = octetStream
req, err = http.NewRequest(method, u.String(), body.(io.Reader))
}
} else {
req, err = http.NewRequest(method, u.String(), nil)
}
if err != nil {
return nil, err
}
if contentTypeOverride != "" {
req.Header.Add("Content-Type", contentTypeOverride)
} else {
if ctype != "" {
req.Header.Add("Content-Type", ctype)
}
req.Header.Add("Accept", appJSON)
req.Header.Add("User-Agent", c.UserAgent)
}
if c.auth.AccessToken != "" {
req.Header.Add("Authorization", "Bearer "+c.auth.AccessToken)
} else {
req.SetBasicAuth(c.auth.Username, c.auth.Password)
}
return req, nil
}
// sets the request completion callback for the API
func (c *EdgeClient) OnRequestCompleted(rc RequestCompletionCallback) {
c.onRequestCompleted = rc
}
// newResponse creates a new Response for the provided http.Response
func newResponse(r *http.Response) *Response {
response := Response{Response: r}
return &response
}
func debugDump(data []byte, err error) {
if err == nil {
fmt.Printf("%s\n\n", data)
} else {
log.Fatalf("%s\n\n", err)
}
}
// Do sends an API request and returns the API response. The API response is
// JSON decoded and stored in the value pointed to by v, or returned as an error
// if an API error has occurred. If v implements the io.Writer interface, the
// raw response will be written to v, without attempting to decode it.
func (c *EdgeClient) Do(req *http.Request, v interface{}) (*Response, error) {
if c.debug {
debugDump(httputil.DumpRequestOut(req, true))
}
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
if c.onRequestCompleted != nil {
c.onRequestCompleted(req, resp)
}
defer func() {
if rerr := resp.Body.Close(); err == nil {
err = rerr
}
}()
response := newResponse(resp)
err = CheckResponse(resp)
if err != nil {
return response, err
}
if v != nil {
if w, ok := v.(io.Writer); ok {
_, err := io.Copy(w, resp.Body)
if err != nil {
return nil, err
}
} else {
err := json.NewDecoder(resp.Body).Decode(v)
if err != nil {
return nil, err
}
}
}
return response, err
}
func (r *ErrorResponse) Error() string {
return fmt.Sprintf("%v %v: %d %v",
r.Response.Request.Method, r.Response.Request.URL, r.Response.StatusCode, r.Message)
}
// CheckResponse checks the API response for errors, and returns them if
// present. A response is considered an error if it has a status code outside
// the 200 range. API error responses are expected to have either no response
// body, or a JSON response body that maps to ErrorResponse. Any other response
// body will be silently ignored.
func CheckResponse(r *http.Response) error {
if c := r.StatusCode; c >= 200 && c <= 299 {
return nil
}
errorResponse := &ErrorResponse{Response: r}
data, err := ioutil.ReadAll(r.Body)
if err == nil && len(data) > 0 {
err := json.Unmarshal(data, errorResponse)
if err != nil {
return err
}
}
return errorResponse
}
// String is a helper routine that allocates a new string value
// to store v and returns a pointer to it.
func String(v string) *string {
p := new(string)
*p = v
return p
}
// Int is a helper routine that allocates a new int32 value
// to store v and returns a pointer to it, but unlike Int32
// its argument value is an int.
func Int(v int) *int {
p := new(int)
*p = v
return p
}
// Bool is a helper routine that allocates a new bool value
// to store v and returns a pointer to it.
func Bool(v bool) *bool {
p := new(bool)
*p = v
return p
}
// StreamToString converts a reader to a string
func StreamToString(stream io.Reader) string {
buf := new(bytes.Buffer)
_, _ = buf.ReadFrom(stream)
return buf.String()
}