http

Documentation

Overview

Package http implements the HTTP transport protocol.

Index

• Variables
• func NewClient(c *http.Client) transport.Transport
• func NewErr(r *http.Response) error
• type AuthMethod
• type BasicAuth
  • func NewBasicAuth(username, password string) *BasicAuth
  • func (a *BasicAuth) Name() string
  • func (a *BasicAuth) String() string
• type Err
  • func (e *Err) Error() string
  • func (e *Err) StatusCode() int

Variables

var DefaultClient = NewClient(nil)

DefaultClient is the default HTTP client, which uses `http.DefaultClient`.

Functions

func NewClient

func NewClient(c *http.Client) transport.Transport

NewClient creates a new client with a custom net/http client. See `InstallProtocol` to install and override default http client. Unless a properly initialized client is given, it will fall back into `http.DefaultClient`.

Note that for HTTP client cannot distinguist between private repositories and unexistent repositories on GitHub. So it returns `ErrAuthorizationRequired` for both.

func NewErr

func NewErr(r *http.Response) error

NewErr returns a new Err based on a http response

Types

type AuthMethod

type AuthMethod interface {
	transport.AuthMethod
	// contains filtered or unexported methods
}

AuthMethod is concrete implementation of common.AuthMethod for HTTP services

type BasicAuth

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

BasicAuth represent a HTTP basic auth

func NewBasicAuth

func NewBasicAuth(username, password string) *BasicAuth

NewBasicAuth returns a basicAuth base on the given user and password

func (*BasicAuth) Name

func (a *BasicAuth) Name() string

Name is name of the auth

func (*BasicAuth) String

func (a *BasicAuth) String() string

type Err

type Err struct {
	Response *http.Response
}

Err is a dedicated error to return errors based on status code

func (*Err) Error

func (e *Err) Error() string

func (*Err) StatusCode

func (e *Err) StatusCode() int

StatusCode returns the status code of the response