-
Notifications
You must be signed in to change notification settings - Fork 0
/
pingo.go
1071 lines (887 loc) · 26.8 KB
/
pingo.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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// MIT License
//
// Copyright (c) 2024 Soma Rádóczi
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package pingo
import (
"bufio"
"bytes"
"context"
"encoding/json"
"encoding/xml"
"errors"
"fmt"
"io"
"log"
"mime/multipart"
"net/http"
"net/http/httputil"
"net/textproto"
"net/url"
"os"
"path"
"runtime"
"strings"
"sync/atomic"
"time"
)
type (
// logger is the internal logger used by the package
logger struct {
l *log.Logger // underlying [log.Logger]
flag atomic.Int32 // logging flags
timeFormat atomic.Pointer[string] // format of the time part when [Ftime] flag is provided
}
// Client is the client used by the package
Client struct {
client *http.Client // underlying [net/http.Client]
baseUrl string // base URL for the client
debug bool // debug mode
debugBody bool // debug mode to include body
headers http.Header // headers for the client
queryParams url.Values // query parameters for the client
timeout time.Duration // timeout for the client
logger *logger // logger used by the client
isLogEnabled bool // whether logging is enabled or disabled in this client
}
// Request is the request created by calling [NewRequest]
Request struct {
client *Client // the client the request was created on
method string // method of the request e.g: "GET", "POST", "PUT"
baseUrl string // base URL for the request
path string // path of the request
headers http.Header // headers for the request
queryParams url.Values // query parameters for the request
timeout time.Duration // timeout for the request
body *bytes.Buffer // request body
bodyErr error // error signaling if there was an error creating the request body
cancel context.CancelFunc // cancel is used to cancel any resources associated with the [context.Context] of the request
ctx context.Context // [context.Context] of the request
debug bool // debug mode
debugBody bool // debug mode to include body
isLogEnabled bool // whether loggin is enabled or disabled for the request
}
// responseHeader contains information about response headers
responseHeader struct {
status string // status of the response
statusCode int // status code of the response
headers http.Header // headers of the response
}
// ResponseStream is a streamed response
ResponseStream struct {
responseHeader // response header info
cancel context.CancelFunc // [context.CancelFunc] to cancel any resources associated with the request/response
reader *bufio.Reader // [bufio.Reader] to read the response from
response *http.Response // the original [net/http.Response]
}
// Response holds the response data
Response struct {
responseHeader // response header info
body []byte // response body
}
// ResponseError holds data of response that is considered to be an error
ResponseError struct {
responseHeader // response header info
body []byte // response body
}
// AsyncResponse is a structure holding response data for async request
AsyncResponse struct {
Response *Response // response data
Err error // error of the request
}
// ResponseUnmarshaler is a function that can be used to unmarshal a response
ResponseUnmarshaler func(r *Response) error
// StreamReceiver is a function that can be used to read from a streamed response
StreamReceiver func(r *bufio.Reader) error
// multipartFormFile contains information about a multipartform file
multipartFormFile struct {
reader io.Reader // [io.Reader] to read the file data
filePath string // the full filepath
fieldName string // name to use when performing the request
fileName string // name of the file
}
)
var (
headerUserAgentDefaultValue = pingoWithVersion + " (github.com/mauserzjeh/pingo)"
pingoWithVersion = pingo + " " + version
// default client created by the package
defaultClient = newDefaultClient()
// header constants
headerContentType = textproto.CanonicalMIMEHeaderKey("Content-Type")
headerAccept = textproto.CanonicalMIMEHeaderKey("Accept")
headerCacheControl = textproto.CanonicalMIMEHeaderKey("Cache-Control")
headerConnection = textproto.CanonicalMIMEHeaderKey("Connection")
headerUserAgent = textproto.CanonicalMIMEHeaderKey("User-Agent")
// errors
ErrRequestTimedOut = errors.New("request timed out")
)
const (
version = "v2.2.0"
pingo = "pingo"
defaultTimeFormat = "2006-01-02 15:04:05"
// Logger flags
Fshortfile = 1 << iota // short file name and line number: file.go:123
Flongfile // full file name and line number: a/b/c/file.go:123
Ftime // whether to include date-time in the log message
FtimeUTC // if [Ftime] is set then use UTC
// content type headers
ContentTypeJson = "application/json"
ContentTypeXml = "application/xml"
ContentTypeFormUrlEncoded = "application/x-www-form-urlencoded"
ContentTypeTextEventStream = "text/event-stream"
)
// ---------------------------------------------- //
// Logger //
// ---------------------------------------------- //
// newDefaultLogger creates a new default logger
func newDefaultLogger() *logger {
l := &logger{
l: log.New(os.Stdout, "", 0),
}
l.setFlags(Ftime)
l.setTimeFormat(defaultTimeFormat)
return l
}
// setFlags sets the flag value
func (l *logger) setFlags(flag int) {
l.flag.Store(int32(flag))
}
// flags returns the flag value
func (l *logger) flags() int {
return int(l.flag.Load())
}
// setTimeFormat sets the time format
func (l *logger) setTimeFormat(format string) {
l.timeFormat.Store(&format)
}
// timeFmt returns the time format
func (l *logger) timeFmt() string {
return *(l.timeFormat.Load())
}
// setOutput sets the output
func (l *logger) setOutput(w io.Writer) {
l.l.SetOutput(w)
}
// log writes the log message
func (l *logger) log(format string, args ...any) {
t := time.Now()
flag := l.flags()
sb := strings.Builder{}
// pingo label
sb.WriteRune('[')
sb.WriteString(pingoWithVersion)
sb.WriteRune(']')
sb.WriteRune(' ')
// time
if flag&Ftime != 0 {
if flag&FtimeUTC != 0 {
t = t.UTC()
}
timeFmt := l.timeFmt()
sb.WriteString(t.Format(timeFmt))
sb.WriteString(" | ")
}
// file + line
if flag&(Fshortfile|Flongfile) != 0 {
_, file, line, _ := runtime.Caller(5)
if flag&Fshortfile != 0 {
file = path.Base(file)
}
sb.WriteString(file)
sb.WriteRune(':')
fmt.Fprintf(&sb, "%d", line)
sb.WriteString(" | ")
}
fmt.Fprintf(&sb, format, args...)
l.l.Println(sb.String())
}
// ---------------------------------------------- //
// Client //
// ---------------------------------------------- //
// newDefaultClient creates a new default client
func newDefaultClient() *Client {
c := &Client{
client: &http.Client{},
logger: newDefaultLogger(),
headers: make(http.Header),
queryParams: make(url.Values),
isLogEnabled: true,
}
c.headers.Set(headerUserAgent, headerUserAgentDefaultValue)
return c
}
// NewClient creates a new client with the default settings
func NewClient() *Client {
c := newDefaultClient()
return c
}
// SetClient sets the underlying [net/http.Client]
func (c *Client) SetClient(client *http.Client) *Client {
c.client = client
return c
}
// SetBaseUrl sets the base URL
func (c *Client) SetBaseUrl(baseUrl string) *Client {
c.baseUrl = baseUrl
return c
}
// SetHeaders sets the header values
func (c *Client) SetHeaders(headers http.Header) *Client {
setValues(headers, c.headers)
return c
}
// SetHeader sets a single header value
func (c *Client) SetHeader(key, value string) *Client {
c.headers.Set(key, value)
return c
}
// AddHeaders adds the header values
func (c *Client) AddHeaders(headers http.Header) *Client {
addValues(headers, c.headers)
return c
}
// AddHeader adds a single header value
func (c *Client) AddHeader(key, value string) *Client {
c.headers.Add(key, value)
return c
}
// SetQueryParams sets the query parameters
func (c *Client) SetQueryParams(queryParams url.Values) *Client {
setValues(queryParams, c.queryParams)
return c
}
// SetQueryParam sets a single query parameter
func (c *Client) SetQueryParam(key, value string) *Client {
c.queryParams.Set(key, value)
return c
}
// AddQueryParams adds the query parameters
func (c *Client) AddQueryParams(queryParams url.Values) *Client {
addValues(queryParams, c.queryParams)
return c
}
// AddQueryParam adds a single query parameter
func (c *Client) AddQueryParam(key, value string) *Client {
c.queryParams.Add(key, value)
return c
}
// SetTimeout sets the timeout
func (c *Client) SetTimeout(timeout time.Duration) *Client {
c.timeout = timeout
return c
}
// SetDebug sets the debug mode
func (c *Client) SetDebug(debug, includeBody bool) *Client {
c.debug = debug
c.debugBody = includeBody
return c
}
// SetLogEnabled sets the log mode
func (c *Client) SetLogEnabled(enable bool) *Client {
c.isLogEnabled = enable
return c
}
// SetLogTimeFormat sets the log time format if [Ftime] flag is given
func (c *Client) SetLogTimeFormat(layout string) *Client {
c.logger.setTimeFormat(layout)
return c
}
// SetLogOutput sets the log output to the given [io.Writer]
func (c *Client) SetLogOutput(w io.Writer) *Client {
c.logger.setOutput(w)
return c
}
// SetLogFlags sets the log flags
func (c *Client) SetLogFlags(flag int) *Client {
c.logger.setFlags(flag)
return c
}
// NewRequest creates a new request
func (c *Client) NewRequest() *Request {
return &Request{
client: c,
method: http.MethodGet,
baseUrl: c.baseUrl,
path: "",
headers: c.headers,
queryParams: c.queryParams,
timeout: c.timeout,
body: nil,
bodyErr: nil,
cancel: nil,
ctx: nil,
debug: c.debug,
debugBody: c.debugBody,
isLogEnabled: c.isLogEnabled,
}
}
// ---------------------------------------------- //
// Request //
// ---------------------------------------------- //
// NewRequest creates a new request on the default client
func NewRequest() *Request {
return defaultClient.NewRequest()
}
// SetDebug sets the debug mode
func (r *Request) SetDebug(debug, includeBody bool) *Request {
r.debug = debug
r.debugBody = includeBody
return r
}
// SetLogEnabled sets the log mode
func (r *Request) SetLogEnabled(enabled bool) *Request {
r.isLogEnabled = enabled
return r
}
// SetMethod sets the request method
// e.g.: "GET", "POST", "PUT"
func (r *Request) SetMethod(method string) *Request {
if method != "" {
r.method = method
}
return r
}
// SetBaseUrl sets the base URL
func (r *Request) SetBaseUrl(baseUrl string) *Request {
r.baseUrl = baseUrl
return r
}
// SetPath sets the request path
func (r *Request) SetPath(path string) *Request {
r.path = path
return r
}
// SetHeaders sets the header values
func (r *Request) SetHeaders(headers http.Header) *Request {
setValues(headers, r.headers)
return r
}
// SetHeader sets a single header value
func (r *Request) SetHeader(key, value string) *Request {
r.headers.Set(key, value)
return r
}
// AddHeaders adds the header values
func (r *Request) AddHeaders(headers http.Header) *Request {
addValues(headers, r.headers)
return r
}
// AddHeader adds a single header value
func (r *Request) AddHeader(key, value string) *Request {
r.headers.Add(key, value)
return r
}
// SetQueryParams sets the query parameters
func (r *Request) SetQueryParams(queryParams url.Values) *Request {
setValues(queryParams, r.queryParams)
return r
}
// SetQueryParam sets a single query parameter
func (r *Request) SetQueryParam(key, value string) *Request {
r.queryParams.Set(key, value)
return r
}
// AddQueryParams adds the query parameters
func (r *Request) AddQueryParams(queryParams url.Values) *Request {
addValues(queryParams, r.queryParams)
return r
}
// AddQueryParam adds a single query parameter
func (r *Request) AddQueryParam(key, value string) *Request {
r.queryParams.Add(key, value)
return r
}
// SetTimeout sets the timeout
func (r *Request) SetTimeout(timeout time.Duration) *Request {
r.timeout = timeout
return r
}
// BodyJson prepares the body as a JSON request with the given data.
// Content-Type header is automatically set to "application/json"
func (r *Request) BodyJson(data any) *Request {
r.resetBody()
r.SetHeader(headerContentType, ContentTypeJson)
b, err := json.Marshal(data)
if err != nil {
r.bodyErr = err
return r
}
r.body = bytes.NewBuffer(b)
return r
}
// BodyXml prepares the body as an XML request with the given data.
// Content-Type header is automatically set to "application/xml"
func (r *Request) BodyXml(data any) *Request {
r.resetBody()
r.SetHeader(headerContentType, ContentTypeXml)
b, err := xml.Marshal(data)
if err != nil {
r.bodyErr = err
return r
}
r.body = bytes.NewBuffer(b)
return r
}
// BodyFormUrlEncoded prepares the body as a form URL encoded request with the given data.
// Content-Type header is automatically set to "application/x-www-form-urlencoded"
func (r *Request) BodyFormUrlEncoded(data url.Values) *Request {
r.resetBody()
r.SetHeader(headerContentType, ContentTypeFormUrlEncoded)
r.body = bytes.NewBufferString(data.Encode())
return r
}
// BodyCustom prepares the body with the given callback function
func (r *Request) BodyCustom(f func() (*bytes.Buffer, error)) *Request {
r.resetBody()
body, err := f()
if err != nil {
r.bodyErr = err
return r
}
r.body = body
return r
}
// BodyRaw prepares the body with the given raw data bytes
func (r *Request) BodyRaw(data []byte) *Request {
r.resetBody()
r.body = bytes.NewBuffer(data)
return r
}
// BodyMultipartForm prepares the body as a multipartform request with the given data and files.
// Content-Type header is automatically set to "multipart/form-data" with the proper boundary.
// Use [NewMultipartFormFile] or [NewMultipartFormFileReader] to pass files for file upload
func (r *Request) BodyMultipartForm(data map[string]any, files ...multipartFormFile) *Request {
r.resetBody()
body := &bytes.Buffer{}
w := multipart.NewWriter(body)
// handle data
for fieldName, value := range data {
err := w.WriteField(fieldName, fmt.Sprint(value))
if err != nil {
r.bodyErr = err
w.Close()
return r
}
}
// handle files
for _, file := range files {
err := file.write(w)
if err != nil {
r.bodyErr = err
w.Close()
return r
}
}
err := w.Close()
if err != nil {
r.bodyErr = err
return r
}
r.body = body
r.SetHeader(headerContentType, w.FormDataContentType())
return r
}
// do performs the request with the given [context.Context]
func (r *Request) do(ctx context.Context) (*http.Response, error) {
var (
reqDump, resDump []byte
now = time.Now()
statusCode int
err error
)
requestUrl := r.requestUrl()
defer func() {
if err == nil && r.isLogEnabled {
r.client.logger.log("%s", createLog(r.method, statusCode, requestUrl, time.Since(now), reqDump, resDump, r.debug))
}
}()
requestBody, err := r.requestBody()
if err != nil {
return nil, err
}
req, err := r.createRequest(ctx, requestUrl, requestBody)
if err != nil {
return nil, err
}
if r.isLogEnabled && r.debug {
reqDump, _ = httputil.DumpRequestOut(req, r.debugBody)
}
resp, err := r.client.client.Do(req)
if err != nil {
select {
case <-r.ctx.Done():
err = fmt.Errorf("%v \"%v\": %w", strings.ToUpper(r.method), requestUrl, context.Cause(r.ctx))
default:
}
return nil, err
}
statusCode = resp.StatusCode
if r.isLogEnabled && r.debug {
resDump, _ = httputil.DumpResponse(resp, r.debugBody)
}
return resp, nil
}
// DoCtx performs the request with the given [context.Context] and returns a response
func (r *Request) DoCtx(ctx context.Context) (*Response, error) {
resp, err := r.do(ctx)
if err != nil {
return nil, err
}
if r.cancel != nil {
r.cancel()
}
defer resp.Body.Close()
responseBody, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
return &Response{
responseHeader: responseHeader{
status: resp.Status,
statusCode: resp.StatusCode,
headers: resp.Header,
},
body: responseBody,
}, nil
}
// Do performs the request using [context.Background]
func (r *Request) Do() (*Response, error) {
return r.DoCtx(context.Background())
}
// DoAsyncCtx performs an async request with the given [context.Context].
// It returns an [AsyncResponse] channel which will receive the response when the request completes
func (r *Request) DoAsyncCtx(ctx context.Context) <-chan AsyncResponse {
asyncResp := make(chan AsyncResponse, 1)
go func() {
resp, err := r.DoCtx(ctx)
asyncResp <- AsyncResponse{
Response: resp,
Err: err,
}
close(asyncResp)
}()
return asyncResp
}
// DoAsync performs an async request using [context.Background].
// It returns an [AsyncResponse] channel which will receive the response when the request completes
func (r *Request) DoAsync() <-chan AsyncResponse {
return r.DoAsyncCtx(context.Background())
}
// DoStream performs a request using the given [context.Context] and returns a streaming response
func (r *Request) DoStream(ctx context.Context) (*ResponseStream, error) {
r.headers.Set(headerAccept, ContentTypeTextEventStream)
r.headers.Set(headerCacheControl, "no-cache")
r.headers.Set(headerConnection, "keep-alive")
resp, err := r.do(ctx)
if err != nil {
return nil, err
}
return &ResponseStream{
responseHeader: responseHeader{
status: resp.Status,
statusCode: resp.StatusCode,
headers: resp.Header,
},
reader: bufio.NewReader(resp.Body),
response: resp,
cancel: r.cancel,
}, nil
}
// requestUrl creates the request url
func (r *Request) requestUrl() string {
b := strings.Builder{}
baseUrl := strings.TrimRight(r.baseUrl, "/")
if baseUrl != "" {
b.WriteString(baseUrl)
}
path := strings.TrimLeft(r.path, "/")
if path != "" {
if b.Len() > 0 {
b.WriteString("/")
}
b.WriteString(path)
}
return b.String()
}
// requestBody creates the request body
func (r *Request) requestBody() (io.Reader, error) {
if r.bodyErr != nil {
return nil, r.bodyErr
}
if r.body == nil {
return http.NoBody, nil
}
return r.body, nil
}
// createRequest creates a [net/http.Request]
func (r *Request) createRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error) {
var (
req *http.Request
err error
rctx context.Context
)
if r.timeout > 0 {
tctx, cancel := context.WithTimeoutCause(ctx, r.timeout, ErrRequestTimedOut)
r.cancel = cancel
rctx = tctx
} else {
rctx = ctx
}
r.ctx = rctx
req, err = http.NewRequestWithContext(rctx, r.method, url, body)
if err != nil {
return nil, err
}
req.Header = r.headers
query := req.URL.Query()
for k, vs := range r.queryParams {
for _, v := range vs {
query.Set(k, v)
}
}
req.URL.RawQuery = query.Encode()
return req, nil
}
// resetBody resets the request body and bodyErr if subsequent SetBody* functions are called on the request
func (r *Request) resetBody() {
r.body = nil
r.bodyErr = nil
}
// ---------------------------------------------- //
// ResponseHeader //
// ---------------------------------------------- //
// Status returns the status of a response
func (r *responseHeader) Status() string {
return r.status
}
// StatusCode returns the status code of a response
func (r *responseHeader) StatusCode() int {
return r.statusCode
}
// Headers returns the response headers
func (r *responseHeader) Headers() http.Header {
return r.headers
}
// GetHeader is a convenience method to retrieve a single response header value
func (r *responseHeader) GetHeader(key string) string {
return r.headers.Get(key)
}
// ---------------------------------------------- //
// Response //
// ---------------------------------------------- //
// BodyRaw returns the response body as a byte slice
func (r *Response) BodyRaw() []byte {
return r.body
}
// BodyString returns the response body as string
func (r *Response) BodyString() string {
return string(r.body)
}
// IsError returns a non nil error if the response is considered as an error based on the status code.
// The error's type will be [*ResponseError]
func (r *Response) IsError() error {
if r.statusCode < 200 || r.statusCode >= 400 {
return &ResponseError{
responseHeader: r.responseHeader,
body: r.body,
}
}
return nil
}
// Unmarshal is a convenience method that can receive a [ResponseUnmarshaler] callback
// function that performs the unmarshalling of the response body
func (r *Response) Unmarshal(u ResponseUnmarshaler) error {
return u(r)
}
// ---------------------------------------------- //
// ResponseError //
// ---------------------------------------------- //
// Error implements the error interface
func (r ResponseError) Error() string {
return fmt.Sprintf("[%v] %s", r.status, r.body)
}
// BodyRaw returns the response body as a byte slice
func (r *ResponseError) BodyRaw() []byte {
return r.body
}
// BodyString returns the response body as string
func (r *ResponseError) BodyString() string {
return string(r.body)
}
// ---------------------------------------------- //
// ResponseStream //
// ---------------------------------------------- //
// RecvFunc can receive a [StreamReceiver] callback function that performs
// the stream reading of the streamed response body
func (r *ResponseStream) RecvFunc(sr StreamReceiver) error {
return sr(r.reader)
}
// Recv reads up to n bytes from a streamed response body
func (r *ResponseStream) Recv(n uint) ([]byte, error) {
b := make([]byte, n)
nn, err := r.reader.Read(b)
if err != nil {
return nil, err
}
return b[:nn], nil
}
// Close closes the streamed response body and additionally frees up any
// resources associated with the [context.Context] used to perform the streamed request
func (r *ResponseStream) Close() {
r.response.Body.Close()
if r.cancel != nil {
r.cancel()
}
}
// ---------------------------------------------- //
// MultipartFormFile //
// ---------------------------------------------- //
// NewMultipartFormFile creates a new multipartform file by reading the file from the given filepath
func NewMultipartFormFile(name string, filePath string) multipartFormFile {
return multipartFormFile{
filePath: filePath,
fieldName: name,
}
}
// NewMultipartFormFileReader creates a new multipartform file by using the given [io.Reader]
func NewMultipartFormFileReader(name, fileName string, r io.Reader) multipartFormFile {
return multipartFormFile{
reader: r,
fieldName: name,
fileName: fileName,
}
}
// write writes the contents of the file to the given [mime/multipart.Writer]
func (f *multipartFormFile) write(w *multipart.Writer) error {
if f.reader == nil {
ff, err := os.Open(f.filePath)
if err != nil {
return err
}
defer ff.Close()
f.reader = ff
f.fileName = path.Base(ff.Name())
}
pw, err := w.CreateFormFile(f.fieldName, f.fileName)
if err != nil {
return err
}
_, err = io.Copy(pw, f.reader)
if err != nil {
return err
}
return nil
}
// ---------------------------------------------- //
// Helpers //
// ---------------------------------------------- //
// setValues is a helper function that sets [net/http.Header] or [net/url.Values]
func setValues[T http.Header | url.Values](src, dst T) {
switch src := any(src).(type) {
case http.Header:
if dst, ok := any(dst).(http.Header); ok {
for k, vs := range src {
if len(vs) == 0 || vs[0] == "" {
dst.Del(k)
continue
}
dst.Set(k, vs[0])
}
}
case url.Values:
if dst, ok := any(dst).(url.Values); ok {
for k, vs := range src {
if len(vs) == 0 || vs[0] == "" {
dst.Del(k)
continue
}
dst.Set(k, vs[0])
}
}
}
}
// setValues is a helper function that adds [net/http.Header] or [net/url.Values]
func addValues[T http.Header | url.Values](src, dst T) {
switch src := any(src).(type) {
case http.Header:
if dst, ok := any(dst).(http.Header); ok {
for k, vs := range src {
for _, v := range vs {
dst.Add(k, v)
}
}
}
case url.Values:
if dst, ok := any(dst).(url.Values); ok {
for k, vs := range src {