client

package

v0.0.0-...-bf65384 Latest Latest Go to latest Published: Apr 28, 2018 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package client contains an implementation of a HTTP client aware of all the Github rules like rate limiting or authenticating

This section is empty.

This section is empty.

This section is empty.

type Client struct {
	HTTPClient
	LastResponse *http.Response
	Log
}

Client is a top-level HTTPClient that remembers the last response and can log information out during the process

func New(httpClient HTTPClient, opts Options) Client

New creates a new instance of Client chaining all the clients together given Options

func (c *Client) Do(req *http.Request) (*http.Response, error)

Do is HTTPClient.Do

type Credentials struct {
	Username            string
	PersonalAccessToken string
}

Credentials struct contains user's name and access token to access the Github API

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient is in interface for a HTTP client which "transforms" a http.Request into http.Response (like http.Client)

type Log func(message string)

Log is a which is used to report for logging

type Options struct {
	*Credentials
	RateLimiter *<-chan time.Time
	MaxRetries  int
	Log
}

Options is a set of configurable options to create a whole chain of clients