client.go

package gocorona

import (
	"bytes"
	"context"
	"encoding/json"
	"fmt"
	"io"
	"io/ioutil"
	"net/http"
	"net/url"
	"time"

	"github.com/pkg/errors"
)

const (
	// DefaultBaseURL is the default server URL.
	DefaultBaseURL = "https://coronavirus-tracker-api.herokuapp.com/v2"
)

// withCtx applies 'ctx' to the the http.Request and returns *http.Request
func withCtx(ctx context.Context, req *http.Request) *http.Request {
	return req.WithContext(ctx)
}

// Client for accessing different endpoints of the API
type Client struct {
	// HTTPClient is a reusable http client instance.
	HTTP *http.Client
	// BaseURL is the REST endpoints URL of the api server
	BaseURL *url.URL
}

// makeGetRequest generates HTTP GET request and calls Do func
func (c Client) makeGetRequest(ctx context.Context, endpoint string, target interface{}) error {
	r, err := http.NewRequest(http.MethodGet, DefaultBaseURL+endpoint, nil)
	if err != nil {
		return errors.Wrap(err, "could not generate http request")
	}

	if err = c.Do(withCtx(ctx, r), target); err != nil {
		return errors.Wrap(err, "request failed")
	}

	return nil
}

// Do sends the http.Request and unmarshalls the JSON response into 'target'
func (c Client) Do(req *http.Request, target interface{}) error {
	if req == nil {
		return errors.New("invalid Request")
	}

	if c.HTTP == nil {
		c.HTTP = http.DefaultClient
		c.HTTP.Transport = http.DefaultTransport
		c.HTTP.Timeout = 15 * time.Second
	}

	if c.BaseURL != nil {
		req.URL.Scheme = c.BaseURL.Scheme
		req.URL.Host = c.BaseURL.Host
	}

	// make request to the api and read the response
	resp, err := c.HTTP.Do(req)
	if err != nil {
		return errors.Wrap(err, "request failed")
	}

	if resp.StatusCode != http.StatusOK {
		return ErrAPI{resp}
	}

	defer func() {
		// Ensure the response body is fully read and closed
		// before we reconnect, so that we reuse the same TCPconnection.
		const maxCopySize = 2 << 10
		io.CopyN(ioutil.Discard, resp.Body, maxCopySize)
		resp.Body.Close()
	}()

	var buf bytes.Buffer
	return json.NewDecoder(io.TeeReader(resp.Body, &buf)).Decode(target)
}

// ErrAPI is returned by API calls when the response status code isn't 200.
type ErrAPI struct {
	// Response from the request which returned error.
	Response *http.Response
}

// Error implements the error interface.
func (err ErrAPI) Error() (errStr string) {
	if err.Response != nil {
		errStr += fmt.Sprintf(
			"request to %s returned %d (%s)",
			err.Response.Request.URL,
			err.Response.StatusCode,
			http.StatusText(err.Response.StatusCode),
		)
	}
	return errStr
}