Rewrite schema generation (#1)

* Completeley rewritten schema generation
* Added support for python 2.7 and 3.4
* Restructured testing and build configuration
* Added nested request schemas

This rewrite completely replaces the public interface of the django rest schema generation library, so 
further changes will be needed to re-enable and further extend the customization points one might want.

testproj/articles/migrations/0001_initial.py

@@ -0,0 +1,26 @@
+# Generated by Django 2.0 on 2017-12-05 04:05
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Article',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.CharField(help_text='Main article headline', max_length=255, unique=True)),
+                ('body', models.TextField(help_text='Article content', max_length=5000)),
+                ('slug', models.SlugField(blank=True, help_text='Unique URL slug identifying the article', unique=True)),
+                ('date_created', models.DateTimeField(auto_now_add=True)),
+                ('date_modified', models.DateTimeField(auto_now=True)),
+                ('cover', models.ImageField(blank=True, upload_to='article/original/')),
+            ],
+        ),
+    ]

testproj/articles/models.py

@@ -0,0 +1,11 @@
+from django.db import models
+
+
+class Article(models.Model):
+    title = models.CharField(help_text="title model help_text", max_length=255, blank=False, unique=True)
+    body = models.TextField(help_text="article model help_text", max_length=5000, blank=False)
+    slug = models.SlugField(help_text="slug model help_text", unique=True, blank=True)
+    date_created = models.DateTimeField(auto_now_add=True)
+    date_modified = models.DateTimeField(auto_now=True)
+
+    cover = models.ImageField(upload_to='article/original/', blank=True)

testproj/articles/serializers.py

@@ -0,0 +1,16 @@
+from rest_framework import serializers
+
+from articles.models import Article
+
+
+class ArticleSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Article
+        fields = ('title', 'body', 'slug', 'date_created', 'date_modified')
+        read_only_fields = ('date_created', 'date_modified')
+        lookup_field = 'slug'
+        extra_kwargs = {'body': {'help_text': 'body serializer help_text'}}
+
+
+class ImageUploadSerializer(serializers.Serializer):
+    upload = serializers.ImageField(help_text="image serializer help_text")

testproj/articles/urls.py

@@ -0,0 +1,11 @@
+from django.conf.urls import include, url
+from rest_framework.routers import SimpleRouter
+
+from articles import views
+
+router = SimpleRouter()
+router.register('', views.ArticleViewSet)
+
+urlpatterns = [
+    url(r'^', include(router.urls)),
+]

testproj/articles/views.py

@@ -0,0 +1,60 @@
+import datetime
+
+from django_filters.rest_framework import DjangoFilterBackend, filters
+from rest_framework import viewsets
+from rest_framework.decorators import detail_route, list_route
+from rest_framework.pagination import LimitOffsetPagination
+from rest_framework.parsers import MultiPartParser
+from rest_framework.response import Response
+
+from articles import serializers
+from articles.models import Article
+
+
+class ArticleViewSet(viewsets.ModelViewSet):
+    """
+    ArticleViewSet class docstring
+
+    retrieve:
+    retrieve class docstring
+
+    destroy:
+    destroy class docstring
+    """
+    queryset = Article.objects.all()
+    lookup_field = 'slug'
+    serializer_class = serializers.ArticleSerializer
+
+    pagination_class = LimitOffsetPagination
+    max_page_size = 5
+    filter_backends = (DjangoFilterBackend, filters.OrderingFilter)
+    filter_fields = ('title',)
+    ordering_fields = ('date_modified',)
+    ordering = ('username',)
+
+    @list_route(methods=['get'])
+    def today(self, request):
+        today_min = datetime.datetime.combine(datetime.date.today(), datetime.time.min)
+        today_max = datetime.datetime.combine(datetime.date.today(), datetime.time.max)
+        articles = self.get_queryset().filter(date_created__range=(today_min, today_max)).all()
+        serializer = self.serializer_class(articles, many=True)
+        return Response(serializer.data)
+
+    @detail_route(
+        methods=['get', 'post'],
+        parser_classes=(MultiPartParser,),
+        serializer_class=serializers.ImageUploadSerializer,
+    )
+    def image(self, request, slug=None):
+        """
+        image method docstring
+        """
+        pass
+
+    def update(self, request, *args, **kwargs):
+        """update method docstring"""
+        return super(ArticleViewSet, self).update(request, *args, **kwargs)
+
+    def destroy(self, request, *args, **kwargs):
+        """destroy method docstring"""
+        return super(ArticleViewSet, self).destroy(request, *args, **kwargs)

testproj/snippets/migrations/0002_auto_20171205_0505.py

@@ -0,0 +1,27 @@
+# Generated by Django 2.0 on 2017-12-05 04:05
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('snippets', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='snippet',
+            name='owner',
+            field=models.ForeignKey(default='', on_delete=django.db.models.deletion.CASCADE, related_name='snippets', to=settings.AUTH_USER_MODEL),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name='snippet',
+            name='code',
+            field=models.TextField(help_text='code model help text'),
+        ),
+    ]

