bible

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 14, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

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

View Source
const BaseURL = "https://" + Host

BaseURL is the root every request is built from.

View Source
const DefaultUserAgent = "bible/dev (+https://github.com/tamnd/bible-cli)"

DefaultUserAgent identifies the client to bible-api.com.

View Source
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

func (c *Client) Get(ctx context.Context, url string) ([]byte, error)

Get fetches url and returns the response body. It paces and retries according to the client's settings.

func (*Client) GetVerses

func (c *Client) GetVerses(ctx context.Context, reference, translation string) (*Passage, error)

GetVerses fetches one or more verses by reference (e.g. "john 3:16" or "romans 8:28-30"). If translation is non-empty it is passed as a query param.

func (*Client) ListBooks

func (c *Client) ListBooks(ctx context.Context) ([]Book, error)

ListBooks returns all books of the Bible from the /data/web/books.json endpoint.

type Domain

type Domain struct{}

Domain is the bible driver. It carries no state.

func (Domain) Classify

func (Domain) Classify(input string) (uriType, id string, err error)

Classify turns any accepted input into the canonical (type, id).

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.

func (Domain) Locate

func (Domain) Locate(uriType, id string) (string, error)

Locate is the inverse: the live https URL for a (type, id).

func (Domain) Register

func (Domain) Register(app *kit.App)

Register installs the client factory and every operation onto app.

type Passage

type Passage struct {
	Reference       string  `kit:"id" json:"reference"`
	Verses          []Verse `json:"verses"`
	TranslationName string  `json:"translation_name"`
}

Passage is a passage (one or more verses) returned by the API.

type Verse

type Verse struct {
	BookID   string `json:"book_id"`
	BookName string `json:"book_name"`
	Chapter  int    `json:"chapter"`
	Verse    int    `json:"verse"`
	Text     string `json:"text"`
}

Verse is a single verse from the Bible.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL