bibleapi

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: 9 Imported by: 0

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

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

BaseURL is the root every request is built from.

View Source
const DefaultUserAgent = "bibleapi-cli/0.1 (tamnd87@gmail.com)"

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 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.

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) GetPassage

func (c *Client) GetPassage(ctx context.Context, reference, translation string) ([]VerseDetail, error)

GetPassage fetches a passage and returns each verse as a VerseDetail.

func (*Client) GetVerse

func (c *Client) GetVerse(ctx context.Context, reference, translation string) (*Verse, error)

GetVerse fetches a verse or passage reference and returns a summary Verse. The reference should use spaces (e.g. "john 3:16" or "romans 8:28-30"). translation is optional; pass "" to use the API default (web).

type Domain

type Domain struct{}

Domain is the bibleapi driver. It carries no state.

func (Domain) Classify

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

Classify turns a reference string into a (type, id) pair.

func (Domain) Info

func (Domain) Info() kit.DomainInfo

Info describes the scheme, hostnames, and binary identity.

func (Domain) Locate

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

Locate returns 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 Verse

type Verse struct {
	Reference       string `json:"reference"        kit:"id"`
	Text            string `json:"text"`
	TranslationID   string `json:"translation_id"`
	TranslationName string `json:"translation_name"`
}

Verse is the summary record for a single verse or passage lookup.

type VerseDetail

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

VerseDetail is one individual verse within a passage.

Jump to

Keyboard shortcuts

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