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 (c Client) Get(uri string, v interface{}) error

Constants

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

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 {
	Token   string // Github API token, used when set.
	BaseURL string // Github API URL, defaults to DefaultBaseURL if unset.
}

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 (Client) Get

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

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