Add tests, including test Django project

Author: supervacuo

Diff for: .gitignore

@@ -1,2 +1,4 @@
 *.pyc
 .DS_Store
+/.tox
+/src/django_sliver.egg-info/

Diff for: setup.py

@@ -1,4 +1,4 @@
-from setuptools import setup
+from setuptools import setup, find_packages
 
 setup(
     name="django-sliver",
@@ -10,14 +10,15 @@
     author_email="[email protected]",
     url="https://github.com/jarcoal/django-sliver",
     license="BSD",
-    packages=["sliver"],
+    package_dir={'': 'src'},
+    packages=find_packages('src'),
     zip_safe=False,
-    install_requires=['django >= 1.3'],
+    install_requires=['django >= 1.11', 'six'],
     include_package_data=True,
     classifiers=[
         "Programming Language :: Python",
         "Topic :: Software Development :: Libraries :: Python Modules",
         "Framework :: Django",
         "Environment :: Web Environment",
     ],
-)
+)

Diff for: sliver/tests.py

@@ -0,0 +1,89 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2012-2013 by Łukasz Langa
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+from unittest.loader import defaultTestLoader
+
+from django.conf import settings
+from django.test import TestCase
+
+try:
+    # Added in Django 1.6
+    from django.test.runner import DiscoverRunner
+    class DiscoveryDjangoTestSuiteRunner(DiscoverRunner):
+        """Unfortunately the new DiscoverRunner doesn't handle custom top level
+        correctly."""
+        def __init__(
+            self, pattern=None, top_level=None, verbosity=1, interactive=True,
+            failfast=False, **kwargs
+        ):
+            self.test_label_default = settings.TEST_DISCOVERY_ROOT
+            if not top_level:
+                top_level = self.test_label_default
+            super(DiscoveryDjangoTestSuiteRunner, self).__init__(
+                pattern=pattern, top_level=top_level, verbosity=verbosity,
+                interactive=interactive, failfast=failfast, **kwargs
+            )
+
+        def build_suite(self, test_labels=None, extra_tests=None, **kwargs):
+            if not test_labels:
+                test_labels = [self.test_label_default]
+            return super(DiscoveryDjangoTestSuiteRunner, self).build_suite(
+                test_labels=test_labels, extra_tests=extra_tests, **kwargs
+            )
+
+except ImportError:
+    # Django < 1.6 compatibility
+    from django.utils.importlib import import_module
+    from django.test.simple import DjangoTestSuiteRunner
+    class DiscoveryDjangoTestSuiteRunner(DjangoTestSuiteRunner):
+        """A test suite runner that uses unittest2 test discovery.
+        Courtesy of @carljm."""
+
+        def build_suite(self, test_labels, extra_tests=None, **kwargs):
+            suite = None
+            discovery_root = settings.TEST_DISCOVERY_ROOT
+
+            if test_labels:
+                suite = defaultTestLoader.loadTestsFromNames(test_labels)
+                # if single named module has no tests, do discovery within it
+                if not suite.countTestCases() and len(test_labels) == 1:
+                    suite = None
+                    discovery_root = import_module(test_labels[0]).__path__[0]
+
+            if suite is None:
+                suite = defaultTestLoader.discover(
+                    discovery_root,
+                    top_level_dir=settings.BASE_PATH,
+                )
+
+            if extra_tests:
+                for test in extra_tests:
+                    suite.addTest(test)
+
+            from django.test.simple import reorder_suite  # Django 1.5 and lower
+            return reorder_suite(suite, (TestCase,))

Diff for: src/_slivertestproject/__init__.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+from django.db import models
+
+
+class Person(models.Model):
+    name = models.CharField(max_length=256)

Diff for: sliver/__init__.py renamed to src/_slivertestproject/app/__init__.py

@@ -0,0 +1,11 @@
+from sliver.views import ModelResource, CollectionResource
+from sliver.mixins import JSONMixin
+
+from .models import Person
+
+
+class PersonCollectionResource(JSONMixin, CollectionResource):
+	model = Person
+
+class PersonResource(JSONMixin, ModelResource):
+	model = Person

Diff for: src/_slivertestproject/app/models.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "_slivertestproject.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

Diff for: src/_slivertestproject/app/views.py

