feat: updating authorization flow & added invitation resource Classroom code snippets. (googleworkspace#601)

* add alias snippet and unit test

* java snippets for topics, create coursework, create alias

* updates based on team review

* renamed alias methods, added devsite comments

* added missing license header to TestDeleteTopic.java

* Adding List, ModifyAttachments, Patch, Return StudentSubmission methods

* minor fixes

* adding comments for developer

* modifications based on team review

* modifications based on team review

* Adding print statements and devsite tag to ListCourseAliases

* added class templates for guardians and guardianInvitations

* guardian and guardian invitation implementation

* tests for list guardians and list guardian invitations

* adding tests for guardians and guardian invites. removing use of ADC for auth.

* base test updates

* updates based on team feedback

* fixing BaseTest.java

* updating copyright year to 2023 for new files

* testing google-java-format plugin to fix lint errors

* updated files after running google-java-format plugin

* updated BaseTest

* fixing copyright header for BaseTest

* updated auth for AddAlias and CreateCourse classes

* removing unused imports

* Fixing comment.

* specifying errors in method signatures

* updated BaseTest and AddStudent

* Adding annotation for GeneralSecurityException

* updating AddStudent method signature and test

* updated AddTeacher and AddStudent test

* updated auth for BatchAddStudents

* updated auth for CreateCourseWork

* updated auth for Topic related classes and tests

* added link to CourseState info and updated GetTopic error handling

* updated auth for remaining classes

* updated auth for CreateCourseWithAlias

* CreateInvitation code snippet

* accept, create, delete invitation classes

* list invitations class

* listAssignedGrades method in ListStudentSubmissions class

* deleting ListInvitations classes until bug is fixed

* team review updates

* google java format for tests

* google-java-format on classes

* google java format DeleteTopic

* added test cases to CreateInvitation and DeleteInvitation classes

* additional comment in accept invitation test case

* fixing java formatting

* google java format fix

Author: mahima-desetty

Diff for: classroom/snippets/src/main/java/AcceptInvitation.java

@@ -0,0 +1,72 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// [START classroom_accept_invitation]
+
+import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
+import com.google.api.client.googleapis.json.GoogleJsonError;
+import com.google.api.client.googleapis.json.GoogleJsonResponseException;
+import com.google.api.client.http.javanet.NetHttpTransport;
+import com.google.api.client.json.gson.GsonFactory;
+import com.google.api.services.classroom.Classroom;
+import com.google.api.services.classroom.ClassroomScopes;
+import java.io.IOException;
+import java.security.GeneralSecurityException;
+import java.util.ArrayList;
+import java.util.Arrays;
+
+/* Class to demonstrate the use of Classroom Accept Invitation API. */
+public class AcceptInvitation {
+
+  /* Scopes required by this API call. If modifying these scopes, delete your previously saved
+  tokens/ folder. */
+  static ArrayList<String> SCOPES =
+      new ArrayList<>(Arrays.asList(ClassroomScopes.CLASSROOM_ROSTERS));
+
+  /**
+   * Accepts an invitation to a course.
+   *
+   * @param id - the identifier of the invitation to accept.
+   * @throws IOException - if credentials file not found.
+   * @throws GeneralSecurityException - if a new instance of NetHttpTransport was not created.
+   */
+  public static void acceptInvitation(String id) throws GeneralSecurityException, IOException {
+
+    // Create the classroom API client.
+    final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
+    Classroom service =
+        new Classroom.Builder(
+                HTTP_TRANSPORT,
+                GsonFactory.getDefaultInstance(),
+                ClassroomCredentials.getCredentials(HTTP_TRANSPORT, SCOPES))
+            .setApplicationName("Classroom samples")
+            .build();
+
+    // [START classroom_accept_invitation_code_snippet]
+    try {
+      service.invitations().accept(id).execute();
+      System.out.printf("Invitation (%s) was accepted.\n", id);
+    } catch (GoogleJsonResponseException e) {
+      GoogleJsonError error = e.getDetails();
+      if (error.getCode() == 404) {
+        System.out.printf("The invitation id (%s) does not exist.\n", id);
+      }
+      throw e;
+    } catch (Exception e) {
+      throw e;
+    }
+    // [END classroom_accept_invitation_code_snippet]
+  }
+}
+// [END classroom_accept_invitation]

Diff for: classroom/snippets/src/main/java/AddAliasToCourse.java

@@ -12,61 +12,61 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-
 // [START classroom_add_alias_to_course_class]
 
+import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
 import com.google.api.client.googleapis.json.GoogleJsonError;
 import com.google.api.client.googleapis.json.GoogleJsonResponseException;
-import com.google.api.client.http.HttpRequestInitializer;
 import com.google.api.client.http.javanet.NetHttpTransport;
 import com.google.api.client.json.gson.GsonFactory;
 import com.google.api.services.classroom.Classroom;
 import com.google.api.services.classroom.ClassroomScopes;
 import com.google.api.services.classroom.model.CourseAlias;
-import com.google.auth.http.HttpCredentialsAdapter;
-import com.google.auth.oauth2.GoogleCredentials;
 import java.io.IOException;
-import java.util.Collections;
+import java.security.GeneralSecurityException;
+import java.util.ArrayList;
+import java.util.Arrays;
 
 /* Class to demonstrate the use of Classroom Create Alias API. */
 public class AddAliasToCourse {
+  /* Scopes required by this API call. If modifying these scopes, delete your previously saved
+  tokens/ folder. */
+  static ArrayList<String> SCOPES =
+      new ArrayList<>(Arrays.asList(ClassroomScopes.CLASSROOM_COURSES));
+
   /**
    * Add an alias on an existing course.
    *
    * @param courseId - id of the course to add an alias to.
    * @return - newly created course alias.
    * @throws IOException - if credentials file not found.
+   * @throws GeneralSecurityException - if a new instance of NetHttpTransport was not created.
    */
-  public static CourseAlias addAliasToCourse(String courseId) throws IOException {
-    /* Load pre-authorized user credentials from the environment.
-       TODO(developer) - See https://developers.google.com/identity for
-        guides on implementing OAuth2 for your application. */
-    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
-        .createScoped(Collections.singleton(ClassroomScopes.CLASSROOM_COURSES));
-    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
-        credentials);
+  public static CourseAlias addAliasToCourse(String courseId)
+      throws GeneralSecurityException, IOException {
 
     // Create the classroom API client.
-    Classroom service = new Classroom.Builder(new NetHttpTransport(),
-        GsonFactory.getDefaultInstance(),
-        requestInitializer)
-        .setApplicationName("Classroom samples")
-        .build();
+    final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
+    Classroom service =
+        new Classroom.Builder(
+                HTTP_TRANSPORT,
+                GsonFactory.getDefaultInstance(),
+                ClassroomCredentials.getCredentials(HTTP_TRANSPORT, SCOPES))
+            .setApplicationName("Classroom samples")
+            .build();
 
     // [START classroom_add_alias_to_course_code_snippet]
 
     /* Create a new CourseAlias object with a project-wide alias. Project-wide aliases use a prefix
     of "p:" and can only be seen and used by the application that created them. */
-    CourseAlias content = new CourseAlias()
-        .setAlias("p:biology_10");
+    CourseAlias content = new CourseAlias().setAlias("p:biology_10");
     CourseAlias courseAlias = null;
 
     try {
-      courseAlias = service.courses().aliases().create(courseId, content)
-          .execute();
+      courseAlias = service.courses().aliases().create(courseId, content).execute();
       System.out.printf("Course alias created: %s \n", courseAlias.getAlias());
     } catch (GoogleJsonResponseException e) {
-      //TODO (developer) - handle error appropriately
+      // TODO (developer) - handle error appropriately
       GoogleJsonError error = e.getDetails();
       if (error.getCode() == 409) {
         System.out.printf("The course alias already exists: %s.\n", content);

Diff for: classroom/snippets/src/main/java/AddStudent.java

@@ -12,57 +12,64 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-
 // [START classroom_add_student]
 
+import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
 import com.google.api.client.googleapis.json.GoogleJsonError;
 import com.google.api.client.googleapis.json.GoogleJsonResponseException;
-import com.google.api.client.http.HttpRequestInitializer;
 import com.google.api.client.http.javanet.NetHttpTransport;
 import com.google.api.client.json.gson.GsonFactory;
 import com.google.api.services.classroom.Classroom;
 import com.google.api.services.classroom.ClassroomScopes;
 import com.google.api.services.classroom.model.Student;
-import com.google.auth.http.HttpCredentialsAdapter;
-import com.google.auth.oauth2.GoogleCredentials;
 import java.io.IOException;
-import java.util.Collections;
+import java.security.GeneralSecurityException;
+import java.util.ArrayList;
+import java.util.Arrays;
 
 /* Class to demonstrate the use of Classroom Add Student API */
 public class AddStudent {
+
+  /* Scopes required by this API call. If modifying these scopes, delete your previously saved
+  tokens/ folder. */
+  static ArrayList<String> SCOPES =
+      new ArrayList<>(Arrays.asList(ClassroomScopes.CLASSROOM_ROSTERS));
+
   /**
    * Add a student in a specified course.
    *
-   * @param courseId       - Id of the course.
+   * @param courseId - Id of the course.
    * @param enrollmentCode - Code of the course to enroll.
    * @return newly added student
    * @throws IOException - if credentials file not found.
+   * @throws GeneralSecurityException - if a new instance of NetHttpTransport was not created.
    */
-  public static Student addStudent(String courseId, String enrollmentCode)
-      throws IOException {
-        /* Load pre-authorized user credentials from the environment.
-           TODO(developer) - See https://developers.google.com/identity for
-            guides on implementing OAuth2 for your application. */
-    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
-        .createScoped(Collections.singleton(ClassroomScopes.CLASSROOM_ROSTERS));
-    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
-        credentials);
+  public static Student addStudent(String courseId, String enrollmentCode, String studentId)
+      throws GeneralSecurityException, IOException {
 
-    // Create the classroom API client
-    Classroom service = new Classroom.Builder(new NetHttpTransport(),
-        GsonFactory.getDefaultInstance(),
-        requestInitializer)
-        .setApplicationName("Classroom samples")
-        .build();
+    // Create the classroom API client.
+    final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
+    Classroom service =
+        new Classroom.Builder(
+                HTTP_TRANSPORT,
+                GsonFactory.getDefaultInstance(),
+                ClassroomCredentials.getCredentials(HTTP_TRANSPORT, SCOPES))
+            .setApplicationName("Classroom samples")
+            .build();
 
-    Student student = new Student().setUserId("[email protected]");
+    Student student = new Student().setUserId(studentId);
     try {
       // Enrolling a student to a specified course
-      student = service.courses().students().create(courseId, student)
-          .setEnrollmentCode(enrollmentCode)
-          .execute();
+      student =
+          service
+              .courses()
+              .students()
+              .create(courseId, student)
+              .setEnrollmentCode(enrollmentCode)
+              .execute();
       // Prints the course id with the Student name
-      System.out.printf("User '%s' was enrolled as a student in the course with ID '%s'.\n",
+      System.out.printf(
+          "User '%s' was enrolled as a student in the course with ID '%s'.\n",
           student.getProfile().getName().getFullName(), courseId);
     } catch (GoogleJsonResponseException e) {
       // TODO(developer) - handle error appropriately
@@ -78,4 +85,4 @@ public static Student addStudent(String courseId, String enrollmentCode)
     return student;
   }
 }
-// [END classroom_add_student]
+// [END classroom_add_student]

Diff for: classroom/snippets/src/main/java/AddTeacher.java

@@ -12,55 +12,58 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-
 // [START classroom_add_teacher]
 
+import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
 import com.google.api.client.googleapis.json.GoogleJsonError;
 import com.google.api.client.googleapis.json.GoogleJsonResponseException;
-import com.google.api.client.http.HttpRequestInitializer;
 import com.google.api.client.http.javanet.NetHttpTransport;
 import com.google.api.client.json.gson.GsonFactory;
 import com.google.api.services.classroom.Classroom;
 import com.google.api.services.classroom.ClassroomScopes;
 import com.google.api.services.classroom.model.Teacher;
-import com.google.auth.http.HttpCredentialsAdapter;
-import com.google.auth.oauth2.GoogleCredentials;
 import java.io.IOException;
-import java.util.Collections;
+import java.security.GeneralSecurityException;
+import java.util.ArrayList;
+import java.util.Arrays;
 
 /* Class to demonstrate the use of Classroom Add Teacher API */
 public class AddTeacher {
+
+  /* Scopes required by this API call. If modifying these scopes, delete your previously saved
+  tokens/ folder. */
+  static ArrayList<String> SCOPES =
+      new ArrayList<>(Arrays.asList(ClassroomScopes.CLASSROOM_ROSTERS));
+
   /**
    * Add teacher to a specific course.
    *
-   * @param courseId     - Id of the course.
+   * @param courseId - Id of the course.
    * @param teacherEmail - Email address of the teacher.
    * @return newly created teacher
    * @throws IOException - if credentials file not found.
+   * @throws GeneralSecurityException - if a new instance of NetHttpTransport was not created.
    */
   public static Teacher addTeacher(String courseId, String teacherEmail)
-      throws IOException {
-        /* Load pre-authorized user credentials from the environment.
-           TODO(developer) - See https://developers.google.com/identity for
-            guides on implementing OAuth2 for your application. */
-    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
-        .createScoped(Collections.singleton(ClassroomScopes.CLASSROOM_ROSTERS));
-    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
-        credentials);
+      throws GeneralSecurityException, IOException {
 
-    // Create the classroom API client
-    Classroom service = new Classroom.Builder(new NetHttpTransport(),
-        GsonFactory.getDefaultInstance(),
-        requestInitializer)
-        .setApplicationName("Classroom samples")
-        .build();
+    // Create the classroom API client.
+    final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
+    Classroom service =
+        new Classroom.Builder(
+                HTTP_TRANSPORT,
+                GsonFactory.getDefaultInstance(),
+                ClassroomCredentials.getCredentials(HTTP_TRANSPORT, SCOPES))
+            .setApplicationName("Classroom samples")
+            .build();
 
     Teacher teacher = new Teacher().setUserId(teacherEmail);
     try {
       // Add a teacher to a specified course
       teacher = service.courses().teachers().create(courseId, teacher).execute();
       // Prints the course id with the teacher name
-      System.out.printf("User '%s' was added as a teacher to the course with ID '%s'.\n",
+      System.out.printf(
+          "User '%s' was added as a teacher to the course with ID '%s'.\n",
           teacher.getProfile().getName().getFullName(), courseId);
     } catch (GoogleJsonResponseException e) {
       // TODO(developer) - handle error appropriately
@@ -76,4 +79,4 @@ public static Teacher addTeacher(String courseId, String teacherEmail)
     return teacher;
   }
 }
-// [END classroom_add_teacher]
+// [END classroom_add_teacher]