github

Documentation

Index

• Constants
• type App
  • func (a *App) Branches(repo *Repository, accessToken string) ([]*Branch, error)
  • func (a *App) Clone(ctx httpclient.Context) *App
  • func (a *App) Emails(accessToken string) ([]*Email, error)
  • func (a *App) Get(path string, data url.Values, accessToken string, out interface{}) error
  • func (a *App) OrganizationRepositories(name string, accessToken string) ([]*Repository, error)
  • func (a *App) Organizations(username string, accessToken string) ([]*Organization, error)
  • func (a *App) Parse(s string) error
  • func (a *App) Post(path string, data url.Values, accessToken string, out interface{}) error
  • func (a *App) Repositories(username string, accessToken string) ([]*Repository, error)
  • func (a *App) Repository(fullName string, accessToken string) (*Repository, error)
  • func (a *App) Tags(repo *Repository, accessToken string) ([]*Tag, error)
  • func (a *App) URL(path string) string
  • func (a *App) User(name string, accessToken string) (*User, error)
• type Branch
• type Commit
• type Email
• type Organization
• type Repository
• type Tag
• type User

Constants

const (
	Authorization = "https://github.com/login/oauth/authorize"
	Exchange      = "https://github.com/login/oauth/access_token"
	Base          = "https://api.github.com"
)

const (
	ScopeUser           = "user"
	ScopeEmail          = "user:email"
	ScopeFollow         = "user:follow"
	ScopePublicRepo     = "public_repo"
	ScopeRepo           = "repo"
	ScopeRepoDeployment = "repo_deployment"
	ScopeRepoStatus     = "repo:status"
	ScopeDeleteRepo     = "delete_repo"
	ScopeNotifications  = "notifications"
	ScopeGist           = "gist"
	ScopeReadRepoHook   = "read:repo_hook"
	ScopeWriteRepoHook  = "write:repo_hook"
	ScopeAdminRepoHook  = "admin:repo_hook"
	ScopeReadOrg        = "read:org"
	ScopeWriteOrg       = "write:org"
	ScopeAdminOrg       = "admin:org"
	ScopeReadPublicKey  = "read:public_key"
	ScopeWritePublicKey = "write:public_key"
	ScopeAdminPublicKey = "admin:public_key"
)

Types

type App

type App struct {
	*oauth2.Client
}

func (*App) Branches

func (a *App) Branches(repo *Repository, accessToken string) ([]*Branch, error)

func (*App) Clone

func (a *App) Clone(ctx httpclient.Context) *App

func (*App) Emails

func (a *App) Emails(accessToken string) ([]*Email, error)

func (*App) Get

func (a *App) Get(path string, data url.Values, accessToken string, out interface{}) error

func (*App) OrganizationRepositories

func (a *App) OrganizationRepositories(name string, accessToken string) ([]*Repository, error)

func (*App) Organizations

func (a *App) Organizations(username string, accessToken string) ([]*Organization, error)

func (*App) Parse

func (a *App) Parse(s string) error

func (*App) Post

func (a *App) Post(path string, data url.Values, accessToken string, out interface{}) error

func (*App) Repositories

func (a *App) Repositories(username string, accessToken string) ([]*Repository, error)

func (*App) Repository

func (a *App) Repository(fullName string, accessToken string) (*Repository, error)

func (*App) Tags

func (a *App) Tags(repo *Repository, accessToken string) ([]*Tag, error)

func (*App) URL

func (a *App) URL(path string) string

func (*App) User

func (a *App) User(name string, accessToken string) (*User, error)

type Branch

type Branch struct {
	Name   string `json:"name"`
	Commit Commit `json:"commit"`
}

type Commit

type Commit struct {
	Sha1 string `json:"sha1"`
	URL  string `json:"url"`
}

type Email

type Email struct {
	Address  string `json:"email"`
	Primary  bool   `json:"primary"`
	Verified bool   `json:"verified"`
}

type Organization

type Organization struct {
	Id        int64  `json:"id"`
	Login     string `json:"login"`
	URL       string `json:"url"`
	AvatarURL string `json:"avatar_url"`
}

type Repository

