scratch

Documentation

Overview

Package scratch fetches user profiles from scratch.mit.edu.

Index

• func ExtractUsername(url string) string
• func Match(url string) bool
• type Client
  • func New(_ context.Context, opts ...Option) (*Client, error)
  • func (c *Client) Fetch(ctx context.Context, urlStr string) (*profile.Profile, error)
• type Option
  • func WithHTTPCache(cache httpcache.Cacher) Option
  • func WithLogger(l *slog.Logger) Option

Functions

func ExtractUsername

func ExtractUsername(url string) string

ExtractUsername returns the username from a scratch.mit.edu URL.

func Match

func Match(url string) bool

Match returns true if the URL is a scratch.mit.edu user profile.

Types

type Client

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

Client fetches scratch.mit.edu profiles.

func New

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

New creates a new scratch client.

func (*Client) Fetch

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

Fetch retrieves a scratch.mit.edu user profile.

type Option

type Option func(*config)

Option configures the Client.

func WithHTTPCache

func WithHTTPCache(cache httpcache.Cacher) Option

WithHTTPCache sets the HTTP cache.

func WithLogger

func WithLogger(l *slog.Logger) Option

WithLogger sets the logger.