Merge pull request #46 from ekonstantinidis/rename-hidden-setting

Change 'HIDDEN' setting to 'HIDE_DOCS'

Author: ekonstantinidis

rest_framework_docs/settings.py

@@ -5,7 +5,7 @@ class DRFSettings(object):
 
     def __init__(self):
         self.drf_settings = {
-            "HIDDEN": self.get_setting("HIDDEN") or False
+            "HIDE_DOCS": self.get_setting("HIDE_DOCS") or False
         }
 
     def get_setting(self, name):

rest_framework_docs/views.py

@@ -10,7 +10,7 @@ class DRFDocsView(TemplateView):
 
     def get_context_data(self, **kwargs):
         settings = DRFSettings().settings
-        if settings["HIDDEN"]:
+        if settings["HIDE_DOCS"]:
             raise Http404("Django Rest Framework Docs are hidden. Check your settings.")
 
         context = super(DRFDocsView, self).get_context_data(**kwargs)

tests/settings.py

@@ -32,7 +32,7 @@
 ROOT_URLCONF = 'tests.urls'
 
 REST_FRAMEWORK_DOCS = {
-    'HIDDEN': False
+    'HIDE_DOCS': False
 }
 
 # Static files (CSS, JavaScript, Images)

tests/tests.py

@@ -6,7 +6,7 @@
 class DRFDocsViewTests(TestCase):
 
     SETTINGS_HIDE_DOCS = {
-        'HIDDEN': True  # Default: False
+        'HIDE_DOCS': True  # Default: False
     }
 
     def setUp(self):
@@ -16,7 +16,7 @@ def test_settings_module(self):
 
         settings = DRFSettings()
 
-        self.assertEqual(settings.get_setting("HIDDEN"), False)
+        self.assertEqual(settings.get_setting("HIDE_DOCS"), False)
         self.assertEqual(settings.get_setting("TEST"), None)
 
     def test_index_view_with_endpoints(self):
@@ -52,8 +52,8 @@ def test_index_search_with_endpoints(self):
     @override_settings(REST_FRAMEWORK_DOCS=SETTINGS_HIDE_DOCS)
     def test_index_view_docs_hidden(self):
         """
-        Should prevent the docs from loading the "HIDDEN" is set
-        to "False" in settings
+        Should prevent the docs from loading the "HIDE_DOCS" is set
+        to "True" or undefined under settings
         """
         response = self.client.get(reverse('drfdocs'))