add django backend in /core

ported from laravel in c3lf/lfbackend repo

core/inventory/admin.py

@@ -0,0 +1,24 @@
+from django.contrib import admin
+
+from inventory.models import Item, Container, Event
+
+
+class ItemAdmin(admin.ModelAdmin):
+    pass
+
+
+admin.site.register(Item, ItemAdmin)
+
+
+class ContainerAdmin(admin.ModelAdmin):
+    pass
+
+
+admin.site.register(Container, ContainerAdmin)
+
+
+class EventAdmin(admin.ModelAdmin):
+    pass
+
+
+admin.site.register(Event, EventAdmin)

core/inventory/api_v1.py

@@ -0,0 +1,143 @@
+from datetime import datetime
+
+from django.urls import path
+from rest_framework import routers, viewsets, serializers
+from rest_framework.decorators import api_view
+from rest_framework.response import Response
+
+from files.models import File
+from inventory.models import Event, Container, Item
+
+
+class EventSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Event
+        fields = ['eid', 'slug', 'name', 'start', 'end', 'pre_start', 'post_end']
+        read_only_fields = ['eid']
+
+
+class EventViewSet(viewsets.ModelViewSet):
+    serializer_class = EventSerializer
+    queryset = Event.objects.all()
+
+
+class ContainerSerializer(serializers.ModelSerializer):
+    itemCount = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Container
+        fields = ['cid', 'name', 'itemCount']
+        read_only_fields = ['cid', 'itemCount']
+
+    def get_itemCount(self, instance):
+        return Item.objects.filter(container=instance.cid).count()
+
+
+class ContainerViewSet(viewsets.ModelViewSet):
+    serializer_class = ContainerSerializer
+    queryset = Container.objects.all()
+
+
+class ItemSerializer(serializers.ModelSerializer):
+    cid = serializers.SerializerMethodField()
+    box = serializers.SerializerMethodField()
+    file = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Item
+        fields = ['cid', 'box', 'uid', 'description', 'file']
+        read_only_fields = ['uid']
+
+    def get_cid(self, instance):
+        return instance.container.cid
+
+    def get_box(self, instance):
+        return instance.container.name
+
+    def get_file(self, instance):
+        if len(instance.files.all()) > 0:
+            return instance.files.all().order_by('-created_at')[0].hash
+        return None
+
+    def to_internal_value(self, data):
+        if 'cid' in data:
+            container = Container.objects.get(cid=data['cid'])
+            internal = super().to_internal_value(data)
+            internal['container'] = container
+            return internal
+        return super().to_internal_value(data)
+
+    def validate(self, attrs):
+        attrs.pop('dataImage', None)
+        return super().validate(attrs)
+
+    def create(self, validated_data):
+        if 'dataImage' in validated_data:
+            file = File.objects.create(data=validated_data['dataImage'], iid=validated_data['iid'])
+            validated_data.pop('dataImage')
+        return Item.objects.create(**validated_data)
+
+    def update(self, instance, validated_data):
+        if 'returned' in validated_data:
+            if validated_data['returned']:
+                validated_data['returned_at'] = datetime.now()
+            validated_data.pop('returned')
+        if 'dataImage' in validated_data:
+            file = File.objects.create(data=validated_data['dataImage'], iid=instance.iid)
+            validated_data.pop('dataImage')
+        return super().update(instance, validated_data)
+
+
+@api_view(['GET'])
+def search_items(request, event_slug, query):
+    event = Event.objects.get(slug=event_slug)
+    query_tokens = query.split(' ')
+    q = Item.objects.filter(event=event)
+    for token in query_tokens:
+        if token:
+            q = q.filter(description__icontains=token)
+    return Response(ItemSerializer(q, many=True).data)
+
+
+@api_view(['GET', 'POST'])
+def item(request, event_slug):
+    event = Event.objects.get(slug=event_slug)
+    if request.method == 'GET':
+        return Response(ItemSerializer(Item.objects.filter(event=event), many=True).data)
+    elif request.method == 'POST':
+        validated_data = ItemSerializer(data=request.data)
+        if validated_data.is_valid():
+            validated_data.save(event=event)
+            return Response(validated_data.data, status=201)
+
+
+@api_view(['GET', 'PUT', 'DELETE'])
+def item_by_id(request, event_slug, id):
+    try:
+        event = Event.objects.get(slug=event_slug)
+        item = Item.objects.get(event=event, uid=id)
+        if request.method == 'GET':
+            return Response(ItemSerializer(item).data)
+        elif request.method == 'PUT':
+            validated_data = ItemSerializer(item, data=request.data)
+            if validated_data.is_valid():
+                validated_data.save()
+                return Response(validated_data.data)
+        elif request.method == 'DELETE':
+            item.delete()
+            return Response(status=204)
+    except Item.DoesNotExist:
+        return Response(status=404)
+
+
+router = routers.SimpleRouter()
+router.register(r'events', EventViewSet, basename='events')
+router.register(r'boxes', ContainerViewSet, basename='boxes')
+router.register(r'box', ContainerViewSet, basename='boxes')
+
+urlpatterns = router.urls + [
+    path('<event_slug>/items/', item),
+    path('<event_slug>/items/<query>/', search_items),
+    path('<event_slug>/item/', item),
+    path('<event_slug>/item/<id>/', item_by_id),
+]

