feature.go

package brewerydb

import (
	"fmt"
	"net/http"
)

// FeatureService provides access to the BreweryDB Feature API. Use Client.Feature.
//
// See: http://www.brewerydb.com/developers/docs-endpoint/feature_index
type FeatureService struct {
	c *Client
}

// Feature represents a combined Featured Beer and Brewery.
// TODO: the Brewery in a Feature should ALSO contain its locations:
type Feature struct {
	ID        int
	Year      int
	Week      int
	BeerID    string
	Beer      Beer
	BreweryID string
	Brewery   Brewery
}

// Get returns this week's Featured Beer and Brewery.
//
// See: http://www.brewerydb.com/developers/docs-endpoint/feature_index#1
func (fs *FeatureService) Get() (f Feature, err error) {
	// GET: /featured
	var req *http.Request
	req, err = fs.c.NewRequest("GET", "/featured", nil)
	if err != nil {
		return
	}

	resp := struct {
		Status  string
		Data    Feature
		Message string
	}{}
	err = fs.c.Do(req, &resp)
	return resp.Data, err
}

// FeatureListRequest contains options for querying for a list of features.
type FeatureListRequest struct {
	Page         int    `url:"p"`
	Year         int    `url:"year,omitempty"`
	Week         int    `url:"week,omitempty"`
	IgnoreFuture string `url:"ignoreFuture,omitempty"` // Y or N
}

// FeatureList represents a single "page" containing a slice of Features.
type FeatureList struct {
	CurrentPage   int
	NumberOfPages int
	TotalResults  int
	Features      []Feature `json:"data"`
}

// List returns all Featured Beers and Breweries.
//
// See: http://www.brewerydb.com/developers/docs-endpoint/feature_index#2
func (fs *FeatureService) List(q *FeatureListRequest) (fl FeatureList, err error) {
	// GET: /features
	var req *http.Request
	req, err = fs.c.NewRequest("GET", "/features", q)
	if err != nil {
		return
	}

	err = fs.c.Do(req, &fl)
	return
}

// ByWeek returns the Featured Beer and Brewery for the given
// year and week number.
//
// See: http://www.brewerydb.com/developers/docs-endpoint/feature_index#3
func (fs *FeatureService) ByWeek(year, week int) (f Feature, err error) {
	// GET: /feature/:year-week
	var req *http.Request
	req, err = fs.c.NewRequest("GET", fmt.Sprintf("/feature/%4d-%02d", year, week), nil)
	if err != nil {
		return
	}

	resp := struct {
		Status  string
		Data    Feature
		Message string
	}{}
	err = fs.c.Do(req, &resp)
	return resp.Data, err
}