feat: Add some GitHub Classroom API endpoints #3690

jferrl · 2025-08-18T21:37:39Z

Summary

This PR implements some GitHub Classroom API endpoints support by adding three new methods to the ClassroomService and fixes a deprecation warning in the addOptions function.

Changes Made

✨ New Features

1. GetClassroom Method

Purpose: Retrieves a specific GitHub Classroom by ID for administrators
API Endpoint: GET /classrooms/{classroom_id}

2. ListClassrooms Method

Purpose: Lists all GitHub Classrooms for the current user
API Endpoint: GET /classrooms

3. ListClassroomAssignments Method

Purpose: Lists all assignments for a specific GitHub Classroom
API Endpoint: GET /classrooms/{classroom_id}/assignments

Refactor

4. Reflect.Ptr Deprecation Fix

Issue: Updated addOptions function to use reflect.Pointer instead of deprecated reflect.Ptr
Change: Replaced reflect.Ptr with reflect.Pointer in github/github.go
Benefit: Ensures compatibility with newer Go versions and removes deprecation warnings

Issue: #3684

Implements the GetClassroom method to retrieve a GitHub Classroom by ID if the user is an administrator. Adds corresponding unit tests to verify correct API interaction and response handling.

Updated the addOptions function to use reflect.Pointer instead of the deprecated reflect.Ptr for checking pointer kinds. This change ensures compatibility with newer Go versions.

Implements the ListClassrooms method to retrieve classrooms for the current user via the GitHub API. Adds corresponding tests to verify correct API interaction and response parsing.

Implements the ListClassroomAssignments method to fetch assignments for a classroom via the GitHub API. Includes comprehensive tests for the new method, covering normal operation and error handling.

gmlewis · 2025-08-18T21:59:53Z

@jferri - just FYI - I lost write access to this repo and this may cause unexpected delays for which I apologize.
You can watch that other PR to check on the status.

jferrl · 2025-08-18T22:04:17Z

@jferri - just FYI - I lost write access to this repo and this may cause unexpected delays for which I apologize. You can watch that other PR to check on the status.

No worries! 😃

Updated the usage of reflect.Ptr to reflect.Pointer in the stringifyValue function to align with the latest Go reflect package conventions.

Replaces usage of http.MethodGet with the string literal "GET" in both the ClassroomService methods and their corresponding tests. Also removes the unused net/http import.

codecov · 2025-09-22T20:59:35Z

Codecov Report

❌ Patch coverage is 87.50000% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.11%. Comparing base (ffc5df8) to head (863baf5).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
github/classroom.go	86.66%	4 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3690      +/-   ##
==========================================
- Coverage   91.12%   91.11%   -0.02%     
==========================================
  Files         187      187              
  Lines       16640    16684      +44     
==========================================
+ Hits        15164    15202      +38     
- Misses       1291     1295       +4     
- Partials      185      187       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gmlewis

Thank you, @jferrl!
Just a few tweaks, please, then we should be ready for a second LGTM+Approval from any other contributor to this repo before merging.

@stevehipwell and/or @alexandear - might you have time for a code review? Thank you!

github/classroom.go

github/classroom_test.go

Revised comments in classroom.go to clarify method descriptions and improve wording for GetClassroom and ListClassrooms functions.

Replaces GitHub and GitHub Classroom URLs with example.com in classroom and assignment test cases for consistency and to avoid referencing real endpoints.

jferrl · 2025-09-23T07:13:38Z

Thank you, @jferrl! Just a few tweaks, please, then we should be ready for a second LGTM+Approval from any other contributor to this repo before merging.

@stevehipwell and/or @alexandear - might you have time for a code review? Thank you!

@gmlewis changes done! 😃

stevehipwell

LGTM

github/classroom_test.go

Introduces test cases for invalid input options in GetAssignment, GetClassroom, ListClassrooms, and ListClassroomAssignments methods to improve error handling coverage.

gmlewis

Thank you, @jferrl and @stevehipwell!
LGTM.
Merging.

gmlewis · 2025-09-23T16:59:07Z

Fixes: #3684.

jferrl added 4 commits August 18, 2025 23:14

feat: Add GetClassroom method to ClassroomService

97b7596

Implements the GetClassroom method to retrieve a GitHub Classroom by ID if the user is an administrator. Adds corresponding unit tests to verify correct API interaction and response handling.

Replace reflect.Ptr with reflect.Pointer in addOptions

a6efddf

