zenquotes

package

v0.1.0 Latest Latest Go to latest Published: Jun 14, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tamnd/zenquotes-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package zenquotes is the library behind the zenquotes command line: the HTTP client, request shaping, and the typed data models for the ZenQuotes.io public motivational quote API.

The API requires no authentication. A polite User-Agent and 200 ms pacing between requests keeps the client well within the free-tier rate limits.

Index ¶

Constants
type Client
- func NewClient(cfg Config) *Client
- func (c *Client) Quotes(ctx context.Context, limit int) ([]Quote, error)
- func (c *Client) Random(ctx context.Context) (Quote, error)
type Config
- func DefaultConfig() Config
type Domain
type Quote

Constants ¶

View Source

const Host = "zenquotes.io"

Host is the site this client talks to.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client talks to ZenQuotes over HTTP.

func NewClient ¶

func NewClient(cfg Config) *Client

NewClient returns a Client configured with cfg.

func (*Client) Quotes ¶

func (c *Client) Quotes(ctx context.Context, limit int) ([]Quote, error)

Quotes fetches a batch of up to 50 motivational quotes. Pass limit <= 0 to return all 50.

func (*Client) Random ¶

func (c *Client) Random(ctx context.Context) (Quote, error)

Random fetches one random motivational quote.

type Config ¶

type Config struct {
	BaseURL   string
	UserAgent string
	Rate      time.Duration
	Timeout   time.Duration
	Retries   int
}

Config holds all tunable parameters for the Client.

func DefaultConfig ¶

func DefaultConfig() Config

DefaultConfig returns a Config with sensible defaults.

type Domain ¶

type Domain struct{}

Domain is the zenquotes driver.

func (Domain) Classify ¶

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

Classify turns an 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 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 Quote ¶

type Quote struct {
	Rank   int    `json:"rank"`
	Text   string `json:"text"`
	Author string `json:"author"`
}

Quote is one motivational quote from ZenQuotes.io.

Source Files ¶

View all Source files

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