testproj/snippets/models.py

@@ -9,11 +9,12 @@ STYLE_CHOICES = sorted((item, item) for item in get_all_styles())
 
 class Snippet(models.Model):
     created = models.DateTimeField(auto_now_add=True)
+    owner = models.ForeignKey('auth.User', related_name='snippets', on_delete=models.CASCADE)
     title = models.CharField(max_length=100, blank=True, default='')
-    code = models.TextField()
+    code = models.TextField(help_text="code model help text")
     linenos = models.BooleanField(default=False)
     language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
     style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)
 
     class Meta:
-        ordering = ('created', )
+        ordering = ('created',)

testproj/snippets/serializers.py

@@ -18,7 +18,8 @@ class SnippetSerializer(serializers.Serializer):
 
     create: docstring for create from serializer classdoc
     """
-    id = serializers.IntegerField(read_only=True, help_text="id help text")
+    id = serializers.IntegerField(read_only=True, help_text="id serializer help text")
+    owner = serializers.ReadOnlyField(source='owner.username')
     title = serializers.CharField(required=False, allow_blank=True, max_length=100)
     code = serializers.CharField(style={'base_template': 'textarea.html'})
     linenos = serializers.BooleanField(required=False)

testproj/snippets/views.py

@@ -1,4 +1,5 @@
 from rest_framework import generics
+
 from snippets.models import Snippet
 from snippets.serializers import SnippetSerializer
 
@@ -8,9 +9,12 @@ class SnippetList(generics.ListCreateAPIView):
     queryset = Snippet.objects.all()
     serializer_class = SnippetSerializer
 
+    def perform_create(self, serializer):
+        serializer.save(owner=self.request.user)
+
     def post(self, request, *args, **kwargs):
         """post method docstring"""
-        return super().post(request, *args, **kwargs)
+        return super(SnippetList, self).post(request, *args, **kwargs)
 
 
 class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
@@ -28,8 +32,8 @@ class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
 
     def patch(self, request, *args, **kwargs):
         """patch method docstring"""
-        return super().patch(request, *args, **kwargs)
+        return super(SnippetDetail, self).patch(request, *args, **kwargs)
 
     def delete(self, request, *args, **kwargs):
         """delete method docstring"""
-        return super().patch(request, *args, **kwargs)
+        return super(SnippetDetail, self).patch(request, *args, **kwargs)

testproj/testproj/settings.py

@@ -30,7 +30,9 @@ INSTALLED_APPS = [
     'corsheaders',
 
     'drf_swagger',
-    'snippets'
+    'snippets',
+    'users',
+    'articles',
 ]
 
 MIDDLEWARE = [
@@ -42,6 +44,7 @@ MIDDLEWARE = [
     'django.contrib.auth.middleware.AuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'drf_swagger.middleware.SwaggerExceptionMiddleware',
 ]
 
 ROOT_URLCONF = 'testproj.urls'

testproj/testproj/tests.py

@@ -1,91 +0,0 @@
-import json
-
-from django.test import TestCase
-from ruamel import yaml
-
-from drf_swagger import openapi, codecs
-from drf_swagger.generators import OpenAPISchemaGenerator
-
-
-class SchemaGeneratorTest(TestCase):
-    def setUp(self):
-        self.generator = OpenAPISchemaGenerator(
-            info=openapi.Info("Test generator", "v1"),
-            version="v2",
-        )
-        self.codec_json = codecs.OpenAPICodecJson(['flex', 'ssv'])
-        self.codec_yaml = codecs.OpenAPICodecYaml(['ssv', 'flex'])
-
-    def _validate_schema(self, swagger):
-        from flex.core import parse as validate_flex
-        from swagger_spec_validator.validator20 import validate_spec as validate_ssv
-
-        validate_flex(swagger)
-        validate_ssv(swagger)
-
-    def test_schema_generates_without_errors(self):
-        self.generator.get_schema(None, True)
-
-    def test_schema_is_valid(self):
-        swagger = self.generator.get_schema(None, True)
-        self.codec_yaml.encode(swagger)
-
-    def test_invalid_schema_fails(self):
-        bad_generator = OpenAPISchemaGenerator(
-            info=openapi.Info(
-                "Test generator", "v1",
-                contact=openapi.Contact(name=69, email=[])
-            ),
-            version="v2",
-        )
-
-        swagger = bad_generator.get_schema(None, True)
-        with self.assertRaises(codecs.SwaggerValidationError):
-            self.codec_json.encode(swagger)
-
-    def test_json_codec_roundtrip(self):
-        swagger = self.generator.get_schema(None, True)
-        json_bytes = self.codec_json.encode(swagger)
-        self._validate_schema(json.loads(json_bytes.decode('utf-8')))
-
-    def test_yaml_codec_roundtrip(self):
-        swagger = self.generator.get_schema(None, True)
-        json_bytes = self.codec_yaml.encode(swagger)
-        self._validate_schema(yaml.safe_load(json_bytes.decode('utf-8')))
-
-
-class SchemaTest(TestCase):
-    def setUp(self):
-        self.generator = OpenAPISchemaGenerator(
-            info=openapi.Info("Test generator", "v1"),
-            version="v2",
-        )
-        self.codec_json = codecs.OpenAPICodecJson(['flex', 'ssv'])
-        self.codec_yaml = codecs.OpenAPICodecYaml(['ssv', 'flex'])
-
-        self.swagger = self.generator.get_schema(None, True)
-        json_bytes = self.codec_yaml.encode(self.swagger)
-        self.swagger_dict = yaml.safe_load(json_bytes.decode('utf-8'))
-
-    def test_paths_not_empty(self):
-        self.assertTrue(bool(self.swagger_dict['paths']))
-
-    def test_appropriate_status_codes(self):
-        snippets_list = self.swagger_dict['paths']['/snippets/']
-        self.assertTrue('200' in snippets_list['get']['responses'])
-        self.assertTrue('201' in snippets_list['post']['responses'])
-        snippets_detail = self.swagger_dict['paths']['/snippets/{id}/']
-        self.assertTrue('200' in snippets_detail['get']['responses'])
-        self.assertTrue('200' in snippets_detail['put']['responses'])
-        self.assertTrue('200' in snippets_detail['patch']['responses'])
-        self.assertTrue('204' in snippets_detail['delete']['responses'])
-
-    def test_operation_docstrings(self):
-        snippets_list = self.swagger_dict['paths']['/snippets/']
-        self.assertEqual(snippets_list['get']['description'], "SnippetList classdoc")
-        self.assertEqual(snippets_list['post']['description'], "post method docstring")
-        snippets_detail = self.swagger_dict['paths']['/snippets/{id}/']
-        self.assertEqual(snippets_detail['get']['description'], "SnippetDetail classdoc")
-        self.assertEqual(snippets_detail['put']['description'], "put class docstring")
-        self.assertEqual(snippets_detail['patch']['description'], "patch method docstring")
-        self.assertEqual(snippets_detail['delete']['description'], "delete method docstring")

testproj/testproj/urls.py

@@ -1,10 +1,10 @@
 from django.conf.urls import url, include
 from django.contrib import admin
-
-from drf_swagger.views import get_schema_view
-from drf_swagger import openapi
 from rest_framework import permissions
 
+from drf_swagger import openapi
+from drf_swagger.views import get_schema_view
+
 schema_view = get_schema_view(
     openapi.Info(
         title="Snippets API",
@@ -14,16 +14,18 @@ schema_view = get_schema_view(
         contact=openapi.Contact(email="contact@snippets.local"),
         license=openapi.License(name="BSD License"),
     ),
-    validators=['flex', 'ssv'],
-    public=False,
+    validators=['ssv', 'flex'],
+    public=True,
     permission_classes=(permissions.AllowAny,),
 )
 
 urlpatterns = [
-    url(r'^swagger(?P<format>.json|.yaml)$', schema_view.without_ui(cache_timeout=None), name='schema-json'),
-    url(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=None), name='schema-swagger-ui'),
+    url(r'^swagger(?P<format>.json|.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),
+    url(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
     url(r'^redoc/$', schema_view.with_ui('redoc', cache_timeout=None), name='schema-redoc'),
 
     url(r'^admin/', admin.site.urls),
     url(r'^snippets/', include('snippets.urls')),
+    url(r'^articles/', include('articles.urls')),
+    url(r'^users/', include('users.urls')),
 ]

testproj/users/serializers.py

@@ -0,0 +1,12 @@
+from django.contrib.auth.models import User
+from rest_framework import serializers
+
+from snippets.models import Snippet
+
+
+class UserSerializer(serializers.ModelSerializer):
+    snippets = serializers.PrimaryKeyRelatedField(many=True, queryset=Snippet.objects.all())
+
+    class Meta:
+        model = User
+        fields = ('id', 'username', 'snippets')

testproj/users/urls.py

@@ -0,0 +1,8 @@
+from django.conf.urls import url
+
+from users import views
+
+urlpatterns = [
+    url(r'^$', views.UserList.as_view()),
+    url(r'^(?P<pk>[0-9]+)/$', views.user_detail),
+]

testproj/users/views.py

@@ -0,0 +1,24 @@
+from django.contrib.auth.models import User
+from rest_framework.decorators import api_view
+from rest_framework.generics import get_object_or_404
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from users.serializers import UserSerializer
+
+
+class UserList(APIView):
+    """UserList cbv classdoc"""
+
+    def get(self, request):
+        queryset = User.objects.all()
+        serializer = UserSerializer(queryset, many=True)
+        return Response(serializer.data)
+
+
+@api_view(['GET'])
+def user_detail(request, pk):
+    """user_detail fbv docstring"""
+    user = get_object_or_404(User.objects, pk=pk)
+    serializer = UserSerializer(user)
+    return Response(serializer.data)