From 091f9c048a93715b805c064b6e926aeb5facf8d7 Mon Sep 17 00:00:00 2001
From: Meng Li <34143965+Meng6@users.noreply.github.com>
Date: Wed, 10 Mar 2021 15:50:25 -0500
Subject: [PATCH] Migrate phone apps notifications sensor to new data stream

---
 docs/datastreams/aware-mysql.md            | 27 ++++++++++++++++++++++
 docs/datastreams/mandatory-phone-format.md | 15 ++++++++++++
 src/data/streams/aware_mysql/format.yaml   | 16 +++++++++++++
 src/data/streams/rapids_columns.yaml       | 11 +++++++++
 4 files changed, 69 insertions(+)

diff --git a/docs/datastreams/aware-mysql.md b/docs/datastreams/aware-mysql.md
index 793455dd..23a282df 100644
--- a/docs/datastreams/aware-mysql.md
+++ b/docs/datastreams/aware-mysql.md
@@ -163,6 +163,33 @@ Stream columns named `FLAG_TO_MUTATE` means they are extracted based on the `MUT
 
         This sensor is not supported by iOS devices.
 
+??? info "PHONE_APPLICATIONS_NOTIFICATIONS"
+
+    === "ANDROID"
+    
+         **RAPIDS_COLUMN_MAPPINGS**
+
+        | RAPIDS column      | Stream column      |
+        |--------------------|--------------------|
+        | TIMESTAMP          | timestamp          |
+        | DEVICE_ID          | device_id          |
+        | PACKAGE_NAME       | package_name       |
+        | APPLICATION_NAME   | application_name   |
+        | TEXT               | text               |
+        | SOUND              | sound              |
+        | VIBRATE            | vibrate            |
+        | DEFAULTS           | defaults           |
+        | FLAGS              | flags              |
+
+        **MUTATION**
+
+        - **COLUMN_MAPPINGS** (None)
+        - **SCRIPTS** (None)
+    
+    === "IOS"
+
+        This sensor is not supported by iOS devices.
+
 ??? info "PHONE_BATTERY"
 
     === "ANDROID"
diff --git a/docs/datastreams/mandatory-phone-format.md b/docs/datastreams/mandatory-phone-format.md
index 9829e3ac..c8df6f1c 100644
--- a/docs/datastreams/mandatory-phone-format.md
+++ b/docs/datastreams/mandatory-phone-format.md
@@ -50,6 +50,21 @@ This is a description of the format RAPIDS needs to process data for the followi
     | IS_SYSTEM_APP      | Device’s pre-installed application                                        |
 
 
+??? info "PHONE_APPLICATIONS_NOTIFICATIONS"
+
+    | RAPIDS column      | Description                                                               |
+    |--------------------|---------------------------------------------------------------------------|
+    | TIMESTAMP          | An UNIX timestamp (13 digits) when a row of data was logged               |
+    | DEVICE_ID          | A string that uniquely identifies a device                                |
+    | PACKAGE_NAME       | Application’s package name                                                |
+    | APPLICATION_NAME   | Application’s localized name                                              |
+    | TEXT               | Notification’s header text, not the content                               |
+    | SOUND              | Notification’s sound source (if applicable)                               |
+    | VIBRATE            | Notification’s vibration pattern (if applicable)                          |
+    | DEFAULTS           | If notification was delivered according to device’s default settings      |
+    | FLAGS              | An integer that denotes [Android notification flag](https://developer.android.com/reference/android/app/Notification.html)  |
+
+
 ??? info "PHONE_BATTERY"
 
     | RAPIDS column        | Description                                                                                                            |
diff --git a/src/data/streams/aware_mysql/format.yaml b/src/data/streams/aware_mysql/format.yaml
index 10fab4fc..f4afbb26 100644
--- a/src/data/streams/aware_mysql/format.yaml
+++ b/src/data/streams/aware_mysql/format.yaml
@@ -73,6 +73,22 @@ PHONE_APPLICATIONS_FOREGROUND:
       COLUMN_MAPPINGS:
       SCRIPTS: # List any python or r scripts that mutate your raw data
 
+PHONE_APPLICATIONS_NOTIFICATIONS:
+  ANDROID:
+    RAPIDS_COLUMN_MAPPINGS:
+      TIMESTAMP: timestamp
+      DEVICE_ID: device_id
+      PACKAGE_NAME: package_name
+      APPLICATION_NAME: application_name
+      TEXT: text
+      SOUND: sound
+      VIBRATE: vibrate
+      DEFAULTS: defaults
+      FLAGS: flags
+    MUTATION:
+      COLUMN_MAPPINGS:
+      SCRIPTS: # List any python or r scripts that mutate your raw data
+
 PHONE_BATTERY:
   ANDROID:
     RAPIDS_COLUMN_MAPPINGS:
diff --git a/src/data/streams/rapids_columns.yaml b/src/data/streams/rapids_columns.yaml
index ec3da129..6f7054de 100644
--- a/src/data/streams/rapids_columns.yaml
+++ b/src/data/streams/rapids_columns.yaml
@@ -30,6 +30,17 @@ PHONE_APPLICATIONS_FOREGROUND:
   - APPLICATION_NAME
   - IS_SYSTEM_APP
 
+PHONE_APPLICATIONS_NOTIFICATIONS:
+  - TIMESTAMP
+  - DEVICE_ID
+  - PACKAGE_NAME
+  - APPLICATION_NAME
+  - TEXT
+  - SOUND
+  - VIBRATE
+  - DEFAULTS
+  - FLAGS
+
 PHONE_BATTERY:
   - TIMESTAMP
   - DEVICE_ID