client

Documentation

Index

• type ApiKeyAuth
  • func (a *ApiKeyAuth) Auth(req *http.Request) error
• type ArrTransport
  • func NewArrTransport(auth Authenticator, inner http.RoundTripper) *ArrTransport
  • func (t *ArrTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type Authenticator
• type BasicAuth
  • func (a *BasicAuth) Auth(req *http.Request) error
• type Client
  • func NewClient(config *config.Config) (*Client, error)
  • func (c *Client) DoRequest(endpoint string, target interface{}, queryParams ...map[string]string) error
• type FormAuth
  • func (a *FormAuth) Auth(req *http.Request) error

Types

type ApiKeyAuth

type ApiKeyAuth struct {
	ApiKey string
}

func (*ApiKeyAuth) Auth

func (a *ApiKeyAuth) Auth(req *http.Request) error

type ArrTransport

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

ArrTransport is a http.RoundTripper that adds authentication to requests

func NewArrTransport

func NewArrTransport(auth Authenticator, inner http.RoundTripper) *ArrTransport

func (*ArrTransport) RoundTrip

func (t *ArrTransport) RoundTrip(req *http.Request) (*http.Response, error)

type Authenticator

type Authenticator interface {
	Auth(req *http.Request) error
}

type BasicAuth

type BasicAuth struct {
	Username string
	Password string
	ApiKey   string
}

func (*BasicAuth) Auth

func (a *BasicAuth) Auth(req *http.Request) error

type Client

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

Client struct is an *Arr client.

func NewClient

func NewClient(config *config.Config) (*Client, error)

NewClient method initializes a new *Arr client.

func (*Client) DoRequest

func (c *Client) DoRequest(endpoint string, target interface{}, queryParams ...map[string]string) error

DoRequest - Take a HTTP Request and return Unmarshaled data

type FormAuth

type FormAuth struct {
	Username    string
	Password    string
	ApiKey      string
	AuthBaseURL *url.URL
	Transport   http.RoundTripper
	// contains filtered or unexported fields
}

func (*FormAuth) Auth

func (a *FormAuth) Auth(req *http.Request) error