From fa0ef1773773c58b5708abad0e90a44fc9a308f8 Mon Sep 17 00:00:00 2001
From: Carlton Gibson <carlton.gibson@noumenal.co.uk>
Date: Tue, 2 Sep 2014 14:53:37 +0200
Subject: [PATCH] Remove Login Dropdown when Auth Views are not registered.

Fixes #1738
---
 .../templates/rest_framework/base.html        | 26 +++-----
 rest_framework/templatetags/rest_framework.py | 17 +++--
 tests/browsable_api/__init__.py               |  0
 tests/browsable_api/auth_urls.py              | 10 +++
 tests/browsable_api/no_auth_urls.py           |  9 +++
 tests/browsable_api/test_browsable_api.py     | 65 +++++++++++++++++++
 tests/browsable_api/views.py                  | 15 +++++
 7 files changed, 121 insertions(+), 21 deletions(-)
 create mode 100644 tests/browsable_api/__init__.py
 create mode 100644 tests/browsable_api/auth_urls.py
 create mode 100644 tests/browsable_api/no_auth_urls.py
 create mode 100644 tests/browsable_api/test_browsable_api.py
 create mode 100644 tests/browsable_api/views.py
diff --git a/rest_framework/templates/rest_framework/base.html b/rest_framework/templates/rest_framework/base.html
index e54e38148..5a12277bc 100644
--- a/rest_framework/templates/rest_framework/base.html
+++ b/rest_framework/templates/rest_framework/base.html
@@ -5,14 +5,14 @@
 <html>
     <head>
         {% block head %}
-    
+
             {% block meta %}
                 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
                 <meta name="robots" content="NONE,NOARCHIVE" />
             {% endblock %}
-    
+
             <title>{% block title %}Django REST framework{% endblock %}</title>
-    
+
             {% block style %}
                 {% block bootstrap_theme %}
                     <link rel="stylesheet" type="text/css" href="{% static "rest_framework/css/bootstrap.min.css" %}"/>
@@ -21,7 +21,7 @@
                 <link rel="stylesheet" type="text/css" href="{% static "rest_framework/css/prettify.css" %}"/>
                 <link rel="stylesheet" type="text/css" href="{% static "rest_framework/css/default.css" %}"/>
             {% endblock %}
-            
+
         {% endblock %}
     </head>
 
@@ -44,15 +44,7 @@
                             <ul class="nav pull-right">
                                 {% block userlinks %}
                                     {% if user.is_authenticated %}
-                                    <li class="dropdown">
-                                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">
-                                            {{ user }}
-                                            <b class="caret"></b>
-                                        </a>
-                                        <ul class="dropdown-menu">
-                                            <li>{% optional_logout request %}</li>
-                                        </ul>
-                                    </li>
+                                        {% optional_logout request user %}
                                     {% else %}
                                         <li>{% optional_login request %}</li>
                                     {% endif %}
@@ -85,7 +77,7 @@
                             <div class="btn-group format-selection">
                                 <a class="btn btn-primary js-tooltip" href='{{ request.get_full_path }}'
                                      rel="nofollow" title="Make a GET request on the {{ name }} resource">GET</a>
-        
+
                                 <button class="btn btn-primary dropdown-toggle js-tooltip" data-toggle="dropdown"
                                         title="Specify a format for the GET request">
                                     <span class="caret"></span>
@@ -144,7 +136,7 @@
                 </div>
 
                 {% if display_edit_forms %}
-    
+
                     {% if post_form or raw_data_post_form %}
                         <div {% if post_form %}class="tabbable"{% endif %}>
                             {% if post_form %}
@@ -190,7 +182,7 @@
                             </div>
                         </div>
                     {% endif %}
-    
+
                     {% if put_form or raw_data_put_form or raw_data_patch_form %}
                         <div {% if put_form %}class="tabbable"{% endif %}>
                             {% if put_form %}
@@ -246,7 +238,7 @@
                 {% endif %}
             </div>
             <!-- END Content -->
-            
+
             <footer>
                 {% block footer %}
                     <p>Sponsored by <a href="http://dabapps.com/">DabApps</a>.</p>
diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py
index b80a7d771..f7332c3b5 100644
--- a/rest_framework/templatetags/rest_framework.py
+++ b/rest_framework/templatetags/rest_framework.py
@@ -46,17 +46,26 @@ def optional_login(request):
 
 
 @register.simple_tag
-def optional_logout(request):
+def optional_logout(request, user):
     """
     Include a logout snippet if REST framework's logout view is in the URLconf.
     """
     try:
         logout_url = reverse('rest_framework:logout')
     except NoReverseMatch:
-        return ''
+        return '<li class="navbar-text">{0}</li>'.format(user)
 
