Bump to 1.2.0

Author: asvetlov

CHANGES.txt

@@ -1,6 +1,12 @@
 Changes
 =======
 
+
+1.2.0 (2017-11-06)
+------------------
+
+- Add MemcachedStorage #224
+
 1.1.0 (2017-11-03)
 ------------------
 

aiohttp_session/__init__.py

@@ -9,7 +9,7 @@
 from aiohttp import web
 
 
-__version__ = '1.1.0'
+__version__ = '1.2.0'
 
 
 class Session(MutableMapping):

docs/conf.py

@@ -332,6 +332,6 @@
 intersphinx_mapping = {'https://docs.python.org/3': None,
                        'https://aiohttp.readthedocs.io/en/stable': None,
                        'https://aioredis.readthedocs.io/en/latest': None,
-                       'https://github.com/aio-libs/aiomcache', None,
+                       # 'https://github.com/aio-libs/aiomcache': None,
                        'http://cryptography.io/en/latest': None,
                        'https://pynacl.readthedocs.io/en/latest': None}

docs/index.rst

@@ -61,27 +61,41 @@ Available session storages are:
 
   Requires :term:`cryptography` library::
 
-      $ pip install aiohttp_session[secure]
+  .. code::
+
+     $ pip3 install aiohttp_session[secure]
 
 * :class:`~aiohttp_session.redis_storage.RedisStorage` -- stores
   JSON-ed data into *redis*, keeping into cookie only redis key
   (random UUID).
-  
+
   Inside redis the key will be saved as COOKIENAME_VALUEOFTHECOOKIE.
-  For example if inside the browser the cookie is saved with name 'AIOHTTP_SESSION' (default option)
-  and value e33b57c7ec6e425eb626610f811ab6ae (a random UUID) they key inside redis will be
-  AIOHTTP_SESSION_e33b57c7ec6e425eb626610f811ab6ae.
+  For example if inside the browser the cookie is saved with name
+  ``'AIOHTTP_SESSION'`` (default option) and value
+  ``e33b57c7ec6e425eb626610f811ab6ae`` (a random UUID) they key inside
+  redis will be ``AIOHTTP_SESSION_e33b57c7ec6e425eb626610f811ab6ae``.
 
-  Requires :term:`aioredis` library::
+  Requires :term:`aioredis` library:
+
+  .. code-block:: bash
 
       $ pip install aiohttp_session[aioredis]
 
+* :class:`~aiohttp_session.memcached_storage.MemcachedStorage` -- the
+  same as Redis storage but uses Memcached database.
+
+  Requires :term:`aiomcache` library:
+
+  .. code-block:: bash
+
+      $ pip install aiohttp_session[aiomcache]
+
 Installation
 --------------------
 
-.. code::
+.. code-block:: bash
 
-   pip3 install aiohttp_session
+   $ pip3 install aiohttp_session
 
 Source code
 -----------

docs/reference.rst

@@ -224,8 +224,7 @@ so it's totally insecure.
 To use the storage you should push it into
 :func:`session_middleware`::
 
-   app = aiohttp.web.Application(
-       middlewares=[aiohttp_session.SimpleCookieStorage()])
+   aiohttp_session.setup(app, aiohttp_session.SimpleCookieStorage())
 
 .. class:: SimpleCookieStorage(*, \
                                cookie_name="AIOHTTP_SESSION", \
@@ -325,16 +324,18 @@ It operates with Redis database via :class:`aioredis.RedisPool`.
 
 To use the storage you need setup it first::
 
-   redis = yield from aioredis.create_pool(('localhost', 6379))
+   redis = await aioredis.create_pool(('localhost', 6379))
    storage = aiohttp_session.redis_storage.RedisStorage(redis)
-   session_middleware = aiohttp_session.session_middleware(storage)
-   app = aiohttp.web.Application(middlewares=[session_middleware])
+   aiohttp_session.setup(app, storage)
 
 
 .. class:: RedisStorage(redis_pool, *, \
-                              cookie_name="AIOHTTP_SESSION", \
-                              domain=None, max_age=None, path='/', \
-                              secure=None, httponly=True)
+                        cookie_name="AIOHTTP_SESSION", \
+                        domain=None, max_age=None, path='/', \
+                        secure=None, httponly=True, \
+                        encoder=json.dumps, \
+                        decoder=json.loads, \
+                        key_factory=lambda: uuid.uuid4().hex)
 
    Create Redis storage for user session data.
 
@@ -343,8 +344,45 @@ To use the storage you need setup it first::
    *redis_pool* is a :class:`~aioredis.RedisPool` which should be
    created by :func:`~aioredis.create_pool` call, e.g.::
 
-      redis = yield from aioredis.create_pool(('localhost', 6379))
+      redis = await aioredis.create_pool(('localhost', 6379))
       storage = aiohttp_session.redis_storage.RedisStorage(redis)
 
    Other parameters are the same as for
    :class:`~aiohttp_session.AbstractStorage` constructor.
+
+
+Memcahed Storage
+----------------
+
+The storage that stores session data in Memcached and
+keeps only keys (UUIDs actually) in HTTP cookies.
+
+It operates with Memcahed database via :class:`aiomecache.Client`.
+
+To use the storage you need setup it first::
+
+   mc = aiomchache.Client('localhost', 11211)
+   storage = aiohttp_session.memcached_storage.Client(mc)
+   aiohttp_session.setup(app, storage)
+
+.. versionadded:: 1.2
+
+.. class:: MemcachedStorage(memcached_conn, *, \
+                            cookie_name="AIOHTTP_SESSION", \
+                            domain=None, max_age=None, path='/', \
+                            secure=None, httponly=True, \
+                            encoder=json.dumps, \
+                            decoder=json.loads, \
+                            key_factory=lambda: uuid.uuid4().hex)
+
+   Create Memcached storage for user session data.
+
+   The class is inherited from :class:`~aiohttp_session.AbstractStorage`.
+
+   *memcached_conn* is a :class:`~aiomcache.Client` instance::
+
+      mc = yield from aiomcache.Client('localhost', 6379)
+      storage = aiohttp_session.memcached_storage.MemcachedStorage(redis)
+
+   Other parameters are the same as for
+   :class:`~aiohttp_session.AbstractStorage` constructor.