/
client.go
287 lines (245 loc) · 7.79 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
// Copyright (c) 2016 John E. Vincent
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Copyright (c) 2018 Target Brands, Inc.
package artifactory
import (
"bytes"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
"reflect"
"strings"
"github.com/google/go-querystring/query"
)
const (
userAgent = "go-arty"
)
// Client is a client that manages communication with the Artifactory API.
type Client struct {
// HTTP client used to communicate with the Artifactory API.
client *http.Client
// Base URL for Artifactory API requests.
baseURL *url.URL
// User agent used when communicating with the Artifactory API.
UserAgent string
// Artifactory service for authentication.
Authentication *AuthenticationService
Artifacts *ArtifactsService
Build *BuildService
Docker *DockerService
Groups *GroupsService
Licenses *LicensesService
Permissions *PermissionsService
PermissionsV2 *PermissionsServiceV2
Replications *ReplicationsService
Repositories *RepositoriesService
Search *SearchService
Storage *StorageService
System *SystemService
Users *UsersService
}
type service struct {
client *Client
}
// NewClient returns a new Artifactory API client.
// baseUrl has to be the HTTP endpoint of the Artifactory API.
// If no httpClient is provided, then the http.DefaultClient will be used.
func NewClient(baseUrl string, httpClient *http.Client) (*Client, error) {
if httpClient == nil {
httpClient = http.DefaultClient
}
if len(baseUrl) == 0 {
return nil, fmt.Errorf("No Artifactory baseUrl provided")
}
baseURL, err := url.Parse(baseUrl)
if err != nil {
return nil, err
}
c := &Client{
client: httpClient,
baseURL: baseURL,
UserAgent: userAgent,
}
c.Authentication = &AuthenticationService{client: c}
c.Artifacts = &ArtifactsService{client: c}
c.Build = &BuildService{client: c}
c.Docker = &DockerService{client: c}
c.Groups = &GroupsService{client: c}
c.Licenses = &LicensesService{client: c}
c.Permissions = &PermissionsService{client: c}
c.PermissionsV2 = &PermissionsServiceV2{client: c}
c.Replications = &ReplicationsService{client: c}
c.Repositories = &RepositoriesService{client: c}
c.Search = &SearchService{client: c}
c.Storage = &StorageService{client: c}
c.System = &SystemService{client: c}
c.Users = &UsersService{client: c}
return c, nil
}
// buildURLForRequest will build the URL (as a string) that will be called.
// It does several cleaning tasks for us.
func (c *Client) buildURLForRequest(urlStr string) (string, error) {
u := c.baseURL.String()
// If there is no / at the end, add one.
if strings.HasSuffix(u, "/") == false {
u += "/"
}
// If there is a "/" at the start, remove it.
if strings.HasPrefix(urlStr, "/") == true {
urlStr = urlStr[1:]
}
rel, err := url.Parse(urlStr)
if err != nil {
return "", err
}
u += rel.String()
return u, nil
}
// addAuthentication adds the necessary authentication to the request.
func (c *Client) addAuthentication(req *http.Request) {
// Apply HTTP Basic Authentication.
if c.Authentication.HasBasicAuth() {
req.SetBasicAuth(*c.Authentication.username, *c.Authentication.secret)
// Apply Token Authentication.
} else if c.Authentication.HasTokenAuth() {
req.Header.Add("X-JFrog-Art-Api", *c.Authentication.secret)
}
}
// addOptions adds the parameters in opt as URL query parameters to s.
// opt must be a struct whose fields may contain "url" tags.
func addOptions(s string, opt interface{}) (string, error) {
v := reflect.ValueOf(opt)
if v.Kind() == reflect.Ptr && v.IsNil() {
return s, nil
}
u, err := url.Parse(s)
if err != nil {
return s, err
}
qs, err := query.Values(opt)
if err != nil {
return s, err
}
u.RawQuery = qs.Encode()
return u.String(), nil
}
// NewRequest creates an API request.
// A relative URL can be provided in urlStr,
// in which case it is resolved relative 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 as the request body.
func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error) {
u, err := c.buildURLForRequest(urlStr)
if err != nil {
return nil, err
}
var buf io.ReadWriter
if body != nil {
buf = new(bytes.Buffer)
err := json.NewEncoder(buf).Encode(body)
if err != nil {
return nil, err
}
}
req, err := http.NewRequest(method, u, buf)
if err != nil {
return nil, err
}
// Apply Authentication.
if c.Authentication.HasAuth() {
c.addAuthentication(req)
}
req.Header.Add("Content-Type", "application/json")
return req, nil
}
// Response represents an Artifactory API response.
// This wraps the standard http.Response returned from Artifactory.
type Response struct {
*http.Response
}
// Call is a combine function for Client.NewRequest and Client.Do.
//
// Most API methods are quite the same.
// Get the URL, apply options, make a request, and get the response.
// Without adding special headers or something.
// To avoid a big amount of code duplication you can Client.Call.
//
// method is the HTTP method you want to call.
// u is the URL you want to call.
// body is the HTTP body.
// v is the HTTP response.
//
// For more information read https://github.com/google/go-github/issues/234
func (c *Client) Call(method, u string, body interface{}, v interface{}) (*Response, error) {
req, err := c.NewRequest(method, u, body)
if err != nil {
return nil, err
}
resp, err := c.Do(req, v)
if err != nil {
return resp, err
}
return resp, 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 body will be written to v,
// without attempting to first decode it.
func (c *Client) Do(req *http.Request, v interface{}) (*Response, error) {
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
// Wrap response
response := &Response{Response: resp}
err = CheckResponse(resp)
if err != nil {
// even though there was an error, we still return the response
// in case the caller wants to inspect it further
return response, err
}
if v != nil {
if w, ok := v.(io.Writer); ok {
io.Copy(w, resp.Body)
} else {
var body []byte
body, err = ioutil.ReadAll(resp.Body)
// This ensures the response body is not empty in the event the user
// wants to inspect the response body further
resp.Body = ioutil.NopCloser(bytes.NewBuffer(body))
if err != nil {
// even though there was an error, we still return the response
// in case the caller wants to inspect it further
return response, err
}
// Since the API we integrate with doesn't always return JSON
// we no longer explicitly return an error if we can't unmarshal the body
_ = json.Unmarshal(body, v)
}
}
return response, err
}
// 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.
func CheckResponse(r *http.Response) error {
if c := r.StatusCode; 200 <= c && c <= 299 {
return nil
}
return fmt.Errorf("API call to %s failed: %s", r.Request.URL.String(), r.Status)
}