feat: Add retrieve classroom course aliases snippet (#368)

vinay-google · web-flow · commit da082ccdb5b9 · 2022-09-15T17:01:47.000-06:00
* feat: Add retrieve classroom course aliases snippet Incorrect snippet in https://developers.google.com/classroom/guides/manage-aliases#retrieve_course_aliases will be replaced by this * Format and sort imports
diff --git a/classroom/snippets/classroom_list_course_aliases.py b/classroom/snippets/classroom_list_course_aliases.py
@@ -0,0 +1,65 @@
+"""
+Copyright 2018 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
+
+    http://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_list_course_aliases]
+
+from __future__ import print_function
+
+import google.auth
+from googleapiclient.discovery import build
+from googleapiclient.errors import HttpError
+
+
+def classroom_list_course_aliases(course_id):
+    """
+    Prints the list of the aliases of a specified course the user has access to.
+    Load pre-authorized user credentials from the environment.
+    TODO(developer) - See https://developers.google.com/identity
+    for guides on implementing OAuth2 for the application.
+    """
+
+    creds, _ = google.auth.default()
+    try:
+        service = build('classroom', 'v1', credentials=creds)
+        course_aliases = []
+        page_token = None
+
+        while True:
+            response = service.courses().aliases().list(
+                pageToken=page_token,
+                courseId=course_id).execute()
+            course_aliases.extend(response.get('aliases', []))
+            page_token = response.get('nextPageToken', None)
+            if not page_token:
+                break
+
+        if not course_aliases:
+            print('No course aliases found.')
+
+        print("Course aliases:")
+        for course_alias in course_aliases:
+            print(f"{course_alias.get('alias')}")
+        return course_aliases
+    except HttpError as error:
+        print(f"An error occurred: {error}")
+        return error
+
+
+if __name__ == '__main__':
+    classroom_list_course_aliases('course_id')
+
+# [END classroom_list_course_aliases]
diff --git a/classroom/snippets/test_classroom_list_course_aliases.py b/classroom/snippets/test_classroom_list_course_aliases.py
@@ -0,0 +1,33 @@
+"""
+Copyright 2022 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
+    http://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.
+"""
+import unittest
+
+from base_test import BaseTest
+from classroom_create_course import classroom_create_course
+from classroom_list_course_aliases import classroom_list_course_aliases
+
+
+class TestClassroomListCourseAliases(BaseTest):
+    """Unit test class for List course aliases snippet"""
+
+    def test_classroom_list_course_aliases(self):
+        """Unit test method for List course snippet"""
+        course = classroom_create_course()
+        self.assertIsNotNone(course)
+        self.delete_course_on_cleanup(course.get('id'))
+        course_aliases = classroom_list_course_aliases(course.get('id'))
+        self.assertIsNotNone(course_aliases)
+
+
+if __name__ == "__main__":
+    unittest.main()
