Documentation
¶
Overview ¶
Package quran is the library behind the quran command line: the HTTP client, request shaping, and the typed data models for api.quran.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. Build your endpoint calls and JSON decoding on top of it.
Index ¶
- Constants
- type Chapter
- type Client
- func (c *Client) Get(ctx context.Context, url string) ([]byte, error)
- func (c *Client) GetChapter(ctx context.Context, id int) (*Chapter, error)
- func (c *Client) GetVerse(ctx context.Context, key string) (*Verse, error)
- func (c *Client) ListChapters(ctx context.Context) ([]Chapter, error)
- func (c *Client) ListVerses(ctx context.Context, chapter, limit int) ([]Verse, error)
- type Domain
- type TranslatedName
- type Verse
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "quran/dev (+https://github.com/tamnd/quran-cli)"
DefaultUserAgent identifies the client to api.quran.com. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "api.quran.com"
Host is the API host this client talks to, and the host the URI driver in domain.go claims.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Chapter ¶
type Chapter struct {
ID int `kit:"id" json:"id"`
NameSimple string `json:"name_simple"`
NameArabic string `json:"name_arabic"`
VersesCount int `json:"verses_count"`
RevelationPlace string `json:"revelation_place"`
TranslatedName TranslatedName `json:"translated_name"`
}
Chapter is a single chapter (surah) of the Quran.
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 api.quran.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. The caller owns nothing extra; the body is read fully and closed here.
func (*Client) GetChapter ¶
GetChapter returns a single chapter by its number (1–114).
func (*Client) ListChapters ¶
ListChapters returns all 114 chapters of the Quran.
type Domain ¶
type Domain struct{}
Domain is the quran driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify turns any accepted input into the canonical (type, id). "N:N" format (e.g. "1:1", "2:255") → ("verse", input) Pure numeric → ("chapter", input) Otherwise → ("query", input)
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 TranslatedName ¶
TranslatedName is the English (or requested-language) name of a chapter.
Source Files