oauthlib_backend_class is now pluggable through oauth2_settings.OAUTH2_BACKEND_CLASS

Author: palazzem

oauth2_provider/oauth2_backends.py

@@ -144,4 +144,4 @@ def get_oauthlib_core():
     from oauthlib.oauth2 import Server
 
     server = Server(oauth2_settings.OAUTH2_VALIDATOR_CLASS())
-    return OAuthLibCore(server)
+    return oauth2_settings.OAUTH2_BACKEND_CLASS(server)

oauth2_provider/settings.py

@@ -34,6 +34,7 @@
     'CLIENT_SECRET_GENERATOR_CLASS': 'oauth2_provider.generators.ClientSecretGenerator',
     'CLIENT_SECRET_GENERATOR_LENGTH': 128,
     'OAUTH2_VALIDATOR_CLASS': 'oauth2_provider.oauth2_validators.OAuth2Validator',
+    'OAUTH2_BACKEND_CLASS': 'oauth2_provider.oauth2_backends.OAuthLibCore',
     'SCOPES': {"read": "Reading scope", "write": "Writing scope"},
     'READ_SCOPE': 'read',
     'WRITE_SCOPE': 'write',
@@ -52,6 +53,7 @@
     'CLIENT_ID_GENERATOR_CLASS',
     'CLIENT_SECRET_GENERATOR_CLASS',
     'OAUTH2_VALIDATOR_CLASS',
+    'OAUTH2_BACKEND_CLASS',
     'SCOPES',
     'ALLOWED_REDIRECT_URI_SCHEMES',
 )
@@ -61,6 +63,7 @@
     'CLIENT_ID_GENERATOR_CLASS',
     'CLIENT_SECRET_GENERATOR_CLASS',
     'OAUTH2_VALIDATOR_CLASS',
+    'OAUTH2_BACKEND_CLASS',
 )
 
 

oauth2_provider/tests/test_client_credential.py

@@ -14,6 +14,7 @@
 from oauthlib.oauth2 import BackendApplicationServer
 
 from ..models import get_application_model, AccessToken
+from ..oauth2_backends import OAuthLibCore
 from ..oauth2_validators import OAuth2Validator
 from ..settings import oauth2_settings
 from ..views import ProtectedResourceView
@@ -114,6 +115,7 @@ def test_extended_request(self):
         class TestView(OAuthLibMixin, View):
             server_class = BackendApplicationServer
             validator_class = OAuth2Validator
+            oauthlib_backend_class = OAuthLibCore
 
             def get_scopes(self):
                 return ['read', 'write']

oauth2_provider/tests/test_mixins.py

@@ -8,6 +8,7 @@
 from oauthlib.oauth2 import Server
 
 from ..views.mixins import OAuthLibMixin, ScopedResourceMixin, ProtectedResourceMixin
+from ..oauth2_backends import OAuthLibCore
 from ..oauth2_validators import OAuth2Validator
 
 
@@ -18,9 +19,19 @@ def setUpClass(cls):
 
 
 class TestOAuthLibMixin(BaseTest):
+    def test_missing_oauthlib_backend_class(self):
+        class TestView(OAuthLibMixin, View):
+            server_class = Server
+            validator_class = OAuth2Validator
+
+        test_view = TestView()
+
+        self.assertRaises(ImproperlyConfigured, test_view.get_oauthlib_backend_class)
+
     def test_missing_server_class(self):
         class TestView(OAuthLibMixin, View):
             validator_class = OAuth2Validator
+            oauthlib_backend_class = OAuthLibCore
 
         test_view = TestView()
 
@@ -29,6 +40,7 @@ class TestView(OAuthLibMixin, View):
     def test_missing_validator_class(self):
         class TestView(OAuthLibMixin, View):
             server_class = Server
+            oauthlib_backend_class = OAuthLibCore
 
         test_view = TestView()
 
@@ -38,6 +50,7 @@ def test_correct_server(self):
         class TestView(OAuthLibMixin, View):
             server_class = Server
             validator_class = OAuth2Validator
+            oauthlib_backend_class = OAuthLibCore
 
         request = self.request_factory.get("/fake-req")
         request.user = "fake"

oauth2_provider/views/base.py

@@ -73,6 +73,7 @@ class AuthorizationView(BaseAuthorizationView, FormView):
 
     server_class = Server
     validator_class = oauth2_settings.OAUTH2_VALIDATOR_CLASS
+    oauthlib_backend_class = oauth2_settings.OAUTH2_BACKEND_CLASS
 
     skip_authorization_completely = False
 
@@ -164,6 +165,7 @@ class TokenView(CsrfExemptMixin, OAuthLibMixin, View):
     """
     server_class = Server
     validator_class = oauth2_settings.OAUTH2_VALIDATOR_CLASS
+    oauthlib_backend_class = oauth2_settings.OAUTH2_BACKEND_CLASS
 
     @method_decorator(sensitive_post_parameters('password'))
     def post(self, request, *args, **kwargs):
@@ -181,6 +183,7 @@ class RevokeTokenView(CsrfExemptMixin, OAuthLibMixin, View):
     """
     server_class = Server
     validator_class = oauth2_settings.OAUTH2_VALIDATOR_CLASS
+    oauthlib_backend_class = oauth2_settings.OAUTH2_BACKEND_CLASS
 
     def post(self, request, *args, **kwargs):
         url, headers, body, status = self.create_revocation_response(request)

oauth2_provider/views/generic.py

@@ -12,6 +12,7 @@ class ProtectedResourceView(ProtectedResourceMixin, View):
     """
     server_class = Server
     validator_class = oauth2_settings.OAUTH2_VALIDATOR_CLASS
+    oauthlib_backend_class = oauth2_settings.OAUTH2_BACKEND_CLASS
 
 
 class ScopedProtectedResourceView(ScopedResourceMixin, ProtectedResourceView):

oauth2_provider/views/mixins.py

@@ -5,7 +5,6 @@
 from django.core.exceptions import ImproperlyConfigured
 from django.http import HttpResponseForbidden
 
-from ..oauth2_backends import OAuthLibCore
 from ..exceptions import FatalClientError
 from ..settings import oauth2_settings
 
@@ -30,6 +29,7 @@ class OAuthLibMixin(object):
     """
     server_class = None
     validator_class = None
+    oauthlib_backend_class = None
 
     @classmethod
     def get_server_class(cls):
@@ -58,12 +58,14 @@ def get_validator_class(cls):
     @classmethod
     def get_oauthlib_backend_class(cls):
         """
-        Return the OAuthLibCore implementation class to use, silently
-        defaults to OAuthLibCore class from oauth2_provider package
+        Return the OAuthLibCore implementation class to use
         """
-        if not hasattr(cls, 'oauthlib_backend_class'):
-            return OAuthLibCore
-        return cls.oauthlib_backend_class
+        if cls.oauthlib_backend_class is None:
+            raise ImproperlyConfigured(
+                "OAuthLibMixin requires either a definition of 'oauthlib_backend_class'"
+                " or an implementation of 'get_oauthlib_backend_class()'")
+        else:
+            return cls.oauthlib_backend_class
 
     @classmethod
     def get_server(cls):