fixup! feat: Refactor repositories download contents

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>

Author: stevehipwell

example/contents/main.go

@@ -0,0 +1,69 @@
+// Copyright 2026 The go-github AUTHORS. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// The commitpr command utilizes go-github as a CLI tool for
+// pushing files to a branch and creating a pull request from it.
+// It takes an auth token as an environment variable and creates
+// the commit and the PR under the account affiliated with that token.
+//
+// The purpose of this example is to show how to use refs, trees and commits to
+// create commits and pull requests.
+//
+// Note, if you want to push a single file, you probably prefer to use the
+// content API. An example is available here:
+// https://pkg.go.dev/github.com/google/go-github/v84/github#example-RepositoriesService-CreateFile
+//
+// Note, for this to work at least 1 commit is needed, so you if you use this
+// after creating a repository you might want to make sure you set `AutoInit` to
+// `true`.
+package main
+
+import (
+	"context"
+	"fmt"
+	"io"
+	"os"
+
+	"github.com/google/go-github/v84/github"
+)
+
+// downloadContents downloads the contents of a file in a repository and returns it as a byte slice.
+func downloadContents(ctx context.Context, client *github.Client, owner, repo, path, ref string) ([]byte, error) {
+	rc, _, err := client.Repositories.DownloadContents(ctx, owner, repo, path, &github.RepositoryContentGetOptions{Ref: ref})
+	if err != nil {
+		return nil, err
+	}
+	defer rc.Close()
+
+	by, err := io.ReadAll(rc)
+	if err != nil {
+		return nil, err
+	}
+
+	fmt.Printf("Downloaded %v/%v/%v as %d bytes\n", owner, repo, path, len(by))
+	return by, nil
+}
+
+func main() {
+	client := github.NewClient(nil)
+
+	t := []struct {
+		owner string
+		repo  string
+		path  string
+		ref   string
+	}{
+		{"google", "go-github", "README.md", "master"},
+		{"github", "rest-api-description", "descriptions/api.github.com/api.github.com.2026-03-10.yaml", "main"},
+		{"ScoopInstaller", "Main", "bucket/yq.json", "master"},
+	}
+
+	for _, v := range t {
+		if _, err := downloadContents(context.Background(), client, v.owner, v.repo, v.path, v.ref); err != nil {
+			fmt.Printf("Error: %v\n", err)
+			os.Exit(1)
+		}
+	}
+}

github/repos_contents_test.go

@@ -126,17 +126,72 @@ func TestRepositoriesService_GetReadme(t *testing.T) {
 	})
 }
 
-func TestRepositoriesService_DownloadContents_Success(t *testing.T) {
+func TestRepositoriesService_DownloadContents_SuccessWithContent(t *testing.T) {
 	t.Parallel()
-	client, mux, _ := setup(t)
+	client, mux, serverURL := setup(t)
 
 	mux.HandleFunc("/repos/o/r/contents/d/f", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
-		fmt.Fprint(w, `{
+		fmt.Fprintf(w, `{
   "type": "file",
   "name": "f",
-  "content": "foo"
-}`)
+  "content": "foo",
+  "download_url": "%v/download/f"
+}`, serverURL+baseURLPath)
+	})
+
+	ctx := t.Context()
+	r, resp, err := client.Repositories.DownloadContents(ctx, "o", "r", "d/f", nil)
+	if err != nil {
+		t.Errorf("Repositories.DownloadContents returned error: %v", err)
+	}
+
+	if got, want := resp.Response.StatusCode, http.StatusOK; got != want {
+		t.Errorf("Repositories.DownloadContents returned status code %v, want %v", got, want)
+	}
+
+	bytes, err := io.ReadAll(r)
+	if err != nil {
+		t.Errorf("Error reading response body: %v", err)
+	}
+	r.Close()
+
+	if got, want := string(bytes), "foo"; got != want {
+		t.Errorf("Repositories.DownloadContents returned %v, want %v", got, want)
+	}
+
+	const methodName = "DownloadContents"
+	testBadOptions(t, methodName, func() (err error) {
+		_, _, err = client.Repositories.DownloadContents(ctx, "\n", "\n", "\n", nil)
+		return err
+	})
+
+	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
+		got, resp, err := client.Repositories.DownloadContents(ctx, "o", "r", "d/f", nil)
+		if got != nil {
+			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
+		}
+		return resp, err
+	})
+}
+
+func TestRepositoriesService_DownloadContents_SuccessByDownload(t *testing.T) {
+	t.Parallel()
+	client, mux, serverURL := setup(t)
+
+	mux.HandleFunc("/repos/o/r/contents/d/f", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprintf(w, `{
+  "type": "file",
+  "name": "f",
+  "content": "",
+  "download_url": "%v/download/f"
+}`, serverURL+baseURLPath)
+	})
+
+	mux.HandleFunc("/download/f", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprint(w, "foo")
 	})
 
 	ctx := t.Context()
