Feature/replace street maintenance app with maintenance app

street_maintenance/README.md → maintenance/README.md

@@ -1,8 +1,9 @@
-# Street Maintenance history
+# Maintenance history
 
-Django app for importing and serving street maintenance data.
+Django app for importing, processing and serving maintenance data.
 
-## Importer
+## Street maintenance history
+### Importer
 Name:
 import_street_maintenance_history 
 

street_maintenance/admin.py → maintenance/admin.py

@@ -1,6 +1,6 @@
 from django.contrib import admin
 
-from street_maintenance.models import MaintenanceUnit, MaintenanceWork
+from maintenance.models import MaintenanceUnit, MaintenanceWork
 
 admin.site.register(MaintenanceWork)
 admin.site.register(MaintenanceUnit)

street_maintenance/api/serializers.py → maintenance/api/serializers.py

@@ -3,7 +3,7 @@
 from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
 
-from street_maintenance.models import GeometryHistory, MaintenanceUnit, MaintenanceWork
+from maintenance.models import GeometryHistory, MaintenanceUnit, MaintenanceWork
 
 
 class GeometryHistorySerializer(serializers.ModelSerializer):

street_maintenance/api/urls.py → maintenance/api/urls.py

@@ -3,7 +3,7 @@
 
 from . import views
 
-app_name = "street_maintenance"
+app_name = "maintenance"
 
 router = routers.DefaultRouter()
 router.register("active_events", views.ActiveEventsViewSet, basename="active_events")
@@ -20,6 +20,5 @@
 )
 
 urlpatterns = [
-    # re_path("^street_maintenance/active_events", )
-    path("", include(router.urls), name="street_maintenance"),
+    path("", include(router.urls), name="maintenance"),
 ]

maintenance/api/urls_street_maintenance.py

@@ -0,0 +1,28 @@
+"""
+Keep backward compatibility to street_maintenance API.
+"""
+
+from django.urls import include, path
+from rest_framework import routers
+
+from . import views
+
+app_name = "street_maintenance"
+
+router = routers.DefaultRouter()
+router.register("active_events", views.ActiveEventsViewSet, basename="active_events")
+
+router.register(
+    "maintenance_works", views.MaintenanceWorkViewSet, basename="maintenance_works"
+)
+router.register(
+    "maintenance_units", views.MaintenanceUnitViewSet, basename="maintenance_units"
+)
+
+router.register(
+    "geometry_history", views.GeometryHitoryViewSet, basename="geometry_history"
+)
+
+urlpatterns = [
+    path("", include(router.urls), name="street_maintenance"),
+]

street_maintenance/api/views.py → maintenance/api/views.py

@@ -8,18 +8,18 @@
 from rest_framework.exceptions import ParseError
 from rest_framework.pagination import PageNumberPagination
 
