adding query string support to URL redirects

.gitignore

@@ -3,6 +3,10 @@
 *.pot
 *.py[co]
 
-htmlcov/
+.coverage
+.coveralls.yml
+
 dist/
+htmlcov/
+coverage/
 django_url_tracker.egg-info/

.travis.yml

@@ -0,0 +1,18 @@
+language: python
+python:
+  - "2.6"
+  - "2.7"
+env:
+  - DJANGO_VERSION="1.3.7"
+  - DJANGO_VERSION="1.4.5"
+  - DJANGO_VERSION="1.5"
+# command to install dependencies
+install:
+    # NOTE: easy_install *will* downgrade if setup.py specifies a max version
+    # # This leads to seemingly passing tests
+  - easy_install Django==$DJANGO_VERSION
+# command to run tests
+script:
+  - make travis
+after_script:
+  - coveralls

AUTHORS

@@ -1,5 +1,6 @@
 AUTHOR
 
-    * Sebastian Vetter (elbaschid)
+   * Sebastian Vetter (elbaschid)
+   * Saul Shanabrook (saulshanabrook)
 
 CONTRIBUTORS

CHANGELOG.rst

@@ -0,0 +1,29 @@
+=========
+Changelog
+=========
+
+0.1.4
+-----
+
+* Changed URL record fields from ``CharField`` to ``TextField``
+* Improved admin interface
+
+0.1.3
+-----
+
+* Increased the max length of the old and new URL database fields to match
+  Django's redirects app (200).
+
+0.1.2
+-----
+
+* The middleware now supports URLs that contain a query string and
+  redirect using 301 or 410 as with other URLs now. That means it
+  is possible to redirect ``/some/old/url/using.php?with=query&in=string``
+  to a shiny new URL.
+
+
+0.1.1
+-----
+
+* Initial release of the package

MANIFEST.in

@@ -1,2 +1 @@
-include README.rst LICENSE AUTHORS *.rst
-recursive-include tests *
+include LICENSE AUTHORS *.rst

Makefile

@@ -0,0 +1,16 @@
+install:
+	python setup.py develop
+	pip install -r requirements.txt --use-mirrors
+
+tests: install
+	python run_tests.py --with-specplugin
+
+coverage: install
+	python run_tests.py --with-coverage --cover-package=url_tracker \
+	 		    --with-specplugin --no-spec-color \
+			    --cover-html --cover-html-dir=coverage
+
+travis: coverage
+	coveralls
+
+.PHONY: install tests travis coverage

README.rst

@@ -1,6 +1,12 @@
 django-url-tracker
 ==================
 
