Documentation
¶
Overview ¶
Package bored is the library behind the bored command line: the HTTP client, request shaping, and the typed data models for the Bored API.
The Client here is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public site throws under load.
Index ¶
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "bored/dev (+https://github.com/tamnd/bored-cli)"
DefaultUserAgent identifies the client to the Bored API.
const Host = "bored-api.appbrewery.com"
Host is the site this client talks to, and the host the URI driver in domain.go claims.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Activity ¶
type Activity struct {
Key string `kit:"id" json:"key"`
Activity string `json:"activity"`
Type string `json:"type"`
Participants int `json:"participants"`
Price float64 `json:"price"`
Availability float64 `json:"availability"`
Accessibility string `json:"accessibility"`
Duration string `json:"duration"`
KidFriendly bool `json:"kid_friendly"`
Link string `json:"link"`
}
Activity is one activity record from the Bored API.
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
BaseURL string
// Rate is the minimum gap between requests. Zero means no pacing.
Rate time.Duration
Retries int
// contains filtered or unexported fields
}
Client talks to the Bored API over HTTP.
func (*Client) Filter ¶
func (c *Client) Filter(ctx context.Context, actType string, participants int, minPrice, maxPrice float64) ([]Activity, error)
Filter returns activities matching the given criteria. Any zero/empty parameter is omitted from the request so the API applies no constraint on it.
type Config ¶
Config holds the tunable settings for a Client.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns sensible defaults for the Bored API client.
type Domain ¶
type Domain struct{}
Domain is the bored driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify turns any accepted input into the canonical (type, id), so `ant resolve` and `ant url` touch no network.
- Alphanumeric key (6-7 digits): ("key", input)
- Type word (one of the 9 valid types): ("type", input)
- Otherwise: ("query", input)
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.
Source Files