github

Documentation

Index

• Constants
• Variables
• type AuthorizationMethod
• type Client
  • func NewClient() Client
• type OrganizationTeams
• type OrganizationVerifier
  • func NewOrganizationVerifier(organizations []string, gitHubClient Client) OrganizationVerifier
  • func (verifier OrganizationVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)
• type Provider
  • func NewProvider(gitHubAuth db.GitHubAuth, redirectURL string) Provider
  • func (Provider) DisplayName() string
• type Team
• type TeamVerifier
  • func (verifier TeamVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)
• type UserVerifier
  • func (verifier UserVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)
• type Verifier
  • func NewTeamVerifier(teams []Team, gitHubClient Client) Verifier
  • func NewUserVerifier(users []string, gitHubClient Client) Verifier
• type VerifierBasket
  • func NewVerifierBasket(verifiers ...Verifier) VerifierBasket
  • func (vb VerifierBasket) Verify(logger lager.Logger, client *http.Client) (bool, error)

Constants

const ProviderName = "github"

Variables

var Scopes = []string{"read:org"}

Types

type AuthorizationMethod

type AuthorizationMethod struct {
	Organization string
	Team         string

	User string
}

type Client

type Client interface {
	CurrentUser(*http.Client) (string, error)
	Organizations(*http.Client) ([]string, error)
	Teams(*http.Client) (OrganizationTeams, error)
}

func NewClient

func NewClient() Client

type OrganizationTeams

type OrganizationTeams map[string][]string

type OrganizationVerifier

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

func NewOrganizationVerifier

func NewOrganizationVerifier(
	organizations []string,
	gitHubClient Client,
) OrganizationVerifier

func (OrganizationVerifier) Verify

func (verifier OrganizationVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)

type Provider

type Provider struct {
	*oauth2.Config
	Verifier
}

func NewProvider

func NewProvider(
	gitHubAuth db.GitHubAuth,
	redirectURL string,
) Provider

func (Provider) DisplayName

func (Provider) DisplayName() string

type Team

type Team struct {
	Name         string
	Organization string
}

type TeamVerifier

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

func (TeamVerifier) Verify

func (verifier TeamVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)

type UserVerifier

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

func (UserVerifier) Verify

func (verifier UserVerifier) Verify(logger lager.Logger, httpClient *http.Client) (bool, error)

type Verifier

type Verifier interface {
	Verify(lager.Logger, *http.Client) (bool, error)
}

func NewTeamVerifier

func NewTeamVerifier(
	teams []Team,
	gitHubClient Client,
) Verifier

func NewUserVerifier

func NewUserVerifier(
	users []string,
	gitHubClient Client,
) Verifier

type VerifierBasket

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

func NewVerifierBasket

func NewVerifierBasket(verifiers ...Verifier) VerifierBasket

func (VerifierBasket) Verify

func (vb VerifierBasket) Verify(logger lager.Logger, client *http.Client) (bool, error)