Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

('Django abstract classes to allow Set it and Forget it! behavior for models.',)

Project description

==========
Gatekeeper
==========

Gatekeeper allows for "Set it and forget it!" behavior for your models.

There are two basic configurations:

1. You have a model where some number of instances of the model should be "live". A good example of this would be an Article model, where you've written some articles that are "live", some that might've been taken down, some that are still "in progress", and others that are ready to "go live", but have a "go live" date that's in the future.

2. You have a model where ONE instance should be "live" depending on the underlying metadata of the model. A good example of this would be a Homepage models: you have different renditions of the home page that you want to go live at different date/times, but only one should be live at any given time.

Happily, we can accommodate both!

Other features:

1. If you're logged into the Django Admin, you can still "see" pages that aren't live (so you can easily QA things that are in progress).

-----------
Quick start
-----------

1. Add "gatekeeper" to your INSTALLED_APPS setting like this::

INSTALLED_APPS = [
...
'gatekeeper',
]

------------------
Gatekeeping Models
------------------

The main use for gatekeeping is where you have a model with many instances, but you only want some to be "live" on the site.

A good example is a generic "Article" model:

* Some articles are ready-to-go and you want them live to the public;
* Other articles are still being worked on - you want to be able to preview them, but not take them live JUST yet;
* Some articles might be pulled (and re-published later)
* Some articles are ready to be published, but you want them to only go live at a later date.

Here, all you need to do is subclass the `GatekeeperAbstractModel` abstract class, e.g.:

.. code::

from django.db import models
from gatekeeper.models import GatekeeperAbstractModel

class Article(GatekeeperAbstractModel):
... (your custom fields go here)

The superclass creates two fields:

1. `live_as_of` (DateTime, default = None) - this is the timestamp of when the object should go live. If it's not set (None) you can think of this as an "in development" phase. For an Article model, you've created the instance, but you're still writing the Article. You can preview it through the Admin, but it's not live on the site.

2. `publish_status` (controlled vocabulary, default = None) - this has 4 possible values:

* None = has never been published
* 0 = "use live_as_of" date to determine if the object is available to the public
* 1 = "always on" - hard-wired to be always available to the public
* -1 = "permanently off" - hard-wired to NEVER be available to the public

You set the `publish_status` and `live_as_of` values through the Admin.

View Code
=========

Setting up gatekeeping for models is easy! Using the Article model as an example, here is the corresponding view code for a listing and a detail view.

.. code::

from django.views.generic import DetailView, ListView
from .models import Article
from gatekeeper.mixins import GatekeeperListMixin, GatekeeperDetailMixin


class ArticleListView(GatekeeperListMixin, ListView):
model = Article
template_name = 'article/article_list.html'
context_object_name = 'articles'

class ArticleDetailView(GatekeeperDetailMixin, DetailView):
model = Article
template_name = 'article/article_detail.html'
context_object_name = 'article'

What's happening behind the scenes:

#. In the ListView, the gatekeeper is filtering the model with the following rules:

#. If the user is logged into the Admin and `publish_status` != -1, _include the model instance_
#. If there is no user, and the `publish_status` = 1, _include the model instance_
#. If there is no user, `publish_status` = 0, *and* the current date/time > `live_as_of`, _include the model instance_.
#. Return the filtered list of model instances.

#. In the DetailView, the gatekeeper follows the same rules, but will throw a 404 error, if the user is not logged into the Admin and the request object isn't "live" yet.

## Using the Gatekeeper with querysets in your own code

Say there's a section on your homepage that gives a list of the three most recent articles. If you just create a queryset along the lines of:

.. code::

most_recent_articles = Article.objects.order_by(-date_created)[:3]

it will include articles regardless of what their gatekeeping situation is.

So there are two helper functions to apply the gatekeeping rules to any queryset you generate.

`view_gatekeeper`
-----------------


This takes a queryset, applies the rules and returns a filtered queryset.

.. code::

from gatekeeper.view_utils import view_gatekeeper
...
recent_articles = Article.objects.order_by('-date_created')
recent_articles = view_gatekeeper(recent_articles, is_auth)
...

The `is_auth` parameter allows you to filter based on whether the user making the request is logged in or not. If they are logged in, then objects that aren't live but still available to the Admin will "pass" through the gatekeeper. For this, you'd set `is_auth = self.request.user.is_authenticated`. (About the only time I can see doing this is if you want to see how a particular non-live object will "play" in a generated content feature.)

