Ensure support for class-based views and add corresponding test cases

Author: mojtaba-arvin

django_api_versioning/decorators.py

@@ -1,5 +1,6 @@
 from functools import wraps
 from typing import Callable, Optional, List
+from django.views import View
 from .settings import api_settings as settings
 from .registry import registry
 from .exceptions import InvalidVersionError, VersionRangeError, VersionTypeError
@@ -41,8 +42,13 @@ def endpoint(
     """
 
     def decorator(func: Callable) -> Callable:
+        
         @wraps(func)
         def view(*args, **kwargs):
+            # Check if the view is a class-based view (CBV)
+            if isinstance(func, type) and issubclass(func, View):
+                # For class-based views, ensure it's called as a method
+                return func.as_view()(*args, **kwargs)
             return func(*args, **kwargs)
 
         # Read API versioning settings

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="django-api-versioning",
-    version="0.1.2",
+    version="0.1.3",
     author="Mojtaba Arvin",
     author_email="ArvinDevDay@gmail.com",
     description= (

tests/test_decorators.py

@@ -1,10 +1,13 @@
 import pytest
 from unittest.mock import patch
+from django.http import JsonResponse
+from django.views import View
 from django_api_versioning.settings import api_settings as settings
 from django_api_versioning.registry import registry
 from django_api_versioning.decorators import endpoint
 from django_api_versioning.exceptions import InvalidVersionError, VersionTypeError, VersionRangeError
 
+
 @pytest.fixture(autouse=True)
 def clear_registered_routes():
     """Clear the registry before each test to ensure isolation."""
@@ -86,3 +89,34 @@ def test_missing_api_version_settings():
             @endpoint("users", version=2)
             def test_view():
                 pass
+
+def test_class_based_view(mock_settings):
+    # Create a class-based view and decorate it with the `endpoint` decorator
+    @endpoint("users", version=2)
+    class UsersView(View):
+        def get(self, request):
+            return JsonResponse({"message": "API Version 2 Users"})
+
+    # Register the view and check if the route is correctly registered
+    registered_routes = [str(p.pattern) for p in registry.urlpatterns]
+    assert "api/v2/users" in registered_routes, f"Route for version 2 is missing: {registered_routes}"
+
+def test_class_based_view_with_invalid_version(mock_settings):
+    # Test invalid version for class-based view
+    with pytest.raises(InvalidVersionError):
+        @endpoint("users", version=4)
+        class UsersView(View):
+            def get(self, request):
+                return JsonResponse({"message": "API Version 4 Users"})
+
+def test_class_based_view_with_backward_compatibility(mock_settings):
+    # Test class-based view with backward compatibility
+    @endpoint("users", version=3)
+    class UsersView(View):
+        def get(self, request):
+            return JsonResponse({"message": "API Version 3 Users"})
+
+    registered_routes = [str(p.pattern) for p in registry.urlpatterns]
+    # Assert that versions 1, 2, and 3 are registered for backward compatibility
+    for version in range(1, 4):
+        assert f"api/v{version}/users" in registered_routes, f"Missing route for v{version}: {registered_routes}"