diff --git a/.gitignore b/.gitignore index eb2856f..c69f5b8 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,5 @@ /.coverage /.tox/ + +/docs/_build/ diff --git a/README.rst b/README.rst index 24fa8d9..d0347f1 100644 --- a/README.rst +++ b/README.rst @@ -36,9 +36,16 @@ And also in a custom layout: .. image:: http://i.imgur.com/d7kZtr9.png +Also, have a look at the online `example app`_, hosted by Heroku_. It also +contains the package `django-two-factor-auth`_, but that application is not a +dependency for this package. Also have a look at the bundled example templates +and views to see how you can integrate the application into your project. + +Compatible with Django 1.4, 1.5 and 1.6 on Python 2.6, 2.7, 3.2 and 3.3. Documentation is available at `readthedocs.org`_. + + Installation ============ - 1. ``pip install django-user-sessions`` 2. In ``INSTALLED_APPS`` replace ``'django.contrib.sessions'`` with ``'user_sessions'``. @@ -48,7 +55,8 @@ Installation 4. Add ``SESSION_ENGINE = 'user_sessions.backends.db'``. 5. Add ``url(r'', include('user_sessions.urls', 'user_sessions')),`` to your ``urls.py``. -6. Run ``python manage.py syncdb`` (or ``migrate``) and start hacking! +6. Run ``python manage.py syncdb`` (or ``migrate``) and browse to + ``/account/sessions/``. GeoIP ----- @@ -58,21 +66,21 @@ documentation on `installing GeoIP`_. .. _installing GeoIP: https://docs.djangoproject.com/en/1.6/ref/contrib/gis/geoip/ -Example application -------------------- -Also, have a look at the example application. It includes template examples and -shows how to use the session list and delete views. - -Compatibility -------------- -Tested on Django 1.4, 1.5 and 1.6 with Python 2.7 and 3.3. However it should -work fine with Python 2.6 and 3.2 as well. -Contributing -============ +Contribute +========== * Fork the repository on GitHub and start hacking. * Run the tests. * Send a pull request with your changes. * Provide a translation using Transifex_. + +License +======= +This project is licensed under the MIT license. + + .. _Transifex: https://www.transifex.com/projects/p/django-user-sessions/ +.. _`readthedocs.org`: http://django-user-sessions.readthedocs.org/ +.. _`example app`: http://example-two-factor-auth.herokuapp.com +.. _Heroku: https://www.heroku.com diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..15a8428 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DjangoUserSessions.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DjangoUserSessions.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/DjangoUserSessions" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DjangoUserSessions" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/_static/admin-view.png b/docs/_static/admin-view.png new file mode 100644 index 0000000..70c9562 Binary files /dev/null and b/docs/_static/admin-view.png differ diff --git a/docs/_static/custom-view.png b/docs/_static/custom-view.png new file mode 100644 index 0000000..726d580 Binary files /dev/null and b/docs/_static/custom-view.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..182ed5c --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,273 @@ +# -*- coding: utf-8 -*- +# +# Django User Sessions documentation build configuration file, created by +# sphinx-quickstart on Wed Jan 8 00:00:33 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Django User Sessions' +copyright = u'2014, Bouke Haarsma' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.1.2' +# The full version, including alpha/beta/rc tags. +release = '0.1.2' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# otherwise, readthedocs.org uses their theme by default, so no need to specify it + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'DjangoUserSessionsdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'DjangoUserSessions.tex', u'Django User Sessions Documentation', + u'Bouke Haarsma', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'djangousersessions', u'Django User Sessions Documentation', + [u'Bouke Haarsma'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'DjangoUserSessions', u'Django User Sessions Documentation', + u'Bouke Haarsma', 'DjangoUserSessions', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +from django.conf import settings +settings.configure(DEBUG=False) \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..db03db8 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,26 @@ +Django User Sessions's Documentation +==================================== + +Django includes excellent built-in sessions, however all the data is hidden +away into base64 encoded data. This makes it very difficult to run a query on +all active sessions for a particular user. `django-user-sessions` fixes this +and makes session objects a first class citizen like other ORM objects. + +Contents: + +.. toctree:: + :maxdepth: 2 + + installation + usage + reference + release-notes + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..567b637 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,20 @@ +Installation +============ +1. ``pip install django-user-sessions`` +2. In ``INSTALLED_APPS`` replace ``'django.contrib.sessions'`` with + ``'user_sessions'``. +3. In ``MIDDLEWARE_CLASSES`` replace + ``'django.contrib.sessions.middleware.SessionMiddleware'`` with + ``'user_sessions.middleware.SessionMiddleware'``. +4. Add ``SESSION_ENGINE = 'user_sessions.backends.db'``. +5. Add ``url(r'', include('user_sessions.urls', 'user_sessions')),`` to your + ``urls.py``. +6. Run ``python manage.py syncdb`` (or ``migrate``) and start hacking! + +GeoIP +----- +You need to setup GeoIP for the location detection to work. See the Django +documentation on `installing GeoIP`_. + +.. _installing GeoIP: + https://docs.djangoproject.com/en/1.6/ref/contrib/gis/geoip/ diff --git a/docs/reference.rst b/docs/reference.rst new file mode 100644 index 0000000..86bfe8d --- /dev/null +++ b/docs/reference.rst @@ -0,0 +1,28 @@ +Reference +========= + +Middleware +---------- +.. autoclass:: user_sessions.middleware.SessionMiddleware + +Models +------ +.. autoclass:: user_sessions.models.Session + +Session Backends +---------------- +.. autoclass:: user_sessions.backends.db.SessionStore + +Template Tags +------------- +.. automodule:: user_sessions.templatetags.user_sessions + :members: + +Views +----- +.. autoclass:: user_sessions.views.SessionListView +.. autoclass:: user_sessions.views.SessionDeleteView + +Unit tests +---------- +.. autoclass:: user_sessions.utils.tests.Client \ No newline at end of file diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..afbc94e --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,20 @@ +Release Notes +============= + +0.1.3 +----- +* Documentation +* Added Arabic translation + +0.1.2 +----- +* Ship with default templates +* Added Dutch translation + +0.1.1 +----- +* Added South migrations + +0.1.0 +----- +* Initial release diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..1e6e19d --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,53 @@ +Usage +===== + +Current session +--------------- +The current session is available on the request, just like the normal session +middleware makes the session available:: + + def my_view(request): + request.session + + +All sessions +------------ +To get the list of a user's sessions:: + + sessions = user.session_set.filter(expire_date__gt=now()) + +You could logout the user everywhere:: + + user.session_set.all().delete() + + +Generic views +------------- +There are two views included with this application, +:class:`~user_sessions.views.SessionListView` and +:class:`~user_sessions.views.SessionDeleteView`. Using this views you have a +simple, but effective, user session management that even looks great out of +the box: + +.. image:: _static/custom-view.png + +Template tags +~~~~~~~~~~~~~ +Two template tags are included +:meth:`~user_sessions.templatetags.user_sessions.device` and +:meth:`~user_sessions.templatetags.user_sessions.location`. These can be used +for respectively humanizing the user agent string and showing an approximate +location of the IP address:: + + {% load user_sessions %} + {{ session.user_agent|device }} -> Safari on OS X + {{ session.ip|location }} -> Zwolle, The Netherlands + + +Admin views +----------- + +The user's IP address and user agent are also stored on the session. This +allows to show a list of active sessions to the user in the admin: + +.. image:: _static/admin-view.png diff --git a/requirements_dev.txt b/requirements_dev.txt index 3cc8d9e..7f71f09 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -12,3 +12,8 @@ South coverage flake8 tox + +# Documentation + +Sphinx +sphinx_rtd_theme diff --git a/user_sessions/middleware.py b/user_sessions/middleware.py index e688faa..e5383d4 100644 --- a/user_sessions/middleware.py +++ b/user_sessions/middleware.py @@ -7,6 +7,9 @@ class SessionMiddleware(object): + """ + Middleware that provides ip and user_agent to the session store. + """ def process_request(self, request): engine = import_module(settings.SESSION_ENGINE) session_key = request.COOKIES.get(settings.SESSION_COOKIE_NAME, None) diff --git a/user_sessions/models.py b/user_sessions/models.py index 86296a2..00fa334 100644 --- a/user_sessions/models.py +++ b/user_sessions/models.py @@ -7,20 +7,16 @@ class Session(models.Model): """ + Session objects containing user session information. + Django provides full support for anonymous sessions. The session framework lets you store and retrieve arbitrary data on a per-site-visitor basis. It stores data on the server side and abstracts the sending and receiving of cookies. Cookies contain a session ID -- not the data itself. - The Django sessions framework is entirely cookie-based. It does - not fall back to putting session IDs in URLs. This is an intentional - design decision. Not only does that behavior make URLs ugly, it makes - your site vulnerable to session-ID theft via the "Referer" header. - - For complete documentation on using Sessions in your code, consult - the sessions documentation that is shipped with Django (also available - on the Django Web site). + Additionally this session object providers the following properties: + ``user``, ``user_agent`` and ``ip``. """ session_key = models.CharField(_('session key'), max_length=40, primary_key=True) diff --git a/user_sessions/templatetags/user_sessions.py b/user_sessions/templatetags/user_sessions.py index ffccf1b..ba11299 100644 --- a/user_sessions/templatetags/user_sessions.py +++ b/user_sessions/templatetags/user_sessions.py @@ -32,6 +32,16 @@ @register.filter def device(value): + """ + Transform a User Agent into a human readable text. + + Example output: + + * Safari on iPhone + * Chrome on Windows 8.1 + * Safari on OS X + """ + for regex, name in BROWSERS: if regex.search(value): browser = name @@ -50,6 +60,14 @@ def device(value): @register.filter def location(value): + """ + Transform an IP address into an approximate location. + + Example output: + + * Zwolle, The Netherlands + * ``unknown`` + """ location = geoip() and geoip().city(value) if location and location['country_name']: if location['city']: diff --git a/user_sessions/views.py b/user_sessions/views.py index 8f222a3..3f098b5 100644 --- a/user_sessions/views.py +++ b/user_sessions/views.py @@ -19,11 +19,24 @@ def dispatch(self, request, *args, **kwargs): class SessionListView(LoginRequiredMixin, SessionMixin, ListView): + """ + View for listing a user's own sessions. + + This view shows list of a user's currently active sessions. You can + override the template by providing your own template at + `user_sessions/session_list.html`. + """ def get_context_data(self, **kwargs): kwargs['session_key'] = self.request.session.session_key return super(SessionListView, self).get_context_data(**kwargs) class SessionDeleteView(LoginRequiredMixin, SessionMixin, DeleteView): + """ + View for deleting a user's own session. + + This view allows a user to delete an active session. For example locking + out a session from a computer at the local library or a friend's place. + """ def get_success_url(self): return str(reverse_lazy('user_sessions:session_list'))