plain.oauth 0.19.0__py3-none-any.whl → 0.20.0__py3-none-any.whl

plain/oauth/exceptions.py

@@ -1,12 +1,16 @@
 class OAuthError(Exception):
     """Base class for OAuth errors"""
 
-    pass
+    message = "An error occurred during the OAuth process."
+
+
+class OAuthStateMissingError(OAuthError):
+    message = "The state parameter is missing. Please try again."
 
 
 class OAuthStateMismatchError(OAuthError):
-    pass
+    message = "The state parameter did not match. Please try again."
 
 
 class OAuthUserAlreadyExistsError(OAuthError):
-    pass
+    message = "A user already exists with this email address. Please log in first and then connect this OAuth provider to the existing account."

plain/oauth/migrations/0005_alter_oauthconnection_unique_together_and_more.py

@@ -6,7 +6,6 @@ from plain.models import migrations
 
 class Migration(migrations.Migration):
     dependencies = [
-        ("users", "__first__"),
         ("plainoauth", "0004_alter_oauthconnection_access_token_and_more"),
     ]
 

plain/oauth/providers.py

@@ -7,10 +7,11 @@ from plain.auth import login as auth_login
 from plain.http import HttpRequest, Response, ResponseRedirect
 from plain.runtime import settings
 from plain.urls import reverse
+from plain.utils.cache import add_never_cache_headers
 from plain.utils.crypto import get_random_string
 from plain.utils.module_loading import import_string
 
-from .exceptions import OAuthError, OAuthStateMismatchError
+from .exceptions import OAuthError, OAuthStateMismatchError, OAuthStateMissingError
 from .models import OAuthConnection
 
 SESSION_STATE_KEY = "plainoauth_state"
@@ -105,7 +106,11 @@ class OAuthProvider:
         if error := request.query_params.get("error"):
             raise OAuthError(error)
 
-        state = request.query_params["state"]
+        try:
+            state = request.query_params["state"]
+        except KeyError as e:
+            raise OAuthStateMissingError() from e
+
         expected_state = request.session.pop(SESSION_STATE_KEY)
         request.session.save()  # Make sure the pop is saved (won't save on an exception)
         if not secrets.compare_digest(state, expected_state):
@@ -130,7 +135,7 @@ class OAuthProvider:
         # Sort authorization params for consistency
         sorted_authorization_params = sorted(authorization_params.items())
         redirect_url = authorization_url + "?" + urlencode(sorted_authorization_params)
-        return ResponseRedirect(redirect_url)
+        return self.get_redirect_response(redirect_url)
 
     def handle_connect_request(
         self, *, request: HttpRequest, redirect_to: str = ""
@@ -144,7 +149,7 @@ class OAuthProvider:
         )
         connection.delete()
         redirect_url = self.get_disconnect_redirect_url(request=request)
-        return ResponseRedirect(redirect_url)
+        return self.get_redirect_response(redirect_url)
 
     def handle_callback_request(self, *, request: HttpRequest) -> Response:
         self.check_request_state(request=request)
@@ -174,7 +179,7 @@ class OAuthProvider:
             self.login(request=request, user=user)
 
         redirect_url = self.get_login_redirect_url(request=request)
-        return ResponseRedirect(redirect_url)
+        return self.get_redirect_response(redirect_url)
 
     def login(self, *, request: HttpRequest, user: Any) -> Response:
         auth_login(request=request, user=user)
@@ -185,6 +190,15 @@ class OAuthProvider:
     def get_disconnect_redirect_url(self, *, request: HttpRequest) -> str:
         return request.data.get("next", "/")
 
+    def get_redirect_response(self, redirect_url: str) -> Response:
+        """
+        Returns a redirect response to the given URL.
+        This is a utility method to ensure consistent redirect handling.
+        """
+        response = ResponseRedirect(redirect_url)
+        add_never_cache_headers(response)
+        return response
+
 
 def get_oauth_provider_instance(*, provider_key: str) -> OAuthProvider:
     OAUTH_LOGIN_PROVIDERS = getattr(settings, "OAUTH_LOGIN_PROVIDERS", {})

plain/oauth/templates/oauth/callback.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block content %}
+<div class="text-center">
+    <h1 class="text-lg">OAuth Error</h1>
+    <p>{{ oauth_error.message }}</p>
+</div>
+{% endblock %}

plain/oauth/views.py

@@ -1,14 +1,11 @@
 import logging
 
 from plain.auth.views import AuthViewMixin
-from plain.http import ResponseBadRequest, ResponseRedirect
-from plain.templates import Template
-from plain.views import View
+from plain.http import ResponseRedirect
+from plain.views import TemplateView, View
 
 from .exceptions import (
     OAuthError,
-    OAuthStateMismatchError,
-    OAuthUserAlreadyExistsError,
 )
 from .providers import get_oauth_provider_instance
 
@@ -26,39 +23,29 @@ class OAuthLoginView(View):
         return provider_instance.handle_login_request(request=request)
 
 
-class OAuthCallbackView(View):
+class OAuthCallbackView(TemplateView):
     """
     The callback view is used for signup, login, and connect.
     """
 
+    template_name = "oauth/callback.html"
+
     def get(self):
-        request = self.request
         provider = self.url_kwargs["provider"]
         provider_instance = get_oauth_provider_instance(provider_key=provider)
         try:
-            return provider_instance.handle_callback_request(request=request)
-        except OAuthUserAlreadyExistsError:
-            template = Template("oauth/error.html")
-            return ResponseBadRequest(
-                template.render(
-                    {
-                        "oauth_error": "A user already exists with this email address. Please log in first and then connect this OAuth provider to the existing account."
-                    }
-                )
-            )
-        except OAuthStateMismatchError:
-            template = Template("oauth/error.html")
-            return ResponseBadRequest(
-                template.render(
-                    {
-                        "oauth_error": "The state parameter did not match. Please try again."
-                    }
-                )
-            )
+            return provider_instance.handle_callback_request(request=self.request)
         except OAuthError as e:
             logger.exception("OAuth error")
