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
|
// Copyright (c) 2019-2023, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the LICENSE.md file
// distributed with the sources of this project regarding your rights to use or distribute this
// software.
package client
import (
"context"
"fmt"
"io"
"net/http"
"net/url"
"strings"
"github.com/go-log/log"
)
// Config contains the client configuration.
type Config struct {
// Base URL of the service.
BaseURL string
// Auth token to include in the Authorization header of each request (if supplied).
AuthToken string
// User agent to include in each request (if supplied).
UserAgent string
// HTTPClient to use to make HTTP requests (if supplied).
HTTPClient *http.Client
// Logger to be used when output is generated
Logger log.Logger
}
// DefaultConfig is a configuration that uses default values.
var DefaultConfig = &Config{}
// Client describes the client details.
type Client struct {
// Base URL of the service.
BaseURL *url.URL
// Auth token to include in the Authorization header of each request (if supplied).
AuthToken string
// User agent to include in each request (if supplied).
UserAgent string
// HTTPClient to use to make HTTP requests.
HTTPClient *http.Client
// Logger to be used when output is generated
Logger log.Logger
}
const defaultBaseURL = ""
// NewClient sets up a new Cloud-Library Service client with the specified base URL and auth token.
func NewClient(cfg *Config) (*Client, error) {
if cfg == nil {
cfg = DefaultConfig
}
// Determine base URL
bu := defaultBaseURL
if cfg.BaseURL != "" {
bu = cfg.BaseURL
}
if bu == "" {
return nil, errNoBaseURL
}
// If baseURL has a path component, ensure it is terminated with a separator, to prevent
// url.ResolveReference from stripping the final component of the path when constructing
// request URL.
if !strings.HasSuffix(bu, "/") {
bu += "/"
}
baseURL, err := url.Parse(bu)
if err != nil {
return nil, err
}
if baseURL.Scheme != "http" && baseURL.Scheme != "https" {
return nil, fmt.Errorf("%w: unsupported protocol scheme %q", errHTTP, baseURL.Scheme)
}
c := &Client{
BaseURL: baseURL,
AuthToken: cfg.AuthToken,
UserAgent: cfg.UserAgent,
}
// Set HTTP client
if cfg.HTTPClient != nil {
c.HTTPClient = cfg.HTTPClient
} else {
c.HTTPClient = http.DefaultClient
}
if cfg.Logger != nil {
c.Logger = cfg.Logger
} else {
c.Logger = log.DefaultLogger
}
return c, nil
}
// newRequestWithURL returns a new Request given a method, url, and (optional) body.
func (c *Client) newRequestWithURL(ctx context.Context, method, url string, body io.Reader) (*http.Request, error) {
r, err := http.NewRequestWithContext(ctx, method, url, body)
if err != nil {
return nil, err
}
if v := c.AuthToken; v != "" {
if err := (bearerTokenCredentials{authToken: v}).ModifyRequest(r); err != nil {
return nil, err
}
}
if v := c.UserAgent; v != "" {
r.Header.Set("User-Agent", v)
}
return r, nil
}
// newRequest returns a new Request given a method, relative path, rawQuery, and (optional) body.
func (c *Client) newRequest(ctx context.Context, method, path, rawQuery string, body io.Reader) (*http.Request, error) {
u := c.BaseURL.ResolveReference(&url.URL{
Path: path,
RawQuery: rawQuery,
})
return c.newRequestWithURL(ctx, method, u.String(), body)
}
|
