Add client wrapper for github.com/google/go-github/v62

internal/githubclient/githubclient.go

@@ -0,0 +1,160 @@
+package githubclient
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"slices"
+
+	"github.com/google/go-github/v62/github"
+)
+
+const emptyUserMeansTheAuthenticatedUser = ""
+
+type UserInfo struct {
+	ID    string
+	Login string
+}
+
+type TeamInfo struct {
+	Name string
+	Slug string
+	Org  string
+}
+
+type GitHubInterface interface {
+	GetUserInfo() (*UserInfo, error)
+	GetOrgMembership() ([]string, error)
+	GetTeamMembership(allowedOrganizations []string) ([]TeamInfo, error)
+}
+
+type githubClient struct {
+	client *github.Client
+}
+
+var _ GitHubInterface = (*githubClient)(nil)
+
+func NewGitHubClient(httpClient *http.Client, apiBaseURL, token string) (GitHubInterface, error) {
+	if httpClient == nil {
+		return nil, fmt.Errorf("httpClient cannot be nil")
+	}
+
+	if token == "" {
+		return nil, fmt.Errorf("token cannot be empty string")
+	}
+
+	if apiBaseURL == "https://github.com" {
+		apiBaseURL = "https://api.github.com/"
+	}
+
+	client, err := github.NewClient(httpClient).WithEnterpriseURLs(apiBaseURL, "")
+	if err != nil {
+		return nil, fmt.Errorf("unable to create GitHub client using WithEnterpriseURLs: %w", err)
+	}
+
+	if client.BaseURL.Scheme != "https" {
+		return nil, fmt.Errorf(`apiBaseURL must use "https" protocol, found "%s" instead`, client.BaseURL.Scheme)
+	}
+
+	return &githubClient{
+		client: client.WithAuthToken(token),
+	}, nil
+}
+
+// GetUserInfo returns the "Login" and "ID" attributes of the logged-in user.
+// TODO: where should context come from?
+func (g *githubClient) GetUserInfo() (*UserInfo, error) {
+	user, response, err := g.client.Users.Get(context.Background(), emptyUserMeansTheAuthenticatedUser)
+	if err != nil {
+		return nil, fmt.Errorf("error fetching authenticated user: %w", err)
+	}
+	if user == nil { // untested
+		return nil, fmt.Errorf("error fetching authenticated user: user is nil")
+	}
+	if response == nil { // untested
+		return nil, fmt.Errorf("error fetching authenticated user: response is nil")
+	}
+	if user.ID == nil {
+		return nil, fmt.Errorf(`the "ID" attribute is missing for authenticated user`)
+	}
+	if user.Login == nil {
+		return nil, fmt.Errorf(`the "login" attribute is missing for authenticated user`)
+	}
+
+	return &UserInfo{
+		Login: user.GetLogin(),
+		ID:    fmt.Sprintf("%d", user.GetID()),
+	}, nil
+}
+
+// GetOrgMembership returns an array of the "Login" attributes for all organizations to which the authenticated user belongs.
+// TODO: where should context come from?
+// TODO: what happens if login is nil?
+func (g *githubClient) GetOrgMembership() ([]string, error) {
+	organizationsAsStrings := make([]string, 0)
+
+	opt := &github.ListOptions{PerPage: 10}
+	// get all pages of results
+	for {
+		organizationResults, response, err := g.client.Organizations.List(context.Background(), emptyUserMeansTheAuthenticatedUser, opt)
+		if err != nil {
+			return nil, fmt.Errorf("error fetching organizations for authenticated user: %w", err)
+		}
+
+		for _, organization := range organizationResults {
+			organizationsAsStrings = append(organizationsAsStrings, organization.GetLogin())
+		}
+		if response.NextPage == 0 {
+			break
+		}
+		opt.Page = response.NextPage
+	}
+
+	return organizationsAsStrings, nil
+}
+
+// GetTeamMembership returns a description of each team to which the authenticated user belongs, filtered by allowedOrganizations.
+// Parent teams will also be returned.
+// TODO: where should context come from?
+// TODO: what happens if org or login or id are nil?
+func (g *githubClient) GetTeamMembership(allowedOrganizations []string) ([]TeamInfo, error) {
+	teamInfos := make([]TeamInfo, 0)
+
+	opt := &github.ListOptions{PerPage: 10}
+	// get all pages of results
+	for {
+		teamsResults, response, err := g.client.Teams.ListUserTeams(context.Background(), opt)
+		if err != nil {
+			return nil, fmt.Errorf("error fetching team membership for authenticated user: %w", err)
+		}
+
+		for _, team := range teamsResults {
+			org := team.GetOrganization().GetLogin()
+
+			if !slices.Contains(allowedOrganizations, org) {
+				continue
+			}
+
+			teamInfos = append(teamInfos, TeamInfo{
+				Name: team.GetName(),
+				Slug: team.GetSlug(),
+				Org:  org,
+			})
+
+			parent := team.GetParent()
+			if parent != nil {
+				teamInfos = append(teamInfos, TeamInfo{
+					Name: parent.GetName(),
+					Slug: parent.GetSlug(),
+					Org:  org,
+				})
+			}
+		}
+		if response.NextPage == 0 {
+			break
+		}
+		opt.Page = response.NextPage
+	}
+
+	return teamInfos, nil
+}