Add app_name in urls + tests

demo/project/urls.py

@@ -21,6 +21,7 @@
  url(r'^docs/', include('rest_framework_docs.urls')),
 
  # API
- url(r'^accounts/', view=include('project.accounts.urls', namespace='accounts')),
- url(r'^organisations/', view=include('project.organisations.urls', namespace='organisations')),
+ url(r'^accounts/', view=include('project.accounts.urls', namespace='accounts', app_name='accounts')),
+ url(r'^organisations/', view=include('project.organisations.urls', namespace='organisations',
+ app_name='organisations')),
 ]

rest_framework_docs/api_endpoint.py

@@ -9,13 +9,12 @@ class ApiEndpoint(object):
  def __init__(self, pattern, parent_pattern=None):
  self.pattern = pattern
  self.callback = pattern.callback
- # self.name = pattern.name
  self.docstring = self.__get_docstring__()
  if parent_pattern:
  self.name_parent = parent_pattern.namespace or parent_pattern.app_name or \
  simplify_regex(parent_pattern.regex.pattern).replace('/', '-')
  if hasattr(pattern.callback, 'cls') and issubclass(pattern.callback.cls, ModelViewSet):
- self.name_parent = '{} (REST)'.format(self.name_parent)
+ self.name_parent = '%s (REST)' % self.name_parent
  else:
  self.name_parent = ''
  self.path = self.__get_path__(parent_pattern)

tests/tests.py

@@ -30,16 +30,16 @@ def test_index_view_with_endpoints(self):
  self.assertEqual(len(response.context["endpoints"]), 10)
 
  # Test the login view
- self.assertEqual(response.context["endpoints"][0].name_parent, "accounts")
- self.assertEqual(response.context["endpoints"][0].allowed_methods, ['POST', 'OPTIONS'])
- self.assertEqual(response.context["endpoints"][0].path, "/accounts/login/")
- self.assertEqual(response.context["endpoints"][0].docstring, "A view that allows users to login providing their username and password.")
- self.assertEqual(len(response.context["endpoints"][0].fields), 2)
- self.assertEqual(response.context["endpoints"][0].fields[0]["type"], "CharField")
- self.assertTrue(response.context["endpoints"][0].fields[0]["required"])
+ self.assertEqual(response.context["endpoints"][1].name_parent, "accounts")
+ self.assertEqual(response.context["endpoints"][1].allowed_methods, ['POST', 'OPTIONS'])
+ self.assertEqual(response.context["endpoints"][1].path, "/accounts/login/")
+ self.assertEqual(response.context["endpoints"][1].docstring, "A view that allows users to login providing their username and password.")
+ self.assertEqual(len(response.context["endpoints"][1].fields), 2)
+ self.assertEqual(response.context["endpoints"][1].fields[0]["type"], "CharField")
+ self.assertTrue(response.context["endpoints"][1].fields[0]["required"])
 
  # The view "OrganisationErroredView" (organisations/(?P<slug>[\w-]+)/errored/) should contain an error.
- self.assertEqual(str(response.context["endpoints"][8].errors), "'test_value'")
+ self.assertEqual(str(response.context["endpoints"][9].errors), "'test_value'")
 
  def test_index_search_with_endpoints(self):
  response = self.client.get("%s?search=reset-password" % reverse("drfdocs"))
@@ -59,3 +59,42 @@ def test_index_view_docs_hidden(self):
 
  self.assertEqual(response.status_code, 404)
  self.assertEqual(response.reason_phrase.upper(), "NOT FOUND")
+
+ def test_index_view_with_existent_app_name(self):
+ """
+ Should load the drf docs view with all the endpoints contained in the specified app_name.
+ NOTE: Views that do **not** inherit from DRF's "APIView" are not included.
+ """
+ # Test 'accounts' app_name
+ response = self.client.get(reverse('drfdocs-ns', args=['accounts']))
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(len(response.context["endpoints"]), 5)
+
+ # Test the login view
+ self.assertEqual(response.context["endpoints"][0].name_parent, "accounts")
+ self.assertEqual(response.context["endpoints"][0].allowed_methods, ['POST', 'OPTIONS'])
+ self.assertEqual(response.context["endpoints"][0].path, "/accounts/login/")
+
+ # Test 'organisations' app_name
+ response = self.client.get(reverse('drfdocs-ns', args=['organisations']))
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(len(response.context["endpoints"]), 4)
+
+ # The view "OrganisationErroredView" (organisations/(?P<slug>[\w-]+)/errored/) should contain an error.
+ self.assertEqual(str(response.context["endpoints"][3].errors), "'test_value'")
+
+ def test_index_search_with_existent_app_name(self):
+ response = self.client.get("%s?search=reset-password" % reverse('drfdocs-ns', args=['accounts']))
+
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(len(response.context["endpoints"]), 2)
+ self.assertEqual(response.context["endpoints"][1].path, "/accounts/reset-password/confirm/")
+ self.assertEqual(len(response.context["endpoints"][1].fields), 3)
+
+ def test_index_view_with_non_existent_app_name(self):
+ """
+ Should load the drf docs view with no endpoint.
+ """
+ response = self.client.get(reverse('drfdocs-ns', args=['non_existent_app_name']))
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(len(response.context["endpoints"]), 0)

tests/urls.py

@@ -27,8 +27,8 @@
  url(r'^docs/', include('rest_framework_docs.urls')),
 
  # API
- url(r'^accounts/', view=include(accounts_urls, namespace='accounts')),
- url(r'^organisations/', view=include(organisations_urls, namespace='organisations')),
+ url(r'^accounts/', view=include(accounts_urls, namespace='accounts', app_name='accounts')),
+ url(r'^organisations/', view=include(organisations_urls, namespace='organisations', app_name='organisations')),
 
  # Endpoints without parents/namespaces
  url(r'^another-login/$', views.LoginView.as_view(), name="login"),