Merge pull request #3 from easy-as-python/django-compatibility-update

Updates for Django 1.10+ and Django 2.0+ compatibility

Author: daneah

.travis.yml

@@ -2,5 +2,15 @@ language: python
 python:
   - "3.4"
   - "3.5"
+  - "3.6"
+env:
+  - DJANGO_VERSION=1.8.18
+  - DJANGO_VERSION=1.9.13
+  - DJANGO_VERSION=1.10.8
+  - DJANGO_VERSION=1.11.9
+  - DJANGO_VERSION=2.0.1
+install:
+  - pip install -r requirements.txt
+  - pip install Django==$DJANGO_VERSION
 script:
   - python runtests.py

README.md

@@ -9,11 +9,14 @@
 * Add `webmention` to `INSTALLED_APPS`
 * Run `manage.py migrate webmention`
 * Add `url(r'^webmention', include('webmention.urls', namespace='webmention'))` to top-level `urls.py`
+    * Use `path('webmention/', include(webmention.urls))` for newer projects
 * Run `manage.py test webmention` to ensure unit tests all pass 
 
 ## Usage
 
 * Include webmention information by either:
-    * Adding `webmention.middleware.WebMentionMiddleware` to `MIDDLEWARE_CLASSES` (affects all views)
+    * Installing the middleware in `settings.py` (affects all views)
+        * Use `webmention.middleware.webmention_middleware` in `MIDDLEWARE` for new projects and projects with Django >= 1.10
+        * Use `webmention.middleware.WebMentionMiddleware` in `MIDDLEWARE_CLASSES` for older projects
     * Decorating a specific view with `webmention.middleware.include_webmention_information`
 * View webmention responses in the Django admin tool and mark them as reviewed as needed

setup.py

@@ -11,26 +11,30 @@
 
 setup(
     name='django-webmention',
-    version='0.0.4',
+    version='0.1.0',
     packages=find_packages(),
     description='A pluggable implementation of webmention for Django projects.',
     keywords='webmention pingback linkback blogging',
     author='Dane Hillard',
     author_email='[email protected]',
     long_description=readme,
     install_requires=requirements,
-    url='https://github.com/daneah/django-webmention',
+    url='https://github.com/easy-as-python/django-webmention',
     license='MIT',
     classifiers=[
         'Development Status :: 2 - Pre-Alpha',
         'Intended Audience :: Developers',
         'Framework :: Django',
         'Framework :: Django :: 1.8',
         'Framework :: Django :: 1.9',
+        'Framework :: Django :: 1.10',
+        'Framework :: Django :: 1.11',
+        'Framework :: Django :: 2.0',
         'Topic :: Internet :: WWW/HTTP :: Indexing/Search',
         'License :: OSI Approved :: MIT License',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
     ],
 )

webmention/__init__.py

@@ -0,0 +1 @@
+from . import checks

webmention/checks.py

@@ -0,0 +1,20 @@
+import django
+from django.conf import settings
+from django.core.checks import Error, register, Tags
+
+
+@register(Tags.compatibility)
+def new_style_middleware_check(app_configs, **kwargs):
+    errors = []
+
+    if django.VERSION[1] >= 10 or django.VERSION[0] > 1:
+        installed_middlewares = getattr(settings, 'MIDDLEWARE', []) or []
+        if 'webmention.middleware.WebMentionMiddleware' in installed_middlewares:
+            errors.append(
+                Error(
+                    'You are attempting to use an old-style middleware class in the MIDDLEWARE setting',
+                    hint='Either use MIDDLEWARE_CLASSES or use webmention.middleware.webmention_middleware instead',
+                    id='webmention.E001',
+                )
+            )
+    return errors

webmention/middleware.py

@@ -1,9 +1,12 @@
-from django.core.urlresolvers import reverse
 from django.utils.decorators import decorator_from_middleware
 
+try:
+    from django.core.urlresolvers import reverse
+except ImportError:
+    from django.urls import reverse
 
-class WebMentionMiddleware(object):
-    def process_response(self, request, response):
+
+def add_webmention_headers_to_response(request, response):
         link_header = '<{scheme}://{host}{path}>; rel="webmention"'.format(
             scheme=request.scheme,
             host=request.META.get('HTTP_HOST'),
@@ -16,4 +19,18 @@ def process_response(self, request, response):
 
         return response
 
+
+class WebMentionMiddleware(object):
+    def process_response(self, request, response):
+        return add_webmention_headers_to_response(request, response)
+
+
+def webmention_middleware(get_response):
+    def middleware(request):
+        response = get_response(request)
+        return add_webmention_headers_to_response(request, response)
+
+    return middleware
+
+
 include_webmention_information = decorator_from_middleware(WebMentionMiddleware)

webmention/resolution.py

@@ -1,7 +1,11 @@
 import requests
 
 from urllib.parse import urlparse
-from django.core.urlresolvers import resolve, Resolver404
+
+try:
+    from django.core.urlresolvers import resolve, Resolver404
+except ImportError:
+    from django.urls import resolve, Resolver404
 
 
 def url_resolves(url):

webmention/templatetags/__init__.py

@@ -1,5 +1,9 @@
 from unittest.mock import Mock
-from django.core.urlresolvers import reverse
+
+try:
+    from django.core.urlresolvers import reverse
+except ImportError:
+    from django.urls import reverse
 
 from django.http import HttpResponse
 from django.test import TestCase, Client

webmention/templatetags/webmention.py

@@ -1,5 +1,9 @@
 from unittest.mock import Mock, patch
-from django.core.urlresolvers import Resolver404
+
+try:
+    from django.core.urlresolvers import Resolver404
+except ImportError:
+    from django.urls import Resolver404
 
 from django.test import TestCase
 

webmention/tests/test_middleware.py

@@ -2,6 +2,10 @@
 
 from . import views
 
+
+app_name = 'webmention'
+
+
 urlpatterns = [
     url(r'^receive$', views.receive, name='receive'),
 ]

webmention/tests/test_resolution.py

@@ -25,7 +25,7 @@ def receive(request):
 
             response_body = fetch_and_validate_source(source, target)
             webmention.update(source, target, response_body)
-            return HttpResponse(status_code=202, reason_phrase='The webmention was successfully received')
+            return HttpResponse('The webmention was successfully received', status=202)
         except (SourceFetchError, TargetNotFoundError) as e:
             webmention.invalidate()
             return HttpResponseBadRequest(str(e))