webmention

Documentation

Index

• Variables
• func DoFetch(ctx context.Context, client Client, mentionChannel chan Mention, ...) error
• func DoPersist(fetchedMentions []Mention, s *sync.WaitGroup, persistable Persistable) error
• func Save(filepath string, mentions []Mention) error
• type Author
• type Client
  • func (client *Client) GetMentions() (*Response, error)
• type Content
• type FetchWorker
  • func (fetchWorker *FetchWorker) AddObserver(observer MentionObserver)
  • func (fetchWorker *FetchWorker) AddObservers(observers []MentionObserver)
  • func (fetchWorker *FetchWorker) DoFetch(ctx context.Context, client Getter, mentionChannel chan<- Mention) error
• type Fetchable
• type FileReader
• type FileWriter
• type Getter
• type Loader
• type Mention
  • func InsertMention(mentions []Mention, mention Mention) []Mention
  • func LoadMentions(path string) ([]Mention, error)
  • func (m *Mention) GenerateSlug() (string, error)
• type MentionObserver
• type MetricsObserver
  • func (m *MetricsObserver) GetMetrics() MetricsResponse
  • func (m *MetricsObserver) Update(mention Mention)
• type MetricsResponse
• type Persistable
• type PersistenceWorker
  • func (w *PersistenceWorker) AddObserver(observer MentionObserver)
  • func (w *PersistenceWorker) DoPersist(fetchedMentions []Mention, s *sync.WaitGroup) error
• type Response
• type Saver

Variables

var BaseUrl = "https://webmention.io/api/mentions.jf2" // API endpoint

var LoadFunc = LoadMentions

var ReadFileFunc = os.ReadFile

var SaveFunc = Save

var WriteFileFunc = os.WriteFile

Functions

func DoFetch

func DoFetch(ctx context.Context, client Client, mentionChannel chan Mention, worker Fetchable) error

func DoPersist

func DoPersist(fetchedMentions []Mention, s *sync.WaitGroup, persistable Persistable) error

func Save

func Save(filepath string, mentions []Mention) error

Save adds the current mention to a JSON file using provided io.Reader and io.Writer

Types

type Author

type Author struct {
	Type  string `json:"type" faker:"oneof: card"`
	Name  string `json:"name" faker:"name"`
	Photo string `json:"photo" faker:"url"`
	URL   string `json:"url" faker:"url"`
}

type Client

type Client struct {
	Domain   string
	Token    string
	SinceID  int
	PageSize int
	// contains filtered or unexported fields
}

func (*Client) GetMentions

func (client *Client) GetMentions() (*Response, error)

type Content

type Content struct {
	HTML string `json:"html" faker:"paragraph"`
	Text string `json:"text" faker:"paragraph"`
}

type FetchWorker

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

func (*FetchWorker) AddObserver

func (fetchWorker *FetchWorker) AddObserver(observer MentionObserver)

func (*FetchWorker) AddObservers

func (fetchWorker *FetchWorker) AddObservers(observers []MentionObserver)

func (*FetchWorker) DoFetch

func (fetchWorker *FetchWorker) DoFetch(ctx context.Context, client Getter, mentionChannel chan<- Mention) error

DoFetch fetches mentions and sends them on mentionChannel until the source returns an empty response

type Fetchable

type Fetchable interface {
	DoFetch(context.Context, Getter, chan<- Mention) error
}

type FileReader

type FileReader interface {
	ReadFile(filepath string) ([]byte, error)
}

type FileWriter

type FileWriter interface {
	WriteFile(filepath string, data []byte, perm os.FileMode) error
}

FileWriter defines the WriteFile method for saving data to the filesystem.

type Getter

type Getter interface {
	GetMentions() (*Response, error)
}

type Loader

type Loader interface {
	LoadMentions(context.Context) ([]Mention, error)
}

type Mention

type Mention struct {
	Type       string    `json:"type" faker:"oneof: entry"`
	Author     Author    `json:"author"`
	URL        string    `json:"url" faker:"url"`
	Published  time.Time `json:"published"`
	WMReceived time.Time `json:"wm-received"`
	WMID       int       `json:"wm-id" faker:"unique"`
	WMSource   string    `json:"wm-source" faker:"url"`
	WMTarget   string    `json:"wm-target" faker:"url"`
	WMProtocol string    `json:"wm-protocol"`
	Name       string    `json:"name"`
	Content    Content   `json:"content"`
	InReplyTo  string    `json:"in-reply-to" faker:"url"`
	WMProperty string    `json:"wm-property" faker:"oneof: in-reply-to"`
	WMPrivate  bool      `json:"wm-private"`
}

func InsertMention

func InsertMention(mentions []Mention, mention Mention) []Mention

func LoadMentions

func LoadMentions(path string) ([]Mention, error)

func (*Mention) GenerateSlug

func (m *Mention) GenerateSlug() (string, error)

GenerateSlug creates a slug based on the WMTarget URL

type MentionObserver

type MentionObserver interface {
	Update(mention Mention)
}

type MetricsObserver

type MetricsObserver struct {
	MaxID            int
	EarliestReceived time.Time
	LatestReceived   time.Time
	AllSenders       []string
	MentionsSeen     int
	UniqueMentions   []int
	// contains filtered or unexported fields
}

func (*MetricsObserver) GetMetrics

func (m *MetricsObserver) GetMetrics() MetricsResponse

func (*MetricsObserver) Update

func (m *MetricsObserver) Update(mention Mention)

Update performs the necessary operations on an observed mention to main it's set of metrics.

type MetricsResponse

type MetricsResponse struct {
	MaxID            int
	EarliestReceived time.Time
	LatestReceived   time.Time
	AllSenders       []string
	MentionsSeen     int
	UniqueMentions   []int
}

type Persistable

type Persistable interface {
	DoPersist([]Mention, *sync.WaitGroup) error
}

type PersistenceWorker

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

func (*PersistenceWorker) AddObserver

func (w *PersistenceWorker) AddObserver(observer MentionObserver)

func (*PersistenceWorker) DoPersist

func (w *PersistenceWorker) DoPersist(fetchedMentions []Mention, s *sync.WaitGroup) error

type Response

type Response struct {
	Type     string    `json:"type" faker:"oneof: 15, 16"`
	Name     string    `json:"name" faker:"oneof: entry"`
	Children []Mention `json:"children"`
}

Response Define structs based on the JSON structure

type Saver

type Saver interface {
	Save(filepath string, mentions []Mention) error
}