githubwrap

README

Github-Wrapper

Simple Package that wrap Github api to make it easy to use.

currently feature :

• Create file to repository
• Get downloadable link from repository
• Update file in repository
• Delete file in repository
• Get file content as byte from repository
• Get file content from repository

Documentation

Index

• func NewGithubClient(httpClient *http.Client) (client *github.Client)
• func NewOauth2Client(ctx context.Context, accessToken string) (client *http.Client)
• func NewOauth2ClientLimited(ctx context.Context, accessToken string) (client *http.Client)
• type FilesService
  • func NewFilesService(client *github.Client, owner, repo string) (wrapper *FilesService)
  • func (wrp *FilesService) ChangeRepository(owner, repo string)
  • func (wrp *FilesService) Create(ctx context.Context, path, message string, content []byte) (repopath string, err error)
  • func (wrp *FilesService) Delete(ctx context.Context, path, sha string) (file *github.RepositoryContentResponse, err error)
  • func (wrp *FilesService) Download(ctx context.Context, path string) (file io.ReadCloser, err error)
  • func (wrp *FilesService) GetContent(ctx context.Context, path string) (file *github.RepositoryContent, err error)
  • func (wrp *FilesService) GetLink(ctx context.Context, path string) (link string, err error)
  • func (wrp *FilesService) GetPath(ctx context.Context, path string) (link string, err error)
  • func (wrp *FilesService) Update(ctx context.Context, path, sha string, content []byte) (file *github.RepositoryContentResponse, err error)

Functions

func NewGithubClient

func NewGithubClient(httpClient *http.Client) (client *github.Client)

func NewOauth2Client

func NewOauth2Client(ctx context.Context, accessToken string) (client *http.Client)

func NewOauth2ClientLimited

func NewOauth2ClientLimited(ctx context.Context, accessToken string) (client *http.Client)

Types

type FilesService

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

func NewFilesService

func NewFilesService(client *github.Client, owner, repo string) (wrapper *FilesService)

func (*FilesService) ChangeRepository

func (wrp *FilesService) ChangeRepository(owner, repo string)

func (*FilesService) Create

func (wrp *FilesService) Create(ctx context.Context, path, message string, content []byte) (repopath string, err error)

func (*FilesService) Delete

func (wrp *FilesService) Delete(ctx context.Context, path, sha string) (file *github.RepositoryContentResponse, err error)

func (*FilesService) Download

func (wrp *FilesService) Download(ctx context.Context, path string) (file io.ReadCloser, err error)

func (*FilesService) GetContent

func (wrp *FilesService) GetContent(ctx context.Context, path string) (file *github.RepositoryContent, err error)

func (*FilesService) GetLink

func (wrp *FilesService) GetLink(ctx context.Context, path string) (link string, err error)

func (*FilesService) GetPath

func (wrp *FilesService) GetPath(ctx context.Context, path string) (link string, err error)

func (*FilesService) Update

func (wrp *FilesService) Update(ctx context.Context, path, sha string, content []byte) (file *github.RepositoryContentResponse, err error)