cactusFriday · IlyaKK · Nov 4, 2021 · Nov 4, 2021 · Nov 4, 2021 · Nov 4, 2021
diff --git a/accident/README.md b/accident/README.md
@@ -0,0 +1,175 @@
+## Accient endpoints
+--------------------
+##### Content  
+[Endpoints](#methods)
+[1.1. List all accidents in system](#list_accidents)
+[1.2. Create accident](#create_accident)
+[1.3. Get accident with id](#id_accident)
+[1.4. Delete certain accident](#id_accident_delete)
+[2.1. List the history of editing accidents](#list_history)
+[2.2. Create a history record (Edit existing accident)](#create_history)
+
+
+<a name="methods"><h4>Endpoints</h4></a>
+Method|Endpoint|Description|
+--------|--------------------|-----------|
+`GET`   |`api/v1/accident/`  |Return all existing accidents|
+`POST`  |`api/v1/accident/`  |Create accident|
+`GET`   |`api/v1/accident/1` |Return accident with `id=1`|
+`DELETE`|`api/v1/accident/`  |Delete accident with `id=1` and all edit history|
+`GET`   |`api/v1/accident/history/`|Return all edit hitory of all accidents|
+`POST`  |`api/v1/accident/history/`|Create accident history record (edit existing accident)|
+
+### 1. Accident
+<a name="list_accidents"><h4>1. List all accidents in system</h4></a>
+Request
+`GET` `api/v1/accident/`
+Response
+```json
+{
+    "count": 1,
+    "next": null,
+    "previous": null,
+    "results": [
+        {
+            "id": 1,
+            "user": "admin",
+            "time_appeared": "2020-01-07T19:28:40Z",
+            "time_solved": null,
+            "post": 11,
+            "accident_class": 3,
+            "description": "Инцидент изменен. Класс изменен на 3",
+            "accident_history": [
+                {
+                    "id": 1,
+                    "time_changed": "2021-10-31T15:11:57.332716Z",
+                    "accident_id": 1,
+                    "accident_class": null,
+                    "description": "Тестовый инцидент"
+                }
+            ]
+        }
+    ]
+}
+```
+Or you can add **search parameters** for **filtering**
+`GET` `api/v1/accident/?sort=ASC&dateStart=2020-02-02&dateEnd=2020-09-09&accClass=2`
+`sort = ASC/DESC`
+`dateStart=YYYY-MM-DD`
+`accClass=null` or `accClass=1%3B2%3B3` == `1;2;3`
+
+<a name="create_accident"><h4>2. Create accident</h4></a>
+
+Request
+`POST` `api/v1/accident/`
+
+Body
+```json
+{
+    "time_appeared": "2021-03-08 19:28:40+00:00", 
+    "time_solved": null, 
+    "post": 11, 
+    "accident_class": 1, 
+    "description": "Test accident"
+}
+```
+Response
+```json
+{
+    "id": 6,
+    "user": "admin",
+    "time_appeared": "2021-03-08T19:28:40Z",
+    "time_solved": null,
+    "post": 11,
+    "accident_class": 1,
+    "description": "Test accident",
+    "accident_history": []
+}
+```
+
+<a name="id_accident"><h4>3. Get accident with id</h4></a>
+
+Request
+`GET` `api/v1/accident/2/`
+
+Response
+```json
+{
+    "id": 2,
+    "user": "admin",
+    "time_appeared": "2020-01-07T19:28:40Z",
+    "time_solved": null,
+    "post": 11,
+    "accident_class": 3,
+    "description": "Refactored",
+    "accident_history": [
+        {
+            "id": 4,
+            "time_changed": "2021-10-31T15:11:57.332716Z",
+            "accident_id": 2,
+            "accident_class": null,
+            "description": "Тестовый инцидент"
+        }
+    ]
+}
+```
+
+<a name="id_accident_delete"><h4>4. Delete certain accident</h4></a>
+
+Request
+`DELETE` `api/v1/accident/2/`
+
+Returns response code `204`
+
+### 2. Edit Accidents
+
+<a name="list_history"><h4>1. List the history of editing accidents</h4></a>
+
+Request
+`GET` `api/v1/accident/history`
+Response
+```json
+{
+    "count": 2,
+    "next": null,
+    "previous": null,
+    "results": [
+        {
+            "id": 1,
+            "time_changed": "2021-10-28T12:49:02.895479Z",
+            "accident_id": 3,
+            "accident_class": 1,
+            "description": "Тестовый инцидент"
+        },
+        {
+            "id": 2,
+            "time_changed": "2021-10-28T14:20:55.233350Z",
+            "accident_id": 1,
+            "accident_class": 2,
+            "description": "Тип травма изменен на Тип некомплектность"
+        }
+    ]
+}
+```
+
+<a name="create_history"><h4>2. Create a history record (Edit existing accident)</h4></a>
+
+Request
+`POST` `api/v1/accident/`
+
+Body
+```json
+{
+    "accident_id": 2,
+    "accident_class": 3,
+    "description": "Refactored"
+}
+```
+Response
+```json
+{
+    "accident_id": 2,
+    "accident_class": 3,
+    "description": "Refactored"
+}
+```
diff --git a/coreAPI/__init__.py → accident/__init__.py b/coreAPI/__init__.py → accident/__init__.py
diff --git a/accident/__pycache__/__init__.cpython-36.pyc b/accident/__pycache__/__init__.cpython-36.pyc
diff --git a/accident/__pycache__/admin.cpython-36.pyc b/accident/__pycache__/admin.cpython-36.pyc
diff --git a/accident/__pycache__/apps.cpython-36.pyc b/accident/__pycache__/apps.cpython-36.pyc
diff --git a/accident/__pycache__/filters.cpython-36.pyc b/accident/__pycache__/filters.cpython-36.pyc
diff --git a/accident/__pycache__/models.cpython-36.pyc b/accident/__pycache__/models.cpython-36.pyc
diff --git a/accident/__pycache__/permissions.cpython-36.pyc b/accident/__pycache__/permissions.cpython-36.pyc
diff --git a/accident/__pycache__/serializers.cpython-36.pyc b/accident/__pycache__/serializers.cpython-36.pyc
diff --git a/accident/__pycache__/urls.cpython-36.pyc b/accident/__pycache__/urls.cpython-36.pyc
diff --git a/accident/__pycache__/views.cpython-36.pyc b/accident/__pycache__/views.cpython-36.pyc
diff --git a/coreAPI/admin.py → accident/admin.py b/coreAPI/admin.py → accident/admin.py
@@ -1,7 +1,7 @@
 from django.contrib import admin
-from .models import *
+from accident.models import *
+
 
 admin.site.register(Accident)
 admin.site.register(AccidentClass)
-admin.site.register(AccidentHistory)
-
+admin.site.register(AccidentHistory)
diff --git a/coreAPI/apps.py → accident/apps.py b/coreAPI/apps.py → accident/apps.py
@@ -1,6 +1,6 @@
 from django.apps import AppConfig
 
 
-class CoreApiConfig(AppConfig):
+class AccidentConfig(AppConfig):
     default_auto_field = 'django.db.models.BigAutoField'
-    name = 'coreAPI'
+    name = 'accident'
diff --git a/accident/filters.py b/accident/filters.py
@@ -0,0 +1,30 @@
+import django_filters
+from django_filters import FilterSet
+from accident.models import Accident
+
+
+"""
+TODO: Разобраться как передавать класс инцидента и фильтровать, а так же ренж даты
+"""
+
+class AccidentFilter(FilterSet):
+
+    class Meta:
+        model = Accident
+        fields = {
+            # 'accident_class': ['number',],
+            'posts_block': ['exact',],
+            'time_appeared': ['date__range',]
+        }
+
+    @property
+    def qs(self):
+        """Переопределяем геттер queryset'а. 
+        Вернет элемент, зафиксированный последним, с учетом фильтров"""
+        # возвращает queryset Инцидентов
+        parent = super().qs
+        is_last = self.request.query_params.get('last')
+        if is_last is not None and is_last == "True":
+            # Необходимо положить в список/кортеж, чтобы пагинатор мог определить длинну последовательности
+            parent = (parent.latest('time_appeared'), )
+        return parent
diff --git a/accident/migrations/0001_initial.py b/accident/migrations/0001_initial.py
@@ -0,0 +1,56 @@
+# Generated by Django 3.2.8 on 2021-11-15 00:25
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Accident',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('time_appeared', models.DateTimeField(default=django.utils.timezone.now, unique=True, verbose_name='Время появления происшествия')),
+                ('time_solved', models.DateTimeField(blank=True, null=True, verbose_name='Время решения происшествия')),
+                ('post', models.IntegerField(verbose_name='Пост с происшествием')),
+                ('description', models.TextField(blank=True, null=True, verbose_name='Описание происшествия')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='AccidentClass',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('number', models.IntegerField(verbose_name='Класс происшествия')),
+                ('name', models.CharField(max_length=64, verbose_name='Название класса происшествия')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='AccidentHistory',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('time_changed', models.DateTimeField(default=django.utils.timezone.now, verbose_name='Время внесения изменений')),
+                ('description', models.TextField(blank=True, null=True, verbose_name='Описание происшествия')),
+                ('accident', models.ForeignKey(default=None, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='accident_history', to='accident.accident')),
+                ('accident_class', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='accident.accidentclass')),
+            ],
+        ),
+        migrations.AddField(
+            model_name='accident',
+            name='accident_class',
+            field=models.ForeignKey(default=None, null=True, on_delete=django.db.models.deletion.SET_NULL, to='accident.accidentclass'),
+        ),
+        migrations.AddField(
+            model_name='accident',
+            name='user',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='accidents', to=settings.AUTH_USER_MODEL),
+        ),
+    ]
diff --git a/accident/migrations/0002_rename_post_accident_posts_block.py b/accident/migrations/0002_rename_post_accident_posts_block.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.2.8 on 2021-11-18 07:45
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('accident', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='accident',
+            old_name='post',
+            new_name='posts_block',
+        ),
+    ]
diff --git a/coreAPI/README.md → accident/migrations/__init__.py b/coreAPI/README.md → accident/migrations/__init__.py
diff --git a/accident/migrations/__pycache__/0001_initial.cpython-36.pyc b/accident/migrations/__pycache__/0001_initial.cpython-36.pyc
diff --git a/accident/migrations/__pycache__/0002_alter_accident_user.cpython-36.pyc b/accident/migrations/__pycache__/0002_alter_accident_user.cpython-36.pyc
diff --git a/accident/migrations/__pycache__/0002_rename_post_accident_posts_block.cpython-36.pyc b/accident/migrations/__pycache__/0002_rename_post_accident_posts_block.cpython-36.pyc
diff --git a/accident/migrations/__pycache__/0003_alter_accident_user.cpython-36.pyc b/accident/migrations/__pycache__/0003_alter_accident_user.cpython-36.pyc
diff --git a/accident/migrations/__pycache__/__init__.cpython-36.pyc b/accident/migrations/__pycache__/__init__.cpython-36.pyc
diff --git a/coreAPI/models.py → accident/models.py b/coreAPI/models.py → accident/models.py
@@ -1,7 +1,19 @@
-from django.conf import settings
 from django.db import models
+from django.conf import settings
 from django.utils import timezone
 
+'''
+Как только сообщается красная кнопка - фиксация времени.
+создание происшествия с начальным временем и номером поста в соответствии с конфигурацией. Accident().save()
+Больше одного НЕрешенного происшествия на одном блоке кнопок быть не может.
+Значит при нажатии на клиенте на красную кнопку берем последний инцидент (GET + /?last=true)
+Причем в соотетствии с конфигурацией (можно ее хранить в локалсторедж), понимаем на какой пост нажали - запрашиваем инцидент по такому посту
+подгружаем время фиксации, ставим пост. Менять можно класс, описание. Время решения менять нельзя, 
+оно выставляется на беке в момент переключения кнопки, в дальнейшем обновится на фронте.
+'''
+
+
+
 
 class AccidentClass(models.Model):
     """Таблица с классами инцидентов"""
@@ -13,15 +25,14 @@ def __str__(self) -> str:
 
 
 class Accident(models.Model):
-    objects = None
+    """Основная информация происшествия"""
     ACC_HIST_ARGS = ('accident_class', 'description')
-    '''Основная информация происшествия'''
-    user = models.ForeignKey(to=settings.AUTH_USER_MODEL, related_name='accidents', on_delete=models.CASCADE)
+    user = models.ForeignKey(to=settings.AUTH_USER_MODEL, related_name='accidents', on_delete=models.CASCADE, blank=True, null=True)
     # Время появления проблемы (момент нажатия кнопки)
     time_appeared = models.DateTimeField('Время появления происшествия', blank=False, default=timezone.now, unique=True)
     # Время решения проблемы (мастер зарегестрировал в системе) TODO: узнать как это поле заполнять
     time_solved = models.DateTimeField('Время решения происшествия', blank=True, null=True)
-    post = models.IntegerField('Пост с происшествием')
+    posts_block = models.IntegerField('Пост с происшествием')
     accident_class = models.ForeignKey(to=AccidentClass, on_delete=models.SET_NULL, null=True, default=None)
     description = models.TextField('Описание происшествия', blank=True, null=True)
 
@@ -41,34 +52,17 @@ def add_history_record(self, **kwargs):
         return history_record
 
     def __str__(self) -> str:
-        return f'[{self.user.username}][{self.time_appeared}]: {self.accident_class}'
+        return f'[{self.time_appeared}]: {self.accident_class}'
 
 
 class AccidentHistory(models.Model):
     """Таблица истори изменений происшествий"""
     objects = None
-    accident = models.ForeignKey(Accident, related_name='accident_history', on_delete=models.SET_NULL, null=True,
+    accident = models.ForeignKey(Accident, related_name='accident_history', on_delete=models.CASCADE, null=True,
                                  default=None)
     time_changed = models.DateTimeField('Время внесения изменений', blank=False, default=timezone.now)
     accident_class = models.ForeignKey(to=AccidentClass, on_delete=models.SET_NULL, null=True)
     description = models.TextField('Описание происшествия', blank=True, null=True)
 
     def __str__(self) -> str:
-        return f'History record [{self.pk}]: {self.accident}'
-
-
-class ConveyorState(models.Model):
-    """Таблица с 28 записями состояний постов"""
-
-    objects = None
-
-    class StatusChoices(models.IntegerChoices):
-        ACTIVE = 1
-        SUCCESS = 2
-        ERROR = 3
-
-    post = models.IntegerField('Номер поста')
-    status = models.CharField('Статус поста', max_length=12, default='success')
-
-    def __str__(self) -> str:
-        return f'[{self.status}]: post {self.post}'
+        return f'History record [{self.pk}]: {self.accident}'
diff --git a/coreAPI/premissions.py → accident/permissions.py b/coreAPI/premissions.py → accident/permissions.py
@@ -9,4 +9,4 @@ def has_object_permission(self, request, view, obj):
             return True
 
         # относится только к инцидентам (Accident.user), либо другим моделям, где есть поле user с той же сущностью
-        return obj.user == request.user
+        return obj.user == request.user