Created by user drf mixin (#13)

* add DefaultUserCreateMixin

* better explanation of DefaultUsercreateMixin

* add tests for CreateUser mixin stuff..!

* fix drf req

Author: ckcollab

README.md

@@ -1,6 +1,7 @@
 django-ckc [<img src="https://ckcollab.com/assets/images/badges/badge.svg" alt="CKC" height="20">](https://ckcollab.com)
 ==========
-tools, utilities, etc. we use across projects @ [ckc](https://ckcollab.com)
+tools, utilities
+, etc. we use across projects @ [ckc](https://ckcollab.com)
 
 
 ## installing
@@ -29,10 +30,12 @@ $ ./setup.py sdist
 $ twine upload dist/*
 ```
 
-## run tests
+## tests
 
 ```bash
-$ docker-compose exec django py.test
+# get into a virtual env of some kind
+$ pip install -r requirements.txt
+$ pytest
 ```
 
 ## what's in this
@@ -62,4 +65,3 @@ class MySerializer(DefaultUserCreateMixin, ModelSerializer):
 | command | description|
 | :---        |    :----:   |
 | `upload_file <source> <destination>` | uses `django-storages` settings to upload a file |
-

ckc/serializers.py

@@ -0,0 +1,27 @@
+class DefaultUserCreateMixin:
+    """This will automatically set `YourModel.created_by` to `request.user`. To override which
+    attribute the user is written to, add a `user_field` to your classes Meta information
+    Example:
+        class YourModel(models.Model):
+            owner = models.ForeignKey(User, on_delete=models.CASCADE)
+
+        class MySerializer(DefaultUserCreateMixin, ModelSerializer):
+            class Meta:
+                model = YourModel
+                # YourModel.owner = a foreign key to request.user which differs from the
+                # default `created_by`
+                user_field = 'owner'
+    """
+    def create(self, validated_data):
+        # get name of the user field we'll be writing request.user to, default created_by
+        user_field = getattr(self.Meta, 'user_field', 'created_by')
+
+        assert hasattr(self.Meta.model, user_field), f"{self.Meta.model} needs to have field {user_field} so " \
+                                                     f"DefaultUserCreateMixin can write to it"
+
+        if user_field not in validated_data:
+            if 'request' not in self.context:
+                raise Exception('self.context does not contain "request". Have you overwritten get_serializer_context '
+                                'and overwrote context?')
+            validated_data[user_field] = self.context['request'].user
+        return super().create(validated_data)

requirements.txt

@@ -1,5 +1,11 @@
+# python packaging
 twine==3.1.1
+
+# django stuff
 Django==3.0.7
+djangorestframework==3.12.2
+
+# tests
 pytest==5.4.1
 pytest-django==3.9.0
 pytest-pythonpath==0.7.3

testproject/testapp/models.py

@@ -1,7 +1,19 @@
+from django.contrib.auth import get_user_model
 from django.db import models
 
 from ckc.models import SoftDeletableModel
 
 
-class TestModel(SoftDeletableModel):
+User = get_user_model()
+
+
+class AModel(SoftDeletableModel):
     title = models.CharField(max_length=255, default="I'm a test!")
+
+
+class ModelWithACreator(models.Model):
+    created_by = models.ForeignKey(User, on_delete=models.CASCADE)
+
+
+class ModelWithADifferentNamedCreator(models.Model):
+    owner = models.ForeignKey(User, on_delete=models.CASCADE)

testproject/testapp/serializers.py

@@ -0,0 +1,17 @@
+from rest_framework.serializers import ModelSerializer
+
+from ckc.serializers import DefaultUserCreateMixin
+from testapp.models import ModelWithACreator, ModelWithADifferentNamedCreator
+
+
+class TestModelWithACreatorSerializer(DefaultUserCreateMixin, ModelSerializer):
+    class Meta:
+        model = ModelWithACreator
+        fields = []
+
+
+class TestModelWithADifferentNamedCreatorSerializer(DefaultUserCreateMixin, ModelSerializer):
+    class Meta:
+        model = ModelWithADifferentNamedCreator
+        fields = []
+        user_field = 'owner'

testproject/testapp/viewsets.py

@@ -0,0 +1,14 @@
+from rest_framework.viewsets import ModelViewSet
+
+from testapp.models import ModelWithACreator, ModelWithADifferentNamedCreator
+from testapp.serializers import TestModelWithACreatorSerializer, TestModelWithADifferentNamedCreatorSerializer
+
+
+class TestModelWithACreatorViewSet(ModelViewSet):
+    queryset = ModelWithACreator.objects.all()
+    serializer_class = TestModelWithACreatorSerializer
+
+
+class TestModelWithADifferentNamedCreatorViewSet(ModelViewSet):
+    queryset = ModelWithADifferentNamedCreator.objects.all()
+    serializer_class = TestModelWithADifferentNamedCreatorSerializer

testproject/urls.py

@@ -1 +1,10 @@
-urlpatterns = []
+from rest_framework import routers
+
+from testapp.viewsets import TestModelWithACreatorViewSet, TestModelWithADifferentNamedCreatorViewSet
+
+
+router = routers.SimpleRouter()
+router.register(r'creators', TestModelWithACreatorViewSet)
+router.register(r'creators-alternative', TestModelWithADifferentNamedCreatorViewSet)
+
+urlpatterns = router.urls

tests/integration/test_default_user_create_mixin.py

@@ -0,0 +1,28 @@
+from django.contrib.auth import get_user_model
+from django.urls import reverse
+from rest_framework.test import APITestCase
+
+from testapp.models import ModelWithACreator, ModelWithADifferentNamedCreator
+
+User = get_user_model()
+
+
+class TestDefaultUserCreateMixin(APITestCase):
+
+    def setUp(self):
+        self.user = User.objects.create_user(username="test", password="test")
+        self.client.force_authenticate(self.user)
+
+    def test_default_create_user_mixin_works(self):
+        from django.urls import get_resolver
+        print(get_resolver().reverse_dict.keys())
+
+        resp = self.client.post(reverse('modelwithacreator-list'))
+        print(resp.content)
+        assert resp.status_code == 201
+        assert ModelWithACreator.objects.get(created_by=self.user)
+
+    def test_default_create_user_mixin_with_different_field_name_works(self):
+        resp = self.client.post(reverse('modelwithadifferentnamedcreator-list'))
+        assert resp.status_code == 201
+        assert ModelWithADifferentNamedCreator.objects.get(owner=self.user)

tests/integration/test_soft_delete.py

@@ -1,12 +1,12 @@
 from django.test import TestCase
 
-from testapp.models import TestModel
+from testapp.models import AModel
 
 
 class TestSoftDelete(TestCase):
 
     def test_soft_delete_model_doesnt_really_delete(self):
-        instance = TestModel.objects.create()
+        instance = AModel.objects.create()
         instance.delete()
-        assert not TestModel.objects.filter(pk=instance.pk).exists()
-        assert TestModel.all_objects.filter(pk=instance.pk).exists()
+        assert not AModel.objects.filter(pk=instance.pk).exists()
+        assert AModel.all_objects.filter(pk=instance.pk).exists()