mastodon

package module
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 25, 2017 License: MIT Imports: 19 Imported by: 0

README

go-mastodon

Build Status Coverage Status GoDoc Go Report Card

Usage

Application
package main

import (
	"context"
	"fmt"
	"log"

	"github.com/mattn/go-mastodon"
)

func main() {
	app, err := mastodon.RegisterApp(context.Background(), &mastodon.AppConfig{
		Server:     "https://mstdn.jp",
		ClientName: "client-name",
		Scopes:     "read write follow",
		Website:    "https://github.com/mattn/go-mastodon",
	})
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("client-id    : %s\n", app.ClientID)
	fmt.Printf("client-secret: %s\n", app.ClientSecret)
}
Client
package main

import (
	"context"
	"fmt"
	"log"

	"github.com/mattn/go-mastodon"
)

func main() {
	c := mastodon.NewClient(&mastodon.Config{
		Server:       "https://mstdn.jp",
		ClientID:     "client-id",
		ClientSecret: "client-secret",
	})
	err := c.Authenticate(context.Background(), "your-email", "your-password")
	if err != nil {
		log.Fatal(err)
	}
	timeline, err := c.GetTimelineHome(context.Background(), nil)
	if err != nil {
		log.Fatal(err)
	}
	for i := len(timeline) - 1; i >= 0; i-- {
		fmt.Println(timeline[i])
	}
}

Status of implementations

  • GET /api/v1/accounts/:id
  • GET /api/v1/accounts/verify_credentials
  • PATCH /api/v1/accounts/update_credentials
  • GET /api/v1/accounts/:id/followers
  • GET /api/v1/accounts/:id/following
  • GET /api/v1/accounts/:id/statuses
  • POST /api/v1/accounts/:id/follow
  • POST /api/v1/accounts/:id/unfollow
  • GET /api/v1/accounts/:id/block
  • GET /api/v1/accounts/:id/unblock
  • GET /api/v1/accounts/:id/mute
  • GET /api/v1/accounts/:id/unmute
  • GET /api/v1/accounts/relationships
  • GET /api/v1/accounts/search
  • POST /api/v1/apps
  • GET /api/v1/blocks
  • GET /api/v1/favourites
  • GET /api/v1/follow_requests
  • POST /api/v1/follow_requests/:id/authorize
  • POST /api/v1/follow_requests/:id/reject
  • POST /api/v1/follows
  • GET /api/v1/instance
  • POST /api/v1/media
  • GET /api/v1/mutes
  • GET /api/v1/notifications
  • GET /api/v1/notifications/:id
  • POST /api/v1/notifications/clear
  • GET /api/v1/reports
  • POST /api/v1/reports
  • GET /api/v1/search
  • GET /api/v1/statuses/:id
  • GET /api/v1/statuses/:id/context
  • GET /api/v1/statuses/:id/card
  • GET /api/v1/statuses/:id/reblogged_by
  • GET /api/v1/statuses/:id/favourited_by
  • POST /api/v1/statuses
  • DELETE /api/v1/statuses/:id
  • POST /api/v1/statuses/:id/reblog
  • POST /api/v1/statuses/:id/unreblog
  • POST /api/v1/statuses/:id/favourite
  • POST /api/v1/statuses/:id/unfavourite
  • GET /api/v1/timelines/home
  • GET /api/v1/timelines/public
  • GET /api/v1/timelines/tag/:hashtag

Installation

$ go get github.com/mattn/go-mastodon

License

MIT

Author

Yasuhiro Matsumoto (a.k.a. mattn)

Documentation

Overview

Package mastodon provides functions and structs for accessing the mastodon API.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func Base64Encode 

func Base64Encode(file *os.File) (string, error)

Base64Encode returns the base64 data URI format string of the file.

func Base64EncodeFileName 

func Base64EncodeFileName(filename string) (string, error)

Base64EncodeFileName returns the base64 data URI format string of the file with the file name.

func String 

func String(v string) *string

String is a helper function to get the pointer value of a string.

Types

type Account 

type Account struct {
	ID             ID        `json:"id"`
	Username       string    `json:"username"`
	Acct           string    `json:"acct"`
	DisplayName    string    `json:"display_name"`
	Locked         bool      `json:"locked"`
	CreatedAt      time.Time `json:"created_at"`
	FollowersCount int64     `json:"followers_count"`
	FollowingCount int64     `json:"following_count"`
	StatusesCount  int64     `json:"statuses_count"`
	Note           string    `json:"note"`
	URL            string    `json:"url"`
	Avatar         string    `json:"avatar"`
	AvatarStatic   string    `json:"avatar_static"`
	Header         string    `json:"header"`
	HeaderStatic   string    `json:"header_static"`
}

