django-api-versioning 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

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

{django_api_versioning-0.1.1.dist-info → django_api_versioning-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-api-versioning
-Version: 0.1.1
+Version: 0.1.3
 Summary: Django API versioning decorator provides a solution for managing multiple API versions within the Django framework, enabling versioning through URLs with backward compatibility and automatically registering routes.
 Home-page: https://github.com/mojtaba-arvin/django-api-versioning
 Author: Mojtaba Arvin
@@ -15,7 +15,7 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
+Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: Django>=3.2

{django_api_versioning-0.1.1.dist-info → django_api_versioning-0.1.3.dist-info}/RECORD

@@ -1,17 +1,17 @@
 django_api_versioning/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_api_versioning/decorators.py,sha256=YHyIapxlaQ3IgZnkdjjJ7QXaZxsMFjq-2TY12a5pXAA,3888
+django_api_versioning/decorators.py,sha256=5xWC5gIeDvkaH9UqmLv5eL0FxQ856451_QLMMi_7ex8,4180
 django_api_versioning/exceptions.py,sha256=MgCpaNBsD8laQoVIVK823_t1liQ82K_uqguuA60PxXQ,485
 django_api_versioning/registry.py,sha256=FCRTHGyl995U1kLlxtIBp3lb62v-6AbSK9k3orzZxWA,1140
 django_api_versioning/settings.py,sha256=8p57CIEQR65luxU7xo-eYdH-lSGGk3-BQFMVRRFG2pY,2975
 django_api_versioning/urls.py,sha256=B8UBYSXdyq_xTpWeN5zzH2SQzKiqZQMx3WFBrsu93X0,144
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_decorators.py,sha256=G2G3PR_QAPNyJuaw7H9BMARSOK8C6GJlHRAL3KmTuCY,3587
+tests/test_decorators.py,sha256=qtscdA3Sz7eZBwtjSXKBkfOZBcRk2ckm8i1E5t-ihUs,5104
 tests/test_exceptions.py,sha256=fsyfA7ouIMqz6Emexqo_oB7oVEZlhqptNmwH8KX37s8,863
 tests/test_registry.py,sha256=KQT6yWkfKZmcLShFkidHwfJfPi8yHN5i9xuzC3vqDso,2634
 tests/test_settings.py,sha256=SjieOTnwHdU0E6A2-qLE3iXG5osY3qacbAzJJ7tqD-0,5213
 tests/test_urls.py,sha256=DA8DbIEAYX812Re2PlTkL1OpkwCO2IZ1vW_QMh2d9nI,1207
-django_api_versioning-0.1.1.dist-info/LICENSE,sha256=iDPJdze6sBlBBSoB-BIyT2iHfHDGUAaZG3nTFd6m2FQ,1070
-django_api_versioning-0.1.1.dist-info/METADATA,sha256=vJvAL-_cghuGe-GbXQ1KyqjGE-xcfGcpifb-gRi5jRg,10679
-django_api_versioning-0.1.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-django_api_versioning-0.1.1.dist-info/top_level.txt,sha256=F4n1zaE6P--9OytuMrvCD50vn7NvIVWkIl6ie9fsFck,28
-django_api_versioning-0.1.1.dist-info/RECORD,,
+django_api_versioning-0.1.3.dist-info/LICENSE,sha256=iDPJdze6sBlBBSoB-BIyT2iHfHDGUAaZG3nTFd6m2FQ,1070
+django_api_versioning-0.1.3.dist-info/METADATA,sha256=qtUKqfKFPH_YbzkBDfydKKnUtCU31gOISnAHX5VtyCY,10679
+django_api_versioning-0.1.3.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+django_api_versioning-0.1.3.dist-info/top_level.txt,sha256=F4n1zaE6P--9OytuMrvCD50vn7NvIVWkIl6ie9fsFck,28
+django_api_versioning-0.1.3.dist-info/RECORD,,

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}"