gh

Documentation

Index

• Variables
• type API
  • func (gh *API) GetBranch(location *Location) (*Branch, error)
  • func (gh *API) GetFile(location *Location) (string, error)
  • func (gh *API) GetFileAsync(location *Location) *FileFuture
  • func (gh *API) GetFiles(location *Location) (map[string]string, error)
• type Branch
• type Client
  • func New(token string, cacheDir string, statsd statsdw.Interface) Client
• type FileFuture
  • func (ff *FileFuture) Get() (string, error)
• type Location
  • func NewLocation(location string) (*Location, error)
  • func (l *Location) Defaults(defaults Location)
  • func (l Location) String() string

Variables

var (
	ContentLocationRE = regexp.MustCompile(`^github.com/([^/]+)/([^/]+)/(.*)$`)
)

Types

type API

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

func (*API) GetBranch

func (gh *API) GetBranch(location *Location) (*Branch, error)

func (*API) GetFile

func (gh *API) GetFile(location *Location) (string, error)

func (*API) GetFileAsync

func (gh *API) GetFileAsync(location *Location) *FileFuture

func (*API) GetFiles

func (gh *API) GetFiles(location *Location) (map[string]string, error)

type Branch

type Branch struct {
	Location
	github.Rate
	Name, SHA string
	Author    string
	Date      time.Time
	Message   string
}

type Client

type Client interface {
	GetBranch(location *Location) (*Branch, error)
	GetFile(location *Location) (string, error)
	GetFiles(location *Location) (map[string]string, error)
}

func New

func New(token string, cacheDir string, statsd statsdw.Interface) Client

type FileFuture

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

func (*FileFuture) Get

func (ff *FileFuture) Get() (string, error)

type Location

type Location struct {
	Owner, Repo, Path, Ref string
}

func NewLocation

func NewLocation(location string) (*Location, error)

func (*Location) Defaults

func (l *Location) Defaults(defaults Location)

func (Location) String

func (l Location) String() string