Merge pull request #88 from django-json-api/feature/test-all-versions

Automatically test combinations of Python 2.7+, Django 1.6+, and DRF 3.1+

Author: jsenecal

.gitignore

@@ -26,4 +26,7 @@ pip-log.txt
 pip-delete-this-directory.txt
 
 # Pycharm project files
-.idea/
+.idea/
+
+# Tox
+.tox/

.travis.yml

@@ -1,9 +1,27 @@
 language: python
 sudo: false
-python:
-  - "2.7"
-  - "3.3"
-  - "3.4"
-install:
-  - pip install -e .
-script: python runtests.py
+install: pip install tox
+script: tox
+env:
+  - TOXENV=py27-django16-drf31
+  - TOXENV=py27-django16-drf32
+  - TOXENV=py32-django16-drf31
+  - TOXENV=py32-django16-drf32
+  - TOXENV=py33-django16-drf31
+  - TOXENV=py33-django16-drf32
+  - TOXENV=py27-django17-drf31
+  - TOXENV=py27-django17-drf32
+  - TOXENV=py32-django17-drf31
+  - TOXENV=py32-django17-drf32
+  - TOXENV=py33-django17-drf31
+  - TOXENV=py33-django17-drf32
+  - TOXENV=py34-django17-drf31
+  - TOXENV=py34-django17-drf32
+  - TOXENV=py27-django18-drf31
+  - TOXENV=py27-django18-drf32
+  - TOXENV=py32-django18-drf31
+  - TOXENV=py32-django18-drf32
+  - TOXENV=py33-django18-drf31
+  - TOXENV=py33-django18-drf32
+  - TOXENV=py34-django18-drf31
+  - TOXENV=py34-django18-drf32

docs/getting-started.md

@@ -53,7 +53,7 @@ like the following:
 
 1. Python >= 2.7
 2. Django
-3. Django REST Framework >= 2.4
+3. Django REST Framework >= 3.1
 
 ## Installation
 

example/api/resources/identity.py

@@ -1,4 +1,6 @@
 from django.contrib.auth import models as auth_models
+from django.utils import encoding
+
 from rest_framework import viewsets, generics, renderers, parsers, serializers
 from rest_framework.decorators import list_route, detail_route
 from rest_framework.response import Response
@@ -31,8 +33,8 @@ def posts(self, request):
         posts = [{'id': 1, 'title': 'Test Blog Post'}]
 
         data = {
-            u'identities': IdentitySerializer(identities, many=True).data,
-            u'posts': PostSerializer(posts, many=True).data,
+            encoding.force_text('identities'): IdentitySerializer(identities, many=True).data,
+            encoding.force_text('posts'): PostSerializer(posts, many=True).data,
         }
         return Response(utils.format_keys(data, format_type='camelize'))
 

example/api/urls.py

@@ -1,18 +0,0 @@
-"""
-Example app URLs
-"""
-from django.conf.urls import patterns, include, url
-from rest_framework import routers
-from .resources.identity import Identity, GenericIdentity
-
-router = routers.DefaultRouter(trailing_slash=False)
-
-router.register(r'identities', Identity)
-
-urlpatterns = router.urls
-
-urlpatterns += patterns('',
-    url(r'identities/default/(?P<pk>\d+)',
-        GenericIdentity.as_view(), name='user-default'),
-)
-

example/factories/__init__.py

@@ -0,0 +1,13 @@
+# -*- encoding: utf-8 -*-
+from __future__ import unicode_literals
+
+import factory
+
+from example.models import Blog
+
+
+class BlogFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = Blog
+
+    name = "Blog 1"

example/models.py

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models
+from django.utils.encoding import python_2_unicode_compatible
+
+
+class BaseModel(models.Model):
+    """
+    I hear RoR has this by default, who doesn't need these two fields!
+    """
+    created_at = models.DateTimeField(auto_now_add=True)
+    modified_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        abstract = True
+
+
+@python_2_unicode_compatible
+class Blog(BaseModel):
+    name = models.CharField(max_length=100)
+    tagline = models.TextField()
+
+    def __str__(self):
+        return self.name
+
+
+@python_2_unicode_compatible
+class Author(BaseModel):
+    name = models.CharField(max_length=50)
+    email = models.EmailField()
+
+    def __str__(self):
+        return self.name
+
+
+@python_2_unicode_compatible
+class Entry(BaseModel):
+    blog = models.ForeignKey(Blog)
+    headline = models.CharField(max_length=255)
+    body_text = models.TextField()
+    pub_date = models.DateField()
+    mod_date = models.DateField()
+    authors = models.ManyToManyField(Author)
+    n_comments = models.IntegerField()
+    n_pingbacks = models.IntegerField()
+    rating = models.IntegerField()
+
+    def __str__(self):
+        return self.headline

example/serializers.py

@@ -0,0 +1,7 @@
+from rest_framework import serializers
+
+
+class BlogSerializer(serializers.Serializer):
+
+    class Meta:
+        fields = ('name', )

example/settings.py

@@ -22,10 +22,10 @@
     'django.contrib.auth',
     'django.contrib.admin',
     'rest_framework',
-    'example.api',
+    'example',
 ]
 
-ROOT_URLCONF = 'example.api.urls'
+ROOT_URLCONF = 'example.urls'
 
 SECRET_KEY = 'abc123'
 

example/tests/conftest.py

@@ -0,0 +1,5 @@
+from pytest_factoryboy import register
+
+from example.factories import BlogFactory
+
+register(BlogFactory)