I've found that I almost NEVER need that. Typically for constructed lists of object you want to only see what IS live, so in almost every case where I've used `view_gatekeeper`, I've set `is_auth = False`. You can still "see" all the non-live objects through their detail page when you're logged into the Admin.

`object_gatekeeper`
-------------------

This takes a single object instance and returns True or False depending on whether it "passes" the gate.

.. code::

from gatekeeper.view_utils import object_gatekeeper
...
my_article = Article.objects.first()
am_i_avaiable = object_gatekeeper(my_article, is_auth)
...

Generally, you don't need this method since the model property `available_to_public` already exists. The one case where I've needed it was when I had a list come from an outside source where there was an overlap with objects in one of my models. I wanted to show all the external object, and construct links to the object that overlapped but ONLY if they were live.

------------------------------------
Gatekeeping Model Instances Serially
------------------------------------

In some situations, you only want a single instance of model to be "live" on the site at a time. You can use the Gatekeeper to do this.

A good example would be a Home page app. You can queue up different renditions of the home page to go live at different times.

Here, there's only a small change to the model and view code:

.. code::

from django.db import models
from django.utils.translation import ugettext_lazy as _
from gatekeeper.models import GatekeeperSerialAbstractModel

class Homepage(GatekeeperSerialAbstractModel):
title = models.CharField (
_('Title'),
max_length = 200,
null = False
)

def get_absolute_url(self):
return reverse('homepage-detail', args=(self.pk))

def __str__(self):
return self.title

class Meta:
verbose_name = 'Home Page'
verbose_name_plural = 'Home Pages'


As before, the`GatekeeperSerialAbstractModel` creates the `live_as_of` and `publish_status` fields. It also creates a `default_live` field.

View Code
=========


The View code becomes:

.. code::

from django.views.generic import DetailView
from gatekeeper.mixins import GatekeeperSerialMixin

class HomepageDetailView(GatekeeperSerialMixin, DetailView):
model = Homepage
template_name = 'homepage/homepage_detail.html'
context_object_name = 'homepage'

Setting up `urls.py`
====================


In the `urls.py` there's a slight twist. You'll want two entries.

.. code::

from django.urls import path
from .views import HomepageDetailView

urlpatterns = (
path('', HomepageDetailView.as_view(), name='homepage-live'),
path('homepage/<int:pk>/', HomepageDetailView.as_view(), name='homepage-detail'),
)

How it Works
============

What's happening behind the scenes:

1. If you are logged into the Admin you can view any Homepage instance (with the `/homepage/<pk>/` URL).
2. However, for the "live" site, we send the `pk`-less URL.
3. The `GatekeeperSerialMixin` mixin - if no PK is provided, will attempt to find the "most approrpiate" instance of the model.

How does it do that?

* Rule 0: Only objects that COULD be in play can play (i.e., `publish_status` cannot be -1)

* Rule 1: if your date is in the future, then you can't play

* Rule 2: pick from the ones with "date set" that's in the past who have been published (i.e., `live_as_of` is not None)

