Documentation
¶
Overview ¶
Package zippopotam is the library behind the zippopotam command line: the HTTP client, request shaping, and the typed data models for zippopotam.
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 = "zippopotam/dev (+https://github.com/tamnd/zippopotam-cli)"
DefaultUserAgent identifies the client to the API. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "api.zippopotam.us"
Host is the API host this client talks to.
const WebHost = "www.zippopotam.us"
WebHost is the site homepage used in Locate.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 Zippopotam API 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 zippopotam driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify turns an accepted input — a bare postal code, an optional "CC:postalcode" prefix form, or a full zippopotam URL — into (uriType, id). The URI authority for Place records is "place" (kit derives it from the struct name). The id is the bare postal code stored in Place.PostCode.
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.
type Place ¶ added in v0.1.1
type Place struct {
PostCode string `kit:"id" json:"post_code"`
Country string `json:"country"`
CountryAbb string `json:"country_abbreviation"`
PlaceName string `json:"place_name"`
State string `json:"state"`
StateAbb string `json:"state_abbreviation"`
Latitude string `json:"latitude"`
Longitude string `json:"longitude"`
}
Place is the output record for a postal code lookup. One record is emitted per place returned by the API; a single postal code can match many places.
Source Files