type Repository struct {
	ArchiveURL       string `json:"archive_url"`
	AssigneesURL     string `json:"assignees_url"`
	BlobsURL         string `json:"blobs_url"`
	BranchesURL      string `json:"branches_url"`
	CloneURL         string `json:"clone_url"`
	CollaboratorsURL string `json:"collaborators_url"`
	CommentsURL      string `json:"comments_url"`
	CommitsURL       string `json:"commits_url"`
	CompareURL       string `json:"compare_url"`
	ContentsURL      string `json:"contents_url"`
	ContributorsURL  string `json:"contributors_url"`
	CreatedAt        string `json:"created_at"`
	DefaultBranch    string `json:"default_branch"`
	Description      string `json:"description"`
	DownloadsURL     string `json:"downloads_url"`
	EventsURL        string `json:"events_url"`
	Fork             bool   `json:"fork"`
	Forks            int64  `json:"forks"`
	ForksCount       int64  `json:"forks_count"`
	ForksURL         string `json:"forks_url"`
	FullName         string `json:"full_name"`
	GitCommitsURL    string `json:"git_commits_url"`
	GitRefsURL       string `json:"git_refs_url"`
	GitTagsURL       string `json:"git_tags_url"`
	GitURL           string `json:"git_url"`
	HasDownloads     bool   `json:"has_downloads"`
	HasIssues        bool   `json:"has_issues"`
	HasWiki          bool   `json:"has_wiki"`
	Homepage         string `json:"homepage"`
	HooksURL         string `json:"hooks_url"`
	HtmlURL          string `json:"html_url"`
	Id               int64  `json:"id"`
	IssueCommentURL  string `json:"issue_comment_url"`
	IssueEventsURL   string `json:"issue_events_url"`
	IssuesURL        string `json:"issues_url"`
	KeysURL          string `json:"keys_url"`
	LabelsURL        string `json:"labels_url"`
	Language         string `json:"language"`
	LanguagesURL     string `json:"languages_url"`
	MergesURL        string `json:"merges_url"`
	MilestonesURL    string `json:"milestones_url"`
	MirrorURL        string `json:"mirror_url"`
	Name             string `json:"name"`
	NetworkCount     int64  `json:"network_count"`
	NotificationsURL string `json:"notifications_url"`
	OpenIssues       int64  `json:"open_issues"`
	OpenIssuesCount  int64  `json:"open_issues_count"`
	Owner            *User
	Private          bool   `json:"private"`
	PullsURL         string `json:"pulls_url"`
	PushedAt         string `json:"pushed_at"`
	ReleasesURL      string `json:"releases_url"`
	Size             int64  `json:"size"`
	SshURL           string `json:"ssh_url"`
	StargazersCount  int64  `json:"stargazers_count"`
	StargazersURL    string `json:"stargazers_url"`
	StatusesURL      string `json:"statuses_url"`
	SubscribersCount int64  `json:"subscribers_count"`
	SubscribersURL   string `json:"subscribers_url"`
	SubscriptionURL  string `json:"subscription_url"`
	SvnURL           string `json:"svn_url"`
	TagsURL          string `json:"tags_url"`
	TeamsURL         string `json:"teams_url"`
	TreesURL         string `json:"trees_url"`
	UpdatedAt        string `json:"updated_at"`
	URL              string `json:"url"`
	Watchers         int64  `json:"watchers"`
	WatchersCount    int64  `json:"watchers_count"`
}

type Tag

type Tag struct {
	Name       string `json:"name"`
	Commit     Commit `json:"commit"`
	ZipballURL string `json:"zipball_url"`
	TarballURL string `json:"tarball_url"`
}

type User

type User struct {
	Id                int64  `json:"id"`
	Name              string `json:"name"`
	AvatarURL         string `json:"avatar_url"`
	Bio               string `json:"bio"`
	Blog              string `json:"blog"`
	Company           string `json:"company"`
	CreatedAt         string `json:"created_at"`
	Email             string `json:"email"`
	EventsURL         string `json:"events_url"`
	Followers         int64  `json:"followers"`
	FollowersURL      string `json:"followers_url"`
	Following         int64  `json:"following"`
	FollowingURL      string `json:"following_url"`
	GistsURL          string `json:"gists_url"`
	GravatarId        string `json:"gravatar_id"`
	Hireable          bool   `json:"hireable"`
	HtmlURL           string `json:"html_url"`
	Location          string `json:"location"`
	Login             string `json:"login"`
	OrganizationsURL  string `json:"organizations_url"`
	PublicGists       int64  `json:"public_gists"`
	PublicRepos       int64  `json:"public_repos"`
	ReceivedEventsURL string `json:"received_events_url"`
	ReposURL          string `json:"repos_url"`
	SiteAdmin         bool   `json:"site_admin"`
	StarredURL        string `json:"starred_url"`
	SubscriptionsURL  string `json:"subscriptions_url"`
	Type              string `json:"type"`
	UpdatedAt         string `json:"updated_at"`
	URL               string `json:"url"`
}