@@ -0,0 +1,147 @@
+DEBUG = True
+TEMPLATE_DEBUG = DEBUG
+
+ADMINS = ()
+
+MANAGERS = ADMINS
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
+        'NAME': ':memory:',                     # Or path to database file if using sqlite3.
+        'USER': '',                      # Not used with sqlite3.
+        'PASSWORD': '',                  # Not used with sqlite3.
+        'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
+        'PORT': '',                      # Set to empty string for default. Not used with sqlite3.
+    }
+}
+
+# Local time zone for this installation. Choices can be found here:
+# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
+# although not all choices may be available on all operating systems.
+# On Unix systems, a value of None will cause Django to use the same
+# timezone as the operating system.
+# If running in a Windows environment this must be set to the same as your
+# system time zone.
+TIME_ZONE = 'America/Chicago'
+
+# Language code for this installation. All choices can be found here:
+# http://www.i18nguy.com/unicode/language-identifiers.html
+LANGUAGE_CODE = 'en-us'
+
+SITE_ID = 1
+
+# If you set this to False, Django will make some optimizations so as not
+# to load the internationalization machinery.
+USE_I18N = False
+
+# If you set this to False, Django will not format dates, numbers and
+# calendars according to the current locale
+USE_L10N = True
+
+# Absolute filesystem path to the directory that will hold user-uploaded files.
+# Example: "/home/media/media.lawrence.com/media/"
+MEDIA_ROOT = ''
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash.
+# Examples: "http://media.lawrence.com/media/", "http://example.com/media/"
+MEDIA_URL = ''
+
+# Absolute path to the directory static files should be collected to.
+# Don't put anything in this directory yourself; store your static files
+# in apps' "static/" subdirectories and in STATICFILES_DIRS.
+# Example: "/home/media/media.lawrence.com/static/"
+STATIC_ROOT = ''
+
+# URL prefix for static files.
+# Example: "http://media.lawrence.com/static/"
+STATIC_URL = '/static/'
+
+# Additional locations of static files
+STATICFILES_DIRS = (
+    # Put strings here, like "/home/html/static" or "C:/www/django/static".
+    # Always use forward slashes, even on Windows.
+    # Don't forget to use absolute paths, not relative paths.
+)
+
+# List of finder classes that know how to find static files in
+# various locations.
+STATICFILES_FINDERS = (
+    'django.contrib.staticfiles.finders.FileSystemFinder',
+    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
+#    'django.contrib.staticfiles.finders.DefaultStorageFinder',
+)
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = 'dqro09o2k7eha5px#h_t75ji)qmz3va)tdk!91tn7-%f99=qj&'
+
+# List of callables that know how to import templates from various sources.
+TEMPLATE_LOADERS = (
+    'django.template.loaders.filesystem.Loader',
+    'django.template.loaders.app_directories.Loader',
+#     'django.template.loaders.eggs.Loader',
+)
+
+MIDDLEWARE_CLASSES = (
+    'django.middleware.common.CommonMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+)
+
+ROOT_URLCONF = '_slivertestproject.urls'
+
+TEMPLATE_DIRS = (
+    # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
+    # Always use forward slashes, even on Windows.
+    # Don't forget to use absolute paths, not relative paths.
+)
+
+INSTALLED_APPS = (
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.sites',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'sliver',
+    '_slivertestproject.app',
+)
+
+# A sample logging configuration. The only tangible logging
+# performed by this configuration is to send an email to
+# the site admins on every HTTP 500 error.
+# See http://docs.djangoproject.com/en/dev/topics/logging for
+# more details on how to customize your logging configuration.
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'filters': {
+        'require_debug_false': {
+            '()': 'django.utils.log.RequireDebugFalse'
+        }
+    },
+    'handlers': {
+        'mail_admins': {
+            'level': 'ERROR',
+            'filters': ['require_debug_false'],
+            'class': 'django.utils.log.AdminEmailHandler'
+        }
+    },
+    'loggers': {
+        'django.request': {
+            'handlers': ['mail_admins'],
+            'level': 'ERROR',
+            'propagate': True,
+        },
+    }
+}
+
+import os
+import sliver
+
+BASE_PATH = os.path.realpath(os.path.join(os.path.dirname(__file__), '..'))
+TEST_DISCOVERY_ROOT = os.path.realpath(os.path.dirname(sliver.__file__))
+TEST_RUNNER = "_slivertestproject.DiscoveryDjangoTestSuiteRunner"

Diff for: src/_slivertestproject/manage.py

@@ -0,0 +1,8 @@
+from django.conf.urls import url
+
+from app.views import PersonCollectionResource, PersonResource
+
+urlpatterns = [
+	url(r'^people/$', PersonCollectionResource.as_view(), name='api-people-collection'),
+	url(r'^people/(?P<pk>\d+)/$', PersonResource.as_view(), name='api-people-model'),
+]

Diff for: src/_slivertestproject/settings.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""Tests for sliver."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+import json
+import six
+
+from django.core.urlresolvers import reverse
+from django.test import TestCase
+
+
+class SimpleTest(TestCase):
+    def test_dummy(self):
+        """Just see if the import works as expected."""
+        import sliver
+
+    def test_collection(self):
+        from _slivertestproject.app.models import Person
+        person = Person.objects.create(name='Juan')
+        r = self.client.get(
+            reverse('api-people-collection')
+        )
+
+        self.assertEqual(
+            json.loads(r.content),
+            [{'name': 'Juan', 'id': 1}]
+        )
+
+    def test_model(self):
+        from _slivertestproject.app.models import Person
+        person = Person.objects.create(name='Juan')
+        r = self.client.get(
+            reverse('api-people-model', kwargs={'pk': person.pk})
+        )
+
+        self.assertEqual(
+            json.loads(r.content),
+            {'name': 'Juan', 'id': 1}
+        )

Diff for: src/_slivertestproject/urls.py

@@ -0,0 +1,15 @@
+[tox]
+envlist =
+    py37-django{200,202},
+    {py27,py37}-django{110,111},
+
+[testenv]
+commands =
+  {envbindir}/django-admin.py test --pythonpath=src/
+setenv =
+  DJANGO_SETTINGS_MODULE=_slivertestproject.settings
+deps =
+    django110: Django==1.10.8
+    django111: Django==1.11.26
+    django200: Django==2.0.13
+    django202: Django==2.2.7