CON-72-story(notifications): admin receives notification when device is not seen in a while

- setup queue manager for when notifications are sent
- implement notifications when device is not seen in a while

[Delivers CON-72]

Author: [Arusey]

.circleci/config.yml

@@ -36,9 +36,9 @@ gcloud_setup: &gcloud_setup
   run:
     name: setup gcloud
     command: |
-      # install 
+      # install
       sudo curl https://dl.google.com/dl/cloudsdk/release/google-cloud-sdk.tar.gz > /tmp/google-cloud-sdk.tar.gz
-      sudo mkdir -p /usr/local/gcloud 
+      sudo mkdir -p /usr/local/gcloud
       sudo tar -C /usr/local/gcloud -xvf /tmp/google-cloud-sdk.tar.gz
       sudo /usr/local/gcloud/google-cloud-sdk/install.sh --quiet
       echo PATH=$PATH:/usr/local/gcloud/google-cloud-sdk/bin >> ~/.bashrc
@@ -190,8 +190,8 @@ jobs:
           command: |
             ./cc-test-reporter before-build
             . venv/bin/activate
-            coverage combine parallel-coverage/ 
-            coverage xml
+            coverage combine parallel-coverage/
+            coverage xml -i
             coverage report
             ./cc-test-reporter format-coverage -o ./.coverage -t coverage.py
             ./cc-test-reporter upload-coverage -i .coverage
@@ -304,13 +304,13 @@ jobs:
           command: |
             if [ "$CIRCLE_BRANCH" == master ] || [ "$CIRCLE_BRANCH" == develop ]; then
               touch google-service-key.json
-              echo $GOOGLE_CREDENTIALS_STAGING | base64 --decode >> google-service-key.json 
+              echo $GOOGLE_CREDENTIALS_STAGING | base64 --decode >> google-service-key.json
               gcloud auth activate-service-account --key-file google-service-key.json
               gcloud --quiet config set project ${GOOGLE_PROJECT_ID_STAGING}
               gcloud --quiet config set compute/zone ${GOOGLE_COMPUTE_ZONE}
             else
               touch google-service-key.json
-              echo $GOOGLE_CREDENTIALS_SANDBOX | base64 --decode >> google-service-key.json 
+              echo $GOOGLE_CREDENTIALS_SANDBOX | base64 --decode >> google-service-key.json
               gcloud auth activate-service-account --key-file google-service-key.json
               gcloud --quiet config set project ${GOOGLE_PROJECT_ID_SANDBOX}
               gcloud --quiet config set compute/zone ${GOOGLE_COMPUTE_ZONE}

.codeclimate.yml

@@ -2,4 +2,6 @@ version: "2"
 exclude_patterns:
   - "helpers/auth/authentication.py"
   - "helpers/calendar/events.py"
-  - "alembic/"
+  - "**/alembic/"
+  - "**/*__init__.py"
+  - "**/tests/"

.coveragerc

@@ -13,5 +13,3 @@ omit =
 
 [html]
 directory=html_coverage_report
-
-    

.gitignore

@@ -42,8 +42,6 @@ html_coverage_report/
 .tox/
 .coverage
 .coverage.*
-.coveragerc
-setup.cfg
 .cache
 nosetests.xml
 coverage.xml

admin_notifications/__init__.py

@@ -0,0 +1,32 @@
+from admin_notifications.models import AdminNotification
+from api.location.models import Location
+from datetime import datetime
+
+
+def update_notification(notification_id):
+    notification = AdminNotification.query.filter_by(id=notification_id).first()
+    notification.date_received = datetime.now()
+    notification.save()
+
+
+def create_notification(title, message, location_id):
+    """
+    Create notifications in the database and emit them to the client
+    """
+    from manage import socketio
+    location = Location.query.filter_by(id=location_id).first()
+    location_name = location.name
+    notification = AdminNotification(
+        title=title,
+        message=message,
+        location_id=location_id,
+        status="unread"
+    )
+    notification.save()
+    new_notification = {"title": title, "message": message}
+    return socketio.emit(
+        f"notifications-{location_name}",
+        {'notification': new_notification},
+        broadcast=True,
+        callback=update_notification(notification.id)
+    )

admin_notifications/helpers/__init__.py

@@ -0,0 +1,33 @@
+from datetime import datetime
+from api.devices.models import Devices as DevicesModel
+from utilities.utility import update_entity_fields
+from admin_notifications.helpers.create_notification import create_notification
+from admin_notifications.helpers.notification_templates import device_offline_notification  # noqa 501
+import celery
+
+
+@celery.task(name='check-device-last-seen')
+def notify_when_device_is_offline():
+    """Asynchronous method that checks whether a device's last seen is greater\
+        than 24hours, turns them to offline and subsequently notify's
+    """
+    query = DevicesModel.query
+    online_devices = query.filter(DevicesModel.activity == "online").all()
+    for device in online_devices:
+        device_last_seen = device.last_seen
+        current_time = datetime.now()
+        duration_offline = current_time - device_last_seen
+
+        if duration_offline.days > 1:
+            update_entity_fields(device, activity="offline")
+            device.save()
+
+            room_name = device.room.name
+            room_id = device.room.id
+            notification_payload = device_offline_notification(
+                room_name, room_id)
+            create_notification(title=notification_payload['title'],
+                                message=notification_payload['message'],
+                                location_id=device.room.location_id)
+
+    return online_devices

admin_notifications/helpers/create_notification.py

@@ -0,0 +1,7 @@
+
+def device_offline_notification(room_name, room_id):
+    """Notification message when device has been offline for a while"""
+    return {
+        "title": "Device is offline",
+        "message": f"A device in {room_name} roomid:{room_id} is offline."
+    }

admin_notifications/helpers/device_last_seen.py

@@ -0,0 +1,8 @@
+from datetime import timedelta
+"""Celery beat schedule that checks a device's last seen every 24 hours"""
+beat_schedule = {
+    'run-check-device-last-seen-hourly': {
+        'task': 'check-device-last-seen',
+        'schedule': timedelta(hours=24)
+    }
+}