core/inventory/migrations/0001_initial.py

@@ -0,0 +1,54 @@
+# Generated by Django 4.2.7 on 2023-11-18 11:28
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Container',
+            fields=[
+                ('cid', models.AutoField(primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=255)),
+                ('created_at', models.DateTimeField(blank=True, null=True)),
+                ('updated_at', models.DateTimeField(blank=True, null=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Event',
+            fields=[
+                ('eid', models.AutoField(primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=255)),
+                ('slug', models.CharField(max_length=255, unique=True)),
+                ('start', models.DateTimeField(blank=True, null=True)),
+                ('end', models.DateTimeField(blank=True, null=True)),
+                ('pre_start', models.DateTimeField(blank=True, null=True)),
+                ('post_end', models.DateTimeField(blank=True, null=True)),
+                ('created_at', models.DateTimeField(blank=True, null=True)),
+                ('updated_at', models.DateTimeField(blank=True, null=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Item',
+            fields=[
+                ('iid', models.AutoField(primary_key=True, serialize=False)),
+                ('uid', models.IntegerField()),
+                ('description', models.TextField()),
+                ('returned_at', models.DateTimeField(blank=True, null=True)),
+                ('created_at', models.DateTimeField(blank=True, null=True)),
+                ('updated_at', models.DateTimeField(blank=True, null=True)),
+                ('container', models.ForeignKey(db_column='cid', on_delete=django.db.models.deletion.CASCADE, to='inventory.container')),
+                ('event', models.ForeignKey(db_column='eid', on_delete=django.db.models.deletion.CASCADE, to='inventory.event')),
+            ],
+            options={
+                'unique_together': {('uid', 'event')},
+            },
+        ),
+    ]

core/inventory/models.py

@@ -0,0 +1,48 @@
+from django.core.files.base import ContentFile
+from django.db import models, IntegrityError
+from django_softdelete.models import SoftDeleteModel
+
+
+class ItemManager(models.Manager):
+
+    def create(self, **kwargs):
+        if 'uid' in kwargs:
+            raise ValueError('uid must not be set manually')
+        uid = Item.objects.filter(event=kwargs['event']).count() + 1
+        kwargs['uid'] = uid
+        return super().create(**kwargs)
+
+
+class Item(models.Model):
+    iid = models.AutoField(primary_key=True)
+    uid = models.IntegerField()
+    description = models.TextField()
+    event = models.ForeignKey('Event', models.CASCADE, db_column='eid')
+    container = models.ForeignKey('Container', models.CASCADE, db_column='cid')
+    returned_at = models.DateTimeField(blank=True, null=True)
+    created_at = models.DateTimeField(blank=True, null=True)
+    updated_at = models.DateTimeField(blank=True, null=True)
+
+    objects = ItemManager()
+
+    class Meta:
+        unique_together = (('uid', 'event'),)
+
+
+class Container(models.Model):
+    cid = models.AutoField(primary_key=True)
+    name = models.CharField(max_length=255)
+    created_at = models.DateTimeField(blank=True, null=True)
+    updated_at = models.DateTimeField(blank=True, null=True)
+
+
+class Event(models.Model):
+    eid = models.AutoField(primary_key=True)
+    name = models.CharField(max_length=255)
+    slug = models.CharField(max_length=255, unique=True)
+    start = models.DateTimeField(blank=True, null=True)
+    end = models.DateTimeField(blank=True, null=True)
+    pre_start = models.DateTimeField(blank=True, null=True)
+    post_end = models.DateTimeField(blank=True, null=True)
+    created_at = models.DateTimeField(blank=True, null=True)
+    updated_at = models.DateTimeField(blank=True, null=True)

core/inventory/tests/test_api.py

@@ -0,0 +1,34 @@
+from django.test import TestCase, Client
+
+client = Client()
+
+
+class ApiTest(TestCase):
+
+    def test_root(self):
+        from core.settings import SYSTEM3_VERSION
+        response = client.get('/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json()["framework_version"], SYSTEM3_VERSION)
+
+    def test_events(self):
+        response = client.get('/1/events/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), [])
+
+    def test_containers(self):
+        response = client.get('/1/boxes/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), [])
+
+    def test_files(self):
+        response = client.get('/1/files/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), [])
+
+    def test_items(self):
+        from inventory.models import Event
+        Event.objects.create(slug='TEST1', name='Event')
+        response = client.get('/1/TEST1/items/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), [])

core/inventory/tests/test_containers.py

@@ -0,0 +1,59 @@
+from django.test import TestCase, Client
+from inventory.models import Container
+
+client = Client()
+
+
+class ContainerTestCase(TestCase):
+
+    def test_empty(self):
+        response = client.get('/1/boxes/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), [])
+
+    def test_members(self):
+        Container.objects.create(name='BOX')
+        response = client.get('/1/boxes/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()), 1)
+        self.assertEqual(response.json()[0]['cid'], 1)
+        self.assertEqual(response.json()[0]['name'], 'BOX')
+        self.assertEqual(response.json()[0]['itemCount'], 0)
+
+    def test_multi_members(self):
+        Container.objects.create(name='BOX 1')
+        Container.objects.create(name='BOX 2')
+        Container.objects.create(name='BOX 3')
+        response = client.get('/1/boxes/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()), 3)
+
+    def test_create_container(self):
+        response = client.post('/1/box/', {'name': 'BOX'})
+        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.json()['cid'], 1)
+        self.assertEqual(response.json()['name'], 'BOX')
+        self.assertEqual(response.json()['itemCount'], 0)
+        self.assertEqual(len(Container.objects.all()), 1)
+        self.assertEqual(Container.objects.all()[0].cid, 1)
+        self.assertEqual(Container.objects.all()[0].name, 'BOX')
+
+    def test_update_container(self):
+        from rest_framework.test import APIClient
+        box = Container.objects.create(name='BOX 1')
+        response = APIClient().put(f'/1/box/{box.cid}/', {'name': 'BOX 2'})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json()['cid'], 1)
+        self.assertEqual(response.json()['name'], 'BOX 2')
+        self.assertEqual(response.json()['itemCount'], 0)
+        self.assertEqual(len(Container.objects.all()), 1)
+        self.assertEqual(Container.objects.all()[0].cid, 1)
+        self.assertEqual(Container.objects.all()[0].name, 'BOX 2')
+
+    def test_delete_container(self):
+        box = Container.objects.create(name='BOX 1')
+        Container.objects.create(name='BOX 2')
+        self.assertEqual(len(Container.objects.all()), 2)
+        response = client.delete(f'/1/box/{box.cid}/')
+        self.assertEqual(response.status_code, 204)
+        self.assertEqual(len(Container.objects.all()), 1)

core/inventory/tests/test_events.py

@@ -0,0 +1,56 @@
+from django.test import TestCase, Client
+from inventory.models import Event
+
+client = Client()
+
+
+class EventTestCase(TestCase):
+
+    def test_empty(self):
+        response = client.get('/1/events/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), [])
+
+    def test_members(self):
+        Event.objects.create(slug='EVENT', name='Event')
+        response = client.get('/1/events/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()), 1)
+        self.assertEqual(response.json()[0]['slug'], 'EVENT')
+        self.assertEqual(response.json()[0]['name'], 'Event')
+
+    def test_multi_members(self):
+        Event.objects.create(slug='EVENT1', name='Event 1')
+        Event.objects.create(slug='EVENT2', name='Event 2')
+        Event.objects.create(slug='EVENT3', name='Event 3')
+        response = client.get('/1/events/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()), 3)
+
+    def test_create_event(self):
+        response = client.post('/1/events/', {'slug': 'EVENT', 'name': 'Event'})
+        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.json()['slug'], 'EVENT')
+        self.assertEqual(response.json()['name'], 'Event')
+        self.assertEqual(len(Event.objects.all()), 1)
+        self.assertEqual(Event.objects.all()[0].slug, 'EVENT')
+        self.assertEqual(Event.objects.all()[0].name, 'Event')
+
+    def test_update_event(self):
+        from rest_framework.test import APIClient
+        event = Event.objects.create(slug='EVENT1', name='Event 1')
+        response = APIClient().put(f'/1/events/{event.eid}/', {'slug': 'EVENT2', 'name': 'Event 2 new'})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json()['slug'], 'EVENT2')
+        self.assertEqual(response.json()['name'], 'Event 2 new')
+        self.assertEqual(len(Event.objects.all()), 1)
+        self.assertEqual(Event.objects.all()[0].slug, 'EVENT2')
+        self.assertEqual(Event.objects.all()[0].name, 'Event 2 new')
+
+    def test_remove_event(self):
+        event = Event.objects.create(slug='EVENT1', name='Event 1')
+        Event.objects.create(slug='EVENT2', name='Event 2')
+        self.assertEqual(len(Event.objects.all()), 2)
+        response = client.delete(f'/1/events/{event.eid}/')
+        self.assertEqual(response.status_code, 204)
+        self.assertEqual(len(Event.objects.all()), 1)

core/inventory/tests/test_items.py

@@ -0,0 +1,93 @@
+from django.test import TestCase, Client
+
+from files.models import File
+from inventory.models import Event, Container, Item
+
+client = Client()
+
+
+class ItemTestCase(TestCase):
+
+    def setUp(self):
+        super().setUp()
+        self.event = Event.objects.create(slug='EVENT', name='Event')
+        self.box = Container.objects.create(name='BOX')
+
+    def test_empty(self):
+        response = client.get(f'/1/{self.event.slug}/item/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.content, b'[]')
+
+    def test_members(self):
+        item = Item.objects.create(container=self.box, event=self.event, description='1')
+        response = client.get(f'/1/{self.event.slug}/item/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None}])
+
+    def test_members_with_file(self):
+        import base64
+        item = Item.objects.create(container=self.box, event=self.event, description='1')
+        file = File.objects.create(item=item, data=base64.b64encode(b"foo").decode('utf-8'))
+        response = client.get(f'/1/{self.event.slug}/item/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(),
+                         [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': file.hash}])
+
+    def test_multi_members(self):
+        Item.objects.create(container=self.box, event=self.event, description='1')
+        Item.objects.create(container=self.box, event=self.event, description='2')
+        Item.objects.create(container=self.box, event=self.event, description='3')
+        response = client.get(f'/1/{self.event.slug}/item/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()), 3)
+
+    def test_create_item(self):
+        response = client.post(f'/1/{self.event.slug}/item/', {'cid': self.box.cid, 'description': '1'})
+        self.assertEqual(response.status_code, 201)
+        self.assertEqual(response.json(), {'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None})
+        self.assertEqual(len(Item.objects.all()), 1)
+        self.assertEqual(Item.objects.all()[0].uid, 1)
+        self.assertEqual(Item.objects.all()[0].description, '1')
+        self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid)
+
+    #def test_create_item_fail(self):
+    #    response = client.post(f'/1/{self.event.slug}/item/', {'cid': self.box.cid})
+    #    self.assertEqual(response.status_code, 500)
+
+    def test_update_item(self):
+        item = Item.objects.create(container=self.box, event=self.event, description='1')
+        response = client.put(f'/1/{self.event.slug}/item/{item.uid}/', {'description': '2'}, content_type='application/json')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(),
+                         {'uid': 1, 'description': '2', 'box': 'BOX', 'cid': self.box.cid, 'file': None})
+        self.assertEqual(len(Item.objects.all()), 1)
+        self.assertEqual(Item.objects.all()[0].uid, 1)
+        self.assertEqual(Item.objects.all()[0].description, '2')
+        self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid)
+
+    def test_delete_item(self):
+        item = Item.objects.create(container=self.box, event=self.event, description='1')
+        Item.objects.create(container=self.box, event=self.event, description='2')
+        self.assertEqual(len(Item.objects.all()), 2)
+        response = client.delete(f'/1/{self.event.slug}/item/{item.uid}/')
+        self.assertEqual(response.status_code, 204)
+        self.assertEqual(len(Item.objects.all()), 1)
+
+    def test_delete_item2(self):
+        Item.objects.create(container=self.box, event=self.event, description='1')
+        item2 = Item.objects.create(container=self.box, event=self.event, description='2')
+        self.assertEqual(len(Item.objects.all()), 2)
+        response = client.delete(f'/1/{self.event.slug}/item/{item2.uid}/')
+        self.assertEqual(response.status_code, 204)
+        self.assertEqual(len(Item.objects.all()), 1)
+        item3 = Item.objects.create(container=self.box, event=self.event, description='3')
+        self.assertEqual(item3.uid, 2)
+        self.assertEqual(len(Item.objects.all()), 2)
+
+    def test_item_count(self):
+        Item.objects.create(container=self.box, event=self.event, description='1')
+        Item.objects.create(container=self.box, event=self.event, description='2')
+        response = client.get('/1/boxes/')
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.json()), 1)
+        self.assertEqual(response.json()[0]['itemCount'], 2)