-    snippet = "<a href='%s?next=%s'>Log out</a>" % (logout_url, escape(request.path))
-    return snippet
+    snippet = """<li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+            {0}
+            <b class="caret"></b>
+        </a>
+        <ul class="dropdown-menu">
+            <li><a href='{1}?next={2}'>Log out</a></li>
+        </ul>
+    </li>"""
+
+    return snippet.format(user, logout_url, escape(request.path))
 
 
 @register.simple_tag
diff --git a/tests/browsable_api/__init__.py b/tests/browsable_api/__init__.py
new file mode 100644
index 000000000..e69de29bb
diff --git a/tests/browsable_api/auth_urls.py b/tests/browsable_api/auth_urls.py
new file mode 100644
index 000000000..3cb2d8daf
--- /dev/null
+++ b/tests/browsable_api/auth_urls.py
@@ -0,0 +1,10 @@
+from __future__ import unicode_literals
+from django.conf.urls import patterns, url, include
+
+from views import MockView
+
+urlpatterns = patterns(
+    '',
+    (r'^$', MockView.as_view()),
+    url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')),
+)
diff --git a/tests/browsable_api/no_auth_urls.py b/tests/browsable_api/no_auth_urls.py
new file mode 100644
index 000000000..d9b9bc43d
--- /dev/null
+++ b/tests/browsable_api/no_auth_urls.py
@@ -0,0 +1,9 @@
+from __future__ import unicode_literals
+from django.conf.urls import patterns
+
+from views import MockView
+
+urlpatterns = patterns(
+    '',
+    (r'^$', MockView.as_view()),
+)
diff --git a/tests/browsable_api/test_browsable_api.py b/tests/browsable_api/test_browsable_api.py
new file mode 100644
index 000000000..61c76b4f7
--- /dev/null
+++ b/tests/browsable_api/test_browsable_api.py
@@ -0,0 +1,65 @@
+from __future__ import unicode_literals
+from django.contrib.auth.models import User
+from django.test import TestCase
+
+from rest_framework.test import APIClient
+
+
+class DropdownWithAuthTests(TestCase):
+    """Tests correct dropdown behaviour with Auth views enabled."""
+
+    urls = 'tests.browsable_api.auth_urls'
+
+    def setUp(self):
+        self.client = APIClient(enforce_csrf_checks=True)
+        self.username = 'john'
+        self.email = 'lennon@thebeatles.com'
+        self.password = 'password'
+        self.user = User.objects.create_user(self.username, self.email, self.password)
+
+    def tearDown(self):
+        self.client.logout()
+
+    def test_name_shown_when_logged_in(self):
+        self.client.login(username=self.username, password=self.password)
+        response = self.client.get('/')
+        self.assertContains(response, 'john')
+
+    def test_logout_shown_when_logged_in(self):
+        self.client.login(username=self.username, password=self.password)
+        response = self.client.get('/')
+        self.assertContains(response, '>Log out<')
+
+    def test_login_shown_when_logged_out(self):
+        response = self.client.get('/')
+        self.assertContains(response, '>Log in<')
+
+
+class NoDropdownWithoutAuthTests(TestCase):
+    """Tests correct dropdown behaviour with Auth views enabled."""
+
+    urls = 'tests.browsable_api.no_auth_urls'
+
+    def setUp(self):
+        self.client = APIClient(enforce_csrf_checks=True)
+        self.username = 'john'
+        self.email = 'lennon@thebeatles.com'
+        self.password = 'password'
+        self.user = User.objects.create_user(self.username, self.email, self.password)
+
+    def tearDown(self):
+        self.client.logout()
+
+    def test_name_shown_when_logged_in(self):
+        self.client.login(username=self.username, password=self.password)
+        response = self.client.get('/')
+        self.assertContains(response, 'john')
+
+    def test_dropdown_not_shown_when_logged_in(self):
+        self.client.login(username=self.username, password=self.password)
+        response = self.client.get('/')
+        self.assertNotContains(response, '<li class="dropdown">')
+
+    def test_dropdown_not_shown_when_logged_out(self):
+        response = self.client.get('/')
+        self.assertNotContains(response, '<li class="dropdown">')
diff --git a/tests/browsable_api/views.py b/tests/browsable_api/views.py
new file mode 100644
index 000000000..000f4e804
--- /dev/null
+++ b/tests/browsable_api/views.py
@@ -0,0 +1,15 @@
+from __future__ import unicode_literals
+
+from rest_framework.views import APIView
+from rest_framework import authentication
+from rest_framework import renderers
+from rest_framework.response import Response
+
+
+class MockView(APIView):
+
+    authentication_classes = (authentication.SessionAuthentication,)
+    renderer_classes = (renderers.BrowsableAPIRenderer,)
+
+    def get(self, request):
+        return Response({'a': 1, 'b': 2, 'c': 3})
