issue #11. rename config to REDIRECT_TO_LOGIN_IMMEDIATELY

Author: bugov

README.md

@@ -54,12 +54,12 @@ AUTO_LOGOUT = {'IDLE_TIME': timedelta(minutes=10)}
 ```
 
 The user will log out the next time the page is requested.
-See `REDIRECT_TO_LOGIN_PAGE` to log out right after the idle-time has expired
+See `REDIRECT_TO_LOGIN_IMMEDIATELY` to log out right after the idle-time has expired
 (and redirect to login page).
 
-### 🔄 `REDIRECT_TO_LOGIN_PAGE` right after the idle-time has expired
+### 🔄 `REDIRECT_TO_LOGIN_IMMEDIATELY` right after the idle-time has expired
 
-Use the `REDIRECT_TO_LOGIN_PAGE` option
+Use the `REDIRECT_TO_LOGIN_IMMEDIATELY` option
 if you want to redirect the user to the login page
 immediately after the idle-time expires:
 
@@ -68,7 +68,7 @@ from datetime import timedelta
 
 AUTO_LOGOUT = {
     'IDLE_TIME': timedelta(minutes=10),
-    'REDIRECT_TO_LOGIN_PAGE': True,
+    'REDIRECT_TO_LOGIN_IMMEDIATELY': True,
 }
 ```
 
@@ -98,7 +98,7 @@ TEMPLATES = [
 And add it to your templates (will add a redirect script to your html):
 
 ```
-{{ redirect_to_login_page }}
+{{ redirect_to_login_immediately }}
 ```
 
 If you want to use this in your JavaScript code, following template variables will be useful:
@@ -108,7 +108,7 @@ var sessionEnd = {{ seconds_until_session_end }};
 var idleEnd = {{ seconds_until_idle_end }};
 ```
 
-`REDIRECT_TO_LOGIN_PAGE` works with `SESSION_TIME` too.
+`REDIRECT_TO_LOGIN_IMMEDIATELY` works with `SESSION_TIME` too.
 
 ## ⌛ Limit session time
 
@@ -132,7 +132,7 @@ AUTO_LOGOUT = {'SESSION_TIME': timedelta(hours=1)}
 
 **NOTE**
 
-See `REDIRECT_TO_LOGIN_PAGE` option
+See `REDIRECT_TO_LOGIN_IMMEDIATELY` option
 if you want to redirect user to the login page
 right after the idle-time has expired.
 
@@ -183,6 +183,6 @@ AUTO_LOGOUT = {
     'IDLE_TIME': timedelta(minutes=5),
     'SESSION_TIME': timedelta(minutes=30),
     'MESSAGE': 'The session has expired. Please login again to continue.',
-    'REDIRECT_TO_LOGIN_PAGE': True,
+    'REDIRECT_TO_LOGIN_IMMEDIATELY': True,
 }
 ```

django_auto_logout/context_processors.py

@@ -50,7 +50,7 @@ def auto_logout_client(request):
     if 'IDLE_TIME' in options:
         ctx['seconds_until_idle_end'] = seconds_until_idle_time_end(request, options['IDLE_TIME'], current_time)
 
-    if options.get('REDIRECT_TO_LOGIN_PAGE'):
+    if options.get('REDIRECT_TO_LOGIN_IMMEDIATELY'):
         at = None
 
         if 'SESSION_TIME' in options and 'IDLE_TIME' in options:
@@ -64,6 +64,6 @@ def auto_logout_client(request):
             at = f"at=Date.now()+Math.max({ ctx['seconds_until_idle_end'] },0)*1000+999;"
 
         if at:
-            ctx['redirect_to_login_page'] = mark_safe(_trim(LOGOUT_TIMEOUT_SCRIPT_PATTERN % at))
+            ctx['redirect_to_login_immediately'] = mark_safe(_trim(LOGOUT_TIMEOUT_SCRIPT_PATTERN % at))
 
     return ctx

example/example/settings.py

@@ -168,5 +168,5 @@
     'IDLE_TIME': 10,  # 10 seconds
     'SESSION_TIME': 120,  # 2 minutes
     'MESSAGE': 'The session has expired. Please login again to continue.',
-    'REDIRECT_TO_LOGIN_PAGE': True,
+    'REDIRECT_TO_LOGIN_IMMEDIATELY': True,
 }

example/some_app_login_required/templates/layout.html

@@ -18,6 +18,6 @@
 
 {% block content %}{% endblock %}
 
-{{ redirect_to_login_page }}
+{{ redirect_to_login_immediately }}
 </body>
 </html>

example/some_app_login_required/tests.py

@@ -212,7 +212,7 @@ def test_script_anon(self):
         settings.AUTO_LOGOUT = {
             'IDLE_TIME': 10,  # 10 seconds
             'SESSION_TIME': 120,  # 2 minutes
-            'REDIRECT_TO_LOGIN_PAGE': True,
+            'REDIRECT_TO_LOGIN_IMMEDIATELY': True,
         }
         resp = self.client.get(settings.LOGIN_URL)
         self.assertNotContains(resp, '<script>')
@@ -227,35 +227,35 @@ def test_session_idle_combinations(self):
         settings.AUTO_LOGOUT = {
             'IDLE_TIME': 10,  # 10 seconds
             'SESSION_TIME': 120,  # 2 minutes
-            'REDIRECT_TO_LOGIN_PAGE': True,
+            'REDIRECT_TO_LOGIN_IMMEDIATELY': True,
         }
         self.assertContains(self.client.get(self.url), '<script>')
         self.assertContains(self.client.get(self.url), 'Math.min')
 
         settings.AUTO_LOGOUT = {
             'IDLE_TIME': 10,  # 10 seconds
-            'REDIRECT_TO_LOGIN_PAGE': True,
+            'REDIRECT_TO_LOGIN_IMMEDIATELY': True,
         }
         self.assertContains(self.client.get(self.url), '<script>')
         self.assertNotContains(self.client.get(self.url), 'Math.min')
 
         settings.AUTO_LOGOUT = {
             'SESSION_TIME': 120,  # 2 minutes
-            'REDIRECT_TO_LOGIN_PAGE': True,
+            'REDIRECT_TO_LOGIN_IMMEDIATELY': True,
         }
         self.assertContains(self.client.get(self.url), '<script>')
         self.assertNotContains(self.client.get(self.url), 'Math.min')
 
         settings.AUTO_LOGOUT = {
-            'REDIRECT_TO_LOGIN_PAGE': True,
+            'REDIRECT_TO_LOGIN_IMMEDIATELY': True,
         }
         self.assertNotContains(self.client.get(self.url), '<script>')
 
     def test_no_config(self):
         self.client.force_login(self.user)
 
         settings.AUTO_LOGOUT = {
-            'REDIRECT_TO_LOGIN_PAGE': False,
+            'REDIRECT_TO_LOGIN_IMMEDIATELY': False,
         }
         self.assertNotContains(self.client.get(self.url), '<script>')