github

Documentation

Overview

Package github is a mini-library for querying the GitHub v3 API that takes care of authentication (with tokens only) and pagination.

Index

• Constants
• Variables
• func DoAuthRequest(method, url, mime, token string, headers map[string]string, body io.Reader) (*http.Response, error)
• func GetFileSize(f *os.File) (int64, error)
• type Client
  • func NewClient(username, token string, client *restclient.Client) Client
  • func (c Client) Do(r *http.Request) (*http.Response, error)
  • func (c Client) Get(uri string, v interface{}) error
  • func (c Client) GetPaginated(uri string, limit int, v interface{}) (string, error)
  • func (c Client) NewRequest(method, uri string, body io.Reader) (*http.Request, error)
  • func (c Client) SetBaseURL(baseurl string)

Constants

const DefaultBaseURL = "https://api.github.com"

const VERSION = "0.10.1-mist1"

Variables

var VERBOSITY = 0

Set to values > 0 to control verbosity, for debugging.

Functions

func DoAuthRequest

func DoAuthRequest(method, url, mime, token string, headers map[string]string, body io.Reader) (*http.Response, error)

DoAuthRequest ...

TODO: This function is amazingly ugly (separate headers, token, no API URL constructions, et cetera).

func GetFileSize

func GetFileSize(f *os.File) (int64, error)

Types

type Client

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

Client collects a few options that can be set when contacting the GitHub API, such as authorization tokens. Methods called on Client will supply these options when calling the API.

func NewClient

func NewClient(username, token string, client *restclient.Client) Client

NewClient creates a new Client for use with the Github API.

func (Client) Do

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

Caller is responsible for reading and closing the response body.

func (Client) Get

func (c Client) Get(uri string, v interface{}) error

func (Client) GetPaginated

func (c Client) GetPaginated(uri string, limit int, v interface{}) (string, error)

Get fetches uri (relative URL) from the GitHub API and unmarshals the response into v. It takes care of pagination transparantly.

func (Client) NewRequest

func (c Client) NewRequest(method, uri string, body io.Reader) (*http.Request, error)

func (Client) SetBaseURL

func (c Client) SetBaseURL(baseurl string)

SetBaseURL updates the client's base URL, if baseurl is a non-empty value.