Ensure cache keys are safe to use

Cache keys can't contain characters outside of a fairly
limited ASCII range. Base 64 encoding it should be safe.

Fixes #19.

Author: dominicrodger

docs/changelog.rst

@@ -1,6 +1,12 @@
 Release Notes
 =============
 
+v0.6.1
+------
+
+* Modify cache name, to prevent warnings for non-ASCII characters or
+  whitespace (thanks @ad-m).
+
 v0.6.0
 ------
 

docs/conf.py

@@ -50,9 +50,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.6.0'
+version = '0.6.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.6.0'
+release = '0.6.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.cfg

@@ -1,2 +1,5 @@
 [wheel]
 universal = 1
+
+[flake8]
+ignore = F999

tests/conftest.py

@@ -17,6 +17,15 @@ def simple_content():
     return content
 
 
+@pytest.fixture()
+def simple_content_with_space():
+    content, _ = TinyContent.objects.get_or_create(
+        name='foo bar',
+        content='This is a test with a space.'
+    )
+    return content
+
+
 @pytest.fixture()
 def split_content():
     content, _ = TinyContent.objects.get_or_create(

tests/test_simple.py

@@ -13,3 +13,10 @@ def test_simple_existent(simple_content):
     assert "This is a test." == render_template(
         "{% tinycontent_simple 'foobar' %}"
     )
+
+
+@pytest.mark.django_db
+def test_simple_with_space(simple_content_with_space):
+    assert "This is a test with a space." == render_template(
+        "{% tinycontent_simple 'foo bar' %}"
+    )

tinycontent/__init__.py

@@ -1,2 +1,2 @@
-__version__ = '0.6.0'
+__version__ = '0.6.1'
 VERSION = tuple(map(int, __version__.split('.')))

tinycontent/compat.py

@@ -1,4 +1,6 @@
+import base64
 import django
+from django.utils import six
 
 
 if django.VERSION > (1, 8,):
@@ -43,3 +45,12 @@ def render_to_string(
             "Using the request keyword argument requires Django >= 1.8"
         )
         return _render_to_string(template_name, context)
+
+
+def cache_safe_key(key):
+    if six.PY2:
+        return base64.b64encode(
+            key
+        )
+
+    return base64.b64encode(bytes(key, 'utf-8'))

tinycontent/models.py

@@ -3,6 +3,7 @@
 from django.db import models
 from django.utils.encoding import python_2_unicode_compatible
 from tinycontent.conf import get_filter_list
+from tinycontent.compat import cache_safe_key
 
 
 @python_2_unicode_compatible
@@ -36,7 +37,7 @@ def get_content_by_name(name):
 
     @staticmethod
     def get_cache_key(name):
-        return 'tinycontent_%s' % name
+        return 'tinycontent_%s' % cache_safe_key(name)
 
     def delete(self, *args, **kwargs):
         cache.delete(TinyContent.get_cache_key(self.name))