Documentation
¶
Overview ¶
Package catfacts is the library behind the catfacts command line: the HTTP client, request shaping, and the typed data models for catfact.ninja.
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. Build your endpoint calls and JSON decoding on top of it.
Index ¶
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "catfacts/dev (+https://github.com/tamnd/catfacts-cli)"
DefaultUserAgent identifies the client to catfact.ninja. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "catfact.ninja"
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 Breed ¶
type Breed struct {
Breed string `kit:"id" json:"breed"`
Country string `json:"country"`
Origin string `json:"origin"`
Coat string `json:"coat"`
Pattern string `json:"pattern"`
}
Breed is a cat breed returned by the /breeds endpoint.
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent 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 catfact.ninja over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 200ms minimum gap between requests, and five retries on transient errors.
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings. The caller owns nothing extra; the body is read fully and closed here.
type Domain ¶
type Domain struct{}
Domain is the catfacts 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). For catfact.ninja there is no meaningful id, so everything maps to "fact".
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