triviaapi

Documentation

Overview

Package triviaapi is the library behind the triviaapi command line: the HTTP client, request shaping, and the typed data models for The Trivia API (the-trivia-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 API throws under load.

Index

• Constants
• type CategoryInfo
• type Client
  • func NewClient() *Client
  • func (c *Client) Get(ctx context.Context, url string) ([]byte, error)
  • func (c *Client) GetCategories(ctx context.Context) ([]*CategoryInfo, error)
  • func (c *Client) GetQuestions(ctx context.Context, limit int, categories, difficulty string) ([]*Question, error)
• type Config
  • func DefaultConfig() Config
• type Domain
  • func (Domain) Classify(input string) (uriType, id string, err error)
  • func (Domain) Info() kit.DomainInfo
  • func (Domain) Locate(uriType, id string) (string, error)
  • func (Domain) Register(app *kit.App)
• type Question

Constants

const BaseURL = "https://" + Host

BaseURL is the root every request is built from.

const DefaultUserAgent = "triviaapi-cli/0.1 (tamnd87@gmail.com)"

DefaultUserAgent identifies the client to The Trivia API.

const Host = "the-trivia-api.com"

Host is the site this client talks to.

Types

type CategoryInfo

type CategoryInfo struct {
	ID   string `json:"id"   kit:"id"`
	Name string `json:"name"`
}

CategoryInfo describes one trivia category.

type Client

type Client struct {
	HTTP      *http.Client
	UserAgent string
	BaseURL   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 The Trivia API 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) GetCategories

func (c *Client) GetCategories(ctx context.Context) ([]*CategoryInfo, error)

GetCategories fetches all trivia categories.

func (*Client) GetQuestions

func (c *Client) GetQuestions(ctx context.Context, limit int, categories, difficulty string) ([]*Question, error)

GetQuestions fetches trivia questions. limit: number of questions (1-50, 0 = API default of 1). categories: comma-separated category slugs, empty = all. difficulty: "easy", "medium", "hard", or empty = all.

type Config

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

Config holds tunable parameters for the client.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns sensible defaults.

type Domain

type Domain struct{}

Domain is the triviaapi driver. It carries no state; the per-run client is built by the factory Register hands kit.

func (Domain) Classify

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

Classify is not meaningful for a pure-API service with no page-like URIs. Return an error so `ant resolve` gracefully reports unsupported 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.

func (Domain) Locate

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

Locate is the inverse of Classify; not applicable for this domain.

func (Domain) Register

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

Register installs the client factory and every operation onto app.

type Question

type Question struct {
	ID               string   `json:"id"                kit:"id"`
	Category         string   `json:"category"`
	Difficulty       string   `json:"difficulty"`
	Question         string   `json:"question"`
	CorrectAnswer    string   `json:"correct_answer"`
	IncorrectAnswers []string `json:"incorrect_answers"`
}

Question is one trivia question with its answers.