Refactor the canvas API factory to take parameters

lms/services/__init__.py

@@ -106,7 +106,9 @@ def includeme(config):  # noqa: PLR0915
     config.register_service_factory(
         "lms.services.grouping.service_factory", name="grouping"
     )
-    config.register_service_factory("lms.services.file.factory", name="file")
+    config.register_service_factory(
+        "lms.services.file.file_service_factory", name="file"
+    )
     config.register_service_factory(
         "lms.services.jstor.service_factory", iface=JSTORService
     )

lms/services/canvas_api/client.py

@@ -15,6 +15,15 @@
 log = logging.getLogger(__name__)
 
 
+class _SectionStudentSchema(Schema):
+    """Schema for each of the students that belong to a section."""
+
+    class Meta:
+        unknown = EXCLUDE
+
+    id = fields.Int(required=True)
+
+
 class _SectionSchema(Schema):
     """
     Schema for an individual course section dict.
@@ -30,6 +39,10 @@ class Meta:
     id = fields.Int(required=True)
     name = fields.String(required=True)
 
+    students = fields.List(
+        fields.Nested(_SectionStudentSchema), required=False, allow_none=True
+    )
+
 
 class CanvasAPIClient:
     """
@@ -148,7 +161,7 @@ def post_load(self, data, **_kwargs):
             # Return the contents of sections without the key
             return data["sections"]
 
-    def course_sections(self, course_id):
+    def course_sections(self, course_id, with_students=False):
         """
         Return all the sections for the given course_id.
 
@@ -159,10 +172,15 @@ def course_sections(self, course_id):
         # For documentation of this request see:
         # https://canvas.instructure.com/doc/api/sections.html#method.sections.index
 
+        params = {}
+        if with_students:
+            params = {"include[]": "students"}
+
         return self._ensure_sections_unique(
             self._client.send(
                 "GET",
                 f"courses/{course_id}/sections",
+                params=params,
                 schema=self._CourseSectionsSchema,
             )
         )

lms/services/canvas_api/factory.py

@@ -3,16 +3,37 @@
 from lms.services.canvas_api._basic import BasicClient
 from lms.services.canvas_api._pages import CanvasPagesClient
 from lms.services.canvas_api.client import CanvasAPIClient
+from lms.services.file import file_service_factory
+from lms.services.oauth2_token import oauth2_token_service_factory
 
 
-def canvas_api_client_factory(_context, request):
+def canvas_api_client_factory(
+    _context, request, application_instance=None, user_id=None
+):
     """
     Get a CanvasAPIClient from a pyramid request.
 
     :param request: Pyramid request object
     :return: An instance of CanvasAPIClient
     """
-    application_instance = request.lti_user.application_instance
+    if application_instance and user_id:
+        oauth2_token_service = oauth2_token_service_factory(
+            _context,
+            request,
+            application_instance=application_instance,
+            user_id=user_id,
+        )
+        file_service = file_service_factory(_context, request, application_instance)
+
+    else:
+        oauth2_token_service = request.find_service(name="oauth2_token")
+        file_service = request.find_service(name="file")
+
+    if not application_instance:
+        application_instance = request.lti_user.application_instance
+
+    if not user_id:
+        user_id = request.lti_user.user_id
 
     developer_secret = application_instance.decrypted_developer_secret(
         request.find_service(AESService)
@@ -22,13 +43,11 @@ def canvas_api_client_factory(_context, request):
 
     authenticated_api = AuthenticatedClient(
         basic_client=basic_client,
-        oauth2_token_service=request.find_service(name="oauth2_token"),
+        oauth2_token_service=oauth2_token_service,
         client_id=application_instance.developer_key,
         client_secret=developer_secret,
         redirect_uri=request.route_url("canvas_api.oauth.callback"),
     )
-    file_service = request.find_service(name="file")
-
     return CanvasAPIClient(
         authenticated_api,
         file_service=file_service,

lms/services/file.py

@@ -90,7 +90,8 @@ def _file_search_query(  # noqa: PLR0913
         return query
 
 
-def factory(_context, request):
-    return FileService(
-        application_instance=request.lti_user.application_instance, db=request.db
-    )
+def file_service_factory(_context, request, application_instance=None):
+    if application_instance is None:
+        application_instance = request.lti_user.application_instance
+
+    return FileService(application_instance=application_instance, db=request.db)