Documentation
¶
Overview ¶
Package bible is the library behind the bible command line: the HTTP client, request shaping, and the typed data models for bible-api.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 ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "bible/dev (+https://github.com/tamnd/bible-cli)"
DefaultUserAgent identifies the client to bible-api.com.
const Host = "bible-api.com"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Book ¶
type Book struct {
ID string `kit:"id" json:"id"`
Name string `json:"name"`
Testament string `json:"testament"`
Chapters int `json:"chapters"`
}
Book is a single book of the Bible.
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 bible-api.com 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.
type Domain ¶
type Domain struct{}
Domain is the bible driver. It carries no state.
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.