ipinfo

type CacheLogger ¶ added in v0.5.5

type CacheLogger interface {
	Warn(msg, path string, err error)
}

CacheLogger is the interface for logging cache operations.

type CachedFetcher ¶ added in v0.5.5

type CachedFetcher struct {
	CacheDir string
	MaxAge   time.Duration
	Fetcher  Fetcher
	Logger   CacheLogger
}

CachedFetcher is a Fetcher that caches fetched CSV records in a local directory. It checks the cache before fetching, and updates the cache after fetching.

The cache entries are considered valid for a specified maximum age.

func NewCachedFetcher(
	cacheDir string,
	maxAge time.Duration,
	fetcher Fetcher,
	logger CacheLogger,
) *CachedFetcher

func (c *CachedFetcher) Fetch(ctx context.Context, url string) ([][]string, error)

type DBRecord ¶

type DBRecord struct {
	StartIP    netip.Addr
	EndIP      netip.Addr
	Resolution Resolution
}

DBRecord contains the information of a database record.

func ParseASNRecord(record []string) (*DBRecord, error)

func ParseCountryRecord(record []string) (*DBRecord, error)

type DBSource ¶ added in v0.5.2

type DBSource struct {
	DBType    string
	IPVersion string
}

DBSource identifies a database entry by type and IP version.

type DBSourceSpec ¶ added in v0.5.3

type DBSourceSpec struct {
	Source DBSource
	URL    string
	Parser ParserFunc
}

DBSourceSpec defines a database source with its URL and parser.

type DBUpdateCollector ¶ added in v0.5.2

type DBUpdateCollector interface {
	RecordDBUpdate(entries map[DBSource]uint64, duration time.Duration)
}

DBUpdateCollector collects metrics for database updates.

type Fetcher ¶ added in v0.5.3

type Fetcher interface {
	Fetch(ctx context.Context, url string) ([][]string, error)
}

Fetcher fetches CSV records from a URL.

type HTTPFetcher ¶ added in v0.5.3

type HTTPFetcher struct {
	Client *http.Client
}

HTTPFetcher is the default Fetcher implementation that fetches CSV records over HTTP.

func NewHTTPFetcher() *HTTPFetcher

func (f *HTTPFetcher) Fetch(ctx context.Context, url string) ([][]string, error)

type Loader ¶ added in v0.5.3

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

Loader loads database records from a source into an interval tree.

func NewLoader(fetcher Fetcher) *Loader

func (l *Loader) Load(
	ctx context.Context,
	db *ResTree,
	src DBSourceSpec,
) (uint64, error)

type ParserFunc ¶ added in v0.5.7

type ParserFunc func([]string) (*DBRecord, error)

ParserFunc is a function that parses a CSV record into a database record.

type ResTree ¶

type ResTree = itree.Tree[netip.Addr, Resolution]

ResTree is a type alias for an interval tree that maps IP addresses to resolutions.

type Resolution ¶

type Resolution struct {
	CountryCode  string // ISO 3166-1 alpha-2 country code
	Organization string // Organization name
	ASN          uint32 // Autonomous System Number
}

Resolution contains the result of resolving an IP address.

type Resolver ¶

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

Resolver is an IP resolver that returns information about an IP address.

func NewResolver(
	collector DBUpdateCollector,
	fetcher Fetcher,
) *Resolver

func (r *Resolver) Resolve(ip netip.Addr) Resolution

func (r *Resolver) Update(ctx context.Context) error