Account hold information for mastodon account.

type AppConfig 

type AppConfig struct {
	http.Client
	Server     string
	ClientName string

	// Where the user should be redirected after authorization (for no redirect, use urn:ietf:wg:oauth:2.0:oob)
	RedirectURIs string

	// This can be a space-separated list of the following items: "read", "write" and "follow".
	Scopes string

	// Optional.
	Website string
}

AppConfig is a setting for registering applications.

type Application 

type Application struct {
	ID           int64  `json:"id"`
	RedirectURI  string `json:"redirect_uri"`
	ClientID     string `json:"client_id"`
	ClientSecret string `json:"client_secret"`
}

Application is mastodon application.

func RegisterApp 

func RegisterApp(ctx context.Context, appConfig *AppConfig) (*Application, error)

RegisterApp returns the mastodon application.

Example 
app, err := mastodon.RegisterApp(context.Background(), &mastodon.AppConfig{
	Server:     "https://mstdn.jp",
	ClientName: "client-name",
	Scopes:     "read write follow",
	Website:    "https://github.com/mattn/go-mastodon",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("client-id    : %s\n", app.ClientID)
fmt.Printf("client-secret: %s\n", app.ClientSecret)

type Attachment 

type Attachment struct {
	ID         ID     `json:"id"`
	Type       string `json:"type"`
	URL        string `json:"url"`
	RemoteURL  string `json:"remote_url"`
	PreviewURL string `json:"preview_url"`
	TextURL    string `json:"text_url"`
}

Attachment hold information for attachment.

type Card 

type Card struct {
	URL         string `json:"url"`
	Title       string `json:"title"`
	Description string `json:"description"`
	Image       string `json:"image"`
}

Card hold information for mastodon card.

type Client 

type Client struct {
	http.Client
	// contains filtered or unexported fields
}

Client is a API client for mastodon.

Example 
c := mastodon.NewClient(&mastodon.Config{
	Server:       "https://mstdn.jp",
	ClientID:     "client-id",
	ClientSecret: "client-secret",
})
err := c.Authenticate(context.Background(), "your-email", "your-password")
if err != nil {
	log.Fatal(err)
}
timeline, err := c.GetTimelineHome(context.Background(), nil)
if err != nil {
	log.Fatal(err)
}
for i := len(timeline) - 1; i >= 0; i-- {
	fmt.Println(timeline[i])
}

func NewClient 

func NewClient(config *Config) *Client

NewClient return new mastodon API client.

func (*Client) AccountBlock 

func (c *Client) AccountBlock(ctx context.Context, id ID) (*Relationship, error)

AccountBlock block the account.

func (*Client) AccountFollow 

func (c *Client) AccountFollow(ctx context.Context, id ID) (*Relationship, error)

AccountFollow follow the account.

func (*Client) AccountMute 

func (c *Client) AccountMute(ctx context.Context, id ID) (*Relationship, error)

AccountMute mute the account.

func (*Client) AccountUnblock 

func (c *Client) AccountUnblock(ctx context.Context, id ID) (*Relationship, error)

AccountUnblock unblock the account.

func (*Client) AccountUnfollow 

func (c *Client) AccountUnfollow(ctx context.Context, id ID) (*Relationship, error)

AccountUnfollow unfollow the account.

func (*Client) AccountUnmute 

func (c *Client) AccountUnmute(ctx context.Context, id ID) (*Relationship, error)

AccountUnmute unmute the account.

func (*Client) AccountUpdate 

func (c *Client) AccountUpdate(ctx context.Context, profile *Profile) (*Account, error)

AccountUpdate updates the information of the current user.

func (*Client) AccountsSearch 

func (c *Client) AccountsSearch(ctx context.Context, q string, limit int64) ([]*Account, error)

AccountsSearch search accounts by query.

func (*Client) Authenticate 

func (c *Client) Authenticate(ctx context.Context, username, password string) error

Authenticate get access-token to the API.

func (*Client) ClearNotifications 

func (c *Client) ClearNotifications(ctx context.Context) error

ClearNotifications clear notifications.

func (*Client) DeleteStatus 

func (c *Client) DeleteStatus(ctx context.Context, id int64) error

DeleteStatus delete the toot.

func (*Client) Favourite 

func (c *Client) Favourite(ctx context.Context, id int64) (*Status, error)

Favourite is favourite the toot of id and return status of the favourite toot.

func (*Client) FollowRemoteUser 

func (c *Client) FollowRemoteUser(ctx context.Context, uri string) (*Account, error)

FollowRemoteUser send follow-request.

func (*Client) FollowRequestAuthorize 

func (c *Client) FollowRequestAuthorize(ctx context.Context, id ID) error

FollowRequestAuthorize is authorize the follow request of user with id.

func (*Client) FollowRequestReject 

func (c *Client) FollowRequestReject(ctx context.Context, id ID) error

FollowRequestReject is rejects the follow request of user with id.

func (*Client) GetAccount 

func (c *Client) GetAccount(ctx context.Context, id ID) (*Account, error)

GetAccount return Account.

func (*Client) GetAccountCurrentUser 

func (c *Client) GetAccountCurrentUser(ctx context.Context) (*Account, error)

GetAccountCurrentUser return Account of current user.

func (*Client) GetAccountFollowers 

func (c *Client) GetAccountFollowers(ctx context.Context, id ID, pg *Pagination) ([]*Account, error)

GetAccountFollowers return followers list.

func (*Client) GetAccountFollowing 

func (c *Client) GetAccountFollowing(ctx context.Context, id ID, pg *Pagination) ([]*Account, error)

GetAccountFollowing return following list.

func (*Client) GetAccountRelationships 

func (c *Client) GetAccountRelationships(ctx context.Context, ids []string) ([]*Relationship, error)

GetAccountRelationships return relationship for the account.

func (*Client) GetAccountStatuses 

func (c *Client) GetAccountStatuses(ctx context.Context, id ID, pg *Pagination) ([]*Status, error)

GetAccountStatuses return statuses by specified accuont.

func (*Client) GetBlocks 

func (c *Client) GetBlocks(ctx context.Context, pg *Pagination) ([]*Account, error)

GetBlocks return block list.

func (*Client) GetFavouritedBy 

func (c *Client) GetFavouritedBy(ctx context.Context, id int64, pg *Pagination) ([]*Account, error)

GetFavouritedBy returns the account list of the user who liked the toot of id.

func (*Client) GetFavourites 

func (c *Client) GetFavourites(ctx context.Context, pg *Pagination) ([]*Status, error)

GetFavourites return the favorite list of the current user.

func (*Client) GetFollowRequests 

func (c *Client) GetFollowRequests(ctx context.Context, pg *Pagination) ([]*Account, error)

GetFollowRequests return follow-requests.

func (*Client) GetInstance 

func (c *Client) GetInstance(ctx context.Context) (*Instance, error)

GetInstance return Instance.

func (*Client) GetMutes 

func (c *Client) GetMutes(ctx context.Context, pg *Pagination) ([]*Account, error)

GetMutes returns the list of users muted by the current user.

func (*Client) GetNotification 

func (c *Client) GetNotification(ctx context.Context, id int64) (*Notification, error)

GetNotification return notification.

func (*Client) GetNotifications 

func (c *Client) GetNotifications(ctx context.Context, pg *Pagination) ([]*Notification, error)

GetNotifications return notifications.

func (*Client) GetRebloggedBy 

func (c *Client) GetRebloggedBy(ctx context.Context, id int64, pg *Pagination) ([]*Account, error)

GetRebloggedBy returns the account list of the user who reblogged the toot of id.

func (*Client) GetReports 

func (c *Client) GetReports(ctx context.Context) ([]*Report, error)

GetReports return report of the current user.

func (*Client) GetStatus 

func (c *Client) GetStatus(ctx context.Context, id int64) (*Status, error)

GetStatus return status specified by id.

func (*Client) GetStatusCard 

func (c *Client) GetStatusCard(ctx context.Context, id int64) (*Card, error)

GetStatusCard return status specified by id.

func (*Client) GetStatusContext 

func (c *Client) GetStatusContext(ctx context.Context, id int64) (*Context, error)

GetStatusContext return status specified by id.

func (*Client) GetTimelineHashtag 

func (c *Client) GetTimelineHashtag(ctx context.Context, tag string, isLocal bool, pg *Pagination) ([]*Status, error)

GetTimelineHashtag return statuses from tagged timeline.

func (*Client) GetTimelineHome 

func (c *Client) GetTimelineHome(ctx context.Context, pg *Pagination) ([]*Status, error)

GetTimelineHome return statuses from home timeline.

func (*Client) GetTimelineMedia 

func (c *Client) GetTimelineMedia(ctx context.Context, isLocal bool, pg *Pagination) ([]*Status, error)

GetTimelineMedia return statuses from media timeline. NOTE: This is an experimental feature of pawoo.net.

func (*Client) GetTimelinePublic 

func (c *Client) GetTimelinePublic(ctx context.Context, isLocal bool, pg *Pagination) ([]*Status, error)

GetTimelinePublic return statuses from public timeline.

func (*Client) NewWSClient 

func (c *Client) NewWSClient() *WSClient

NewWSClient return WebSocket client.

func (*Client) PostStatus 

func (c *Client) PostStatus(ctx context.Context, toot *Toot) (*Status, error)

PostStatus post the toot.

func (*Client) Reblog 

func (c *Client) Reblog(ctx context.Context, id int64) (*Status, error)

Reblog is reblog the toot of id and return status of reblog.

func (*Client) Report 

func (c *Client) Report(ctx context.Context, accountID int64, ids []int64, comment string) (*Report, error)

Report reports the report

func (*Client) Search 

func (c *Client) Search(ctx context.Context, q string, resolve bool) (*Results, error)

Search search content with query.

func (*Client) StreamingHashtag 

func (c *Client) StreamingHashtag(ctx context.Context, tag string, isLocal bool) (chan Event, error)

StreamingHashtag return channel to read events on tagged timeline.

func (*Client) StreamingPublic 

func (c *Client) StreamingPublic(ctx context.Context, isLocal bool) (chan Event, error)

StreamingPublic return channel to read events on public.

func (*Client) StreamingUser 

func (c *Client) StreamingUser(ctx context.Context) (chan Event, error)

StreamingUser return channel to read events on home.

func (*Client) Unfavourite 

func (c *Client) Unfavourite(ctx context.Context, id int64) (*Status, error)

Unfavourite is unfavourite the toot of id and return status of the unfavourite toot.

func (*Client) Unreblog 

func (c *Client) Unreblog(ctx context.Context, id int64) (*Status, error)

Unreblog is unreblog the toot of id and return status of the original toot.

func (*Client) UploadMedia 

func (c *Client) UploadMedia(ctx context.Context, file string) (*Attachment, error)

UploadMedia upload a media attachment.

type Config 

type Config struct {
	Server       string
	ClientID     string
	ClientSecret string
	AccessToken  string
}

Config is a setting for access mastodon APIs.

type Context 

type Context struct {
	Ancestors   []*Status `json:"ancestors"`
	Descendants []*Status `json:"descendants"`
}

Context hold information for mastodon context.

type DeleteEvent 

type DeleteEvent struct{ ID int64 }

DeleteEvent is struct for passing deletion event to app.

type ErrorEvent 

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

ErrorEvent is struct for passing errors to app.

func (*ErrorEvent) Error 

func (e *ErrorEvent) Error() string

type Event 

type Event interface {
	// contains filtered or unexported methods
}

Event is interface passing events to app.

type ID added in v0.0.2 

type ID string

func (*ID) UnmarshalJSON added in v0.0.2 

func (id *ID) UnmarshalJSON(data []byte) error

type Instance 

type Instance struct {
	URI         string `json:"uri"`
	Title       string `json:"title"`
	Description string `json:"description"`
	EMail       string `json:"email"`
}

Instance hold information for mastodon instance.

type Mention 

type Mention struct {
	URL      string `json:"url"`
	Username string `json:"username"`
	Acct     string `json:"acct"`
	ID       ID     `json:"id"`
}

Mention hold information for mention.

type Notification 

type Notification struct {
	ID        int64     `json:"id"`
	Type      string    `json:"type"`
	CreatedAt time.Time `json:"created_at"`
	Account   Account   `json:"account"`
	Status    *Status   `json:"status"`
}

Notification hold information for mastodon notification.

type NotificationEvent 

type NotificationEvent struct {
	Notification *Notification `json:"notification"`
}

NotificationEvent is struct for passing notification event to app.

type Pagination 

type Pagination struct {
	MaxID   ID
	SinceID ID
	Limit   int64
}

Pagination is a struct for specifying the get range.

Example 
c := mastodon.NewClient(&mastodon.Config{
	Server:       "https://mstdn.jp",
	ClientID:     "client-id",
	ClientSecret: "client-secret",
})
var followers []*mastodon.Account
var pg mastodon.Pagination
for {
	fs, err := c.GetAccountFollowers(context.Background(), "1", &pg)
	if err != nil {
		log.Fatal(err)
	}
	followers = append(followers, fs...)
	if pg.MaxID == "" {
		break
	}
	time.Sleep(10 * time.Second)
}
for _, f := range followers {
	fmt.Println(f.Acct)
}

type Profile 

type Profile struct {
	// If it is nil it will not be updated.
	// If it is empty, update it with empty.
	DisplayName *string
	Note        *string

	// Set the base64 encoded character string of the image.
	Avatar string
	Header string
}

Profile is a struct for updating profiles.

type Relationship 

type Relationship struct {
	ID         ID   `json:"id"`
	Following  bool `json:"following"`
	FollowedBy bool `json:"followed_by"`
	Blocking   bool `json:"blocking"`
	Muting     bool `json:"muting"`
	Requested  bool `json:"requested"`
}

Relationship hold information for relation-ship to the account.

type Report 

type Report struct {
	ID          int64 `json:"id"`
	ActionTaken bool  `json:"action_taken"`
}

Report hold information for mastodon report.

type Results 

type Results struct {
	Accounts []*Account `json:"accounts"`
	Statuses []*Status  `json:"statuses"`
	Hashtags []string   `json:"hashtags"`
}

Results hold information for search result.

type Status 

type Status struct {
	ID                 ID           `json:"id"`
	CreatedAt          time.Time    `json:"created_at"`
	InReplyToID        interface{}  `json:"in_reply_to_id"`
	InReplyToAccountID interface{}  `json:"in_reply_to_account_id"`
	Sensitive          bool         `json:"sensitive"`
	SpoilerText        string       `json:"spoiler_text"`
	Visibility         string       `json:"visibility"`
	Application        Application  `json:"application"`
	Account            Account      `json:"account"`
	MediaAttachments   []Attachment `json:"media_attachments"`
	Mentions           []Mention    `json:"mentions"`
	Tags               []Tag        `json:"tags"`
	URI                string       `json:"uri"`
	Content            string       `json:"content"`
	URL                string       `json:"url"`
	ReblogsCount       int64        `json:"reblogs_count"`
	FavouritesCount    int64        `json:"favourites_count"`
	Reblog             *Status      `json:"reblog"`
	Favourited         interface{}  `json:"favourited"`
	Reblogged          interface{}  `json:"reblogged"`
}

Status is struct to hold status.

type Stream 

type Stream struct {
	Event   string      `json:"event"`
	Payload interface{} `json:"payload"`
}

Stream is a struct of data that flows in streaming.

type Tag 

type Tag struct {
	Name string `json:"name"`
	URL  string `json:"url"`
}

Tag hold information for tag.

type Toot 

type Toot struct {
	Status      string `json:"status"`
	InReplyToID ID     `json:"in_reply_to_id"`
	MediaIDs    []ID   `json:"media_ids"`
	Sensitive   bool   `json:"sensitive"`
	SpoilerText string `json:"spoiler_text"`
	Visibility  string `json:"visibility"`
}

Toot is struct to post status.

type UpdateEvent 

type UpdateEvent struct {
	Status *Status `json:"status"`
}

UpdateEvent is struct for passing status event to app.

type WSClient 

type WSClient struct {
	websocket.Dialer
	// contains filtered or unexported fields
}

WSClient is a WebSocket client.

func (*WSClient) StreamingWSHashtag 

func (c *WSClient) StreamingWSHashtag(ctx context.Context, tag string, isLocal bool) (chan Event, error)

StreamingWSHashtag return channel to read events on tagged timeline using WebSocket.

func (*WSClient) StreamingWSPublic 

func (c *WSClient) StreamingWSPublic(ctx context.Context, isLocal bool) (chan Event, error)

StreamingWSPublic return channel to read events on public using WebSocket.

func (*WSClient) StreamingWSUser 

func (c *WSClient) StreamingWSUser(ctx context.Context) (chan Event, error)

StreamingWSUser return channel to read events on home using WebSocket.

Source Files

View all Source files

Directories

Path Synopsis
cmd
mstdn command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.