stars

type Client ¶

type Client interface {
	GetUserRepos(ctx context.Context, user string) iter.Seq2[*github.Repository, error]
	GetStarGazers(ctx context.Context, repository *github.Repository) ([]*github.Stargazer, error)
}

type Notifier ¶

type Notifier interface {
	Notify(ctx context.Context, added bool, repo *github.Repository, stargazers ...*github.Stargazer)
}

Notifier notifies about added/removed stargazers.

type Notifiers ¶

type Notifiers []Notifier

Notifiers is a collection of Notifiers.

func (n Notifiers) Notify(ctx context.Context, added bool, repo *github.Repository, stargazers ...*github.Stargazer)

type NotifyingStore ¶ added in v0.3.0

type NotifyingStore struct {
	*Store
	Notifiers
}

NotifyingStore is a Store that notifies a Notifier when stargazers are added or removed.

func NewNotifyingStore(databaseDirectory string, notifiers Notifiers) (*NotifyingStore, error)

func (s NotifyingStore) Add(ctx context.Context, repo *github.Repository, stargazers ...*github.Stargazer) error

func (s NotifyingStore) Delete(ctx context.Context, repo *github.Repository, stargazers ...*github.Stargazer) error

type RepoStar ¶ added in v0.3.0

type RepoStar struct {
	StarredAt time.Time `json:"starred_at"`
}

RepoStar is a single star for a repository

type RepoStars ¶ added in v0.3.0

type RepoStars map[string]RepoStar

RepoStars contains all stars for a repository

type SlackNotifier ¶ added in v0.3.0

type SlackNotifier struct {
	// WebHookURL is the URL to the slack webhook
	WebHookURL string
	// MaximumUsers is the maximum number of users to notify about. Default is 5.
	// If the number of stargazers is greater than this, SlackNotifier only notifies the number of users.
	MaximumUsers int
}

SlackNotifier is a Notifier that posts added/removed stargazers to a Slack channel using a webhook.

func (s SlackNotifier) Notify(ctx context.Context, added bool, repo *github.Repository, stargazers ...*github.Stargazer)

type SlogNotifier ¶ added in v0.3.0

type SlogNotifier struct{}

SlogNotifier is a Notifier that logs the added/removed stargazers to a slog.Logger stored in the context.

func (s SlogNotifier) Notify(ctx context.Context, added bool, repo *github.Repository, stargazers ...*github.Stargazer)

type Stargazer ¶ added in v0.3.0

type Stargazer struct {
	StarredAt time.Time
	User      string
}

type Store ¶

type Store struct {
	Repos        map[string]RepoStars
	DatabasePath string
	// contains filtered or unexported fields
}

Store contains all stars for all repositories

func NewStore(databasePath string) (*Store, error)

func (s *Store) Add(repo *github.Repository, stargazers ...*github.Stargazer) ([]*github.Stargazer, error)

func (s *Store) Delete(repo *github.Repository, stargazers ...*github.Stargazer) ([]*github.Stargazer, error)