Merge remote-tracking branch 'upstream/master'

# Conflicts: #	rest_framework_docs/__init__.py #	rest_framework_docs/api_endpoint.py #	tests/tests.py

Author: Marc

.travis.yml

@@ -11,6 +11,14 @@ env:
  - DJANGO_VERSION=1.8
  - DJANGO_VERSION=1.9
 
+cache:
+ - pip
+ - directories:
+ - rest_framework_docs/static/node_modules/
+
+before_install:
+ - nvm install 5
+
 install:
  - cd rest_framework_docs/static/ && npm install && cd ../../
  - pip install -r requirements.txt

codecov.yml

@@ -0,0 +1,11 @@
+coverage:
+ precision: 2
+ round: down
+ range: "70...100"
+
+ status:
+ project: false
+ patch: false
+ changes: false
+
+comment: off

docs/changelog.md

@@ -3,6 +3,11 @@ title: "Changelog"
 source_filename: "changelog"
 ---
 
+### Release 0.0.10
+
+ - Use get_serializer_class for Views without serlaizer_class attribute [#92](https://github.com/ekonstantinidis/django-rest-framework-docs/pull/92)
+
+
 ### Release 0.0.9
 
  - Support for more types of `ROOT_URLCONF`

docs/installation.md

@@ -22,4 +22,4 @@ Finally include the `rest_framework_docs` urls in your `urls.py`:
   url(r'^docs/', include('rest_framework_docs.urls')),
  ]
 
-You can now visit [http://0.0.0.0:/8000/docs/](http://0.0.0.0:/8000/docs/) to view your Web API's docs.
+You can now visit [http://0.0.0.0:/8000/docs/](http://0.0.0.0:8000/docs/) to view your Web API's docs.

docs/templates.md

@@ -36,7 +36,7 @@ To hide the GitHub badge from the page, just override it with an empty block.
  {% block jumbotron %}
  <div class="jumbotron">
   <h1>Project Title</h1>
-  <h3>Documentantion of the project 'Example'.</h3>
+  <h3>Documentation of the project 'Example'.</h3>
  </div>
  {% endblock %}
 
@@ -65,7 +65,7 @@ File location: `templates/rest_framework_docs/docs.html`
  {% block jumbotron %}
  <div class="jumbotron">
   <h1>'Project Name' Web API</h1>
-  <h3>Documentantion of the 'Project Name' Web API.</h3>
+  <h3>Documentation of the 'Project Name' Web API.</h3>
  </div>
  {% endblock %}
 

rest_framework_docs/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '0.0.9'
+__version__ = '0.0.10'
 
 SERIALIZER_FIELDS = {}

rest_framework_docs/api_endpoint.py

@@ -35,7 +35,6 @@ def __init__(self, pattern, parent_pattern=None):
  self.path = self.__get_path__(parent_pattern)
  self.allowed_methods = self.__get_allowed_methods__()
  self.errors = None
- self.nb_recurse = 0
  self.fields = self.__get_serializer_fields__()
  self.fields_json = self.__get_serializer_fields_json__()
  self.permissions = self.__get_permissions_class__()
@@ -64,18 +63,20 @@ def __get_permissions_class__(self):
 
  def __get_serializer_fields__(self):
  fields = []
+ serializer = None
 
- if hasattr(self.callback.cls, 'serializer_class') and hasattr(self.callback.cls.serializer_class, 'get_fields'):
+ if hasattr(self.callback.cls, 'serializer_class'):
  serializer = self.callback.cls.serializer_class
- if hasattr(serializer, 'get_fields'):
- try:
- fields = self.__get_fields__(serializer)
- except KeyError as e:
- self.errors = e
- fields = []
-
- # FIXME:
- # Show more attibutes of `field`?
+
+ elif hasattr(self.callback.cls, 'get_serializer_class'):
+ serializer = self.callback.cls.get_serializer_class(self.pattern.callback.cls())
+
+ if hasattr(serializer, 'get_fields'):
+ try:
+ fields = self.__get_fields__(serializer)
+ except KeyError as e:
+ self.errors = e
+ fields = []
 
  return fields
 

tests/tests.py

@@ -28,19 +28,27 @@ def test_index_view_with_endpoints(self):
  response = self.client.get(reverse('drfdocs'))
 
  self.assertEqual(response.status_code, 200)
- self.assertEqual(len(response.context["endpoints"]), 10)
+ self.assertEqual(len(response.context["endpoints"]), 11)
 
  # 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, ['OPTIONS', 'POST'])
- 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(response.context["endpoints"][1].allowed_methods, ['POST', 'OPTIONS'])
+ self.assertEqual(response.context["endpoints"][1].path, "/accounts/login2/")
+ self.assertEqual(response.context["endpoints"][1].docstring, "A view that allows users to login providing their username and password. Without serializer_class")
  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"][7].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"))

tests/urls.py

@@ -7,6 +7,7 @@
 
 accounts_urls = [
  url(r'^login/$', views.LoginView.as_view(), name="login"),
+ url(r'^login2/$', views.LoginWithSerilaizerClassView.as_view(), name="login2"),
  url(r'^register/$', views.UserRegistrationView.as_view(), name="register"),
  url(r'^reset-password/$', view=views.PasswordResetView.as_view(), name="reset-password"),
  url(r'^reset-password/confirm/$', views.PasswordResetConfirmView.as_view(), name="reset-password-confirm"),

tests/views.py

@@ -111,3 +111,24 @@ def delete(self, request, *args, **kwargs):
 class OrganisationErroredView(generics.ListAPIView):
 
  serializer_class = serializers.OrganisationErroredSerializer
+
+
+class LoginWithSerilaizerClassView(APIView):
+ """
+ A view that allows users to login providing their username and password. Without serializer_class
+ """
+
+ throttle_classes = ()
+ permission_classes = ()
+ parser_classes = (parsers.FormParser, parsers.MultiPartParser, parsers.JSONParser,)
+ renderer_classes = (renderers.JSONRenderer,)
+
+ def post(self, request):
+ serializer = self.serializer_class(data=request.data)
+ serializer.is_valid(raise_exception=True)
+ user = serializer.validated_data['user']
+ token, created = Token.objects.get_or_create(user=user)
+ return Response({'token': token.key})
+
+ def get_serializer_class(self):
+ return AuthTokenSerializer