apps

Documentation

Overview

Package apps provides the _incoming_ HTTP methods for notifiarr.com integrations. Methods are included for Radarr, Readrr, Lidarr and Sonarr. This library also holds the site API Key and the base HTTP server abstraction used throughout the Notifiarr client application. The configuration should be derived from a config file; a Router and an Error Log logger must also be provided.

Index

• Variables
• type APIHandler
• type App
• type Apps
  • func (a *Apps) CheckAPIKey(next http.Handler) http.Handler
  • func (a *Apps) HandleAPIpath(app App, uri string, api APIHandler, method ...string) *mux.Route
  • func (a *Apps) InitHandlers()
  • func (a *Apps) Respond(w http.ResponseWriter, stat int, msg interface{})
  • func (a *Apps) Setup(timeout time.Duration)
• type LidarrConfig
• type RadarrConfig
• type ReadarrConfig
• type SonarrConfig

Variables

var (
	ErrNoTMDB    = fmt.Errorf("TMDB ID must not be empty")
	ErrNoGRID    = fmt.Errorf("GRID ID must not be empty")
	ErrNoTVDB    = fmt.Errorf("TVDB ID must not be empty")
	ErrNoMBID    = fmt.Errorf("MBID ID must not be empty")
	ErrNoRadarr  = fmt.Errorf("configured %s ID not found", Radarr)
	ErrNoSonarr  = fmt.Errorf("configured %s ID not found", Sonarr)
	ErrNoLidarr  = fmt.Errorf("configured %s ID not found", Lidarr)
	ErrNoReadarr = fmt.Errorf("configured %s ID not found", Readarr)
	ErrNotFound  = fmt.Errorf("the request returned an empty payload")
	ErrNonZeroID = fmt.Errorf("provided ID must be non-zero")
	// ErrWrongCount is returned when an app returns the wrong item count.
	ErrWrongCount = fmt.Errorf("wrong item count returned")
)

Errors sent to client web requests.

Types

type APIHandler

type APIHandler func(r *http.Request) (int, interface{})

APIHandler is our custom handler function for APIs. The powers the middleware procedure that stores the app interface in a request context. And the procedures to save and fetch an app interface into/from a request content.

type App

type App string

App allows safely storing context values.

const (
	Sonarr  App = "sonarr"
	Readarr App = "readarr"
	Radarr  App = "radarr"
	Lidarr  App = "lidarr"
)

Constant for each app to unique identify itself. These strings are also used as a suffix to the /api/ web path.

type Apps

type Apps struct {
	APIKey   string           `json:"api_key" toml:"api_key" xml:"api_key" yaml:"api_key"`
	URLBase  string           `json:"urlbase" toml:"urlbase" xml:"urlbase" yaml:"urlbase"`
	Sonarr   []*SonarrConfig  `json:"sonarr,omitempty" toml:"sonarr" xml:"sonarr" yaml:"sonarr,omitempty"`
	Radarr   []*RadarrConfig  `json:"radarr,omitempty" toml:"radarr" xml:"radarr" yaml:"radarr,omitempty"`
	Lidarr   []*LidarrConfig  `json:"lidarr,omitempty" toml:"lidarr" xml:"lidarr" yaml:"lidarr,omitempty"`
	Readarr  []*ReadarrConfig `json:"readarr,omitempty" toml:"readarr" xml:"readarr" yaml:"readarr,omitempty"`
	Router   *mux.Router      `json:"-" toml:"-" xml:"-" yaml:"-"`
	ErrorLog *log.Logger      `json:"-" toml:"-" xml:"-" yaml:"-"`
}

Apps is the input configuration to relay requests to Starr apps.

func (*Apps) CheckAPIKey

func (a *Apps) CheckAPIKey(next http.Handler) http.Handler

CheckAPIKey drops a 403 if the API key doesn't match, otherwise run next handler.

func (*Apps) HandleAPIpath

func (a *Apps) HandleAPIpath(app App, uri string, api APIHandler, method ...string) *mux.Route

HandleAPIpath makes adding APIKey authenticated API paths a little cleaner. An empty App may be passed in, but URI, API and at least one method are required. Automatically adds an id route to routes with an app name. In case you have > 1 of that app.

func (*Apps) InitHandlers

func (a *Apps) InitHandlers()

InitHandlers activates all our handlers. This is part of the web server init.

func (*Apps) Respond

func (a *Apps) Respond(w http.ResponseWriter, stat int, msg interface{})

Respond sends a standard response to our caller. JSON encoded blobs.

func (*Apps) Setup

func (a *Apps) Setup(timeout time.Duration)

Setup creates request interfaces and sets the timeout for each server. This is part of the config/startup init.

type LidarrConfig

type LidarrConfig struct {
	Name      string        `toml:"name"`
	Interval  cnfg.Duration `toml:"interval"`
	StuckItem bool          `toml:"stuck_items"`
	*starr.Config
	*lidarr.Lidarr
}

LidarrConfig represents the input data for a Lidarr server.

type RadarrConfig

type RadarrConfig struct {
	Name      string        `toml:"name"`
	Interval  cnfg.Duration `toml:"interval"`
	DisableCF bool          `toml:"disable_cf"`
	StuckItem bool          `toml:"stuck_items"`
	*starr.Config
	*radarr.Radarr
}

RadarrConfig represents the input data for a Radarr server.

type ReadarrConfig

type ReadarrConfig struct {
	Name      string        `toml:"name"`
	Interval  cnfg.Duration `toml:"interval"`
	StuckItem bool          `toml:"stuck_items"`
	*starr.Config
	*readarr.Readarr
}

ReadarrConfig represents the input data for a Readarr server.

type SonarrConfig

type SonarrConfig struct {
	Name      string        `toml:"name"`
	Interval  cnfg.Duration `toml:"interval"`
	DisableCF bool          `toml:"disable_cf"`
	StuckItem bool          `toml:"stuck_items"`
	*starr.Config
	*sonarr.Sonarr
}

SonarrConfig represents the input data for a Sonarr server.