Change function signature from rest.API to rest.Send.

README.md

@@ -77,7 +77,7 @@ func main() {
  Method: method,
  BaseURL: baseURL,
  }
- response, err := rest.API(request)
+ response, err := rest.Send(request)
  if err != nil {
  fmt.Println(err)
  } else {
@@ -117,7 +117,7 @@ func main() {
  QueryParams: queryParams,
  Body: Body,
  }
- response, err := rest.API(request)
+ response, err := rest.Send(request)
  if err != nil {
  fmt.Println(err)
  } else {

examples/example.go

@@ -35,7 +35,7 @@ func main() {
  Headers: Headers,
  QueryParams: queryParams,
  }
- response, err := rest.API(request)
+ response, err := rest.Send(request)
  if err != nil {
  fmt.Println(err)
  } else {
@@ -62,7 +62,7 @@ func main() {
  QueryParams: queryParams,
  Body: Body,
  }
- response, err = rest.API(request)
+ response, err = rest.Send(request)
  if err != nil {
  fmt.Println(err)
  } else {
@@ -92,7 +92,7 @@ func main() {
  BaseURL: baseURL + "/" + apiKey,
  Headers: Headers,
  }
- response, err = rest.API(request)
+ response, err = rest.Send(request)
  if err != nil {
  fmt.Println(err)
  } else {
@@ -113,7 +113,7 @@ func main() {
  Headers: Headers,
  Body: Body,
  }
- response, err = rest.API(request)
+ response, err = rest.Send(request)
  if err != nil {
  fmt.Println(err)
  } else {
@@ -138,7 +138,7 @@ func main() {
  Headers: Headers,
  Body: Body,
  }
- response, err = rest.API(request)
+ response, err = rest.Send(request)
  if err != nil {
  fmt.Println(err)
  } else {
@@ -156,7 +156,7 @@ func main() {
  Headers: Headers,
  QueryParams: queryParams,
  }
- response, err = rest.API(request)
+ response, err = rest.Send(request)
  if err != nil {
  fmt.Println(err)
  } else {

rest.go

@@ -106,9 +106,14 @@ func BuildResponse(res *http.Response) (*Response, error) {
  return &response, nil
 }
 
-// API is the main interface to the API.
+// Function for support old implementation (deprecated)
 func API(request Request) (*Response, error) {
- return DefaultClient.API(request)
+ return Send(request)
+}
+
+// API is the main interface to the API.
+func Send(request Request) (*Response, error) {
+ return DefaultClient.Send(request)
 }
 
 // The following functions enable the ability to define a
@@ -120,7 +125,7 @@ func (c *Client) MakeRequest(req *http.Request) (*http.Response, error) {
 }
 
 // API is the main interface to the API.
-func (c *Client) API(request Request) (*Response, error) {
+func (c *Client) Send(request Request) (*Response, error) {
  // Build the HTTP request object.
  req, err := BuildRequestObject(request)
  if err != nil {

rest_test.go

@@ -149,10 +149,16 @@ func TestBuildBadResponse(t *testing.T) {
 
 func TestRest(t *testing.T) {
  t.Parallel()
+ testingApi(t, Send)
+ testingApi(t, API)
+}
+
+func testingApi(t *testing.T, fn func(request Request) (*Response, error)) {
  fakeServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  fmt.Fprintln(w, "{\"message\": \"success\"}")
  }))
  defer fakeServer.Close()
+
  host := fakeServer.URL
  endpoint := "/test_endpoint"
  baseURL := host + endpoint
@@ -180,7 +186,8 @@ func TestRest(t *testing.T) {
  fmt.Println("Request :", string(requestDump))
  //End Print Request
 
- response, e := API(request)
+ response, e := fn(request)
+
  if response.StatusCode != 200 {
  t.Error("Invalid status code")
  }
@@ -264,7 +271,7 @@ func TestCustomHTTPClient(t *testing.T) {
  }
 
  customClient := &Client{&http.Client{Timeout: time.Millisecond * 10}}
- _, err := customClient.API(request)
+ _, err := customClient.Send(request)
  if err == nil {
  t.Error("A timeout did not trigger as expected")
  }