fedi

Documentation

Index

• Constants
• func SplitAccount(act string) (string, string, error)
• type Fedi
  • func New(d db.DB, k kv.KV, t *token.Tokenizer) (*Fedi, error)
  • func (f *Fedi) GetLoginURL(ctx context.Context, act string) (*url.URL, error)
  • func (f *Fedi) GetNodeInfo20(ctx context.Context, domain string, url *url.URL) (*models.NodeInfo20, error)
  • func (f *Fedi) GetWellknownNodeInfo(ctx context.Context, domain string) (*models.NodeInfo, error)
  • func (f *Fedi) Helper(s Software) Helper
• type Helper
• type Software

Constants

const (
	// AppWebsite is the uri of the project
	AppWebsite = "https://github.com/tyrm/feditools"
	// NodeInfo20Schema the schema url for nodeinfo 2.0
	NodeInfo20Schema = "http://nodeinfo.diaspora.software/ns/schema/2.0"
	// SoftwareMastodon is the software keyword for Mastodon
	SoftwareMastodon Software = "mastodon"
)

Functions

func SplitAccount

func SplitAccount(act string) (string, string, error)

SplitAccount splits a federated account into a username and domain

Types

type Fedi

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

Fedi is a module for working with federated social instances

func New

func New(d db.DB, k kv.KV, t *token.Tokenizer) (*Fedi, error)

New creates a new fedi module

func (*Fedi) GetLoginURL

func (f *Fedi) GetLoginURL(ctx context.Context, act string) (*url.URL, error)

GetLoginURL retrieves an oauth url for a federated instance

func (*Fedi) GetNodeInfo20

func (f *Fedi) GetNodeInfo20(ctx context.Context, domain string, url *url.URL) (*models.NodeInfo20, error)

GetNodeInfo20 retrieves wellknown nodeinfo from a federated instance

func (*Fedi) GetWellknownNodeInfo

func (f *Fedi) GetWellknownNodeInfo(ctx context.Context, domain string) (*models.NodeInfo, error)

GetWellknownNodeInfo retrieves wellknown nodeinfo from a federated instance

func (*Fedi) Helper

func (f *Fedi) Helper(s Software) Helper

Helper returns a helper for a given software package

type Helper

type Helper interface {
	GetAccessToken(ctx context.Context, instance *models.FediInstance, code string) (accessToken string, err error)
	GetCurrentAccount(ctx context.Context, instance *models.FediInstance, accessToken string) (user *models.FediAccount, err error)
	RegisterApp(ctx context.Context, instance *models.FediInstance) (clientID string, clientSecret string, err error)
	MakeLoginURL(ctx context.Context, instance *models.FediInstance) (url *url.URL, err error)
}

Helper interacts with a federated social instance

type Software

type Software string

Software is a federated social software type