Merge remote-tracking branch 'packback/master' into patch-2

Author: JanHolger

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 5.1.7
+
+Add `AssignmentGradesService::updateLineitem()` to update a line item [#58](https://github.com/packbackbooks/lti-1-3-php-library/pull/58).
+
+## 5.1.0
+
+Add `AssignmentGradesService::getLineItem()` to fetch a single line item [#47](https://github.com/packbackbooks/lti-1-3-php-library/pull/47).
+
 ## 5.0.0
 
 Implemented several changes to comply with (OpenID Connect Core)[https://openid.net/specs/openid-connect-core-1_0.html]. Nonce validation changed such that it now verifies that the nonce and state associated with an LTI Message Launch request matches the state associated with the nonce and state created during the OIDC login request.

PULL_REQUEST_TEMPLATE.md

@@ -7,3 +7,5 @@
 <!-- Describe how this PR has been tested, manually and automatically. -->
 
 - [ ] I have added automated tests for my changes
+- [ ] I ran `composer test` before opening this PR
+- [ ] I ran `composer lint-fix` before opening this PR

src/Interfaces/ILtiServiceConnector.php

@@ -16,16 +16,14 @@ public function makeServiceRequest(
         ILtiRegistration $registration,
         array $scopes,
         IServiceRequest $request,
-        ?int $requestType = null,
         bool $shouldRetry = true
     ): array;
 
     public function getAll(
         ILtiRegistration $registration,
         array $scopes,
         IServiceRequest $request,
-        string $key,
-        ?int $requestType = null
+        string $key
     ): array;
 
     public function setDebuggingMode(bool $enable): void;

src/Interfaces/IServiceRequest.php

@@ -19,4 +19,6 @@ public function setBody(string $body): self;
     public function setAccept(string $accept): self;
 
     public function setContentType(string $contentType): self;
+
+    public function getErrorPrefix(): string;
 }

src/LtiAbstractService.php

@@ -36,24 +36,22 @@ public function setServiceData(array $serviceData): self
 
     abstract public function getScope(): array;
 
-    protected function makeServiceRequest(IServiceRequest $request, ?int $requestType = null): array
+    protected function makeServiceRequest(IServiceRequest $request): array
     {
         return $this->serviceConnector->makeServiceRequest(
             $this->registration,
             $this->getScope(),
             $request,
-            $requestType
         );
     }
 
-    protected function getAll(IServiceRequest $request, string $key = null, ?int $requestType = null): array
+    protected function getAll(IServiceRequest $request, string $key = null): array
     {
         return $this->serviceConnector->getAll(
             $this->registration,
             $this->getScope(),
             $request,
-            $key,
-            $requestType
+            $key
         );
     }
 }

src/LtiAssignmentsGradesService.php

@@ -42,11 +42,15 @@ public function putGrade(LtiGrade $grade, LtiLineitem $lineitem = null)
         $pos = strpos($scoreUrl, '?');
         $scoreUrl = $pos === false ? $scoreUrl.'/scores' : substr_replace($scoreUrl, '/scores', $pos, 0);
 
-        $request = new ServiceRequest(LtiServiceConnector::METHOD_POST, $scoreUrl);
+        $request = new ServiceRequest(
+            ServiceRequest::METHOD_POST,
+            $scoreUrl,
+            ServiceRequest::TYPE_SYNC_GRADE
+        );
         $request->setBody($grade);
         $request->setContentType(static::CONTENTTYPE_SCORE);
 
-        return $this->makeServiceRequest($request, LtiServiceConnector::SYNC_GRADE_REQUEST);
+        return $this->makeServiceRequest($request);
     }
 
     public function findLineItem(LtiLineitem $newLineItem): ?LtiLineitem
@@ -62,13 +66,34 @@ public function findLineItem(LtiLineitem $newLineItem): ?LtiLineitem
         return null;
     }
 
