Refactor client to pass context

Author: qba73

elevation.go

@@ -0,0 +1,18 @@
+package geonames
+
+type ElevationSRTM1 struct {
+	Srtm1 int     `json:"srtm1"`
+	Lng   float64 `json:"lng"`
+	Lat   float64 `json:"lat"`
+}
+
+type Elevation struct {
+	Type string
+	Lat  float64
+	Lng  float64
+}
+
+func GetElevationSRTM1() Elevation {
+
+	return Elevation{}
+}

elevation_test.go

@@ -0,0 +1,49 @@
+package geonames_test
+
+import (
+	"bytes"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/qba73/geonames"
+)
+
+// ts is a helper func that creates a test server with embedded URI validation.
+var testServer = func(reader io.Reader, wantURI string, t *testing.T) *httptest.Server {
+	ts := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+		gotReqURI := r.RequestURI
+		verifyURIs(wantURI, gotReqURI, t)
+		_, err := io.Copy(rw, reader)
+		if err != nil {
+			t.Fatal(err)
+		}
+	}))
+	return ts
+}
+
+func TestGetElevationReturnsDataOnValidInput(t *testing.T) {
+	t.Parallel()
+
+	resp := new(bytes.Buffer)
+	resp.Read([]byte(`23`))
+
+	ts := testServer(&resp)
+
+}
+
+func TestGetElevationValidInput(t *testing.T) {
+	t.Parallel()
+
+	wantReqURI := "/srtm1JSON?lat=50&lng=50&username=DummyUser"
+	ts := newTestServer(testFile, wantReqURI, t)
+	defer ts.Close()
+
+	client, err := geonames.NewClient("DummyUser", geonames.WithBaseURL(ts.URL))
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	client.GetElevation()
+}

geonames.go

@@ -23,7 +23,7 @@ func WithHTTPClient(h *http.Client) option {
 		if h == nil {
 			return errors.New("nil http Client")
 		}
-		c.httpClient = h
+		c.HTTPClient = h
 		return nil
 	}
 }
@@ -34,7 +34,7 @@ func WithBaseURL(url string) option {
 		if url == "" {
 			return errors.New("nil baseURL")
 		}
-		c.baseURL = url
+		c.BaseURL = url
 		return nil
 	}
 }
@@ -45,40 +45,51 @@ func WithHTTPHeaders(header http.Header) option {
 		if header == nil {
 			return errors.New("nil HTTP headers")
 		}
-		c.headers = header
+		c.Headers = header
 		return nil
 	}
 }
 
 // Client holds data required for communicating with the Geonames Web Services.
 type Client struct {
-	userName   string
-	userAgent  string
-	baseURL    string
-	httpClient *http.Client
+	UserName   string
+	UserAgent  string
+	BaseURL    string
+	HTTPClient *http.Client
 
 	// Optional HTTP headers to set for each API request.
-	headers map[string][]string
+	Headers map[string][]string
+}
+
+var DefaultClient = Client{
+	UserName:   "demo",
+	BaseURL:    "http://api.geonames.org",
+	HTTPClient: http.DefaultClient,
+	Headers:    map[string][]string{"Content-Type": {"application/json"}},
+}
+
+// NewDemoClient creates a demo client. Demo client
+// does not require username registration at geonames.org website.
+func NewDemoClient() *Client {
+	return &DefaultClient
 }
 
 // NewClient creates a new client for GeoNames Web service.
 //
 // The username has to be registered at the GeoNames.org website.
 // HTTP requests without a valid username will return 403 HTTP errors.
 func NewClient(username string, options ...option) (*Client, error) {
-	if username == "" {
-		return nil, errors.New("nil geonames user")
-	}
 	c := Client{
-		userName:  username,
-		userAgent: userAgent,
-		baseURL:   "http://api.geonames.org",
-		httpClient: &http.Client{
+		UserName:  username,
+		UserAgent: userAgent,
+		BaseURL:   "http://api.geonames.org",
+		HTTPClient: &http.Client{
 			Timeout: time.Second * 5,
 		},
-		headers: map[string][]string{
+		Headers: map[string][]string{
 			"User-Agent":   {userAgent},
-			"Content-Type": {"application/json"}},
+			"Content-Type": {"application/json"},
+		},
 	}
 	for _, opt := range options {
 		if err := opt(&c); err != nil {
@@ -88,15 +99,12 @@ func NewClient(username string, options ...option) (*Client, error) {
 	return &c, nil
 }
 
-func (c Client) get(url string, data interface{}) error {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
-	defer cancel()
-
+func (c Client) get(ctx context.Context, url string, data any) error {
 	req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
 	if err != nil {
 		return fmt.Errorf("creating request: %w", err)
 	}
-	res, err := c.httpClient.Do(req)
+	res, err := c.HTTPClient.Do(req)
 	if err != nil {
 		return fmt.Errorf("sending GET request: %w", err)
 	}
@@ -117,7 +125,8 @@ func (c Client) get(url string, data interface{}) error {
 	return nil
 }
 
+// Position holds information about Lat and Long.
 type Position struct {
-	Lat  float64
-	Long float64
+	Lat float64
+	Lng float64
 }

geonames_test.go

@@ -1,6 +1,7 @@
 package geonames_test
 
 import (
+	"context"
 	"io"
 	"net/http"
 	"net/http/httptest"
@@ -74,5 +75,5 @@ func TestWikipediaResolvesGeoNameOnValidInput(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	client.GetPlace(name, country, 1)
+	client.GetPlace(context.Background(), name, country, 1)
 }

postal.go

@@ -1,6 +1,7 @@
 package geonames
 
 import (
+	"context"
 	"fmt"
 	"net/url"
 )
@@ -28,13 +29,13 @@ type PostalCode struct {
 }
 
 // GetPostalCode retrieves postal codes for the given place name and the country code.
-func (c Client) GetPostCode(place, country string) ([]PostalCode, error) {
+func (c Client) GetPostCode(ctx context.Context, place, country string) ([]PostalCode, error) {
 	url, err := c.buildPostalURL(place, country)
 	if err != nil {
 		return nil, err
 	}
 	var pr postalResponse
-	if err := c.get(url, &pr); err != nil {
+	if err := c.get(ctx, url, &pr); err != nil {
 		return nil, err
 	}
 
@@ -44,8 +45,8 @@ func (c Client) GetPostCode(place, country string) ([]PostalCode, error) {
 			PlaceName:  pc.PlaceName,
 			AdminName1: pc.AdminName1,
 			Position: Position{
-				Lat:  pc.Lat,
-				Long: pc.Lng,
+				Lat: pc.Lat,
+				Lng: pc.Lng,
 			},
 			PostalCode:  pc.PostalCode,
 			CountryCode: pc.CountryCode,
@@ -60,9 +61,9 @@ func (c Client) buildPostalURL(placeName, countryCode string) (string, error) {
 	params := url.Values{
 		"placename": {placeName},
 		"country":   {countryCode},
-		"username":  {c.userName},
+		"username":  {c.UserName},
 	}
-	basePostal := fmt.Sprintf("%s/postalCodeSearchJSON", c.baseURL)
+	basePostal := fmt.Sprintf("%s/postalCodeSearchJSON", c.BaseURL)
 
 	u, err := url.Parse(basePostal)
 	if err != nil {