gitprovider

Documentation

Index

• Constants
• Variables
• type BitbucketProvider
  • func (g *BitbucketProvider) GetAdditionalParam(key string) string
  • func (g *BitbucketProvider) GetRepository(opt map[string]string) (*Repository, error)
  • func (g *BitbucketProvider) Initialize(baseURL, token string, additionalParams map[string]string) error
  • func (g *BitbucketProvider) Name() string
  • func (g *BitbucketProvider) ValidateAdditionalParams(additionalParams map[string]string) bool
• type GitProvider
• type GithubProvider
  • func (g *GithubProvider) GetAdditionalParam(key string) string
  • func (g *GithubProvider) GetRepository(opt map[string]string) (*Repository, error)
  • func (g *GithubProvider) Initialize(baseURL, token string, additionalParams map[string]string) error
  • func (g *GithubProvider) Name() string
  • func (g *GithubProvider) ValidateAdditionalParams(additionalParams map[string]string) bool
• type GitlabProvider
  • func (g *GitlabProvider) GetAdditionalParam(key string) string
  • func (g *GitlabProvider) GetRepository(opt map[string]string) (*Repository, error)
  • func (g *GitlabProvider) Initialize(baseURL, token string, additionalParams map[string]string) error
  • func (g *GitlabProvider) Name() string
  • func (g *GitlabProvider) ValidateAdditionalParams(additionalParams map[string]string) bool
• type Repository

Constants

const (
	// GitlabName ...
	GitlabName = "gitlab"
	// GitlabParamBaseURL ...
	GitlabParamBaseURL = "GITLAB_BASE_URL"
	// GitlabParamToken ...
	GitlabParamToken = "GITLAB_TOKEN"

	// GithubName ...
	GithubName = "github"
	// GithubParamBaseURL ...
	GithubParamBaseURL = "GITHUB_BASE_URL"
	// GithubParamToken ...
	GithubParamToken = "GITHUB_TOKEN"

	// BitbucketName ...
	BitbucketName = "bitbucket"
	// BitbucketParamBaseURL ...
	BitbucketParamBaseURL = "BITBUCKET_BASE_URL"
	// BitbucketParamClientID ...
	BitbucketParamClientID = "BITBUCKET_CLIENT_ID"
	// BitbucketParamClientSecret ...
	BitbucketParamClientSecret = "BITBUCKET_CLIENT_SECRET"
	// BitbucketParamUsername ...
	BitbucketParamUsername = "BITBUCKET_USERNAME"
	// BitbucketParamPassword ...
	BitbucketParamPassword = "BITBUCKET_PASSWORD"
)

Variables

var (
	// ErrInvalidAdditionalParams ...
	ErrInvalidAdditionalParams = errors.New("invalid additional params")
)

Types

type BitbucketProvider

type BitbucketProvider struct {
	Client           *bitbucket.Bitbucket
	AdditionalParams map[string]string
	Token            string
}

BitbucketProvider holds Bitbucket client fields

func (*BitbucketProvider) GetAdditionalParam

func (g *BitbucketProvider) GetAdditionalParam(key string) string

GetAdditionalParams validates additional params

func (*BitbucketProvider) GetRepository

func (g *BitbucketProvider) GetRepository(opt map[string]string) (*Repository, error)

GetRepository gets repo info

func (*BitbucketProvider) Initialize

func (g *BitbucketProvider) Initialize(baseURL, token string, additionalParams map[string]string) error

Initialize creates and assigns new client

func (*BitbucketProvider) Name

func (g *BitbucketProvider) Name() string

Name returns the provider name

func (*BitbucketProvider) ValidateAdditionalParams

func (g *BitbucketProvider) ValidateAdditionalParams(additionalParams map[string]string) bool

ValidateAdditionalParams validates additional params

type GitProvider

type GitProvider interface {
	Initialize(baseURL, token string, additionalParams map[string]string) error
	GetAdditionalParam(key string) string
	ValidateAdditionalParams(additionalParams map[string]string) bool
	GetRepository(opt map[string]string) (*Repository, error)
	Name() string
}

GitProvider defines interface for interacting with remote Git services

type GithubProvider

type GithubProvider struct {
	Client           *github.Client
	AdditionalParams map[string]string
	Token            string
}

GithubProvider holds Github client fields

func (*GithubProvider) GetAdditionalParam

func (g *GithubProvider) GetAdditionalParam(key string) string

GetAdditionalParams validates additional params

func (*GithubProvider) GetRepository

func (g *GithubProvider) GetRepository(opt map[string]string) (*Repository, error)

GetRepository gets repo info

func (*GithubProvider) Initialize

func (g *GithubProvider) Initialize(baseURL, token string, additionalParams map[string]string) error

Initialize creates and assigns new client

func (*GithubProvider) Name

func (g *GithubProvider) Name() string

Name returns the provider name

func (*GithubProvider) ValidateAdditionalParams

func (g *GithubProvider) ValidateAdditionalParams(additionalParams map[string]string) bool

ValidateAdditionalParams validates additional params

type GitlabProvider

type GitlabProvider struct {
	Client           *gitlab.Client
	AdditionalParams map[string]string
	Token            string
}

GitlabProvider holds Gitlab client fields

func (*GitlabProvider) GetAdditionalParam

func (g *GitlabProvider) GetAdditionalParam(key string) string

GetAdditionalParams validates additional params

func (*GitlabProvider) GetRepository

func (g *GitlabProvider) GetRepository(opt map[string]string) (*Repository, error)

GetRepository gets repo info

func (*GitlabProvider) Initialize

func (g *GitlabProvider) Initialize(baseURL, token string, additionalParams map[string]string) error

Initialize creates and assigns new client

func (*GitlabProvider) Name

func (g *GitlabProvider) Name() string

Name returns the provider name

func (*GitlabProvider) ValidateAdditionalParams

func (g *GitlabProvider) ValidateAdditionalParams(additionalParams map[string]string) bool

ValidateAdditionalParams validates additional params

type Repository

type Repository struct {
	Owner         string
	ID            string
	Name          string
	FullName      string
	CloneURL      string
	URL           string
	DefaultBranch string
	Description   string
	Homepage      string
}

Repository is a universal struct for holding repo info fields