+    public function updateLineitem(LtiLineItem $lineitemToUpdate): LtiLineitem
+    {
+        $request = new ServiceRequest(
+            ServiceRequest::METHOD_PUT,
+            $this->getServiceData()['lineitems'],
+            ServiceRequest::TYPE_UPDATE_LINEITEM
+        );
+
+        $request->setBody($lineitemToUpdate)
+            ->setContentType(static::CONTENTTYPE_LINEITEM)
+            ->setAccept(static::CONTENTTYPE_LINEITEM);
+
+        $updatedLineitem = $this->makeServiceRequest($request);
+
+        return new LtiLineitem($updatedLineitem['body']);
+    }
+
     public function createLineitem(LtiLineitem $newLineItem): LtiLineitem
     {
-        $request = new ServiceRequest(LtiServiceConnector::METHOD_POST, $this->getServiceData()['lineitems']);
+        $request = new ServiceRequest(
+            ServiceRequest::METHOD_POST,
+            $this->getServiceData()['lineitems'],
+            ServiceRequest::TYPE_CREATE_LINEITEM
+        );
         $request->setBody($newLineItem)
             ->setContentType(static::CONTENTTYPE_LINEITEM)
             ->setAccept(static::CONTENTTYPE_LINEITEM);
-        $createdLineItem = $this->makeServiceRequest($request, LtiServiceConnector::CREATE_LINEITEM_REQUEST);
+        $createdLineItem = $this->makeServiceRequest($request);
 
         return new LtiLineitem($createdLineItem['body']);
     }
@@ -87,7 +112,11 @@ public function getGrades(LtiLineitem $lineitem = null)
         $pos = strpos($resultsUrl, '?');
         $resultsUrl = $pos === false ? $resultsUrl.'/results' : substr_replace($resultsUrl, '/results', $pos, 0);
 
-        $request = new ServiceRequest(LtiServiceConnector::METHOD_GET, $resultsUrl);
+        $request = new ServiceRequest(
+            ServiceRequest::METHOD_GET,
+            $resultsUrl,
+            ServiceRequest::TYPE_GET_GRADES
+        );
         $request->setAccept(static::CONTENTTYPE_RESULTCONTAINER);
         $scores = $this->makeServiceRequest($request);
 
@@ -101,12 +130,13 @@ public function getLineItems(): array
         }
 
         $request = new ServiceRequest(
-            LtiServiceConnector::METHOD_GET,
-            $this->getServiceData()['lineitems']
+            ServiceRequest::METHOD_GET,
+            $this->getServiceData()['lineitems'],
+            ServiceRequest::TYPE_GET_LINEITEMS
         );
         $request->setAccept(static::CONTENTTYPE_LINEITEMCONTAINER);
 
-        $lineitems = $this->getAll($request, null, LtiServiceConnector::GET_LINEITEMS_REQUEST);
+        $lineitems = $this->getAll($request);
 
         // If there is only one item, then wrap it in an array so the foreach works
         if (isset($lineitems['body']['id'])) {
@@ -122,7 +152,11 @@ public function getLineItem(string $url): LtiLineitem
             throw new LtiException('Missing required scope', 1);
         }
 
-        $request = new ServiceRequest(LtiServiceConnector::METHOD_GET, $url);
+        $request = new ServiceRequest(
+            ServiceRequest::METHOD_GET,
+            $url,
+            ServiceRequest::TYPE_GET_LINEITEM
+        );
         $request->setAccept(static::CONTENTTYPE_LINEITEM);
 
         $response = $this->makeServiceRequest($request)['body'];

src/LtiCourseGroupsService.php

@@ -14,8 +14,9 @@ public function getScope(): array
     public function getGroups(): array
     {
         $request = new ServiceRequest(
-            LtiServiceConnector::METHOD_GET,
-            $this->getServiceData()['context_groups_url']
+            ServiceRequest::METHOD_GET,
+            $this->getServiceData()['context_groups_url'],
+            ServiceRequest::TYPE_GET_GROUPS
         );
         $request->setAccept(static::CONTENTTYPE_CONTEXTGROUPCONTAINER);
 
@@ -30,8 +31,9 @@ public function getSets(): array
         }
 
         $request = new ServiceRequest(
-            LtiServiceConnector::METHOD_GET,
-            $this->getServiceData()['context_group_sets_url']
+            ServiceRequest::METHOD_GET,
+            $this->getServiceData()['context_group_sets_url'],
+            ServiceRequest::TYPE_GET_SETS
         );
         $request->setAccept(static::CONTENTTYPE_CONTEXTGROUPCONTAINER);
 

