renaming project (#10)

* renaming project

* Fixing travis yml

* Back to full coverage

.travis.yml

@@ -4,5 +4,5 @@ python:
 # command to install dependencies
 install: "pip install -r requirements.txt"
 # command to run tests
-script: nosetests --with-coverage --cover-package redis_cache
+script: nosetests --with-coverage --cover-package backends
 after_success: coveralls

README.md

@@ -9,14 +9,16 @@ Implements high level function caching to Redis with a decorator
 
 ## Setup
 ```python
-from redis_cache import RedisCache
-r = RedisCache('localhost', 6379)
+from cache_deco import Cache
+from backends.redis.redis_backend import RedisBackend
+redis = RedisBackend('localhost', 6379)
+c = Cache(redis)
 ```
 
 ## Cache
 
 ```python
-@r.cache()
+@c.cache()
 def my_method(a, b, c):
   return a ** b ** c
 ```
@@ -26,7 +28,7 @@ def my_method(a, b, c):
 
 e.g.
 ```python
-@r.cache(expiration=100)
+@c.cache(expiration=100)
 def my_method():
   ...
 ```
@@ -39,7 +41,7 @@ e.g.
 def sig_gen(*args, **kwargs):
   return "?".join(args)
 
-r.cache(signature_generator=sig_gen)
+@c.cache(signature_generator=sig_gen)
 def my_method():
   ...
 ```
@@ -48,7 +50,7 @@ def my_method():
 
 e.g.
 ```python
-@r.cache(invalidator=True)
+@c.cache(invalidator=True)
 def my_method():
     ...
 ```

backends/test_backend_base.py

@@ -0,0 +1,22 @@
+from backends.backend_base import Backend
+from unittest import TestCase
+
+
+class BackendTestCase(TestCase):
+
+    def setUp(self):
+        self.backend = Backend()
+
+    def test_not_implemented(self):
+
+        with self.assertRaises(NotImplementedError):
+            self.backend.get_cache('somekey')
+
+        with self.assertRaises(NotImplementedError):
+            self.backend.set_cache('somekey', 'somevalue')
+
+        with self.assertRaises(NotImplementedError):
+            self.backend.invalidate_key('somekey')
+
+        with self.assertRaises(NotImplementedError):
+            self.backend.set_cache_and_expire('somekey', 'somevalue', 'time')

redis_cache/__init__.py → cache_deco/__init__.py

@@ -1,13 +1,13 @@
 import functools
 import pickle
 
-from backends.redis.redis_backend import BackendException
+from backends.backend_base import BackendException
 
 # Default expiration time for a cached object if not given in the decorator
 DEFAULT_EXPIRATION = 60
 
 
-class RedisCache(object):
+class Cache(object):
     def __init__(self, client):
         self.backend = client
 
@@ -23,6 +23,7 @@ def wrapper(*args, **kwargs):
                 fn_hash = self._generate_cache_key(fn, args, kwargs, **options)
                 try:
                     cache_request = self.backend.get_cache(fn_hash)
+                    # TODO
                     if cache_request is '':
                         # Cache miss
                         ret = fn(*args, **kwargs)
@@ -40,7 +41,7 @@ def wrapper(*args, **kwargs):
                         else:
                             return cache_hit
                 except BackendException:
-                    # If Redis fails, just execute the function as normal
+                    # If the backend fails, just execute the function as normal
                     if return_invalidator:
                         return fn(*args, **kwargs), None
                     else:

tests/test_redis_cache.py → tests/test_cache_deco.py

@@ -1,4 +1,4 @@
-from redis_cache import RedisCache, DEFAULT_EXPIRATION
+from cache_deco import Cache, DEFAULT_EXPIRATION
 from backends.backend_base import Backend, BackendException
 from unittest import TestCase
 from mock import Mock
@@ -22,7 +22,7 @@ def test_cache_miss(self):
         """
         mock_client = Mock()
         # Simulates a cache miss
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
         redis_cache.backend.get_cache.return_value = ''
 
@@ -49,7 +49,7 @@ def test_cache_miss_kwargs(self):
         """
         mock_client = Mock()
         # Simulates a cache miss
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
         redis_cache.backend.get_cache.return_value = ''
 
@@ -86,7 +86,7 @@ def test_cache_miss_expiration(self):
         ttl = 100
         mock_client = Mock()
         # Simulates a cache hit
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
         redis_cache.backend.get_cache.return_value = ''
 
@@ -113,7 +113,7 @@ def test_cache_hit(self):
         test_param = 'cache hit test'
         mock_client = Mock()
         # Simulates a cache hit
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
         redis_cache.backend.get_cache.return_value = pickle.dumps(test_param)
 
@@ -139,7 +139,7 @@ def test_cache_hit_invalidate(self):
         test_param = 'cache hit test'
         mock_client = Mock()
         # Simulates a cache hit
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
         redis_cache.backend.get_cache.return_value = pickle.dumps(test_param)
 
@@ -173,7 +173,7 @@ def test_redis_failure(self):
         test_param = 'cache hit test'
         mock_client = Mock()
         # Simulates a cache hit
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
         redis_cache.backend.get_cache.side_effect = BackendException
 
@@ -206,7 +206,7 @@ def test_cache_custom_signature(self):
         test_param = 'cache hit test'
         mock_client = Mock()
         # Simulates a cache hit
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
         redis_cache.backend.get_cache.return_value = pickle.dumps(test_param)
 
@@ -244,7 +244,7 @@ def test_simple_object_pickle(self):
         """
         mock_client = Mock()
         # Simulates a cache miss
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
         redis_cache.backend.get_cache.return_value = ''
 
@@ -280,7 +280,7 @@ def test_simple_object(self):
         """
         mock_client = Mock()
         # Simulates a cache miss
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
         redis_cache.backend.get_cache.return_value = ''
 
@@ -314,7 +314,7 @@ def test_cache_on_class_without_str(self):
         """
 
         mock_client = Mock()
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
 
         class TestClass(object):
@@ -365,7 +365,7 @@ def test_cache_on_stateful_class_without_str(self):
         values for the previous state of the object.
         """
         mock_client = Mock()
-        redis_cache = RedisCache(Backend())
+        redis_cache = Cache(Backend())
         redis_cache.backend = mock_client
 
         class TestClass(object):