Merge pull request #160 from packbackbooks/mgmt-191-user-id-filter

Add user ID filter to grades

Author: dbhynds

.gitignore

@@ -17,3 +17,5 @@ vendor
 # ignore the coverage folders
 **/.phpunit.cache
 **/coverage
+
+**/.claude/settings.local.json

CLAUDE.md

@@ -0,0 +1,24 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Build/Test/Lint Commands
+- Run all tests: `composer test`
+- Run a single test: `vendor/bin/phpunit tests/path/to/TestFile.php --filter testMethodName`
+- Run static analysis: `vendor/bin/phpstan analyse`
+- Check code style: `composer lint`
+- Fix code style issues: `composer lint-fix`
+
+## Code Style Guidelines
+- Follow PSR-1/PSR-2 coding standards (Laravel preset)
+- Use PHP 8.1+ features and type hints
+- Classes organized in the namespace `Packback\Lti1p3`
+- Tests in the namespace `Tests`
+- Document public methods with PHPDoc blocks
+- Constants for error messages (use const ERR_* pattern)
+- Use interfaces for dependency injection
+- Error handling: Throw exceptions with descriptive messages
+- Import all classes with use statements
+- Use strict type checking (avoid loose comparisons)
+- Use camelCase for method names and variables
+- Line length: 80-120 characters

src/LtiAssignmentsGradesService.php

@@ -33,7 +33,7 @@ public function putGrade(LtiGrade $grade, ?LtiLineitem $lineitem = null)
         $this->validateScopes([LtiConstants::AGS_SCOPE_SCORE]);
 
         $lineitem = $this->ensureLineItemExists($lineitem);
-        $scoreUrl = $this->appendLineItemPath($lineitem, '/scores');
+        $scoreUrl = static::appendLineItemPath($lineitem, '/scores');
 
         $request = new ServiceRequest(
             ServiceRequest::METHOD_POST,
@@ -107,10 +107,16 @@ public function findOrCreateLineitem(LtiLineitem $newLineItem): LtiLineitem
         return $this->findLineItem($newLineItem) ?? $this->createLineitem($newLineItem);
     }
 
-    public function getGrades(?LtiLineitem $lineitem = null)
+    public function getGrades(?LtiLineitem $lineitem = null, ?string $userId = null)
     {
         $lineitem = $this->ensureLineItemExists($lineitem);
-        $resultsUrl = $this->appendLineItemPath($lineitem, '/results');
+        $resultsUrl = static::appendLineItemPath($lineitem, '/results');
+
+        if (isset($userId)) {
+            $resultsUrl = static::appendQueryParams($resultsUrl, [
+                'user_id' => $userId,
+            ]);
+        }
 
         $request = new ServiceRequest(
             ServiceRequest::METHOD_GET,
@@ -190,17 +196,31 @@ private function isMatchingLineitem(array $lineitem, LtiLineitem $newLineItem):
             $newLineItem->getResourceLinkId() == ($lineitem['resourceLinkId'] ?? null);
     }
 
-    private function appendLineItemPath(LtiLineitem $lineItem, string $suffix): string
+    public static function appendLineItemPath(LtiLineitem $lineItem, string $suffix): string
     {
         $url = $lineItem->getId();
-        $pos = strpos($url, '?');
 
-        if ($pos === false) {
-            $url = $url.$suffix;
+        $path = implode('', [
+            parse_url($url, PHP_URL_HOST),
+            parse_url($url, PHP_URL_PORT) ? ':'.parse_url($url, PHP_URL_PORT) : '',
+            parse_url($url, PHP_URL_PATH),
+        ]);
+
+        return str_replace($path, $path.$suffix, $url);
+    }
+
+    public static function appendQueryParams(string $url, array $params): string
+    {
+        $existingQueryString = parse_url($url, PHP_URL_QUERY);
+        if ($existingQueryString) {
+            parse_str($existingQueryString, $existingQueryParams);
+            $queryString = http_build_query(array_merge($existingQueryParams, $params));
+
+            return str_replace($existingQueryString, $queryString, $url);
         } else {
-            $url = substr_replace($url, $suffix, $pos, 0);
-        }
+            $queryString = http_build_query($params);
 
-        return $url;
+            return $url.'?'.$queryString;
+        }
     }
 }

tests/LtiAssignmentsGradesServiceTest.php

@@ -480,4 +480,38 @@ public function test_it_gets_a_line_item()
 
         $this->assertEquals($expected, $result);
     }
+
+    public function test_it_appends_path()
+    {
+        // A simple example
+        $lineItem = new LtiLineitem(['id' => 'https://example.com']);
+
+        $result = LtiAssignmentsGradesService::appendLineItemPath($lineItem, '/bat');
+
+        $this->assertEquals('https://example.com/bat', $result);
+
+        // A complicated example
+        $lineItem = new LtiLineitem(['id' => 'https://example.com:443/foo?bar=baz']);
+
+        $result = LtiAssignmentsGradesService::appendLineItemPath($lineItem, '/bat');
+
+        $this->assertEquals('https://example.com:443/foo/bat?bar=baz', $result);
+    }
+
+    public function test_it_query_params()
+    {
+        // A simple example
+        $url = 'https://example.com';
+
+        $result = LtiAssignmentsGradesService::appendQueryParams($url, ['user_id' => 'foo']);
+
+        $this->assertEquals('https://example.com?user_id=foo', $result);
+
+        // A complicated example
+        $url = 'https://example.com:443/foo?bar=baz';
+
+        $result = LtiAssignmentsGradesService::appendQueryParams($url, ['user_id' => 'foo']);
+
+        $this->assertEquals('https://example.com:443/foo?bar=baz&user_id=foo', $result);
+    }
 }