Replace widget with dashboard (#415)

Author: NickSchimek

config/routes.py

@@ -17,7 +17,6 @@
 from resources.tickets import Ticket, Tickets
 from resources.notes import Notes, Note
 from resources.lease import Lease, Leases
-from resources.widgets import Widgets
 from resources.dashboard_resource import DashboardResource
 from tests.cypress.cypress_resource import CypressResource
 
@@ -36,7 +35,6 @@ def routing(app):
         api.add_resource(UsersPending, "users/pending")
         api.add_resource(ArchiveUser, "user/archive/<int:user_id>")
         api.add_resource(UserLogin, "login")
-        api.add_resource(Widgets, "widgets")
         api.add_resource(DashboardResource, "dashboard")
         api.add_resource(UserAccessRefresh, "refresh")
         api.add_resource(StaffTenants, "staff-tenants")

models/dashboard.py

@@ -9,33 +9,6 @@
 class Dashboard:
     @staticmethod
     def json():
-        return {
-            "opentickets": {
-                "new": {
-                    "allNew": {
-                        "stat": TicketModel.new().count(),
-                    },
-                    "unseen24Hrs": {
-                        "stat": TicketModel.new().updated_within(days=1).count(),
-                    },
-                },
-                "inProgress": {
-                    "allInProgress": {
-                        "stat": TicketModel.in_progress().count(),
-                    },
-                    "inProgress1Week": {
-                        "stat": TicketModel.in_progress()
-                        .updated_within(days=7)
-                        .count(),
-                    },
-                },
-            },
-            "managers": [Dashboard._manager_json(m) for m in PropertyManager.take(3)],
-        }
-
-    # Below is what I would like to use instead of the above json^^^
-    @staticmethod
-    def proposed_json():
         return {
             "tickets": {
                 "new": {
@@ -49,7 +22,7 @@ def proposed_json():
                     .count(),
                 },
             },
-            "managers": [Dashboard.__manager_json(m) for m in PropertyManager.take(3)],
+            "managers": [Dashboard._manager_json(m) for m in PropertyManager.take(3)],
             "pending_users": UserModel.query.active().pending().json(),
             "staff": Staff.query.json(),
             "tenants": TenantModel.query.active()
@@ -60,18 +33,6 @@ def proposed_json():
 
     @staticmethod
     def _manager_json(manager):
-        return {
-            "id": manager.id,
-            "firstName": manager.firstName,
-            "lastName": manager.lastName,
-            "date": Dashboard._humanize_date(manager.created_at.date()),
-            "propertyName": manager.properties[0].name
-            if len(manager.properties) > 0
-            else "Not Assigned",
-        }
-
-    @staticmethod
-    def __manager_json(manager):
         return {
             "id": manager.id,
             "first_name": manager.firstName,

resources/dashboard_resource.py

@@ -7,4 +7,4 @@
 class DashboardResource(Resource):
     @admin_required
     def get(self):
-        return Dashboard.proposed_json()
+        return Dashboard.json()

resources/widgets.py

@@ -6,3 +6,4 @@
 from .emergency_contact import *
 from .ticket import *
 from .notes import *
+from .dashboard import *

tests/factory_fixtures/__init__.py

@@ -0,0 +1,44 @@
+import pytest
+
+from models.tickets import TicketModel
+from utils.time import TimeStamp
+
+
+@pytest.fixture
+def create_dashboard(
+    create_ticket, create_property_manager, create_property, create_unauthorized_user
+):
+    def _create_dashboard(**kwargs):
+        def _create_tickets(num, status, tenant=None, author=None, updated_at=None):
+            updated_at = updated_at or TimeStamp.now()
+            for _ in range(num):
+                create_ticket(
+                    status=status, tenant=tenant, author=author, updated_at=updated_at
+                )
+
+        dashboard = {}
+        ticket = create_ticket(status=TicketModel.NEW)
+        tenant = ticket.tenant
+        author = ticket.author
+        dashboard["tenant"] = tenant
+        dashboard["author"] = author
+        _create_tickets(1, TicketModel.NEW, tenant, author)
+        _create_tickets(5, TicketModel.NEW, tenant, author, TimeStamp.weeks_ago(1))
+        _create_tickets(3, TicketModel.IN_PROGRESS, tenant, author)
+        _create_tickets(
+            7, TicketModel.IN_PROGRESS, tenant, author, TimeStamp.weeks_ago(2)
+        )
+
+        dashboard["pending_user"] = create_unauthorized_user()
+        pm = create_property_manager()
+        pm2 = create_property_manager(created_at=TimeStamp.days_ago(1))
+        pm3 = create_property_manager(created_at=TimeStamp.days_ago(2))
+        dashboard["pm"] = pm
+        dashboard["pm2"] = pm2
+        dashboard["pm3"] = pm3
+        dashboard["prop"] = create_property(manager_ids=[pm.id])
+        dashboard["prop2"] = create_property(manager_ids=[pm.id, pm3.id])
+
+        return dashboard
+
+    yield _create_dashboard

tests/factory_fixtures/dashboard.py

@@ -1,9 +1,13 @@
 import pytest
 
+from models.dashboard import Dashboard
+
 
 @pytest.mark.usefixtures("client_class")
 class TestDashboardResource:
-    def test_GET(self, valid_header):
+    def test_GET(self, valid_header, create_dashboard):
+        create_dashboard()
         response = self.client.get("/api/dashboard", headers=valid_header)
 
         assert response.status_code == 200
+        assert response.json == Dashboard.json()

tests/integration/test_dashboard_resource.py

@@ -1,70 +1,46 @@
-from models.tickets import TicketModel
-from utils.time import TimeStamp
 from models.dashboard import Dashboard
 
 
 class TestDashboard:
-    def test_json(
-        self, valid_header, create_ticket, create_property_manager, create_property
-    ):
-        def _create_tickets(num, status, updated_at=None):
-            updated_at = updated_at or TimeStamp.now()
-            for _ in range(num):
-                create_ticket(status=status, updated_at=updated_at)
-
-        _create_tickets(2, TicketModel.NEW)
-        _create_tickets(5, TicketModel.NEW, TimeStamp.weeks_ago(1))
-        _create_tickets(3, TicketModel.IN_PROGRESS)
-        _create_tickets(7, TicketModel.IN_PROGRESS, TimeStamp.weeks_ago(2))
-
-        pm = create_property_manager()
-        pm2 = create_property_manager(created_at=TimeStamp.days_ago(1))
-        pm3 = create_property_manager(created_at=TimeStamp.days_ago(2))
-        prop = create_property(manager_ids=[pm.id])
-        prop2 = create_property(manager_ids=[pm.id, pm3.id])
-
+    def test_json(self, create_dashboard):
+        dashboard = create_dashboard()
         response = Dashboard.json()
 
         assert response == {
             "managers": [
                 {
                     "date": "Today",
-                    "firstName": pm.firstName,
-                    "id": pm.id,
-                    "lastName": pm.lastName,
-                    "propertyName": prop.name,
+                    "first_name": dashboard["pm"].firstName,
+                    "id": dashboard["pm"].id,
+                    "last_name": dashboard["pm"].lastName,
+                    "property_name": dashboard["prop"].name,
                 },
                 {
                     "date": "Yesterday",
-                    "firstName": pm2.firstName,
-                    "id": pm2.id,
-                    "lastName": pm2.lastName,
-                    "propertyName": "Not Assigned",
+                    "first_name": dashboard["pm2"].firstName,
+                    "id": dashboard["pm2"].id,
+                    "last_name": dashboard["pm2"].lastName,
+                    "property_name": "Not Assigned",
                 },
                 {
                     "date": "This Week",
-                    "firstName": pm3.firstName,
-                    "id": pm3.id,
-                    "lastName": pm3.lastName,
-                    "propertyName": prop2.name,
+                    "first_name": dashboard["pm3"].firstName,
+                    "id": dashboard["pm3"].id,
+                    "last_name": dashboard["pm3"].lastName,
+                    "property_name": dashboard["prop2"].name,
                 },
             ],
-            "opentickets": {
+            "pending_users": [dashboard["pending_user"].json()],
+            "staff": [dashboard["author"].json()],
+            "tenants": [dashboard["tenant"].json()],
+            "tickets": {
                 "new": {
-                    "allNew": {
-                        "stat": 7,
-                    },
-                    "unseen24Hrs": {
-                        "stat": 2,
-                    },
+                    "total_count": 7,
+                    "latent_count": 2,
                 },
-                "inProgress": {
-                    "allInProgress": {
-                        "stat": 10,
-                    },
-                    "inProgress1Week": {
-                        "stat": 3,
-                    },
+                "in_progress": {
+                    "total_count": 10,
+                    "latent_count": 3,
                 },
             },
         }