@@ -174,6 +229,46 @@ func TestRepositoriesService_DownloadContents_Success(t *testing.T) {
 	})
 }
 
+func TestRepositoriesService_DownloadContents_FailedResponse(t *testing.T) {
+	t.Parallel()
+	client, mux, serverURL := setup(t)
+
+	mux.HandleFunc("/repos/o/r/contents/d/f", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		fmt.Fprintf(w, `{
+  "type": "file",
+  "name": "f",
+  "content": "",
+  "download_url": "%v/download/f"
+}`, serverURL+baseURLPath)
+	})
+	mux.HandleFunc("/download/f", func(w http.ResponseWriter, r *http.Request) {
+		testMethod(t, r, "GET")
+		w.WriteHeader(http.StatusInternalServerError)
+		fmt.Fprint(w, "foo error")
+	})
+
+	ctx := t.Context()
+	r, resp, err := client.Repositories.DownloadContents(ctx, "o", "r", "d/f", nil)
+	if err != nil {
+		t.Errorf("Repositories.DownloadContents returned error: %v", err)
+	}
+
+	if got, want := resp.Response.StatusCode, http.StatusInternalServerError; got != want {
+		t.Errorf("Repositories.DownloadContents returned status code %v, want %v", got, want)
+	}
+
+	bytes, err := io.ReadAll(r)
+	if err != nil {
+		t.Errorf("Error reading response body: %v", err)
+	}
+	r.Close()
+
+	if got, want := string(bytes), "foo error"; got != want {
+		t.Errorf("Repositories.DownloadContents returned %v, want %v", got, want)
+	}
+}
+
 func TestRepositoriesService_DownloadContents_NoDownloadURL(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
@@ -182,7 +277,8 @@ func TestRepositoriesService_DownloadContents_NoDownloadURL(t *testing.T) {
 		testMethod(t, r, "GET")
 		fmt.Fprint(w, `{
   "type": "file",
-  "name": "f"
+  "name": "f",
+  "content": ""
 }`)
 	})
 
@@ -197,11 +293,11 @@ func TestRepositoriesService_DownloadContents_NoDownloadURL(t *testing.T) {
 	}
 
 	if reader != nil {
-		t.Error("Repositories.DownloadContents returned unexpected reader")
+		t.Error("Repositories.DownloadContents did not return expected reader")
 	}
 }
 
-func TestRepositoriesService_DownloadContents_GetContentsError(t *testing.T) {
+func TestRepositoriesService_DownloadContents_NoFile(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 
@@ -221,21 +317,22 @@ func TestRepositoriesService_DownloadContents_GetContentsError(t *testing.T) {
 	}
 
 	if reader != nil {
-		t.Error("Repositories.DownloadContents returned unexpected reader")
+		t.Error("Repositories.DownloadContents did not return expected reader")
 	}
 }
 
 func TestRepositoriesService_DownloadContentsWithMeta_SuccessWithContent(t *testing.T) {
 	t.Parallel()
-	client, mux, _ := setup(t)
+	client, mux, serverURL := setup(t)
 
 	mux.HandleFunc("/repos/o/r/contents/d/f", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
-		fmt.Fprint(w, `{
+		fmt.Fprintf(w, `{
   "type": "file",
   "name": "f",
-  "content": "foo"
-}`)
+  "content": "foo",
+  "download_url": "%v/download/f"
+}`, serverURL+baseURLPath)
 	})
 
 	ctx := t.Context()
@@ -284,7 +381,7 @@ func TestRepositoriesService_DownloadContentsWithMeta_SuccessWithContent(t *test
 	})
 }
 
