Documentation
¶
Overview ¶
Package harrypotter is the library behind the harrypotter command line: the HTTP client, request shaping, and the typed data models for the Harry Potter API (hp-api.onrender.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 API throws under load. Build your endpoint calls and JSON decoding on top of it.
Index ¶
- Constants
- type Character
- type Client
- func (c *Client) Characters(ctx context.Context, house string) ([]*Character, error)
- func (c *Client) Get(ctx context.Context, url string) ([]byte, error)
- func (c *Client) Spells(ctx context.Context) ([]*Spell, error)
- func (c *Client) Staff(ctx context.Context) ([]*Character, error)
- func (c *Client) Students(ctx context.Context, house string) ([]*Character, error)
- type Domain
- type Spell
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "harrypotter-cli/0.1 (tamnd87@gmail.com)"
DefaultUserAgent identifies the client to the Harry Potter API.
const Host = "hp-api.onrender.com"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Character ¶
type Character struct {
ID string `json:"id" kit:"id"`
Name string `json:"name"`
House string `json:"house"`
Species string `json:"species"`
Gender string `json:"gender"`
DateOfBirth string `json:"date_of_birth"`
Ancestry string `json:"ancestry"`
Patronus string `json:"patronus"`
Actor string `json:"actor"`
Alive bool `json:"alive"`
Wizard bool `json:"wizard"`
WandWood string `json:"wand_wood"`
WandCore string `json:"wand_core"`
}
Character holds the details for a single Harry Potter character.
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 the Harry Potter API over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 20s timeout (onrender.com cold starts can be slow), a 500ms minimum gap between requests, and three retries on transient errors.
func (*Client) Characters ¶
Characters returns all characters, optionally filtered by house (case-insensitive). An empty house string returns all characters.
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 harrypotter 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