Documentation
¶
Overview ¶
Package cataas is the library behind the cataas command line: the HTTP client, request shaping, and the typed data models for cataas.com.
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
- type Cat
- type Client
- func (c *Client) Get(ctx context.Context, rawURL string) ([]byte, error)
- func (c *Client) ListCats(ctx context.Context, tag string, limit int) ([]*Cat, error)
- func (c *Client) ListTags(ctx context.Context, limit int) ([]*Tag, error)
- func (c *Client) RandomCat(ctx context.Context, tag string) (*Cat, error)
- type Config
- type Domain
- type Tag
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "cataas-cli/0.1 (tamnd87@gmail.com)"
DefaultUserAgent identifies the client to cataas honestly.
const Host = "cataas.com"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cat ¶
type Cat struct {
ID string `json:"id" kit:"id"`
URL string `json:"url"`
Tags []string `json:"tags"`
}
Cat is a single cat record from the CATAAS 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 cataas.com over HTTP.
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings.
type Config ¶
type Config struct {
BaseURL string
UserAgent string
Rate time.Duration
Timeout time.Duration
Retries int
}
Config holds the client settings.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns sensible defaults for the client.
type Domain ¶
type Domain struct{}
Domain is the cataas driver. It carries no state; the per-run client is built by the factory Register hands kit.
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