Skip to content

Commit 7c7b491

Browse files
thinkingseriousthinkingserious
committed
Version Bump v2.0.0: Made the Request and Response variables non-redundant. e.g. request.RequestBody becomes request.Body
1 parent 8700672 commit 7c7b491

File tree

5 files changed

+93
-89
lines changed

5 files changed

+93
-89
lines changed

Diff for: ‎CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
33

44
This project adheres to [Semantic Versioning](http://semver.org/).
55

6+
## [2.0.0] - 2016-06-03
7+
### Changed
8+
- Made the Request and Response variables non-redundant. e.g. request.RequestBody becomes request.Body
9+
610
## [1.0.2] - 2016-04-07
711
### Added
812
- these changes are thanks to [deckarep](https://github.com/deckarep). Thanks!

Diff for: ‎README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ func main() {
2929
baseURL := host + endpoint
3030
method := rest.Get
3131
request := rest.Request{
32-
Method: method,
33-
BaseURL: baseURL,
32+
Method: method,
33+
BaseURL: baseURL,
3434
}
3535
response, err := rest.API(request)
3636
if err != nil {
3737
fmt.Println(err)
3838
} else {
3939
fmt.Println(response.StatusCode)
40-
fmt.Println(response.ResponseBody)
41-
fmt.Println(response.ResponseHeaders)
40+
fmt.Println(response.Body)
41+
fmt.Println(response.Headers)
4242
}
4343
}
4444
```
@@ -56,29 +56,29 @@ func main() {
5656
param := "myparam"
5757
endpoint := "/your/api/" + param + "/call"
5858
baseURL := host + endpoint
59-
requestHeaders := make(map[string]string)
59+
Headers := make(map[string]string)
6060
key := os.Getenv("API_KEY")
61-
requestHeaders["Authorization"] = "Bearer " + key
62-
requestHeaders["X-Test"] = "Test"
63-
var requestBody = []byte(`{"some": 0, "awesome": 1, "data": 3}`)
61+
Headers["Authorization"] = "Bearer " + key
62+
Headers["X-Test"] = "Test"
63+
var Body = []byte(`{"some": 0, "awesome": 1, "data": 3}`)
6464
queryParams := make(map[string]string)
6565
queryParams["hello"] = "0"
6666
queryParams["world"] = "1"
6767
method := rest.Post
6868
request = rest.Request{
69-
Method: method,
70-
BaseURL: baseURL,
71-
RequestHeaders: requestHeaders,
72-
QueryParams: queryParams,
73-
RequestBody: requestBody,
69+
Method: method,
70+
BaseURL: baseURL,
71+
Headers: Headers,
72+
QueryParams: queryParams,
73+
Body: Body,
7474
}
7575
response, err := rest.API(request)
7676
if err != nil {
7777
fmt.Println(err)
7878
} else {
7979
fmt.Println(response.StatusCode)
80-
fmt.Println(response.ResponseBody)
81-
fmt.Println(response.ResponseHeaders)
80+
fmt.Println(response.Body)
81+
fmt.Println(response.Headers)
8282
}
8383
}
8484
```

Diff for: ‎examples/example.go

+43-43
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ func main() {
1616

1717
// Build the request headers
1818
key := os.Getenv("SENDGRID_API_KEY")
19-
requestHeaders := make(map[string]string)
20-
requestHeaders["Content-Type"] = "application/json"
21-
requestHeaders["Authorization"] = "Bearer " + key
19+
Headers := make(map[string]string)
20+
Headers["Content-Type"] = "application/json"
21+
Headers["Authorization"] = "Bearer " + key
2222

2323
// GET Collection
2424
method := rest.Get
@@ -30,24 +30,24 @@ func main() {
3030

3131
// Make the API call
3232
request := rest.Request{
33-
Method: method,
34-
BaseURL: baseURL,
35-
RequestHeaders: requestHeaders,
36-
QueryParams: queryParams,
33+
Method: method,
34+
BaseURL: baseURL,
35+
Headers: Headers,
36+
QueryParams: queryParams,
3737
}
3838
response, err := rest.API(request)
3939
if err != nil {
4040
fmt.Println(err)
4141
} else {
4242
fmt.Println(response.StatusCode)
43-
fmt.Println(response.ResponseBody)
44-
fmt.Println(response.ResponseHeaders)
43+
fmt.Println(response.Body)
44+
fmt.Println(response.Headers)
4545
}
4646

4747
// POST
4848
method = rest.Post
4949

50-
var requestBody = []byte(` {
50+
var Body = []byte(` {
5151
"name": "My API Key",
5252
"scopes": [
5353
"mail.send",
@@ -56,25 +56,25 @@ func main() {
5656
]
5757
}`)
5858
request = rest.Request{
59-
Method: method,
60-
BaseURL: baseURL,
61-
RequestHeaders: requestHeaders,
62-
QueryParams: queryParams,
63-
RequestBody: requestBody,
59+
Method: method,
60+
BaseURL: baseURL,
61+
Headers: Headers,
62+
QueryParams: queryParams,
63+
Body: Body,
6464
}
6565
response, err = rest.API(request)
6666
if err != nil {
6767
fmt.Println(err)
6868
} else {
6969
fmt.Println(response.StatusCode)
70-
fmt.Println(response.ResponseBody)
71-
fmt.Println(response.ResponseHeaders)
70+
fmt.Println(response.Body)
71+
fmt.Println(response.Headers)
7272
}
7373

7474
// Get a particular return value.
7575
// Note that you can unmarshall into a struct if
7676
// you know the JSON structure in advance.
77-
b := []byte(response.ResponseBody)
77+
b := []byte(response.Body)
7878
var f interface{}
7979
err = json.Unmarshal(b, &f)
8080
if err != nil {
@@ -88,80 +88,80 @@ func main() {
8888

8989
// Make the API call
9090
request = rest.Request{
91-
Method: method,
92-
BaseURL: baseURL + "/" + apiKey,
93-
RequestHeaders: requestHeaders,
91+
Method: method,
92+
BaseURL: baseURL + "/" + apiKey,
93+
Headers: Headers,
9494
}
9595
response, err = rest.API(request)
9696
if err != nil {
9797
fmt.Println(err)
9898
} else {
9999
fmt.Println(response.StatusCode)
100-
fmt.Println(response.ResponseBody)
101-
fmt.Println(response.ResponseHeaders)
100+
fmt.Println(response.Body)
101+
fmt.Println(response.Headers)
102102
}
103103

104104
// PATCH
105105
method = rest.Patch
106106

107-
requestBody = []byte(`{
107+
Body = []byte(`{
108108
"name": "A New Hope"
109109
}`)
110110
request = rest.Request{
111-
Method: method,
112-
BaseURL: baseURL + "/" + apiKey,
113-
RequestHeaders: requestHeaders,
114-
RequestBody: requestBody,
111+
Method: method,
112+
BaseURL: baseURL + "/" + apiKey,
113+
Headers: Headers,
114+
Body: Body,
115115
}
116116
response, err = rest.API(request)
117117
if err != nil {
118118
fmt.Println(err)
119119
} else {
120120
fmt.Println(response.StatusCode)
121-
fmt.Println(response.ResponseBody)
122-
fmt.Println(response.ResponseHeaders)
121+
fmt.Println(response.Body)
122+
fmt.Println(response.Headers)
123123
}
124124

125125
// PUT
126126
method = rest.Put
127127

128-
requestBody = []byte(`{
128+
Body = []byte(`{
129129
"name": "A New Hope",
130130
"scopes": [
131131
"user.profile.read",
132132
"user.profile.update"
133133
]
134134
}`)
135135
request = rest.Request{
136-
Method: method,
137-
BaseURL: baseURL + "/" + apiKey,
138-
RequestHeaders: requestHeaders,
139-
RequestBody: requestBody,
136+
Method: method,
137+
BaseURL: baseURL + "/" + apiKey,
138+
Headers: Headers,
139+
Body: Body,
140140
}
141141
response, err = rest.API(request)
142142
if err != nil {
143143
fmt.Println(err)
144144
} else {
145145
fmt.Println(response.StatusCode)
146-
fmt.Println(response.ResponseBody)
147-
fmt.Println(response.ResponseHeaders)
146+
fmt.Println(response.Body)
147+
fmt.Println(response.Headers)
148148
}
149149

150150
// DELETE
151151
method = rest.Delete
152152

153153
request = rest.Request{
154-
Method: method,
155-
BaseURL: baseURL + "/" + apiKey,
156-
RequestHeaders: requestHeaders,
157-
QueryParams: queryParams,
158-
RequestBody: requestBody,
154+
Method: method,
155+
BaseURL: baseURL + "/" + apiKey,
156+
Headers: Headers,
157+
QueryParams: queryParams,
158+
Body: Body,
159159
}
160160
response, err = rest.API(request)
161161
if err != nil {
162162
fmt.Println(err)
163163
} else {
164164
fmt.Println(response.StatusCode)
165-
fmt.Println(response.ResponseHeaders)
165+
fmt.Println(response.Headers)
166166
}
167167
}

Diff for: ‎rest.go

+13-13
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@ const (
2121

2222
// Request holds the request to an API Call.
2323
type Request struct {
24-
Method Method
25-
BaseURL string // e.g. https://api.sendgrid.com
26-
RequestHeaders map[string]string
27-
QueryParams map[string]string
28-
RequestBody []byte
24+
Method Method
25+
BaseURL string // e.g. https://api.sendgrid.com
26+
Headers map[string]string
27+
QueryParams map[string]string
28+
Body []byte
2929
}
3030

3131
// Response holds the response from an API call.
3232
type Response struct {
33-
StatusCode int // e.g. 200
34-
ResponseBody string // e.g. {"result: success"}
35-
ResponseHeaders map[string][]string // e.g. map[X-Ratelimit-Limit:[600]]
33+
StatusCode int // e.g. 200
34+
Body string // e.g. {"result: success"}
35+
Headers map[string][]string // e.g. map[X-Ratelimit-Limit:[600]]
3636
}
3737

3838
// AddQueryParameters adds query paramaters to the URL.
@@ -47,8 +47,8 @@ func AddQueryParameters(baseURL string, queryParams map[string]string) string {
4747

4848
// BuildRequestObject creates the HTTP request object.
4949
func BuildRequestObject(request Request) (*http.Request, error) {
50-
req, err := http.NewRequest(string(request.Method), request.BaseURL, bytes.NewBuffer(request.RequestBody))
51-
for key, value := range request.RequestHeaders {
50+
req, err := http.NewRequest(string(request.Method), request.BaseURL, bytes.NewBuffer(request.Body))
51+
for key, value := range request.Headers {
5252
req.Header.Set(key, value)
5353
}
5454
return req, err
@@ -71,9 +71,9 @@ func BuildResponse(res *http.Response) (*Response, error) {
7171
}
7272
defer res.Body.Close()
7373
response := Response{
74-
StatusCode: res.StatusCode,
75-
ResponseBody: string(body),
76-
ResponseHeaders: res.Header,
74+
StatusCode: res.StatusCode,
75+
Body: string(body),
76+
Headers: res.Header,
7777
}
7878
return &response, nil
7979
}

Diff for: ‎rest_test.go

+18-18
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ func TestBuildRequest(t *testing.T) {
2222
method := Get
2323
baseURL := "http://api.test.com"
2424
key := "API_KEY"
25-
requestHeaders := make(map[string]string)
26-
requestHeaders["Content-Type"] = "application/json"
27-
requestHeaders["Authorization"] = "Bearer " + key
25+
Headers := make(map[string]string)
26+
Headers["Content-Type"] = "application/json"
27+
Headers["Authorization"] = "Bearer " + key
2828
queryParams := make(map[string]string)
2929
queryParams["test"] = "1"
3030
queryParams["test2"] = "2"
3131
request := Request{
32-
Method: method,
33-
BaseURL: baseURL,
34-
RequestHeaders: requestHeaders,
35-
QueryParams: queryParams,
32+
Method: method,
33+
BaseURL: baseURL,
34+
Headers: Headers,
35+
QueryParams: queryParams,
3636
}
3737
req, e := BuildRequestObject(request)
3838
if e != nil {
@@ -59,10 +59,10 @@ func TestBuildResponse(t *testing.T) {
5959
if response.StatusCode != 200 {
6060
t.Error("Invalid status code in BuildResponse")
6161
}
62-
if len(response.ResponseBody) == 0 {
62+
if len(response.Body) == 0 {
6363
t.Error("Invalid response body in BuildResponse")
6464
}
65-
if len(response.ResponseHeaders) == 0 {
65+
if len(response.Headers) == 0 {
6666
t.Error("Invalid response headers in BuildResponse")
6767
}
6868
if e != nil {
@@ -78,27 +78,27 @@ func TestRest(t *testing.T) {
7878
endpoint := "/test_endpoint"
7979
baseURL := host + endpoint
8080
key := "API_KEY"
81-
requestHeaders := make(map[string]string)
82-
requestHeaders["Content-Type"] = "application/json"
83-
requestHeaders["Authorization"] = "Bearer " + key
81+
Headers := make(map[string]string)
82+
Headers["Content-Type"] = "application/json"
83+
Headers["Authorization"] = "Bearer " + key
8484
method := Get
8585
queryParams := make(map[string]string)
8686
queryParams["test"] = "1"
8787
queryParams["test2"] = "2"
8888
request := Request{
89-
Method: method,
90-
BaseURL: baseURL,
91-
RequestHeaders: requestHeaders,
92-
QueryParams: queryParams,
89+
Method: method,
90+
BaseURL: baseURL,
91+
Headers: Headers,
92+
QueryParams: queryParams,
9393
}
9494
response, e := API(request)
9595
if response.StatusCode != 200 {
9696
t.Error("Invalid status code")
9797
}
98-
if len(response.ResponseBody) == 0 {
98+
if len(response.Body) == 0 {
9999
t.Error("Invalid response body")
100100
}
101-
if len(response.ResponseHeaders) == 0 {
101+
if len(response.Headers) == 0 {
102102
t.Error("Invalid response headers")
103103
}
104104
if e != nil {

0 commit comments

Comments
 (0)