-func TestRepositoriesService_DownloadContentsWithMeta_SuccessViaDownloadURL(t *testing.T) {
+func TestRepositoriesService_DownloadContentsWithMeta_SuccessByDownload(t *testing.T) {
 	t.Parallel()
 	client, mux, serverURL := setup(t)
 
@@ -296,6 +393,7 @@ func TestRepositoriesService_DownloadContentsWithMeta_SuccessViaDownloadURL(t *t
   "download_url": "%v/download/f"
 }`, serverURL+baseURLPath)
 	})
+
 	mux.HandleFunc("/download/f", func(w http.ResponseWriter, r *http.Request) {
 		testMethod(t, r, "GET")
 		fmt.Fprint(w, "foo")
@@ -385,7 +483,8 @@ func TestRepositoriesService_DownloadContentsWithMeta_NoDownloadURL(t *testing.T
 		testMethod(t, r, "GET")
 		fmt.Fprint(w, `{
   "type": "file",
-  "name": "f"
+  "name": "f",
+  "content": ""
 }`)
 	})
 
@@ -396,7 +495,7 @@ func TestRepositoriesService_DownloadContentsWithMeta_NoDownloadURL(t *testing.T
 	}
 
 	if reader != nil {
-		t.Error("Repositories.DownloadContentsWithMeta returned unexpected reader")
+		t.Error("Repositories.DownloadContentsWithMeta did not return expected reader")
 	}
 
 	if resp == nil {
@@ -408,7 +507,7 @@ func TestRepositoriesService_DownloadContentsWithMeta_NoDownloadURL(t *testing.T
 	}
 }
 
-func TestRepositoriesService_DownloadContentsWithMeta_GetContentsError(t *testing.T) {
+func TestRepositoriesService_DownloadContentsWithMeta_NoFile(t *testing.T) {
 	t.Parallel()
 	client, mux, _ := setup(t)
 
@@ -418,53 +517,14 @@ func TestRepositoriesService_DownloadContentsWithMeta_GetContentsError(t *testin
 	})
 
 	ctx := t.Context()
-	reader, contents, resp, err := client.Repositories.DownloadContentsWithMeta(ctx, "o", "r", "d/f", nil)
-	if err == nil {
-		t.Error("Repositories.DownloadContentsWithMeta did not return expected error")
-	}
-
-	if reader != nil {
-		t.Error("Repositories.DownloadContentsWithMeta returned unexpected reader")
-	}
-
-	if resp == nil {
-		t.Error("Repositories.DownloadContentsWithMeta did not return expected response")
-	}
-
-	if contents != nil {
-		t.Error("Repositories.DownloadContentsWithMeta returned unexpected content")
-	}
-}
-
-func TestRepositoriesService_DownloadContentsWithMeta_NilFileContent(t *testing.T) {
-	t.Parallel()
-	client, mux, _ := setup(t)
-
-	mux.HandleFunc("/repos/o/r/contents/d", func(w http.ResponseWriter, r *http.Request) {
-		testMethod(t, r, "GET")
-		fmt.Fprint(w, `[{
-  "type": "file",
-  "name": "f"
-}]`)
-	})
-
-	ctx := t.Context()
-	reader, contents, resp, err := client.Repositories.DownloadContentsWithMeta(ctx, "o", "r", "d", nil)
+	_, _, resp, err := client.Repositories.DownloadContentsWithMeta(ctx, "o", "r", "d/f", nil)
 	if err == nil {
 		t.Error("Repositories.DownloadContentsWithMeta did not return expected error")
 	}
 
-	if reader != nil {
-		t.Error("Repositories.DownloadContentsWithMeta returned unexpected reader")
-	}
-
 	if resp == nil {
 		t.Error("Repositories.DownloadContentsWithMeta did not return expected response")
 	}
-
-	if contents != nil {
-		t.Error("Repositories.DownloadContentsWithMeta returned unexpected content")
-	}
 }
 
 func TestRepositoriesService_GetContents_File(t *testing.T) {