users

Documentation

Overview

Package "users" implements a users github api client.

You need to create a github client and use it to create a new users github client.

As an examples:

ghc, err := ghclient.NewGithubClient(*username, *password,
                                     ghclient.AUTH_USER_PASSWORD)
ghusersc := ghusers.NewUsers(ghc)
res, err := ghusersc.GetUserInfo(*userinfo)
jr, err := res.Json()

fmt.Printf("JSON: %v\nHTTP REPLY: %v\nERROR: %v\n", jr, res.RawHttpResponse, err)

Index

• type Users
  • func NewUsers(ghc *ghclient.GithubClient) *Users
  • func (ghc *Users) GetAuthenticatedUserInfo() (res *ghclient.GithubResult, err error)
  • func (ghc *Users) GetUserInfo(username string) (res *ghclient.GithubResult, err error)

Types

type Users

type Users struct {
	*ghclient.GithubClient
}

Users is a simplified github users api client.

func NewUsers

func NewUsers(ghc *ghclient.GithubClient) *Users

create a new github Users client from an existent GithubClient

func (*Users) GetAuthenticatedUserInfo

func (ghc *Users) GetAuthenticatedUserInfo() (res *ghclient.GithubResult, err error)

Request the current autenticated user info. It returns a GithubResult and an error.

func (*Users) GetUserInfo

func (ghc *Users) GetUserInfo(username string) (res *ghclient.GithubResult, err error)

Request github user info about a defined username. It returns a GithubResult and an error.