fanbox

Documentation

Index

• Variables
• func IsFailedToThumbnailingErr(resp *http.Response) (bool, error)
• type Block
• type Client
  • func (c *Client) Run(ctx context.Context, creatorID string) error
• type Creator
• type CreatorIDLister
  • func (c *CreatorIDLister) Do(ctx context.Context, in *CreatorIDListerDoInput) ([]string, error)
• type CreatorIDListerDoInput
• type CreatorListFollowingResponse
• type Downloadable
• type File
  • func (f File) GetExtension() string
  • func (f File) GetID() string
  • func (f File) GetThumbnailURL() (string, bool)
  • func (f File) GetURL() string
• type Image
  • func (i Image) GetExtension() string
  • func (i Image) GetID() string
  • func (i Image) GetThumbnailURL() (string, bool)
  • func (i Image) GetURL() string
• type ListCreatorResponse
• type LocalStorage
  • func (s *LocalStorage) Exist(post Post, order int, d Downloadable) (bool, error)
  • func (s *LocalStorage) Save(post Post, order int, d Downloadable, r io.Reader) error
• type OfficialAPIClient
  • func (c *OfficialAPIClient) Request(ctx context.Context, method string, url string) (*http.Response, error)
  • func (c *OfficialAPIClient) RequestAndUnwrapJSON(ctx context.Context, method string, url string, v interface{}) error
• type Pagination
• type Plan
• type PlanListSupportingResponse
• type Post
  • func (f *Post) ListDownloadable() []Downloadable
• type PostBody
• type PostInfoResponse

Variables

var ErrFailedToThumbnailing = fmt.Errorf("failed to thumbnailing")

var ErrStatusForbidden = errors.New("status code 403")

Functions

func IsFailedToThumbnailingErr

func IsFailedToThumbnailingErr(resp *http.Response) (bool, error)

fanbox returns HTTP 500 error and response body is "failed to thumbnailing" when the image is not available (e.g. too large).

Types

type Block

type Block struct {
	Type    string  `json:"type"` // p(text) or image.
	ImageID *string `json:"imageId"`
	FileID  *string `json:"fileId"`
}

type Client

type Client struct {
	CheckAllPosts     bool
	DryRun            bool
	SkipFiles         bool
	SkipImages        bool
	SkipOnError       bool
	OfficialAPIClient *OfficialAPIClient
	Storage           *LocalStorage
}

Client is the struct for Client.

func (*Client) Run

func (c *Client) Run(ctx context.Context, creatorID string) error

type Creator

type Creator struct {
	CreatorID string `json:"creatorId"`
}

type CreatorIDLister

type CreatorIDLister struct {
	OfficialAPIClient *OfficialAPIClient
}

func (*CreatorIDLister) Do

func (c *CreatorIDLister) Do(ctx context.Context, in *CreatorIDListerDoInput) ([]string, error)

type CreatorIDListerDoInput

type CreatorIDListerDoInput struct {
	InputCreatorIDs   []string
	IncludeSupporting bool
	IncludeFollowing  bool
	IgnoreCreatorIDs  []string
}

type CreatorListFollowingResponse

type CreatorListFollowingResponse struct {
	Body []Creator `json:"body"`
}

type Downloadable

type Downloadable interface {
	GetID() string
	GetURL() string
	GetThumbnailURL() (string, bool)
	GetExtension() string
}

type File

type File struct {
	ID        string `json:"id"`
	Name      string `json:"name"`
	Extension string `json:"extension"`
	URL       string `json:"url"`
}

File represents a uploaded file.

func (File) GetExtension

func (f File) GetExtension() string

func (File) GetID

func (f File) GetID() string

func (File) GetThumbnailURL

func (f File) GetThumbnailURL() (string, bool)

func (File) GetURL

func (f File) GetURL() string

type Image

type Image struct {
	ID           string `json:"id"`
	Extension    string `json:"extension"`
	OriginalURL  string `json:"originalUrl"`
	ThumbnailURL string `json:"thumbnailUrl"`
}

Image represents a uploaded image.

func (Image) GetExtension

func (i Image) GetExtension() string

func (Image) GetID

func (i Image) GetID() string

func (Image) GetThumbnailURL

func (i Image) GetThumbnailURL() (string, bool)

func (Image) GetURL

func (i Image) GetURL() string

type ListCreatorResponse

type ListCreatorResponse struct {
	Body []Post `json:"body"`
}

ListCreatorResponse represents the response of https://api.fanbox.cc/post.listCreator.

type LocalStorage

type LocalStorage struct {
	SaveDir   string
	DirByPost bool
	DirByPlan bool

	RemoveUnprintableChars bool
}

func (*LocalStorage) Exist

func (s *LocalStorage) Exist(post Post, order int, d Downloadable) (bool, error)

func (*LocalStorage) Save

func (s *LocalStorage) Save(post Post, order int, d Downloadable, r io.Reader) error

type OfficialAPIClient

type OfficialAPIClient struct {
	HTTPClient *retryablehttp.Client
	Cookie     string
	UserAgent  string
}

func (*OfficialAPIClient) Request

func (c *OfficialAPIClient) Request(ctx context.Context, method string, url string) (*http.Response, error)

func (*OfficialAPIClient) RequestAndUnwrapJSON

func (c *OfficialAPIClient) RequestAndUnwrapJSON(ctx context.Context, method string, url string, v interface{}) error

type Pagination

type Pagination struct {
	Pages []string `json:"body"`
}

Pagination represents the response of https://api.fanbox.cc/post.paginateCreator?creatorId=x.

type Plan

type Plan struct {
	CreatorID string `json:"creatorId"`
}

type PlanListSupportingResponse

type PlanListSupportingResponse struct {
	Body []Plan `json:"body"`
}

type Post

type Post struct {
	ID                string    `json:"id"`
	Title             string    `json:"title"`
	PublishedDateTime string    `json:"publishedDatetime"`
	CreatorID         string    `json:"creatorId"`
	FeeRequired       int       `json:"feeRequired"`
	IsRestricted      bool      `json:"isRestricted"`
	IsPinned          bool      `json:"isPinned"`
	Body              *PostBody `json:"body"`
}

Post represents post attributes.

func (*Post) ListDownloadable

func (f *Post) ListDownloadable() []Downloadable

type PostBody

type PostBody struct {
	// Files is not nil if post type is "file".
	Files *[]File `json:"files"`
	// Images is not nil if post type is "image".
	Images *[]Image `json:"images"`
	// Blocks is not nil if post type is "blog".
	Blocks *[]Block `json:"blocks"`
	// ImageMap is not nil if post type is "blog".
	ImageMap *map[string]Image `json:"imageMap"`
	// FileMap is not nil if post type is "blog".
	FileMap *map[string]File `json:"fileMap"`
}

type PostInfoResponse

type PostInfoResponse struct {
	Body Post `json:"body"`
}

PostInfoResponse represents the response of https://api.fanbox.cc/post.info.