webmention

type Document ¶

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

func DocumentFromReader(ctx context.Context, reader io.Reader, u string) (*Document, error)

func DocumentFromURL(ctx context.Context, u string) (*Document, error)

func (d *Document) ExternalLinks() []string

func (d *Document) Links() []string

type EndpointDiscoverer ¶

type EndpointDiscoverer interface {
	DiscoverEndpoint(ctx context.Context, url string) (string, error)
}

EndpointDiscoverer is used to discover the Webmention endpoint for the given URL.

func NewEndpointDiscoverer(configurators ...EndpointDiscoveryConfigurator) EndpointDiscoverer

type EndpointDiscoveryConfiguration ¶

type EndpointDiscoveryConfiguration struct {
	HTTPClient *http.Client
}

EndpointDiscoveryConfiguration allows to pass configuration parameters to a new Discoverer.

type EndpointDiscoveryConfigurator ¶

type EndpointDiscoveryConfigurator func(*EndpointDiscoveryConfiguration)

EndpointDiscoveryConfigurator is passed to NewEndDiscoverer to configure it.

type Mention ¶

type Mention struct {
	Source     string
	Target     string
	Title      string
	Content    string
	AuthorName string
	Type       string
	RSVP       string
}

Mention is what is sent to a receiver linking source and target.

func ExtractMention(r *http.Request) (*Mention, error)

type Sender ¶

type Sender interface {
	// Send a webmention to the specified endpoint indicating that source
	// mentioned target.
	Send(ctx context.Context, endpoint string, mention Mention) error
}

Sender is used to send webmentions.

func NewSender(configurators ...SenderConfigurator) Sender

type SenderConfiguration ¶

type SenderConfiguration struct {
	HTTPClient *http.Client
}

SenderConfiguration allows to inject a custom HTTP Client into the Sender.

type SenderConfigurator ¶

type SenderConfigurator func(*SenderConfiguration)

SenderConfigurator is used as argument for the NewSender method and helps configuring a new Sender instance.

type Verifier ¶

type Verifier interface {
	Verify(ctx context.Context, resp *http.Response, body io.Reader, mention *Mention) error
}

Verifier is used to check if a given response body produced by fetching mention.Source contains a link to mention.Target.

func NewVerifier() Verifier

type VerifyOptions ¶

type VerifyOptions struct {
	MaxRedirects int
}