Documentation

Overview

    Package http implements the HTTP transport protocol.

    Index

    Constants

    This section is empty.

    Variables

    View Source
    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
          	SetAuth(r *http.Request)
          }

            AuthMethod is concrete implementation of common.AuthMethod for HTTP services

            type BasicAuth

            type BasicAuth struct {
            	Username, Password string
            }

              BasicAuth represent a HTTP basic auth

              func (*BasicAuth) Name

              func (a *BasicAuth) Name() string

                Name is name of the auth

                func (*BasicAuth) SetAuth

                func (a *BasicAuth) SetAuth(r *http.Request)

                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

                    type TokenAuth

                    type TokenAuth struct {
                    	Token string
                    }

                      TokenAuth implements an http.AuthMethod that can be used with http transport to authenticate with HTTP token authentication (also known as bearer authentication).

                      IMPORTANT: If you are looking to use OAuth tokens with popular servers (e.g. GitHub, Bitbucket, GitLab) you should use BasicAuth instead. These servers use basic HTTP authentication, with the OAuth token as user or password. Check the documentation of your git server for details.

                      func (*TokenAuth) Name

                      func (a *TokenAuth) Name() string

                        Name is name of the auth

                        func (*TokenAuth) SetAuth

                        func (a *TokenAuth) SetAuth(r *http.Request)

                        func (*TokenAuth) String

                        func (a *TokenAuth) String() string