-            template = Template("oauth/error.html")
-            return ResponseBadRequest(template.render({"oauth_error": str(e)}))
+            self.oauth_error = e
+
+            # Return a regular template response with the error
+            return 400, super().get()
+
+    def get_template_context(self) -> dict:
+        context = super().get_template_context()
+        context["oauth_error"] = getattr(self, "oauth_error", None)
+        return context
 
 
 class OAuthConnectView(AuthViewMixin, View):

{plain_oauth-0.19.0.dist-info → plain_oauth-0.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.oauth
-Version: 0.19.0
+Version: 0.20.0
 Summary: OAuth login and API access for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause

{plain_oauth-0.19.0.dist-info → plain_oauth-0.20.0.dist-info}/RECORD

@@ -3,21 +3,21 @@ plain/oauth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 plain/oauth/admin.py,sha256=rqrGRRUVxOlG9wiuXtndIyQxd1VT67cvFy6qWo7LF-Q,1278
 plain/oauth/config.py,sha256=0Q4IILBKQbIaxqeL9WRTH5Cka-BO3c3SOj1AdQIAJgc,167
 plain/oauth/default_settings.py,sha256=dlN1J9vSOjjxPNLp-0qe-cLTqwM4E69ZAx_8lpxMhaM,28
-plain/oauth/exceptions.py,sha256=TMGtIGkK3_J4rsEy1oPCmia7BnRSK8N8RMZm4_pNelA,189
+plain/oauth/exceptions.py,sha256=yoZsq8XgzstuwbE2ihoet0nzpw_sVZgDrwUauh6hhUs,546
 plain/oauth/models.py,sha256=ceSw9AKZMXffE4ZKZLxIbOlSyndTCHL22GCuSF3Hpmk,6880
-plain/oauth/providers.py,sha256=M8r_XkKgyCz8YkLyFyNOt35EHThDvwggcDlUoC7ZYwo,7187
+plain/oauth/providers.py,sha256=F5w1ZE0iEF8QZT4cdO6L7v5p2zHxby5_n-f6J0MM12E,7729
 plain/oauth/urls.py,sha256=FYzpQwhvZdcat8n3f7RyA-1Q21finKb8JEyakSOjXXg,696
-plain/oauth/views.py,sha256=dVlFYGsEusD2lr24eVRLVfHfEEreg_1nByepiIOoWLk,3047
+plain/oauth/views.py,sha256=I27UHQ-MgWVFRoeQUIsZZ81u2V8JXGJ6R3m2TO1lc8U,2408
 plain/oauth/migrations/0001_initial.py,sha256=B9Finbn7ijEIUbkDy_B7UsKQLfMWaXd0Kx3oZrUENWc,1753
 plain/oauth/migrations/0002_alter_oauthconnection_options_and_more.py,sha256=3Mb0IU9KDRQfog0PjVbzuNv_AxCs7UVHnA0F263AKNo,581
 plain/oauth/migrations/0003_alter_oauthconnection_access_token_and_more.py,sha256=FyLfwxc2pRzF-CbdRFQRRSQTOCxc9l1womgStygm_lo,629
 plain/oauth/migrations/0004_alter_oauthconnection_access_token_and_more.py,sha256=ho9CG-lf7OVg1vBnjn7miihoioNmOIz7ObxB2QkPeSo,652
-plain/oauth/migrations/0005_alter_oauthconnection_unique_together_and_more.py,sha256=3hmuSvIZhn-haEKOGN3lQzcXD7b_Hy0P8Wa7LOAvJ1k,576
+plain/oauth/migrations/0005_alter_oauthconnection_unique_together_and_more.py,sha256=MdTjX5Awff0QPesdAT5JuToitnbphgIh-nsJnZEAAa0,544
 plain/oauth/migrations/0006_remove_oauthconnection_unique_oauth_provider_user_id_and_more.py,sha256=UjWRezZoAzjVS70oCRQ38k_w6YJtcd_uSYT4Kc3H1pg,713
 plain/oauth/migrations/0007_alter_oauthconnection_provider_key_and_more.py,sha256=B_LW6xG1o_uA13tqUs0KniXl1JBNbQu4wMh2pW8rq5I,675
 plain/oauth/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plain/oauth/templates/oauth/error.html,sha256=xkkWw57sZ3fz4dDfH30SVtq3okJNnJmrSRPfGxrxjh8,108
-plain_oauth-0.19.0.dist-info/METADATA,sha256=nX2C7XH2T6yiXmdkky5STCgWjEkFREIvYmUU-KqeQGU,10304
-plain_oauth-0.19.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain_oauth-0.19.0.dist-info/licenses/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
-plain_oauth-0.19.0.dist-info/RECORD,,
+plain/oauth/templates/oauth/callback.html,sha256=4CJG0oAN0xYjw2IPkjaL7B4hwlf9um9LI4CTu50E-yE,173
+plain_oauth-0.20.0.dist-info/METADATA,sha256=oBC0SBDaGuX3RV27Wfa-VHBymwrHRLqfjoImzOvKfIM,10304
+plain_oauth-0.20.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain_oauth-0.20.0.dist-info/licenses/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
+plain_oauth-0.20.0.dist-info/RECORD,,

plain/oauth/templates/oauth/error.html

@@ -1,6 +0,0 @@
-{% extends "base.html" %}
-
-{% block content %}
-<h1>OAuth Error</h1>
-<p>{{ oauth_error }}</p>
-{% endblock %}