-
Notifications
You must be signed in to change notification settings - Fork 0
/
client.go
471 lines (379 loc) · 10.1 KB
/
client.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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
package minox
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"log"
"net/http"
"net/http/httputil"
"net/url"
"path"
"strconv"
"strings"
"sync"
"text/template"
"time"
)
const (
libraryVersion = "0.0.1"
userAgent = "go-minox/" + libraryVersion
mediaType = "application/json"
charset = "utf-8"
apiVersion = "1"
)
var (
BaseURL = url.URL{
Scheme: "https",
Host: "app.minox.nl",
Path: "api/{{.version}}/tenant/{{.tenant_id}}",
}
)
// NewClient returns a new InvoiceXpress Client client
func NewClient(httpClient *http.Client, tenantID int) *Client {
if httpClient == nil {
httpClient = http.DefaultClient
}
client := &Client{
http: httpClient,
requestTimestamps: []time.Time{},
}
client.SetTenantID(tenantID)
client.SetBaseURL(BaseURL)
client.SetDebug(false)
client.SetUserAgent(userAgent)
client.SetMediaType(mediaType)
client.SetCharset(charset)
return client
}
// Client manages communication with InvoiceXpress Client
type Client struct {
// HTTP client used to communicate with the Client.
http *http.Client
debug bool
baseURL url.URL
// credentials
tenantID int
// User agent for client
userAgent string
mediaType string
charset string
disallowUnknownFields bool
// Optional function called after every successful request made to the DO Clients
onRequestCompleted RequestCompletionCallback
requestTimestamps []time.Time
}
// RequestCompletionCallback defines the type of the request callback function
type RequestCompletionCallback func(*http.Request, *http.Response)
func (c *Client) Debug() bool {
return c.debug
}
func (c *Client) SetDebug(debug bool) {
c.debug = debug
}
func (c *Client) TenantID() int {
return c.tenantID
}
func (c *Client) SetTenantID(tenantID int) {
c.tenantID = tenantID
}
func (c *Client) BaseURL() url.URL {
return c.baseURL
}
func (c *Client) SetBaseURL(baseURL url.URL) {
c.baseURL = baseURL
}
func (c *Client) SetMediaType(mediaType string) {
c.mediaType = mediaType
}
func (c *Client) MediaType() string {
return mediaType
}
func (c *Client) SetCharset(charset string) {
c.charset = charset
}
func (c *Client) Charset() string {
return charset
}
func (c *Client) SetUserAgent(userAgent string) {
c.userAgent = userAgent
}
func (c *Client) UserAgent() string {
return userAgent
}
func (c *Client) SetDisallowUnknownFields(disallowUnknownFields bool) {
c.disallowUnknownFields = disallowUnknownFields
}
func (c *Client) GetEndpointURL(relative string, pathParams PathParams) url.URL {
clientURL := c.BaseURL()
relativeURL, err := url.Parse(relative)
if err != nil {
log.Fatal(err)
}
clientURL.Path = path.Join(clientURL.Path, relativeURL.Path)
clientURL.Path = strings.Replace(clientURL.Path, "{{.tenant_id}}", strconv.Itoa(c.TenantID()), -1)
// clientURL.RawQuery = strings.Replace(clientURL.RawQuery, "{{.tenant_id}}", strconv.Itoa(c.TenantID()), -1)
query := url.Values{}
for k, v := range clientURL.Query() {
query[k] = append(query[k], v...)
}
for k, v := range relativeURL.Query() {
query[k] = append(query[k], v...)
}
clientURL.RawQuery = query.Encode()
tmpl, err := template.New("endpoint_url").Parse(clientURL.Path)
if err != nil {
log.Fatal(err)
}
buf := new(bytes.Buffer)
params := pathParams.Params()
params["version"] = apiVersion
err = tmpl.Execute(buf, params)
if err != nil {
log.Fatal(err)
}
clientURL.Path = buf.String()
return clientURL
}
func (c *Client) NewRequest(ctx context.Context, method string, URL url.URL, body interface{}) (*http.Request, error) {
// convert body struct to json
buf := new(bytes.Buffer)
if body != nil {
err := json.NewEncoder(buf).Encode(body)
if err != nil {
return nil, err
}
}
// create new http request
req, err := http.NewRequest(method, URL.String(), buf)
if err != nil {
return nil, err
}
// optionally pass along context
if ctx != nil {
req = req.WithContext(ctx)
}
// set other headers
req.Header.Add("Content-Type", fmt.Sprintf("%s; charset=%s", c.MediaType(), c.Charset()))
req.Header.Add("Accept", c.MediaType())
req.Header.Add("User-Agent", c.UserAgent())
return req, nil
}
// Do sends an Client request and returns the Client response. The Client response is json decoded and stored in the value
// pointed to by v, or returned as an error if an Client 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 *Client) Do(req *http.Request, responseBody interface{}) (*http.Response, error) {
if c.debug == true {
dump, _ := httputil.DumpRequestOut(req, true)
log.Println(string(dump))
}
c.SleepUntilRequestRate()
c.RegisterRequestTimestamp(time.Now())
httpResp, err := c.http.Do(req)
if err != nil {
return nil, err
}
if c.onRequestCompleted != nil {
c.onRequestCompleted(req, httpResp)
}
// close body io.Reader
defer func() {
if rerr := httpResp.Body.Close(); err == nil {
err = rerr
}
}()
if c.debug == true {
dump, _ := httputil.DumpResponse(httpResp, true)
log.Println(string(dump))
}
// check if the response isn't an error
err = CheckResponse(httpResp)
if err != nil {
return httpResp, err
}
// check the provided interface parameter
if httpResp == nil {
return httpResp, nil
}
// interface implements io.Writer: write Body to it
// if w, ok := response.Envelope.(io.Writer); ok {
// _, err := io.Copy(w, httpResp.Body)
// return httpResp, err
// }
// try to decode body into interface parameter
if responseBody == nil {
return httpResp, nil
}
errorResponse := &ErrorResponse{Response: httpResp}
err = c.Unmarshal(httpResp.Body, &responseBody, &errorResponse)
if err != nil {
return httpResp, err
}
if len(errorResponse.Messages) > 0 {
return httpResp, errorResponse
}
return httpResp, nil
}
func (c *Client) Unmarshal(r io.Reader, vv ...interface{}) error {
if len(vv) == 0 {
return nil
}
wg := sync.WaitGroup{}
wg.Add(len(vv))
errs := []error{}
writers := make([]io.Writer, len(vv))
for i, v := range vv {
pr, pw := io.Pipe()
writers[i] = pw
go func(i int, v interface{}, pr *io.PipeReader, pw *io.PipeWriter) {
dec := json.NewDecoder(pr)
if c.disallowUnknownFields {
dec.DisallowUnknownFields()
}
err := dec.Decode(v)
if err != nil {
errs = append(errs, err)
}
// mark routine as done
wg.Done()
// Drain reader
io.Copy(ioutil.Discard, pr)
// close reader
// pr.CloseWithError(err)
pr.Close()
}(i, v, pr, pw)
}
// copy the data in a multiwriter
mw := io.MultiWriter(writers...)
_, err := io.Copy(mw, r)
if err != nil {
return err
}
wg.Wait()
if len(errs) == len(vv) {
// Everything errored
msgs := make([]string, len(errs))
for i, e := range errs {
msgs[i] = fmt.Sprint(e)
}
return errors.New(strings.Join(msgs, ", "))
}
return nil
}
func (c *Client) RegisterRequestTimestamp(t time.Time) {
if len(c.requestTimestamps) >= 5 {
c.requestTimestamps = c.requestTimestamps[1:5]
}
c.requestTimestamps = append(c.requestTimestamps, t)
}
func (c *Client) SleepUntilRequestRate() {
// Requestrate is 5r/1s
// if there are less then 5 registered requests: execute the request
// immediately
if len(c.requestTimestamps) < 4 {
return
}
// is the first item within 1 second? If it's > 1 second the request can be
// executed imediately
diff := time.Now().Sub(c.requestTimestamps[0])
if diff >= time.Second {
return
}
// Sleep for the time it takes for the first item to be > 1 second old
time.Sleep(time.Second - diff)
}
// CheckResponse checks the Client response for errors, and returns them if
// present. A response is considered an error if it has a status code outside
// the 200 range. Client 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 {
errorResponse := &ErrorResponse{Response: r}
// Don't check content-lenght: a created response, for example, has no body
// if r.Header.Get("Content-Length") == "0" {
// errorResponse.Errors.Message = r.Status
// return errorResponse
// }
if c := r.StatusCode; (c >= 200 && c <= 299) || c == 400 {
return nil
}
err := checkContentType(r)
if err != nil {
return errors.New(r.Status)
}
// read data and copy it back
data, err := ioutil.ReadAll(r.Body)
r.Body = ioutil.NopCloser(bytes.NewReader(data))
if err != nil {
return errorResponse
}
if len(data) == 0 {
return errorResponse
}
// convert json to struct
err = json.Unmarshal(data, errorResponse)
if err != nil {
return err
}
return errorResponse
}
type ErrorResponse struct {
// HTTP response that caused this error
Response *http.Response `json:"-"`
Messages Messages
}
func (r *ErrorResponse) UnmarshalJSON(data []byte) error {
msgs := Messages{}
err := json.Unmarshal(data, &msgs)
if err != nil {
return err
}
for _, msg := range msgs {
if msg.MessageCode != "" || msg.MessageType != "" || msg.Message != "" {
r.Messages = append(r.Messages, msg)
}
}
return nil
}
type Messages []Message
func (msgs Messages) Error() string {
err := []string{}
for _, v := range msgs {
err = append(err, fmt.Sprintf("%s: %s", v.MessageCode, v.Message))
}
return strings.Join(err, ", ")
}
func (r *ErrorResponse) Error() string {
return r.Messages.Error()
}
type Message struct {
MessageCode string `json:"message_code"`
MessageType string `json:"message_type"`
Message string `json:"message"`
}
func checkContentType(response *http.Response) error {
header := response.Header.Get("Content-Type")
contentType := strings.Split(header, ";")[0]
if contentType != mediaType {
return fmt.Errorf("Expected Content-Type \"%s\", got \"%s\"", mediaType, contentType)
}
return nil
}
type PathParams interface {
Params() map[string]string
}
type FilterParams map[string]string
// type FilterParams []Filter
// type Filter struct {
// Field string
// Operator string
// Value string
// }
type Metadata struct {
Last int `json:"last"`
Results Int `json:"results"`
Currentpage Int `json:"currentpage"`
}