DJANGO COUNTRY FILTER

Django middleware is an application access filter from the country of the request. The idea that you can do an access control directly in the application, without the need for a firewall or other resource, because often the applications are for country-specific use without many complexities.

BUILD PROJECT

The use of middleware is very simple, just install the middleware via pip and configure it in the application.

$ pip install django-country-filter

In the settings.py file of the Django application, just insert the following line in the MIDDLEWARE configuration and DJANGO_COUNTRY_FILTER configuration with parameters countries, this is sufficient to load the default geoip provider.

MIDDLEWARE = {
    'django_country_filter.DjangoCountryFilterMiddleware',
    ...
}

DJANGO_COUNTRY_FILTER = {
    'countries': ['BR']
}

CUSTOM GEOIP PROVIDERS

There is a possibility that you can create your plug-in geoip provider in django-country-filter, using the geoip_provider and geoip_provider_path settings.

DJANGO_COUNTRY_FILTER = {
    'countries': ['BR'],
    'geoip_provider': '{NameClassProvider}',
    'geoip_provider_path': '{package_directory.package_py}'
}

CUSTOM CACHE PROVIDERS

There is a possibility that you can create your plug-in cache provider in django-country-filter, using the cache_provider and cache_provider_path settings.

DJANGO_COUNTRY_FILTER = {
    'countries': ['BR'],
    'cache_provider': '{NameClassProvider}',
    'cache_provider_path': '{package_directory.package_py}'
}

BUILD CUSTOM GEOIP PROVIDER

To create a geoip provider is very simple, just follow the convention used by django-country-filter, you need a class with a method called get and with an initializer that receives a HttpRequest object from Django.

To create a geoip provider is very simple, just follow the convention used by django-country-filter, you need a class with a method called get and with an initializer that receives a HttpRequest object from Django.

"""Template for geoip provider."""

from django.http.request import HttpRequest


class TemplateGeoipProvider:
    """Template geoip provider."""

    def __init__(self, request: HttpRequest):
        """Initialize."""
        self.request = request

    def get(self):
        """The method makes a request at the geoip provider and returns a
        dictionary with the country and the ip address of the request object."""

        return {
            'country': 'AU',
            'ip': self.request.META.get('REMOTE_ADDR')
        }

BUILD CUSTOM CACHE PROVIDER

Build the cache provider is very simple as well and helps you create your own rules for handling the cache. After creating the cache provider just put in the custom cache provider settings.

"""Template for cache provider."""

from django.http.request import HttpRequest


class TemplateCacheProvider:
    """Template cache provider."""

    def __init__(self, request: HttpRequest):
        """Initialize."""
        self.request = request

    def get(self):
        """The get method must be return a dict with country, ip and created_at field."""
        ip = self.request.META.get('REMOTE_ADDR')
        ...
        return {
            'country': 'AU',
            'ip': ip,
            'created_at': created_at
        }

    def persist(self, data):
        """The persist method not return, contains only persistence rules."""
        pass

HELP ME

You can help improve the code, improve the documentation and also implement new providers. To help, just keep the tests integral.

DEVELOPMENT ENVIRONMENT

$ python -m venv .env
$ source .env/bin/activate
$ pip install -r requirements/development.txt
$ pytest