Lint & cleanup.

.golangci.yml

@@ -0,0 +1,26 @@
+linters:
+  enable-all: true
+  disable:
+    - execinquery # Deprecated
+    - gomnd # Deprecated
+    - exhaustruct
+    # TODO re-enable these
+    - depguard
+    - err113
+    - forbidigo
+    - funlen
+    - godox
+    - gofumpt
+    - lll
+    - nlreturn
+    - noctx
+    - paralleltest
+    - testifylint
+    - testpackage
+    - tparallel
+linters-settings:
+  tagliatelle:
+    case:
+      use-field-name: true
+      rules:
+        json: snake

api_provider.go

@@ -8,44 +8,45 @@ import (
 
 // TODO docs
 
-type ApiProvider int
+type APIProvider int
 
 const (
-	ApiLayer ApiProvider = iota
-	RapidApi
+	APILayer APIProvider = iota
+	RapidAPI
+	// TODO APIMarket.
 )
 
-func (api ApiProvider) isValid() bool {
+func (api APIProvider) isValid() bool {
 	switch api {
-	case ApiLayer:
+	case APILayer:
 		return true
-	case RapidApi:
+	case RapidAPI:
 		return true
 	default:
 		return false
 	}
 }
 
-func (api ApiProvider) apiKeySource() string {
+func (api APIProvider) apiKeySource() string {
 	switch api {
-	case ApiLayer:
+	case APILayer:
 		return "https://apilayer.com/marketplace/checkiday-api#pricing"
-	case RapidApi:
+	case RapidAPI:
 		return "https://rapidapi.com/westy92-llc-westy92-llc-default/api/checkiday/pricing"
 	default:
 		return ""
 	}
 }
 
-func (api ApiProvider) baseUrl() url.URL {
+func (api APIProvider) baseURL() url.URL {
 	switch api {
-	case ApiLayer:
+	case APILayer:
 		return url.URL{
 			Scheme: "https",
 			Host:   "api.apilayer.com",
 			Path:   "checkiday",
 		}
-	case RapidApi:
+	case RapidAPI:
 		return url.URL{
 			Scheme: "https",
 			Host:   "checkiday.p.rapidapi.com",
@@ -55,30 +56,32 @@ func (api ApiProvider) baseUrl() url.URL {
 	}
 }
 
-func (api ApiProvider) extractRateLimitInfo(headers http.Header) RateLimit {
+func (api APIProvider) extractRateLimitInfo(headers http.Header) RateLimit {
 	var limit, remaining int
+
 	switch api {
-	case ApiLayer:
-		limit, _ = strconv.Atoi(headers.Get("x-ratelimit-limit-month"))
-		remaining, _ = strconv.Atoi(headers.Get("x-ratelimit-remaining-month"))
-	case RapidApi:
-		limit, _ = strconv.Atoi(headers.Get("x-ratelimit-requests-limit"))
-		remaining, _ = strconv.Atoi(headers.Get("x-ratelimit-requests-remaining"))
+	case APILayer:
+		limit, _ = strconv.Atoi(headers.Get("X-Ratelimit-Limit-Month"))
+		remaining, _ = strconv.Atoi(headers.Get("X-Ratelimit-Remaining-Month"))
+	case RapidAPI:
+		limit, _ = strconv.Atoi(headers.Get("X-Ratelimit-Requests-Limit"))
+		remaining, _ = strconv.Atoi(headers.Get("X-Ratelimit-Requests-Remaining"))
 	default:
 	}
+
 	return RateLimit{
 		Limit:     limit,
 		Remaining: remaining,
 	}
 }
 
-func (api ApiProvider) attachRequestHeaders(headers *http.Header, apiKey string) {
+func (api APIProvider) attachRequestHeaders(headers *http.Header, apiKey string) {
 	switch api {
-	case ApiLayer:
-		headers.Set("apikey", apiKey)
-	case RapidApi:
-		headers.Set("X-RapidAPI-Key", apiKey)
-		headers.Set("X-RapidAPI-Host", "checkiday.p.rapidapi.com")
+	case APILayer:
+		headers.Set("Apikey", apiKey)
+	case RapidAPI:
+		headers.Set("X-Rapidapi-Key", apiKey)
+		headers.Set("X-Rapidapi-Host", "checkiday.p.rapidapi.com")
 	default:
 	}
 }

example/main.go

@@ -8,7 +8,7 @@ import (
 
 func main() {
 	// Get a FREE API key from https://apilayer.com/marketplace/checkiday-api#pricing
-	client, err := holidays.New(holidays.ApiLayer, "<your API key>")
+	client, err := holidays.New(holidays.APILayer, "<your API key>")
 
 	if err != nil {
 		fmt.Println(err)
@@ -29,12 +29,12 @@ func main() {
 	}
 
 	event := events.Events[0]
-	fmt.Printf("Today is %s! Find more information at: %s.\n", event.Name, event.Url)
+	fmt.Printf("Today is %s! Find more information at: %s.\n", event.Name, event.URL)
 	fmt.Printf("Rate limit remaining: %d/%d (billing cycle).\n", events.RateLimit.Remaining, events.RateLimit.Limit)
 
 	// Get Event Information
 	eventInfo, err := client.GetEventInfo(holidays.GetEventInfoRequest{
-		Id: event.Id,
+		ID: event.ID,
 		// These parameters can be specified to calculate the range of eventInfo.Event.Occurrences
 		// Start: 2020,
 		// End: 2030,

holidays.go

@@ -11,10 +11,14 @@ import (
 	"strconv"
 )
 
-// The API Client
+var ErrAPIProviderRequired = errors.New("please provide a valid API provider")
+var ErrEventIDRequired = errors.New("event id is required")
+var ErrSearchQueryRequired = errors.New("search query is required")
+
+// The API Client.
 type Client struct {
 	apiKey      string
-	apiProvider ApiProvider
+	apiProvider APIProvider
 }
 
 const (
@@ -25,9 +29,9 @@ const (
 // Creates a New Client using the provided API key.
 // TODO update docs
 // Get a FREE API key from https://apilayer.com/marketplace/checkiday-api#pricing
-func New(apiProvider ApiProvider, apiKey string) (*Client, error) {
+func New(apiProvider APIProvider, apiKey string) (*Client, error) {
 	if !apiProvider.isValid() {
-		return nil, errors.New("please provide a valid API provider")
+		return nil, ErrAPIProviderRequired
 	}
 
 	if apiKey == "" {
@@ -40,7 +44,7 @@ func New(apiProvider ApiProvider, apiKey string) (*Client, error) {
 	}, nil
 }
 
-// Gets the Events for the provided Date
+// Gets the Events for the provided Date.
 func (c *Client) GetEvents(req GetEventsRequest) (*GetEventsResponse, error) {
 	var params = url.Values{
 		"adult": {strconv.FormatBool(req.Adult)},
@@ -64,14 +68,15 @@ func (c *Client) GetEvents(req GetEventsRequest) (*GetEventsResponse, error) {
 	return res, nil
 }
 
-// Gets the Event Info for the provided Event
+// Gets the Event Info for the provided Event.
 func (c *Client) GetEventInfo(req GetEventInfoRequest) (*GetEventInfoResponse, error) {
 	var params = url.Values{}
 
-	if req.Id == "" {
-		return nil, errors.New("event id is required")
+	if req.ID == "" {
+		return nil, ErrEventIDRequired
 	}
-	params["id"] = []string{req.Id}
+
+	params["id"] = []string{req.ID}
 
 	if req.Start != 0 {
 		params["start"] = []string{strconv.Itoa(req.Start)}
@@ -91,15 +96,16 @@ func (c *Client) GetEventInfo(req GetEventInfoRequest) (*GetEventInfoResponse, e
 	return res, nil
 }
 
-// Searches for Events with the given criteria
+// Searches for Events with the given criteria.
 func (c *Client) Search(req SearchRequest) (*SearchResponse, error) {
 	var params = url.Values{
 		"adult": {strconv.FormatBool(req.Adult)},
 	}
 
 	if req.Query == "" {
-		return nil, errors.New("search query is required")
+		return nil, ErrSearchQueryRequired
 	}
+
 	params["query"] = []string{req.Query}
 
 	res, rateLimit, err := request[SearchResponse](c, "search", params)
@@ -112,19 +118,20 @@ func (c *Client) Search(req SearchRequest) (*SearchResponse, error) {
 	return res, nil
 }
 
-// Gets the API Client Version
+// Gets the API Client Version.
 func (c *Client) GetVersion() string {
 	return version
 }
 
 func request[R StandardResponseInterface](client *Client, urlPath string, params url.Values) (*R, *RateLimit, error) {
-	url := client.apiProvider.baseUrl()
+	url := client.apiProvider.baseURL()
 	url.Path = path.Join(url.Path, urlPath)
+
 	if params != nil {
 		url.RawQuery = params.Encode()
 	}
 
-	req, err := http.NewRequest("GET", url.String(), nil)
+	req, err := http.NewRequest(http.MethodGet, url.String(), nil) // TODO pass context lint(noctx)
 	if err != nil {
 		return nil, nil, fmt.Errorf("can't create request: %w", err)
 	}
@@ -139,11 +146,13 @@ func request[R StandardResponseInterface](client *Client, urlPath string, params
 	}
 
 	defer res.Body.Close()
+
 	if res.StatusCode != http.StatusOK {
 		var errBody errorResponse
 		if err := json.NewDecoder(res.Body).Decode(&errBody); err == nil && errBody.Error != "" {
 			return nil, nil, errors.New(errBody.Error)
 		}
+
 		return nil, nil, errors.New(res.Status)
 	}