* Rule 3: Barring that - pick the most-recently modified page with `publish_status` = 1
(this is because it IS possible for a "always on" page to have never gone through
the publish step with a publish date - it's just FORCED TO BE ON)

* Rule 4: Barring THAT - pick the most-recently modified page with `publish_status` != -1 that has `default_live` = True.

* Rule 5: Barring THAT - None (and 404).

Note Rule #4 --- this is where the `default_live` field comes into play. You can define a model instance with `default_live` = True. This item will be return if no other instance passes the rules. Basically it's can be a generic "fall back" for the model so that the public page ALWAYS returns something. Handy!


`utils.py` - helper functions
=============================


In case you need it, there's a helper function, `get_appropriate_object_from_model` that will return the "live" instance of any serial gatekeeper model:

.. code::

get_appropriate_object_from_model(object_set, is_queryset=False)

where object_set is EITHER:

1. a Model that has subclassed `GatekeeperSerialAbstractModel` (and `is_queryset=False`), OR;
2. a query FROM a Model that has subclassed `GatekeeperSerialAbstractModel` (where you send `is_queryset=True`).

-------------------
The Admin Interface
-------------------


Gatekeeper has several helper functions to customize the admin (it doesn't have the admin methods because there's no way to know if there are
other ModelAdmins being used, and Python's MRO doesn't allow for chaning). All of them are in the `gatekeeper.admin_helpers` file.

Readonly Fields
===============

Example code:

.. code::

from gatekeeper.admin_helpers import gatekeeper_add_to_readonly_fields

class MyModelAdmin(admin.ModelAdmin):
readonly_fields = ['my_field_1', 'my_field_2'] + gatekeeper_add_to_readonly_fields()

List Display
============


For the basic gatekeeper, two fields are usually added to the `list_display` (they'll appear after anything set in the ModelAdmin):

1. A `show_publish_status` that takes the `live_as_of` and `publish_status` fields and creates a human-friendly string from them;
2. A `available_to_public` model property that returns True/False to show "is this available to the public"?

For the "serial" gatekeeper, there are also two fields:

1. `show_publish_status` as before
2. `is_live` - returns True/False to show which item is the one that will appear on the live site.

These can be added with the `gatekeeper_add_to_list_display` method, e.g.:

.. code::

from gatekeeper.admin_helpers import gatekeeper_add_to_list_display

class MyModelAdmin(admin.ModelAdmin):
list_display = ['pk', 'title', ] + gatekeeper_add_to_list_display()

for serial models you'll need to add `serial=True` to the call.


Fieldsets
=========

There are two ways to include the gatekeeper fields using the `gatekeeper_add_to_fieldsets` method:


As a separate section
---------------------


There's a `section` attribute (default: True) that returns the entire section tuple with the gatekeeper fields.
There's also a `collapse` attribute (default: False) that uses the Django Admun "collapse" class.

There's also a `serial` attribute (default: False) you'll need to add if the Model is serial.

.. code::

from gatekeeper.admin_helpers import gatekeeper_add_to_fieldsets

class MyModelAdmin(admin.ModelAdmin):
fieldsets = (
(None, ...),
gatekeeper_add_to_fieldsets(section=True, collapse=False, serial=False)
)

Included as part of a section
-----------------------------

Or you can include them as part of another section; in this case you'd set `section=False`

.. code::

from gatekeeper.admin_helpers import gatekeeper_add_to_fieldsets

class MyModelAdmin(admin.ModelAdmin):
fieldsets = (
(None, {
'fields': (
(some set of fields),
gatekeeper_add_to_fieldsets(section=False, serial=False)
)
}),
)

And of course you can just do it all manually with the editable `live_as_of`, `publish_status` fields and the readonly
`is_live` (serial), `show_publish_status` (generic) fields.

Admin actions
=============


For convenience in the listing page of the Admin, five Admin actions have been defined:

1. "Revert to Preview/Pending status": this sets `live_as_of` and `publish_status` to None. The item is no longer live, and won't go live until these values are changed;
2. "Take Item PERMANENTLY LIVE": this sets `publish_status` = 1 --- the item will be live;
3. "Take Live as of Right Now": this sets `live_as_of` = "now", and `publish_status` = 0 --- the item will be live;
4. "CONDITIONALLY online using `live_as_of` date": this sets `publish_status = 0` and keeps `live_as_of` to whatever it was before. You'd use this if you wanted to change a PERMANENTLY LIVE or COMPLETELY OFFLINE setting;
5. "Take item COMPLETELY OFFLINE": this sets `publish_status` = -1 --- the item disappears from the site entirely.

There's a GATEKEEPER_ACTIONS variable in the admin_helpers.py file; you'll need to add them to the `actions`, e.g.:

.. code::

actions = [any actions you've also created] + GATEKEEPER_ACTIONS

-------
Testing
-------


There are unit tests for the `can_this_object_page_be_shown`, `can_this_object_page_be_shown_to_public`, and `get_appropriate_object_from_model` utility methods. Run `python runtests.py`.

---------------
Troubleshooting
---------------

_I have a page that's not live but I can still see it!_
========================================================

Are you sure you're not logged into the Admin? If you are, you can still "see" pages that aren't live.

-------------------------------
Features still to be integrated
-------------------------------

Parental Gatekeeping
====================

(To be added from the PBSMM test case)

Sometimes you have a model that has a FK relationship to another model, and you want both of them to be under gate-keeping. If "parent" model A's gatekeeping should influence model B, you can set things to override model B based upon the settings for model A.

For example, if you have models for Author and Book, you can set it up that if the Author is not live, then NONE of the Books are live either. This is convenient for sites where you might want to take several pages live all at once.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-model-gatekeeper, version 0.1.7
Filename, size File type Python version Upload date Hashes
Filename, size django_model_gatekeeper-0.1.7-py3-none-any.whl (21.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-model-gatekeeper-0.1.7.tar.gz (19.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page