Merge branch 'ucfopen:develop' into develop

Author: bainco

.github/workflows/deploy.yml

@@ -9,13 +9,16 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
+
+      - name: Install build dependency
+        run: pip install build
 
       - name: Create source distribution
-        run: python setup.py sdist
+        run: python -m build
 
       - name: Publish distribution to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/run-tests.yml

@@ -40,7 +40,7 @@ jobs:
       - name: Check for missing kwargs
         run: python scripts/find_missing_kwargs.py
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           fail_ci_if_error: true
           token: ${{ secrets.CODECOV_TOKEN }}

AUTHORS.md

@@ -42,6 +42,7 @@
 - Deundre Williams [@deundrewilliams](https://github.com/deundrewilliams)
 - Devin Singh [@devints47](https://github.com/devints47)
 - Dmitry Savransky [@dsavransky](https://github.com/dsavransky)
+- Elias [@HandcartCactus](https://github.com/HandcartCactus)
 - Elise Heron [@thedarkestknight](https://github.com/thedarkestknight)
 - Elli Howard [@qwertynerd97](https://github.com/qwertynerd97)
 - Erik Tews [@eriktews](https://github.com/eriktews)
@@ -53,6 +54,7 @@
 - Ian Altgilbers [@altgilbers](https://github.com/altgilbers)
 - Ian Turgeon [@iturgeon](https://github.com/iturgeon)
 - [@jackrsteiner](https://github.com/jackrsteiner)
+- Jasmine Hou [@jsmnhou](https://github.com/jsmnhou)
 - John Raible [@rebelaide](https://github.com/rebelaide)
 - Joon Ro [@joonro](https://github.com/joonro)
 - Jonah Majumder [@jonahmajumder](https://github.com/jonahmajumder)

CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## [Unreleased]
 
+### New Endpoint Coverage
+
+- LTI Resource Links (Thanks, [@jsmnhou](https://github.com/jsmnhou))
+
+### Backstage
+
+- Updated deploy Action to use more modern processes.
+- Updated `PaginatedList` to be type-aware, showing which class is included in the response. (Thanks [@HandcartCactus](https://github.com/HandcartCactus))
+
+## [3.3.0] - 2023-08-27
+
+### General
+
+- Added documentation for PaginatedList
+- Rework requester URLs to accommodate graphql and new quizzes endpoints (Thanks, [@bennettscience](https://github.com/bennettscience))
+
+### Bugfixes
+
+- Fixed PaginatedList not respecting new quizzes endpoints (Thanks, [@jonespm](https://github.com/jonespm))
+
+### Backstage
+
+- Updated codecov action
+
 ## [3.2.0] - 2023-05-25
 
 ### New Endpoint Coverage
@@ -621,7 +645,8 @@ Huge thanks to [@liblit](https://github.com/liblit) for lots of issues, suggesti
 - Fixed some incorrectly defined parameters
 - Fixed an issue where tests would fail due to an improperly configured requires block
 
-[Unreleased]: https://github.com/ucfopen/canvasapi/compare/v3.2.0...develop
+[Unreleased]: https://github.com/ucfopen/canvasapi/compare/v3.3.0...develop
+[3.3.0]: https://github.com/ucfopen/canvasapi/compare/v3.2.0...v3.3.0
 [3.2.0]: https://github.com/ucfopen/canvasapi/compare/v3.1.0...v3.2.0
 [3.1.0]: https://github.com/ucfopen/canvasapi/compare/v3.0.0...v3.1.0
 [3.0.0]: https://github.com/ucfopen/canvasapi/compare/v2.2.0...v3.0.0

canvasapi/__init__.py

@@ -4,4 +4,4 @@
 
 __all__ = ["Canvas"]
 
-__version__ = "3.2.0"
+__version__ = "3.3.0"

canvasapi/canvas.py

@@ -1279,7 +1279,7 @@ def graphql(self, query, variables=None, **kwargs):
             _kwargs=combine_kwargs(**kwargs)
             + [("query", query), ("variables", variables)],
             # Needs to call special endpoint without api/v1
-            _url=self.__requester.original_url + "/api/graphql",
+            _url="graphql",
             json=True,
         )
 

canvasapi/course.py

@@ -23,6 +23,7 @@
 from canvasapi.grading_period import GradingPeriod
 from canvasapi.grading_standard import GradingStandard
 from canvasapi.license import License
+from canvasapi.lti_resource_link import LTIResourceLink
 from canvasapi.module import Module
 from canvasapi.new_quiz import NewQuiz
 from canvasapi.outcome_import import OutcomeImport
@@ -438,6 +439,39 @@ def create_late_policy(self, **kwargs):
 
         return LatePolicy(self._requester, late_policy_json["late_policy"])
 
+    def create_lti_resource_link(self, url, title=None, custom=None, **kwargs):
+        """
+        Create a new LTI resource link.
+
+        :calls: `POST /api/v1/courses/:course_id/lti_resource_links \
+        <https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.create>`_
+
+        :param url: The launch URL for the resource link.
+        :type url: `str`
+        :param title: The title of the resource link.
+        :type title: `str`, optional
+        :param custom: Custom parameters to send to the tool.
+        :type custom: `dict`, optional
+
+        :rtype: :class:`canvasapi.lti_resource_link.LTIResourceLink`
+        """
+
+        if not url:
+            raise RequiredFieldMissing("url is required as a str.")
+
+        kwargs["url"] = url
+        if title:
+            kwargs["title"] = title
+        if custom:
+            kwargs["custom"] = custom
+
+        response = self._requester.request(
+            "POST",
+            f"courses/{self.id}/lti_resource_links",
+            _kwargs=combine_kwargs(**kwargs),
+        )
+        return LTIResourceLink(self._requester, response.json())
+
     def create_module(self, module, **kwargs):
         """
         Create a new module.
@@ -480,7 +514,7 @@ def create_new_quiz(self, **kwargs):
         response = self._requester.request(
             "POST",
             endpoint,
-            _url=self._requester.original_url + "/api/quiz/v1/" + endpoint,
+            _url="new_quizzes",
             _kwargs=combine_kwargs(**kwargs),
         )
         response_json = response.json()
@@ -1645,6 +1679,49 @@ def get_licenses(self, **kwargs):
             _kwargs=combine_kwargs(**kwargs),
         )
 
+    def get_lti_resource_link(self, lti_resource_link, **kwargs):
+        """
+        Return details about the specified resource link.
+
+        :calls: `GET /api/v1/courses/:course_id/lti_resource_links/:id \
+        <https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.show>`_
+
+        :param lti_resource_link: The object or ID of the LTI resource link.
+        :type lti_resource_link: :class:`canvasapi.lti_resource_link.LTIResourceLink` or int
+
+        :rtype: :class:`canvasapi.lti_resource_link.LTIResourceLink`
+        """
+
+        lti_resource_link_id = obj_or_id(
+            lti_resource_link, "lti_resource_link", (LTIResourceLink,)
+        )
+
+        response = self._requester.request(
+            "GET",
+            f"courses/{self.id}/lti_resource_links/{lti_resource_link_id}",
+            _kwargs=combine_kwargs(**kwargs),
+        )
+        return LTIResourceLink(self._requester, response.json())
+
+    def get_lti_resource_links(self, **kwargs):
+        """
+        Returns all LTI resource links for this course as a PaginatedList.
+
+        :calls: `GET /api/v1/courses/:course_id/lti_resource_links \
+        <https://canvas.instructure.com/doc/api/lti_resource_links.html#method.lti/resource_links.index>`_
+
+        :rtype: :class:`canvasapi.paginated_list.PaginatedList` of
+            :class:`canvasapi.lti_resource_link.LTIResourceLink`
+        """
+
+        return PaginatedList(
+            LTIResourceLink,
+            self._requester,
+            "GET",
+            f"courses/{self.id}/lti_resource_links",
+            kwargs=combine_kwargs(**kwargs),
+        )
+
     def get_migration_systems(self, **kwargs):
         """
         Return a list of migration systems.
@@ -1758,7 +1835,7 @@ def get_new_quiz(self, assignment, **kwargs):
         response = self._requester.request(
             "GET",
             endpoint,
-            _url=self._requester.original_url + "/api/quiz/v1/" + endpoint,
+            _url="new_quizzes",
             _kwargs=combine_kwargs(**kwargs),
         )
         response_json = response.json()
@@ -1783,7 +1860,7 @@ def get_new_quizzes(self, **kwargs):
             self._requester,
             "GET",
             endpoint,
-            _url_override=self._requester.original_url + "/api/quiz/v1/" + endpoint,
+            _url_override="new_quizzes",
             _kwargs=combine_kwargs(**kwargs),
         )
 

canvasapi/lti_resource_link.py

@@ -0,0 +1,6 @@
+from canvasapi.canvas_object import CanvasObject
+
+
+class LTIResourceLink(CanvasObject):
+    def __str__(self):
+        return "{} ({})".format(self.url, self.title)

canvasapi/new_quiz.py

@@ -21,7 +21,7 @@ def delete(self, **kwargs):
         response = self._requester.request(
             "DELETE",
             endpoint,
-            _url=self._requester.original_url + "/api/quiz/v1/" + endpoint,
+            _url="new_quizzes",
             _kwargs=combine_kwargs(**kwargs),
         )
         response_json = response.json()
@@ -44,7 +44,7 @@ def update(self, **kwargs):
         response = self._requester.request(
             "PATCH",
             endpoint,
-            _url=self._requester.original_url + "/api/quiz/v1/" + endpoint,
+            _url="new_quizzes",
             _kwargs=combine_kwargs(**kwargs),
         )
         response_json = response.json()

canvasapi/paginated_list.py

@@ -1,7 +1,12 @@
+from __future__ import annotations
+
 import re
+from typing import Iterable, Iterator, Type, TypeVar
+
+T = TypeVar("T")
 
 
-class PaginatedList(object):
+class PaginatedList(Iterable[T]):
     """
     Abstracts `pagination of Canvas API \
     <https://canvas.instructure.com/doc/api/file.pagination.html>`_.
@@ -19,15 +24,33 @@ def __getitem__(self, index):
 
     def __init__(
         self,
-        content_class,
+        content_class: Type[T],
         requester,
         request_method,
         first_url,
         extra_attribs=None,
         _root=None,
         _url_override=None,
-        **kwargs
+        **kwargs,
     ):
+        """
+        :param content_class: The expected type to return in the list.
+        :type content_class: class
+        :param requester: The requester to pass HTTP requests through.
+        :type requester: :class:`canvasapi.requester.Requester`
+        :param request_method: HTTP request method
+        :type request_method: str
+        :param first_url: Canvas endpoint for the initial request
+        :type first_url: str
+        :param extra_attribs: Extra data to include in the request
+        :type extra_attribs: dict
+        :param _root: Specify a nested property from Canvas to use for the resulting list.
+        :type _root: str
+        :param _url_override: "new_quizzes" or "graphql" for specific Canvas endpoints.
+        Other URLs may be specified for third-party requests.
+        :type _url_override: str
+        :rtype: :class:`canvasapi.paginated_list.PaginatedList` of type content_class
+        """
         self._elements = list()
 
         self._requester = requester
@@ -42,7 +65,7 @@ def __init__(
         self._root = _root
         self._url_override = _url_override
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[T]:
         for element in self._elements:
             yield element
         while self._has_next():
@@ -78,7 +101,10 @@ def _get_next_page(self):
         else:
             next_link = None
 
-        regex = r"{}(.*)".format(re.escape(self._requester.base_url))
+        regex = r"(?:{}|{})(.*)".format(
+            re.escape(self._requester.base_url),
+            re.escape(self._requester.new_quizzes_url),
+        )
 
         self._next_url = (
             re.search(regex, next_link["url"]).group(1) if next_link else None