src/LtiMessageLaunch.php

@@ -28,7 +28,14 @@ class LtiMessageLaunch
     public const ERR_INVALID_ID_TOKEN = 'Invalid id_token, JWT must contain 3 parts';
     public const ERR_MISSING_NONCE = 'Missing Nonce.';
     public const ERR_INVALID_NONCE = 'Invalid Nonce.';
-    public const ERR_MISSING_REGISTRATION = 'Registration not found. Please have your admin confirm your Issuer URL, client ID, and deployment ID.';
+
+    /**
+     * :issuerUrl and :clientId are used to substitute the queried issuerUrl
+     * and clientId. Do not change those substrings without changing how the
+     * error message is built.
+     */
+    public const ERR_MISSING_REGISTRATION = 'LTI 1.3 Registration not found for Issuer :issuerUrl and Client ID :clientId. Please make sure the LMS has provided the right information, and that the LMS has been registered correctly in the tool.';
+
     public const ERR_CLIENT_NOT_REGISTERED = 'Client id not registered for this issuer.';
     public const ERR_NO_KID = 'No KID specified in the JWT Header.';
     public const ERR_INVALID_SIGNATURE = 'Invalid signature on id_token';
@@ -91,7 +98,7 @@ public static function new(
         ICache $cache = null,
         ICookie $cookie = null,
         ILtiServiceConnector $serviceConnector = null
-        ) {
+    ) {
         return new LtiMessageLaunch($database, $cache, $cookie, $serviceConnector);
     }
 
@@ -276,10 +283,26 @@ public function getLaunchId()
         return $this->launch_id;
     }
 
+    public static function getMissingRegistrationErrorMsg(string $issuerUrl, ?string $clientId = null): string
+    {
+        // Guard against client ID being null
+        if (!isset($clientId)) {
+            $clientId = '(N/A)';
+        }
+
+        $search = [':issuerUrl', ':clientId'];
+        $replace = [$issuerUrl, $clientId];
+
+        return str_replace($search, $replace, static::ERR_MISSING_REGISTRATION);
+    }
+
     private function getPublicKey()
     {
-        $keySetUrl = $this->registration->getKeySetUrl();
-        $request = new ServiceRequest(LtiServiceConnector::METHOD_GET, $keySetUrl);
+        $request = new ServiceRequest(
+            ServiceRequest::METHOD_GET,
+            $this->registration->getKeySetUrl(),
+            ServiceRequest::TYPE_GET_KEYSET
+        );
 
         // Download key set
         try {
@@ -400,15 +423,16 @@ private function validateNonce()
     private function validateRegistration()
     {
         // Find registration.
-        $client_id = is_array($this->jwt['body']['aud']) ? $this->jwt['body']['aud'][0] : $this->jwt['body']['aud'];
-        $this->registration = $this->db->findRegistrationByIssuer($this->jwt['body']['iss'], $client_id);
+        $clientId = is_array($this->jwt['body']['aud']) ? $this->jwt['body']['aud'][0] : $this->jwt['body']['aud'];
+        $issuerUrl = $this->jwt['body']['iss'];
+        $this->registration = $this->db->findRegistrationByIssuer($issuerUrl, $clientId);
 
         if (empty($this->registration)) {
-            throw new LtiException(static::ERR_MISSING_REGISTRATION);
+            throw new LtiException($this->getMissingRegistrationErrorMsg($issuerUrl, $clientId));
         }
 
         // Check client id.
-        if ($client_id !== $this->registration->getClientId()) {
+        if ($clientId !== $this->registration->getClientId()) {
             // Client not registered.
             throw new LtiException(static::ERR_CLIENT_NOT_REGISTERED);
         }

src/LtiNamesRolesProvisioningService.php

@@ -14,8 +14,9 @@ public function getScope(): array
     public function getMembers(): array
     {
         $request = new ServiceRequest(
-            LtiServiceConnector::METHOD_GET,
-            $this->getServiceData()['context_memberships_url']
+            ServiceRequest::METHOD_GET,
+            $this->getServiceData()['context_memberships_url'],
+            ServiceRequest::TYPE_GET_MEMBERSHIPS
         );
         $request->setAccept(static::CONTENTTYPE_MEMBERSHIPCONTAINER);