-from street_maintenance.api.serializers import (
+from maintenance.api.serializers import (
     ActiveEventSerializer,
     GeometryHistorySerializer,
     MaintenanceUnitSerializer,
     MaintenanceWorkSerializer,
 )
-from street_maintenance.management.commands.constants import (
+from maintenance.management.commands.constants import (
     EVENT_CHOICES,
     PROVIDERS,
     START_DATE_TIME_FORMAT,
 )
-from street_maintenance.models import GeometryHistory, MaintenanceUnit, MaintenanceWork
+from maintenance.models import GeometryHistory, MaintenanceUnit, MaintenanceWork
 
 EXAMPLE_TIME_FORMAT = "YYYY-MM-DD HH:MM:SS"
 EXAMPLE_TIME = "2022-09-18 10:00:00"
@@ -133,7 +133,7 @@ def list(self, request):
     list=extend_schema(
         description="MaintananceUnit objets are the entities that creates the MaintenanceWorks. Every MaintenanceWork "
         "has a relation to a MaintenanceUnit. The type of the MaintenanceUnit can vary depending on the provider. It "
-        "can be a machine or a event",
+        "can be a machine or an event.",
     ),
 )
 class MaintenanceUnitViewSet(viewsets.ReadOnlyModelViewSet):

maintenance/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class MaintenanceConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "maintenance"

street_maintenance/management/commands/delete_street_maintenance_history.py → maintenance/management/commands/delete_street_maintenance_history.py

@@ -2,11 +2,11 @@
 
 from django.core.management import BaseCommand
 
-from street_maintenance.models import GeometryHistory, MaintenanceUnit
+from maintenance.models import GeometryHistory, MaintenanceUnit
 
 from .constants import PROVIDERS
 
-logger = logging.getLogger("mobility_data")
+logger = logging.getLogger("maintenance")
 
 # Add deprecated provider name 'AUTORI'
 PROVIDERS.append("AUTORI")

street_maintenance/management/commands/import_street_maintenance_history.py → maintenance/management/commands/import_street_maintenance_history.py

@@ -3,7 +3,7 @@
 
 from django.core.management import BaseCommand
 
-from street_maintenance.models import MaintenanceUnit, MaintenanceWork
+from maintenance.models import MaintenanceUnit, MaintenanceWork
 
 from .constants import (
     FETCH_SIZE,
@@ -23,7 +23,7 @@
     precalculate_geometry_history,
 )
 
-logger = logging.getLogger("street_maintenance")
+logger = logging.getLogger("maintenance")
 
 
 class Command(BaseCommand):

street_maintenance/management/commands/utils.py → maintenance/management/commands/utils.py

@@ -11,7 +11,7 @@
 from django.contrib.gis.geos import LineString, Point
 from munigeo.models import AdministrativeDivision, AdministrativeDivisionGeometry
 
-from street_maintenance.models import (
+from maintenance.models import (
     DEFAULT_SRID,
     GeometryHistory,
     MaintenanceUnit,
@@ -34,7 +34,7 @@
     YIT,
 )
 
-logger = logging.getLogger("street_maintenance")
+logger = logging.getLogger("maintenance")
 # In seconds
 MAX_WORK_LENGTH = 60
 VALID_LINESTRING_MAX_POINT_DISTANCE = 0.01

maintenance/migrations/0001_initial.py

@@ -0,0 +1,156 @@
+# Generated by Django 4.2.15 on 2024-09-17 07:26
+
+import django.contrib.gis.db.models.fields
+import django.contrib.postgres.fields
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="GeometryHistory",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("timestamp", models.DateTimeField()),
+                (
+                    "geometry",
+                    django.contrib.gis.db.models.fields.GeometryField(
+                        null=True, srid=4326
+                    ),
+                ),
+                (
+                    "coordinates",
+                    django.contrib.postgres.fields.ArrayField(
+                        base_field=django.contrib.postgres.fields.ArrayField(
+                            base_field=models.FloatField(), size=None
+                        ),
+                        default=list,
+                        size=None,
+                    ),
+                ),
+                (
+                    "events",
+                    django.contrib.postgres.fields.ArrayField(
+                        base_field=models.CharField(max_length=64),
+                        default=list,
+                        size=None,
+                    ),
+                ),
+                (
+                    "provider",
+                    models.CharField(
+                        choices=[
+                            ("INFRAROAD", "Infraroad"),
+                            ("YIT", "YIT"),
+                            ("KUNTEC", "Kuntec"),
+                            ("DESTIA", "Destia"),
+                        ],
+                        max_length=16,
+                        null=True,
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["-timestamp"],
+            },
+        ),
+        migrations.CreateModel(
+            name="MaintenanceUnit",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("unit_id", models.CharField(max_length=64, null=True)),
+                (
+                    "provider",
+                    models.CharField(
+                        choices=[
+                            ("INFRAROAD", "Infraroad"),
+                            ("YIT", "YIT"),
+                            ("KUNTEC", "Kuntec"),
+                            ("DESTIA", "Destia"),
+                        ],
+                        max_length=16,
+                        null=True,
+                    ),
+                ),
+                (
+                    "names",
+                    django.contrib.postgres.fields.ArrayField(
+                        base_field=models.CharField(max_length=64),
+                        default=list,
+                        size=None,
+                    ),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="MaintenanceWork",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "geometry",
+                    django.contrib.gis.db.models.fields.GeometryField(
+                        null=True, srid=4326
+                    ),
+                ),
+                (
+                    "events",
+                    django.contrib.postgres.fields.ArrayField(
+                        base_field=models.CharField(max_length=64),
+                        default=list,
+                        size=None,
+                    ),
+                ),
+                (
+                    "original_event_names",
+                    django.contrib.postgres.fields.ArrayField(
+                        base_field=models.CharField(max_length=64),
+                        default=list,
+                        size=None,
+                    ),
+                ),
+                ("timestamp", models.DateTimeField()),
+                (
+                    "maintenance_unit",
+                    models.ForeignKey(
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="maintenance_work",
+                        to="maintenance.maintenanceunit",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["-timestamp"],
+            },
+        ),
+    ]

street_maintenance/models.py → maintenance/models.py

@@ -1,7 +1,7 @@
 from django.contrib.gis.db import models
 from django.contrib.postgres.fields import ArrayField
 
-from street_maintenance.management.commands.constants import PROVIDER_CHOICES
+from maintenance.management.commands.constants import PROVIDER_CHOICES
 
 DEFAULT_SRID = 4326
 

street_maintenance/specificatio.swagger.yaml → maintenance/specificatio.swagger.yaml

@@ -1,9 +1,9 @@
 swagger: "2.0"
 
 info:
-  description: "Street maintenance API that serves history data of maintenance works, active events and provides history as generated geometries."
+  description: "Maintenance API that serves history data of maintenance works, active events and provides history as generated geometries."
   version: "1.0.0"
-  title: "Street Maintenance History"  
+  title: Maintenance History"  
 
 schemes:
 - "https"