+.. image:: https://travis-ci.org/elbaschid/django-url-tracker.png
+    :target: https://travis-ci.org/elbaschid/django-url-tracker
+
+.. image:: https://coveralls.io/repos/elbaschid/django-url-tracker/badge.png?branch=master
+    :target: https://coveralls.io/r/elbaschid/django-url-tracker
+
 The ``django-url-tracker`` is meant to be a easy-to-use addition to
 a website to enhance its SEO. This might seem slightly pointless
 as `Cool URIs don't change
@@ -95,13 +101,23 @@ the model::
         def get_absolute_url(self):
             return ('project-detail', (), {'slug': self.slug})
 
-And now the missing link to actually start tracking URL changes is adding
-the following command to the bottom of the class definition, or the file
-for that matter::
+And now the missing link to actually start tracking URL changes. Add the
+``URLTrackingMixin`` to your model and add the following command to the
+bottom of the class definition (or the file if you prefer that)::
 
     import url_tracker
+
+    class Project(url_tracker.URLTrackingMixin, models.Model):
+        ...
+
     url_tracker.track_url_changes_for_model(Project)
 
+
+To change which functions are called to tracks urls, add a
+``url_tracking_methods`` attribute to the clast, which is a list of
+method names to track. By default the the list contains
+``get_absolute_url``.
+
 You are done. If you go to the admin interface, create a new project
 and then change its slug (which changes its URL) you will see a new
 ``URLChangeRecord`` reflecting the change. Opening the ``old_url`` should
@@ -120,4 +136,12 @@ Create a new branch for your feature::
 
     git commit -b feature/whatever-you-like
 
+Then make sure all the tests past (and write new ones for any new features)::
+
+    make tests
+
 push the finished feature to github and open a pull request form the branch.
+
+If you make a change to models.py that requires a database migration,
+use ``django-mini.py -p --app url_tracker --app south schemamigration
+url_tracker --auto`` to create a south migration.

requirements.txt

@@ -0,0 +1,9 @@
+argparse==1.2.1
+coverage==3.5.2
+mock==1.0b1
+wsgiref==0.1.2
+tox==1.4.2
+django-mini==0.4
+spec==0.10.0
+django-nose==1.1
+coveralls==0.1.1

run_tests.py

@@ -4,17 +4,17 @@
 import logging
 logging.disable(logging.CRITICAL)
 
-from argparse import ArgumentParser 
+from argparse import ArgumentParser
 from coverage import coverage
 
 import tests.config
-from django.test.simple import DjangoTestSuiteRunner
+from django_nose import NoseTestSuiteRunner
 
 
 def run_tests(verbosity, *test_args):
     if not test_args:
         test_args = ['url_tracker']
-    test_runner = DjangoTestSuiteRunner(verbosity=verbosity)
+    test_runner = NoseTestSuiteRunner(verbosity=verbosity)
     num_failures = test_runner.run_tests(test_args)
     if num_failures:
         sys.exit(num_failures)
@@ -38,4 +38,5 @@ def run_tests(verbosity, *test_args):
         c.html_report()
     else:
         print 'Running tests'
+        args += ['--with-specplugin', '-s', '-x']
         run_tests(options.verbosity, *args)

setup.py

@@ -11,7 +11,7 @@
 
 setup(
     name = "django-url-tracker",
-    version = '0.1.1',
+    version = '0.1.4',
     url = "https://github.com/tangentlabs/django-url-tracker",
     author = "Sebastian Vetter",
     author_email = "sebastian.vetter@tangentone.com.au",
@@ -22,7 +22,7 @@
     packages = find_packages(exclude=["docs*", "tests*"]),
     include_package_data = True,
     install_requires=[
-        'django>=1.3.1',
+        'django>=1.3.1,<1.6',
         'South>=0.7.3',
     ],
     classifiers=[
@@ -38,5 +38,3 @@
     ],
     keywords = "seo, django, framework",
 )
-
-

tests/functional_test.py

@@ -0,0 +1,40 @@
+from django.test import TestCase
+
+from url_tracker.models import URLChangeRecord
+
+
+class TestUrlRecord(TestCase):
+
+    def test_returns_404_for_invalid_url(self):
+        response = self.client.get('/work/an-invalid-project/')
+        self.assertEquals(response.status_code, 404)
+
+    def test_returns_301_for_a_changed_url(self):
+        URLChangeRecord.objects.create(
+            old_url='/the/old-url/',
+            new_url='/the/new/url/',
+        )
+
+        response = self.client.get('/the/old-url/')
+        self.assertEquals(response.status_code, 301)
+        self.assertEquals(response['location'], 'http://testserver/the/new/url/')
+
+    def test_returns_410_for_a_deleted_url(self):
+        URLChangeRecord.objects.create(
+            old_url='/the/old-url/',
+            new_url='',
+            deleted=True
+        )
+
+        response = self.client.get('/the/old-url/')
+        self.assertEquals(response.status_code, 410)
+
+    def test_returns_301_for_a_changed_url_containing_querystring(self):
+        old_url = '/the/old-url/afile.php?q=test&another=45'
+        URLChangeRecord.objects.create(
+            old_url=old_url,
+            new_url='/the/new/url/',
+        )
+
+        response = self.client.get(old_url)
+        self.assertEquals(response.status_code, 301)