github

Documentation

Overview

Package github fetches GitHub profile data.

Index

• func AuthRequired() bool
• func Match(urlStr string) bool
• type APIError
  • func (e *APIError) Error() string
• type Client
  • func New(ctx context.Context, opts ...Option) (*Client, error)
  • func (c *Client) Fetch(ctx context.Context, urlStr string) (*profile.Profile, error)
  • func (c *Client) UsernameFromEmail(ctx context.Context, email string) string
• type Option
  • func WithHTTPCache(httpCache httpcache.Cacher) Option
  • func WithLogger(logger *slog.Logger) Option
  • func WithToken(token string) Option

Functions

func AuthRequired

func AuthRequired() bool

AuthRequired returns false because GitHub profiles are public.

func Match

func Match(urlStr string) bool

Match returns true if the URL is a GitHub profile URL.

Types

type APIError

type APIError struct {
	StatusCode      int
	RateLimitRemain int
	RateLimitReset  time.Time
	Message         string
	IsRateLimit     bool
}

APIError contains details about a GitHub API error.

func (*APIError) Error

func (e *APIError) Error() string

type Client

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

Client handles GitHub requests.

func New

func New(ctx context.Context, opts ...Option) (*Client, error)

New creates a GitHub client.

func (*Client) Fetch

func (c *Client) Fetch(ctx context.Context, urlStr string) (*profile.Profile, error)

Fetch retrieves a GitHub profile.

func (*Client) UsernameFromEmail

func (c *Client) UsernameFromEmail(ctx context.Context, email string) string

UsernameFromEmail looks up a GitHub username from an email address. It first searches users with the email, then falls back to searching commits. Returns empty string if no username is found.

type Option

type Option func(*config)

Option configures a Client.

func WithHTTPCache

func WithHTTPCache(httpCache httpcache.Cacher) Option

WithHTTPCache sets the HTTP cache.

func WithLogger

func WithLogger(logger *slog.Logger) Option

WithLogger sets a custom logger.

func WithToken

func WithToken(token string) Option

WithToken sets the GitHub API token.