Add NewTokenClient constructor

[icholy]

I often write one-off tools using this module and I keep needing to come back to the docs to copy/paste this snippet.

client := github.NewClient(
	oauth2.NewClient(
		ctx, oauth2.StaticTokenSource(
			&oauth2.Token{
				AccessToken: token,
			},
		),
	),
)

It would be nice if there was a helper to do this.

client := github.NewTokenClient(ctx, token)

[gmlewis]

I don't see the harm. Go for it.
Thank you, @icholy .
Please check out our CONTRIBUTING.md guide if you haven't already done so, and I look forward to your PR.

[gmlewis]

Maybe at the same time you might want to add a github.NewTokenTransport to address questions like: #2631 ?

[icholy]

Sure, I'll open separate PRs though.

[icholy]

The oauth2 module doesn't expose a way to construct a transport, so the NewTokenTransport implementation would have to be something like:

func NewTokenTransport(ctx context.Context, token string) http.RoundTripper {
	return NewTokenClient(ctx, token).Client().Transport
}

[gmlewis]

The oauth2 module doesn't expose a way to construct a transport, so the NewTokenTransport implementation would have to be something like:

Ah, then maybe it is not worth it. Thanks.

[gmlewis]

But couldn't you just add a parameter for Base instead of dbg.New ?

import (
  dbg "github.com/gmlewis/go-httpdebug/httpdebug"
  "github.com/google/go-github/v49/github"
  "golang.org/x/oauth2"
)
...
ctx := context.Background()
ts := oauth2.StaticTokenSource(
	&oauth2.Token{AccessToken: token},
)
tc := &oauth2.Transport{Source: ts, Base: dbg.New()}

client := github.NewClient(&http.Client{Transport: tc})

[gmlewis]

Something like:

// NewTokenClientWithRoundTripper returns a new GitHub API client authenticated with the provided token and
// using the provided RoundTripper.
func NewTokenClientWithRoundTripper(token string, rt http.RoundTripper) *Client {
	ts := oauth2.StaticTokenSource(
		&oauth2.Token{AccessToken: token},
	)
	tc := &oauth2.Transport{Source: ts, Base: rt}
	return github.NewClient(&http.Client{Transport: tc})
}

[icholy]

Users can already pass a transport in the context.

tr := /* user transport */
ctx := context.WithValue(context.Background(), oauth2.HTTPClient, &http.Client{Transport: rt})
client :=  NewTokenClient(ctx, token)

edit: I thought that's why we kept the context parameter.

[gmlewis]

Ah! Fantastic. Thanks, @icholy - sorry for the noise. Carry on. 😄

[icholy]

Is it worth updating the test/examples to use NewTokenClient ?

[gmlewis]

Not a bad idea!