Updated the addOptions function to use reflect.Pointer instead of the deprecated reflect.Ptr for checking pointer kinds. This change ensures compatibility with newer Go versions.

Add ListClassrooms method to ClassroomService

4a35fd3

Implements the ListClassrooms method to retrieve classrooms for the current user via the GitHub API. Adds corresponding tests to verify correct API interaction and response parsing.

Add ListClassroomAssignments to ClassroomService

af27910

Implements the ListClassroomAssignments method to fetch assignments for a classroom via the GitHub API. Includes comprehensive tests for the new method, covering normal operation and error handling.

jferrl and others added 3 commits August 19, 2025 10:04

Replace reflect.Ptr with reflect.Pointer in stringifyValue

e8ca024

Updated the usage of reflect.Ptr to reflect.Pointer in the stringifyValue function to align with the latest Go reflect package conventions.

Replace http.MethodGet with "GET" string in classroom

ecc632b

Replaces usage of http.MethodGet with the string literal "GET" in both the ClassroomService methods and their corresponding tests. Also removes the unused net/http import.

Merge branch 'master' into jferrl-jferrl-3684

95679bf

Merge branch 'master' into jferrl-jferrl-3684

0f0d035

gmlewis requested changes Sep 22, 2025

View reviewed changes

github/classroom.go Outdated Show resolved Hide resolved

github/classroom.go Outdated Show resolved Hide resolved

github/classroom_test.go Outdated Show resolved Hide resolved

gmlewis added the NeedsReview PR is awaiting a review before merging. label Sep 22, 2025

jferrl added 3 commits September 23, 2025 09:07

Merge branch 'master' into jferrl-jferrl-3684

d62562d

chore: Update comments for Classroom service methods

cc627dd

Revised comments in classroom.go to clarify method descriptions and improve wording for GetClassroom and ListClassrooms functions.

Update test URLs to use example.com

e3fd949

Replaces GitHub and GitHub Classroom URLs with example.com in classroom and assignment test cases for consistency and to avoid referencing real endpoints.

jferrl requested a review from gmlewis September 23, 2025 07:12

stevehipwell approved these changes Sep 23, 2025

View reviewed changes

gmlewis removed the NeedsReview PR is awaiting a review before merging. label Sep 23, 2025

gmlewis reviewed Sep 23, 2025

View reviewed changes

github/classroom_test.go Show resolved Hide resolved

gmlewis reviewed Sep 23, 2025

View reviewed changes

github/classroom_test.go Show resolved Hide resolved

Add bad options tests for ClassroomService methods

863baf5

Introduces test cases for invalid input options in GetAssignment, GetClassroom, ListClassrooms, and ListClassroomAssignments methods to improve error handling coverage.

jferrl requested a review from gmlewis September 23, 2025 13:28

gmlewis approved these changes Sep 23, 2025

View reviewed changes

gmlewis merged commit 7e700a7 into google:master Sep 23, 2025
5 of 7 checks passed

jferrl deleted the jferrl-jferrl-3684 branch September 24, 2025 07:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add some GitHub Classroom API endpoints #3690

feat: Add some GitHub Classroom API endpoints #3690

Uh oh!

jferrl commented Aug 18, 2025 •

edited

Loading

Uh oh!

gmlewis commented Aug 18, 2025 •

edited

Loading

Uh oh!

jferrl commented Aug 18, 2025

Uh oh!

codecov bot commented Sep 22, 2025 •

edited

Loading

Uh oh!

gmlewis left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jferrl commented Sep 23, 2025

Uh oh!

stevehipwell left a comment

Uh oh!

Uh oh!

Uh oh!

gmlewis left a comment

Uh oh!

gmlewis commented Sep 23, 2025

Uh oh!

Uh oh!

Uh oh!

feat: Add some GitHub Classroom API endpoints #3690

feat: Add some GitHub Classroom API endpoints #3690

Uh oh!

Conversation

jferrl commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes Made

✨ New Features

1. GetClassroom Method

2. ListClassrooms Method

3. ListClassroomAssignments Method

Refactor

4. Reflect.Ptr Deprecation Fix

Uh oh!

gmlewis commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jferrl commented Aug 18, 2025

Uh oh!

codecov bot commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jferrl commented Sep 23, 2025

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

gmlewis commented Sep 23, 2025

Uh oh!

Uh oh!

Uh oh!

jferrl commented Aug 18, 2025 •

edited

Loading

gmlewis commented Aug 18, 2025 •

edited

Loading

codecov bot commented Sep 22, 2025 •

edited

Loading