Repository navigation
Expand file tree
/
Copy pathclient.go
More file actions
269 lines (235 loc) · 6.51 KB
/
Copy pathclient.go
File metadata and controls
269 lines (235 loc) · 6.51 KB
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
// Copyright 2017 Yutaka Nishimura. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
/*
The redash package implements a simple client and wrapper library for
Redash REST api.
GET/POST/DELETE is accepted.
Original client is made by implement Interface.
Summary of use case.
Case 1:
Get/Post/Delete directory.
Case 2:
implement your Interface and
GetInter/PostInter/DeleteInter with new Client.
Case 3:
Queries.GetQuery/(other func in Queries)
*/
package redash
import (
"bytes"
"errors"
"fmt"
"io"
"log"
"net/http"
"net/url"
"os"
"path"
"runtime"
)
const (
redashUrlEnv = "REDASH_URL"
redashApikeyEnv = "REDASH_APIKEY"
)
var (
repository = "https://github.com/ynishi/redash"
ua = fmt.Sprintf("RedashGoClient/0.1 (+%s; %s)",
repository, runtime.Version())
defaultPostHeader = map[string]string{
"Content-Type": "application/json",
}
DefaultClient = NewDefaultClient()
)
func defaultOpts() *Options {
return &Options{
Params: make(map[string]string),
Header: map[string]string{
"User-Agent": ua,
},
Body: nil,
}
}
// Options is option value container.
type Options struct {
Params map[string]string
Header map[string]string
Body io.Reader
}
// Url is Redash server's endpoint.
type Urler interface {
Url() (*url.URL, error)
}
// Apikey is Redash Apikey to connect primary.
type Apikeyer interface {
Apikey() (string, error)
}
// HTTPClient is HTTP client to do request.
type HTTPClienter interface {
HTTPClient() *http.Client
}
// DefaultOpts is default options for request.
type DefaultOptser interface {
DefaultOpts() *Options
}
// A type, for original client, that sufisfies redash.Interface can
// use GetInter, PostInter, DeleteInter methods.
// If want to change apikey management, Httpclient and so on,
// just implement methods of this Interface.
type Interface interface {
Urler
Apikeyer
HTTPClienter
DefaultOptser
}
// GetInter do Redash GET with Interface and return result.
func GetInter(client Interface, sub string, params map[string]string) (resp *http.Response, err error) {
opts := client.DefaultOpts()
for key, value := range params {
opts.Params[key] = value
}
return DoInter(client, http.MethodGet, sub, opts)
}
// PostInter do Redash POST with Interface and return result.
func PostInter(client Interface, sub string, jsonBody []byte) (resp *http.Response, err error) {
opts := client.DefaultOpts()
for key, value := range defaultPostHeader {
opts.Header[key] = value
}
opts.Body = bytes.NewReader(jsonBody)
return DoInter(client, http.MethodPost, sub, opts)
}
// DeleteInter do Redash DELETE with Interface and return result.
func DeleteInter(client Interface, sub string, params map[string]string) (resp *http.Response, err error) {
opts := client.DefaultOpts()
for key, value := range params {
opts.Params[key] = value
}
return DoInter(client, http.MethodDelete, sub, opts)
}
// DoInter do Redash apis with Interface and return result.
func DoInter(client Interface, method, sub string, opts *Options) (resp *http.Response, err error) {
log.Printf("[INFO] do: %s %s", method, sub)
req, err := RequestInter(client, method, sub, opts)
if err != nil {
return nil, err
}
return client.HTTPClient().Do(req)
}
// RequestInter make request with Interface.
func RequestInter(client Interface, method, sub string, opts *Options) (req *http.Request, err error) {
u, err := client.Url()
if err != nil {
return nil, err
}
u.Path = path.Join(u.Path, sub)
values := url.Values{}
for key, value := range opts.Params {
values.Add(key, value)
}
req, err = http.NewRequest(method, u.String(), opts.Body)
req.URL.RawQuery = values.Encode()
if err != nil {
return nil, err
}
apikey, err := client.Apikey()
if err != nil {
return nil, err
}
opts.Header["Authorization"] = "Key " + apikey
for key, value := range opts.Header {
req.Header.Set(key, value)
}
return req, nil
}
// Get do Redash api GET and return result.
func Get(sub string, params map[string]string) (resp *http.Response, err error) {
return GetInter(DefaultClient, sub, params)
}
// Post do Redash api POST and return result.
func Post(sub string, jsonBody []byte) (resp *http.Response, err error) {
return PostInter(DefaultClient, sub, jsonBody)
}
// Delete do Redash api DELETE and return result.
func Delete(sub string, params map[string]string) (resp *http.Response, err error) {
return DeleteInter(DefaultClient, sub, params)
}
// Do do Redash apis and return result.
func Do(method, sub string, opts *Options) (resp *http.Response, err error) {
return DoInter(DefaultClient, method, sub, opts)
}
// Request make http.Request for Redash.
func Request(method, sub string, opts *Options) (req *http.Request, err error) {
return RequestInter(DefaultClient, method, sub, opts)
}
// Default implemet of client include Logger.
type ClientData struct {
*log.Logger
}
// Default implement of client. This is provided as DefaultClient.
type DefaultClientData struct {
ClientData
apikey string
u *url.URL
}
// Implementation of apikey for DefaultClient
func (dc DefaultClientData) Apikey() (apikey string, err error) {
if len(dc.apikey) < 1 {
dc.apikey = os.Getenv(redashApikeyEnv)
}
if len(dc.apikey) < 1 {
return "", errors.New("invalid apikey")
}
dc.Logger.Printf("[DEBUG] apikey: [%s]", maskKey(dc.apikey))
return dc.apikey, nil
}
// Implementation of Url for DefaultClient
func (dc DefaultClientData) Url() (u *url.URL, err error) {
if dc.u.String() == "" {
dc.u, err = url.Parse(os.Getenv(redashUrlEnv))
if err != nil {
return nil, err
}
}
return dc.u, err
}
// Implementation of HTTPClient for DefaultClient
func (dc DefaultClientData) HTTPClient() *http.Client {
return http.DefaultClient
}
// Implementation of DefaultOpts for DefaultClient
func (dc DefaultClientData) DefaultOpts() *Options {
return defaultOpts()
}
// Create a new defaultClient
func NewDefaultClient() *DefaultClientData {
var u *url.URL
var err error
if ue := os.Getenv(redashUrlEnv); ue != "" {
u, err = url.Parse(os.Getenv(redashUrlEnv))
if err != nil {
return nil
}
log.Printf("[DEBUG] set url: %s", u)
} else {
u = &url.URL{}
}
dcd := &DefaultClientData{
apikey: os.Getenv(redashApikeyEnv),
u: u,
}
dcd.Logger = &log.Logger{}
dcd.Logger.SetOutput(os.Stdout)
dcd.Logger.SetFlags(log.Ldate | log.Ltime)
return dcd
}
// maskKey is mask helper for apikey.
func maskKey(s string) string {
var pre string
if len(s) >= 4 {
pre = s[0:4]
} else {
pre = "****"
}
return pre + "****"
}