feat: add LTI tools for LTI APIs in edX

Author: arslanashraf7

edx_api/client.py

@@ -15,6 +15,7 @@
 from .grades import UserCurrentGrades
 from .user_info import UserInfo
 from .user_validation import UserValidation
+from .lti_tools import LTITools
 
 
 class EdxApi:
@@ -123,3 +124,9 @@ def user_validation(self):
     def course_runs(self):
         """Course runs management API (Works with CMS)"""
         return CourseRuns(self.get_requester(token_type="jwt"), self.base_url)
+
+    @property
+    def lti_tools(self):
+        """LTI Tools API"""
+        return LTITools(self.get_requester(), self.base_url)
+

edx_api/lti_tools/__init__.py

@@ -0,0 +1,38 @@
+"""Client for LTI Tools API"""
+from urllib.parse import urljoin
+
+
+class LTITools:
+    """
+    Open edX LTI Tools client
+    """
+
+    def __init__(self, requester, base_url):
+        """
+        Args:
+            requester (Requester): an authenticated objects for requests to edX
+            base_url (str): string representing the base URL of an edX LMS instance
+        """
+        self.requester = requester
+        self.base_url = base_url
+
+
+    def fix_lti_user(self, email):
+        """
+        Fixes an LTI user with duplicate email
+
+        Args:
+            email (str): Email of the Application user
+
+        Returns:
+            bool: True if the user was fixed successfully, False otherwise
+        """
+        request_data = {"email": email}
+
+        # the request is done on behalf of the current logged in user
+        return self.requester.post(
+            urljoin(
+                self.base_url,
+                '/api/lti-user-fix/'
+            ),
+            json=request_data)

edx_api/lti_tools/init_test.py

@@ -0,0 +1,68 @@
+"""Tests for LTI Tools API client"""
+
+from unittest.mock import Mock
+from urllib.parse import urljoin
+
+from edx_api.lti_tools import LTITools
+
+
+class TestLTITools:
+    """Tests for LTITools class"""
+
+    def setup_method(self):
+        """Set up test fixtures"""
+        self.requester = Mock()
+        self.base_url = "https://example.edx.org"
+        self.client = LTITools(self.requester, self.base_url)
+
+    def test_init(self):
+        """Test LTITools initialization"""
+        assert self.client.requester == self.requester
+        assert self.client.base_url == self.base_url
+
+    def test_fix_lti_user_success(self):
+        """Test fix_lti_user with successful response"""
+        email = "[email protected]"
+        expected_response = Mock()
+        self.requester.post.return_value = expected_response
+
+        result = self.client.fix_lti_user(email)
+
+        self.requester.post.assert_called_once_with(
+            urljoin(self.base_url, '/api/lti-user-fix/'),
+            json={"email": email}
+        )
+        assert result == expected_response
+
+    def test_fix_lti_user_with_different_credentials(self):
+        """Test fix_lti_user with email"""
+        email = "[email protected]"
+        expected_response = Mock()
+        self.requester.post.return_value = expected_response
+
+        result = self.client.fix_lti_user(email)
+
+        self.requester.post.assert_called_once_with(
+            urljoin(self.base_url, '/api/lti-user-fix/'),
+            json={"email": email}
+        )
+        assert result == expected_response
+
+    def test_fix_lti_user_url_construction(self):
+        """Test that the correct URL is constructed"""
+        email = "[email protected]"
+
+        self.client.fix_lti_user(email)
+
+        call_args = self.requester.post.call_args
+        expected_url = urljoin(self.base_url, '/api/lti-user-fix/')
+        assert call_args[0][0] == expected_url
+
+    def test_fix_lti_user_request_data_format(self):
+        """Test that request data is formatted correctly"""
+        email = "[email protected]"
+
+        self.client.fix_lti_user(email)
+
+        call_args = self.requester.post.call_args
+        assert call_args[1]['json'] == {"email": email}