Merge pull request 1EdTech#30 from packbackbooks/fix-no-sync-for-0-gr…

…ades PODB-263 Fix 0 grades not syncing for LTI 1.3
snake · Oct 25, 2021 · fc2dae1 · fc2dae1
2 parents 78fab66 + dd2a358
commit fc2dae1
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 6 deletions.
diff --git a/src/Helpers/Helpers.php b/src/Helpers/Helpers.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Packback\Lti1p3\Helpers;
+
+class Helpers
+{
+    /**
+     * @param $value
+     */
+    public static function checkIfNullValue($value): bool
+    {
+        return !is_null($value);
+    }
+}
diff --git a/src/LtiGrade.php b/src/LtiGrade.php
@@ -28,17 +28,20 @@ public function __construct(array $grade = null)
 
     public function __toString()
     {
-        return json_encode(array_filter([
-            'scoreGiven' => 0 + $this->score_given,
-            'scoreMaximum' => 0 + $this->score_maximum,
+        // Additionally, includes the call back to filter out only NULL values
+        $request = array_filter([
+            'scoreGiven' => $this->score_given,
+            'scoreMaximum' => $this->score_maximum,
             'comment' => $this->comment,
             'activityProgress' => $this->activity_progress,
             'gradingProgress' => $this->grading_progress,
             'timestamp' => $this->timestamp,
             'userId' => $this->user_id,
             'submissionReview' => $this->submission_review,
             'https://canvas.instructure.com/lti/submission' => $this->canvas_extension,
-        ]));
+        ], '\Packback\Lti1p3\Helpers\Helpers::checkIfNullValue');
+
+        return json_encode($request);
     }
 
     /**

diff --git a/src/LtiGradeSubmissionReview.php b/src/LtiGradeSubmissionReview.php
@@ -19,12 +19,13 @@ public function __construct(array $gradeSubmission = null)
 
     public function __toString()
     {
+        // Additionally, includes the call back to filter out only NULL values
         return json_encode(array_filter([
             'reviewableStatus' => $this->reviewable_status,
             'label' => $this->label,
             'url' => $this->url,
             'custom' => $this->custom,
-        ]));
+        ], '\Packback\Lti1p3\Helpers\Helpers::checkIfNullValue'));
     }
 
     /**

diff --git a/src/LtiLineitem.php b/src/LtiLineitem.php
@@ -27,6 +27,7 @@ public function __construct(array $lineitem = null)
 
     public function __toString()
     {
+        // Additionally, includes the call back to filter out only NULL values
         return json_encode(array_filter([
             'id' => $this->id,
             'scoreMaximum' => $this->score_maximum,
@@ -35,7 +36,7 @@ public function __toString()
             'tag' => $this->tag,
             'startDateTime' => $this->start_date_time,
             'endDateTime' => $this->end_date_time,
-        ]));
+        ], '\Packback\Lti1p3\Helpers\Helpers::checkIfNullValue'));
     }
 
     /**

diff --git a/tests/LtiGradeTest.php b/tests/LtiGradeTest.php
@@ -213,6 +213,25 @@ public function testItCastsFullObjectToString()
         $this->assertEquals(json_encode($expected), (string) $grade);
     }
 
+    public function testItCastsFullObjectToStringWith0Grade()
+    {
+        $expected = [
+            'scoreGiven' => 0,
+            'scoreMaximum' => 10,
+            'comment' => 'Comment',
+            'activityProgress' => 'ActivityProgress',
+            'gradingProgress' => 'GradingProgress',
+            'timestamp' => 'Timestamp',
+            'userId' => 'UserId',
+            'submissionReview' => 'SubmissionReview',
+            'https://canvas.instructure.com/lti/submission' => 'CanvasExtension',
+        ];
+
+        $grade = new LtiGrade($expected);
+
+        $this->assertEquals(json_encode($expected), (string) $grade);
+    }
+
     public function testItCastsEmptyObjectToString()
     {
         $this->assertEquals('[]', (string) $this->grade);