Documentation
¶
Overview ¶
Package bibleapi is the library behind the bibleapi 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 = "bibleapi-cli/0.1 (tamnd87@gmail.com)"
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 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 (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings.
func (*Client) GetPassage ¶
func (c *Client) GetPassage(ctx context.Context, reference, translation string) ([]VerseDetail, error)
GetPassage fetches a passage and returns each verse as a VerseDetail.
type Domain ¶
type Domain struct{}
Domain is the bibleapi driver. It carries no state.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, hostnames, and binary identity.