client

Documentation

Index

• type Client
  • func NewClient(opts ClientOptions) *Client
  • func (c *Client) AuthFork(username, password string) *Client
  • func (c *Client) Delete(url string, result interface{}) (*napping.Response, error)
  • func (c *Client) Fork(opts ClientOptions) *Client
  • func (c *Client) Get(url string, params *url.Values, result interface{}) (*napping.Response, error)
  • func (c *Client) Head(url string, result interface{}) (*napping.Response, error)
  • func (c *Client) Options(url string, result interface{}) (*napping.Response, error)
  • func (c *Client) Patch(url string, payload, result interface{}) (*napping.Response, error)
  • func (c *Client) Post(url string, payload, result interface{}) (*napping.Response, error)
  • func (c *Client) Put(url string, payload, result interface{}) (*napping.Response, error)
  • func (c *Client) Url(urlpath string) string
• type ClientOptions
• type Error
  • func DecodeError(reader io.Reader) (*Error, error)
  • func (e *Error) Error() string

Types

type Client

type Client struct {
	*napping.Session
	*ClientOptions
}

func NewClient

func NewClient(opts ClientOptions) *Client

func (*Client) AuthFork

func (c *Client) AuthFork(username, password string) *Client

AuthFork is a shorthand of Fork, when you simply want to change the auth

func (*Client) Delete

func (c *Client) Delete(url string, result interface{}) (*napping.Response, error)

func (*Client) Fork

func (c *Client) Fork(opts ClientOptions) *Client

Fork creates a new client off of the base client however it shares the same http.Client for efficiency reasons this prevents socket leaks from happening etc ...

func (*Client) Get

func (c *Client) Get(url string, params *url.Values, result interface{}) (*napping.Response, error)

func (*Client) Head

func (c *Client) Head(url string, result interface{}) (*napping.Response, error)

func (*Client) Options

func (c *Client) Options(url string, result interface{}) (*napping.Response, error)

func (*Client) Patch

func (c *Client) Patch(url string, payload, result interface{}) (*napping.Response, error)

func (*Client) Post

func (c *Client) Post(url string, payload, result interface{}) (*napping.Response, error)

func (*Client) Put

func (c *Client) Put(url string, payload, result interface{}) (*napping.Response, error)

func (*Client) Url

func (c *Client) Url(urlpath string) string

Url returns the full http url including host

type ClientOptions

type ClientOptions struct {
	// Hostname of gitbookio endpoint
	Host string

	// Auth info
	Username string
	Password string
}

type Error

type Error struct {
	Msg  string `json:"error"`
	Code int    `json:"code"`
}

func DecodeError

func DecodeError(reader io.Reader) (*Error, error)

func (*Error) Error

func (e *Error) Error() string