Merge pull request #376 from elimu-ai/375-add-numberassessmentevent

feat(utils): add number assessment event

Author: jo-elimu

utils/src/main/java/ai/elimu/analytics/utils/AssessmentEventUtil.kt

@@ -2,6 +2,7 @@ package ai.elimu.analytics.utils
 
 import ai.elimu.model.v2.gson.content.LetterGson
 import ai.elimu.model.v2.gson.content.LetterSoundGson
+import ai.elimu.model.v2.gson.content.NumberGson
 import ai.elimu.model.v2.gson.content.SoundGson
 import ai.elimu.model.v2.gson.content.WordGson
 import android.content.Context
@@ -23,7 +24,7 @@ object AssessmentEventUtil {
      * @param masteryScore A value in the range [0.0, 1.0].
      * @param timeSpentMs The number of milliseconds passed between the student opening the assessment task and submitting a response. E.g. `15000`.
      * @param additionalData Any additional data related to the learning event, e.g. `{'is_letter_pressed':true}`
-     * @param context Needed to fetch the `packageName` of the application where the learning event occurred.
+     * @param context Needed to fetch the `packageName` of the application where the event occurred.
      * @param analyticsApplicationId The package name of the analytics application that will receive the Intent and store the event.
      */
     fun reportLetterSoundAssessmentEvent(
@@ -59,16 +60,16 @@ object AssessmentEventUtil {
      * @param masteryScore A value in the range [0.0, 1.0].
      * @param timeSpentMs The number of milliseconds passed between the student opening the assessment task and submitting a response. E.g. `15000`.
      * @param additionalData Any additional data related to the learning event, e.g. `{'is_word_pressed':true}`
-     * @param context Needed to fetch the `packageName` of the application where the learning event occurred.
+     * @param context Needed to fetch the `packageName` of the application where the event occurred.
      * @param analyticsApplicationId The package name of the analytics application that will receive the Intent and store the event.
      */
     fun reportWordAssessmentEvent(
         wordGson: WordGson,
-        masteryScore: Float?,
-        timeSpentMs: Long?,
+        masteryScore: Float,
+        timeSpentMs: Long,
         additionalData: JSONObject? = null,
         context: Context,
-        analyticsApplicationId: String?
+        analyticsApplicationId: String
     ) {
         Log.i(TAG, "reportWordAssessmentEvent")
 
@@ -86,4 +87,37 @@ object AssessmentEventUtil {
         broadcastIntent.setPackage(analyticsApplicationId)
         context.sendBroadcast(broadcastIntent)
     }
+
+    /**
+     * @param numberGson The number that the student is being assessed for.
+     * @param masteryScore A value in the range [0.0, 1.0].
+     * @param timeSpentMs The number of milliseconds passed between the student opening the assessment task and submitting a response. E.g. `15000`.
+     * @param additionalData Any additional data related to the learning event, e.g. `{'is_number_pressed':true}`
+     * @param context Needed to fetch the `packageName` of the application where the event occurred.
+     * @param analyticsApplicationId The package name of the analytics application that will receive the Intent and store the event.
+     */
+    fun reportNumberAssessmentEvent(
+        numberGson: NumberGson,
+        masteryScore: Float,
+        timeSpentMs: Long,
+        additionalData: JSONObject? = null,
+        context: Context,
+        analyticsApplicationId: String
+    ) {
+        Log.i(TAG, "reportNumberAssessmentEvent")
+
+        val broadcastIntent = Intent()
+        broadcastIntent.setPackage(analyticsApplicationId)
+        broadcastIntent.setAction("ai.elimu.intent.action.NUMBER_ASSESSMENT_EVENT")
+        broadcastIntent.putExtra(BundleKeys.KEY_PACKAGE_NAME, context.packageName)
+        broadcastIntent.putExtra(BundleKeys.KEY_MASTERY_SCORE, masteryScore)
+        broadcastIntent.putExtra(BundleKeys.KEY_TIME_SPENT_MS, timeSpentMs)
+        additionalData?.let {
+            broadcastIntent.putExtra(BundleKeys.KEY_ADDITIONAL_DATA, additionalData.toString())
+        }
+        broadcastIntent.putExtra(BundleKeys.KEY_NUMBER_VALUE, numberGson.value)
+        broadcastIntent.putExtra(BundleKeys.KEY_NUMBER_ID, numberGson.id)
+
+        context.sendBroadcast(broadcastIntent)
+    }
 }

utils/src/main/java/ai/elimu/analytics/utils/IntentAction.kt

@@ -7,8 +7,8 @@ enum class IntentAction(val action: String) {
     WORD_ASSESSMENT("ai.elimu.intent.action.WORD_ASSESSMENT_EVENT"),
     WORD_LEARNING("ai.elimu.intent.action.WORD_LEARNING_EVENT"),
 
-    NUMBER_LEARNING("ai.elimu.intent.action.NUMBER_LEARNING_EVENT"),
     // TODO: number assessment
+    NUMBER_LEARNING("ai.elimu.intent.action.NUMBER_LEARNING_EVENT"),
 
     STORYBOOK_LEARNING("ai.elimu.intent.action.STORYBOOK_LEARNING_EVENT"),
 

utils/src/main/java/ai/elimu/analytics/utils/LearningEventUtil.kt

@@ -24,7 +24,7 @@ object LearningEventUtil {
     /**
      * @param letterSoundGson The letter-sound correspondence that the student is learning.
      * @param additionalData Any additional data related to the learning event, e.g. `{'is_letter_pressed':true}`
-     * @param context Needed to fetch the `packageName` of the application where the learning event occurred.
+     * @param context Needed to fetch the `packageName` of the application where the event occurred.
      * @param analyticsApplicationId The package name of the analytics application that will receive the Intent and store the event.
      */
     fun reportLetterSoundLearningEvent(
@@ -64,7 +64,7 @@ object LearningEventUtil {
     /**
      * @param wordGson The word that the student is learning.
      * @param additionalData Any additional data related to the learning event, e.g. `{'is_word_pressed':true}`
-     * @param context Needed to fetch the `packageName` of the application where the learning event occurred.
+     * @param context Needed to fetch the `packageName` of the application where the event occurred.
      * @param analyticsApplicationId The package name of the analytics application that will receive the Intent and store the event.
      */
     fun reportWordLearningEvent(
@@ -91,7 +91,7 @@ object LearningEventUtil {
     /**
      * @param storyBookGson The storybook that the student is learning from.
      * @param additionalData Any additional data related to the learning event, e.g. `{'time_spent_per_chapter_ms':[7500,12900,34422,5023]}`
-     * @param context Needed to fetch the `packageName` of the application where the learning event occurred.
+     * @param context Needed to fetch the `packageName` of the application where the event occurred.
      * @param analyticsApplicationId The package name of the analytics application that will receive the Intent and store the event.
      */
     fun reportStoryBookLearningEvent(
@@ -118,7 +118,7 @@ object LearningEventUtil {
     /**
      * @param videoGson The video that the student is learning from.
      * @param additionalData Any additional data related to the learning event, e.g. `{'is_video_paused':true}`
-     * @param context Needed to fetch the `packageName` of the application where the learning event occurred.
+     * @param context Needed to fetch the `packageName` of the application where the event occurred.
      * @param analyticsApplicationId The package name of the analytics application that will receive the Intent and store the event.
      */
     fun reportVideoLearningEvent(
@@ -145,7 +145,7 @@ object LearningEventUtil {
     /**
      * @param numberGson The number that the student is learning.
      * @param additionalData Any additional data related to the learning event, e.g. `{'is_number_pressed':true}`
-     * @param context Needed to fetch the `packageName` of the application where the learning event occurred.
+     * @param context Needed to fetch the `packageName` of the application where the event occurred.
      * @param analyticsApplicationId The package name of the analytics application that will receive the Intent and store the event.
      */
     fun reportNumberLearningEvent(