reqapi

Documentation

Index

• Variables
• type API
  • func GetAPI(ident APIIdent) *API
  • func (api *API) GetSession() *napping.Session
  • func (api *API) GetURL(url string) string
• type APIIdent
• type CacheEntry
• type Request
  • func (r *Request) ApplyCache(c *CacheEntry)
  • func (r *Request) ApplyResponse(resp *napping.Response)
  • func (r *Request) CacheRead() error
  • func (r *Request) CacheWrite() error
  • func (r *Request) Do() (err error)
  • func (r *Request) Error(err error)
  • func (r *Request) Lock() error
  • func (r *Request) LogStatus()
  • func (r *Request) Marshal() ([]byte, error)
  • func (r *Request) MarshalCache() ([]byte, error)
  • func (r *Request) Prepare() (err error)
  • func (r *Request) Reset()
  • func (r *Request) Size(size uint64)
  • func (r *Request) String() string
  • func (r *Request) Unlock() error
  • func (r *Request) Unmarshal(b *bytes.Buffer) error
  • func (r *Request) UnmarshalCache(b *bytes.Buffer) (*CacheEntry, error)

Variables

var (
	TMDBAPI = &API{
		Ident:       TMDBIdent,
		Endpoint:    "https://api.themoviedb.org/3",
		RetriesLeft: 3,
		RateLimiter: util.NewRateLimiter(50, 1*time.Second, 50),
	}

	TraktAPI = &API{
		Ident:       TraktIdent,
		Endpoint:    "https://api.trakt.tv",
		RetriesLeft: 3,
		RateLimiter: util.NewRateLimiter(100, 10*time.Second, 25),
	}

	FanartAPI = &API{
		Ident:       FanArtIdent,
		Endpoint:    "http://webservice.fanart.tv/v3",
		RetriesLeft: 3,
		RateLimiter: util.NewRateLimiter(100, 10*time.Second, 25),
	}

	OpenSubtitlesAPI = &API{
		Ident:       OpenSubtitlesIdent,
		Endpoint:    "https://api.opensubtitles.com/api/v1",
		RetriesLeft: 3,
		RateLimiter: util.NewRateLimiter(100, 10*time.Second, 25),
	}
)

Types

type API

type API struct {
	Ident       APIIdent
	RateLimiter *util.RateLimiter
	Endpoint    string
	RetriesLeft int
}

func GetAPI

func GetAPI(ident APIIdent) *API

func (*API) GetSession

func (api *API) GetSession() *napping.Session

func (*API) GetURL

func (api *API) GetURL(url string) string

type APIIdent

type APIIdent string

const (
	TMDBIdent          APIIdent = cache.TMDBKey
	TraktIdent         APIIdent = cache.TraktKey
	FanArtIdent        APIIdent = cache.FanartKey
	OpenSubtitlesIdent APIIdent = cache.OpensubtitlesKey
)

type CacheEntry

type CacheEntry struct {
	Header     http.Header `json:"header"`
	Body       []byte      `json:"body"`
	Status     string      `json:"status"`
	StatusCode int         `json:"statuscode"`
}

type Request

type Request struct {
	trace.Tracer
	API *API

	Method      string
	URL         string
	Params      url.Values  `msg:"-"`
	Header      http.Header `msg:"-"`
	Payload     *bytes.Buffer
	Description string

	Retry        int
	RetryBackoff time.Duration

	ResponseError      error
	ResponseStatus     string
	ResponseStatusCode int
	ResponseHeader     http.Header
	ResponseBody       *bytes.Buffer
	ResponseSize       uint64
	ResponseIgnore     []int

	Result any

	Cache            bool
	CacheExpire      time.Duration
	CacheForceExpire bool
	CacheKey         string
	// contains filtered or unexported fields
}

func (*Request) ApplyCache

func (r *Request) ApplyCache(c *CacheEntry)

func (*Request) ApplyResponse

func (r *Request) ApplyResponse(resp *napping.Response)

func (*Request) CacheRead

func (r *Request) CacheRead() error

func (*Request) CacheWrite

func (r *Request) CacheWrite() error

func (*Request) Do

func (r *Request) Do() (err error)

func (*Request) Error

func (r *Request) Error(err error)

func (*Request) Lock

func (r *Request) Lock() error

func (*Request) LogStatus

func (r *Request) LogStatus()

func (*Request) Marshal

func (r *Request) Marshal() ([]byte, error)

func (*Request) MarshalCache

func (r *Request) MarshalCache() ([]byte, error)

func (*Request) Prepare

func (r *Request) Prepare() (err error)

func (*Request) Reset

func (r *Request) Reset()

func (*Request) Size

func (r *Request) Size(size uint64)

func (*Request) String

func (r *Request) String() string

func (*Request) Unlock

func (r *Request) Unlock() error

func (*Request) Unmarshal

func (r *Request) Unmarshal(b *bytes.Buffer) error

func (*Request) UnmarshalCache

func (r *Request) UnmarshalCache(b *bytes.Buffer) (*CacheEntry, error)