red

Documentation

Index

• Constants
• type ApiClient
  • func NewClient(apiKey string, opts ...OptFunc) ApiClient
• type Client
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) GetIndex(ctx context.Context) (*IndexResponse, error)
  • func (c *Client) GetTorrentByID(ctx context.Context, torrentID string) (*domain.TorrentBasic, error)
  • func (c *Client) TestAPI(ctx context.Context) (bool, error)
• type ErrorResponse
• type Group
• type IndexResponse
• type OptFunc
  • func WithUrl(url string) OptFunc
• type Torrent
• type TorrentDetailsResponse

Constants

const DefaultURL = "https://redacted.ch/ajax.php"

Types

type ApiClient

type ApiClient interface {
	GetTorrentByID(ctx context.Context, torrentID string) (*domain.TorrentBasic, error)
	TestAPI(ctx context.Context) (bool, error)
}

func NewClient

func NewClient(apiKey string, opts ...OptFunc) ApiClient

type Client

type Client struct {
	APIKey string
	// contains filtered or unexported fields
}

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

func (*Client) GetIndex

func (c *Client) GetIndex(ctx context.Context) (*IndexResponse, error)

GetIndex get API index

func (*Client) GetTorrentByID

func (c *Client) GetTorrentByID(ctx context.Context, torrentID string) (*domain.TorrentBasic, error)

func (*Client) TestAPI

func (c *Client) TestAPI(ctx context.Context) (bool, error)

TestAPI try api access against torrents page

type ErrorResponse

type ErrorResponse struct {
	Status string `json:"status"`
	Error  string `json:"error,omitempty"`
}

type Group

type Group struct {
	//WikiBody        string `json:"wikiBody"`
	//WikiImage       string `json:"wikiImage"`
	Id              int    `json:"id"`
	Name            string `json:"name"`
	Year            int    `json:"year"`
	RecordLabel     string `json:"recordLabel"`
	CatalogueNumber string `json:"catalogueNumber"`
	ReleaseType     int    `json:"releaseType"`
	CategoryId      int    `json:"categoryId"`
	CategoryName    string `json:"categoryName"`
	Time            string `json:"time"`
	VanityHouse     bool   `json:"vanityHouse"`
}

type IndexResponse

type IndexResponse struct {
	Status   string `json:"status"`
	Response struct {
		Username      string `json:"username"`
		Id            int    `json:"id"`
		Authkey       string `json:"authkey"`
		Passkey       string `json:"passkey"`
		ApiVersion    string `json:"api_version"`
		Notifications struct {
			Messages        int  `json:"messages"`
			Notifications   int  `json:"notifications"`
			NewAnnouncement bool `json:"newAnnouncement"`
			NewBlog         bool `json:"newBlog"`
		} `json:"notifications"`
		UserStats struct {
			Uploaded      int64   `json:"uploaded"`
			Downloaded    int64   `json:"downloaded"`
			Ratio         float64 `json:"ratio"`
			RequiredRatio float64 `json:"requiredratio"`
			Class         string  `json:"class"`
		} `json:"userstats"`
	} `json:"response"`
}

type OptFunc

type OptFunc func(*Client)

func WithUrl

func WithUrl(url string) OptFunc

type Torrent

type Torrent struct {
	Id                      int    `json:"id"`
	InfoHash                string `json:"infoHash"`
	Media                   string `json:"media"`
	Format                  string `json:"format"`
	Encoding                string `json:"encoding"`
	Remastered              bool   `json:"remastered"`
	RemasterYear            int    `json:"remasterYear"`
	RemasterTitle           string `json:"remasterTitle"`
	RemasterRecordLabel     string `json:"remasterRecordLabel"`
	RemasterCatalogueNumber string `json:"remasterCatalogueNumber"`
	Scene                   bool   `json:"scene"`
	HasLog                  bool   `json:"hasLog"`
	HasCue                  bool   `json:"hasCue"`
	LogScore                int    `json:"logScore"`
	FileCount               int    `json:"fileCount"`
	Size                    int    `json:"size"`
	Seeders                 int    `json:"seeders"`
	Leechers                int    `json:"leechers"`
	Snatched                int    `json:"snatched"`
	FreeTorrent             bool   `json:"freeTorrent"`
	IsNeutralleech          bool   `json:"isNeutralleech"`
	IsFreeload              bool   `json:"isFreeload"`
	Time                    string `json:"time"`
	Description             string `json:"description"`
	FileList                string `json:"fileList"`
	FilePath                string `json:"filePath"`
	UserId                  int    `json:"userId"`
	Username                string `json:"username"`
}

type TorrentDetailsResponse

type TorrentDetailsResponse struct {
	Status   string `json:"status"`
	Response struct {
		Group   Group   `json:"group"`
		Torrent Torrent `json:"torrent"`
	} `json:"response"`
	Error string `json:"error,omitempty"`
}