plain.oauth 0.19.1__py3-none-any.whl → 0.21.0__py3-none-any.whl

plain/oauth/README.md

@@ -89,10 +89,12 @@ class ExampleOAuthProvider(OAuthProvider):
         data = response.json()
         return OAuthUser(
             # The provider ID is required
-            id=data["id"],
-            # And you can populate any of your User model fields with additional kwargs
-            email=data["email"],
-            username=data["username"],
+            provider_id=data["id"],
+            # Populate your User model fields using the user_model_fields dict
+            user_model_fields={
+                "email": data["email"],
+                "username": data["username"],
+            },
         )
 ```
 

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/models.py

@@ -76,7 +76,7 @@ class OAuthConnection(models.Model):
         self.refresh_token_expires_at = oauth_token.refresh_token_expires_at
 
     def set_user_fields(self, oauth_user: "OAuthUser"):
-        self.provider_user_id = oauth_user.id
+        self.provider_user_id = oauth_user.provider_id
 
     def access_token_expired(self) -> bool:
         return (
@@ -97,7 +97,7 @@ class OAuthConnection(models.Model):
         try:
             connection = cls.objects.get(
                 provider_key=provider_key,
-                provider_user_id=oauth_user.id,
+                provider_user_id=oauth_user.provider_id,
             )
             connection.set_token_fields(oauth_token)
             connection.save()
@@ -137,7 +137,7 @@ class OAuthConnection(models.Model):
             connection = cls.objects.get(
                 user=user,
                 provider_key=provider_key,
-                provider_user_id=oauth_user.id,
+                provider_user_id=oauth_user.provider_id,
             )
         except cls.DoesNotExist:
             # Create our own instance (not using get_or_create)
@@ -145,7 +145,7 @@ class OAuthConnection(models.Model):
             connection = cls(
                 user=user,
                 provider_key=provider_key,
-                provider_user_id=oauth_user.id,
+                provider_user_id=oauth_user.provider_id,
             )
 
         connection.set_user_fields(oauth_user)

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"
@@ -23,8 +24,8 @@ class OAuthToken:
         *,
         access_token: str,
         refresh_token: str = "",
-        access_token_expires_at: datetime.datetime = None,
-        refresh_token_expires_at: datetime.datetime = None,
+        access_token_expires_at: datetime.datetime | None = None,
+        refresh_token_expires_at: datetime.datetime | None = None,
     ):
         self.access_token = access_token
         self.refresh_token = refresh_token
@@ -33,16 +34,16 @@ class OAuthToken:
 
 
 class OAuthUser:
-    def __init__(self, *, id: str, **user_model_fields: dict):
-        self.id = id  # ID on the provider's system
-        self.user_model_fields = user_model_fields
+    def __init__(self, *, provider_id: str, user_model_fields: dict | None = None):
+        self.provider_id = provider_id  # ID on the provider's system
+        self.user_model_fields = user_model_fields or {}
 
     def __str__(self):
         if "email" in self.user_model_fields:
             return self.user_model_fields["email"]
         if "username" in self.user_model_fields:
             return self.user_model_fields["username"]
-        return str(self.id)
+        return str(self.provider_id)
 
 
 class OAuthProvider:
@@ -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,9 +179,9 @@ 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:
+    def login(self, *, request: HttpRequest, user: Any) -> None:
         auth_login(request=request, user=user)
 
     def get_login_redirect_url(self, *, request: HttpRequest) -> str:
@@ -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,30 @@ 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
+
+            response = super().get()
+            response.status_code = 400
+            return response
+
+    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.1.dist-info → plain_oauth-0.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.oauth
-Version: 0.19.1
+Version: 0.21.0
 Summary: OAuth login and API access for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
@@ -103,10 +103,12 @@ class ExampleOAuthProvider(OAuthProvider):
         data = response.json()
         return OAuthUser(
             # The provider ID is required
-            id=data["id"],
-            # And you can populate any of your User model fields with additional kwargs
-            email=data["email"],
-            username=data["username"],
+            provider_id=data["id"],
+            # Populate your User model fields using the user_model_fields dict
+            user_model_fields={
+                "email": data["email"],
+                "username": data["username"],
+            },
         )
 ```
 

{plain_oauth-0.19.1.dist-info → plain_oauth-0.21.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-plain/oauth/README.md,sha256=9_l9lOSndGBG31mD3oteT8UJMeonuCKdBreLQhUO70E,9900
+plain/oauth/README.md,sha256=N8getAUUhLX6P4mg-5P0V41gk5EKBGb8v904OfP2Z9E,9961
 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/models.py,sha256=ceSw9AKZMXffE4ZKZLxIbOlSyndTCHL22GCuSF3Hpmk,6880
-plain/oauth/providers.py,sha256=M8r_XkKgyCz8YkLyFyNOt35EHThDvwggcDlUoC7ZYwo,7187
+plain/oauth/exceptions.py,sha256=yoZsq8XgzstuwbE2ihoet0nzpw_sVZgDrwUauh6hhUs,546
+plain/oauth/models.py,sha256=_DS8Mv-dn_a9EO63aNb8oV8jxXUgHkoytrMkBritVhQ,6916
+plain/oauth/providers.py,sha256=YDftJUMyyfXgsDCkyTNxGwrbwXAowL0Hg6KrwrAN5S0,7793
 plain/oauth/urls.py,sha256=FYzpQwhvZdcat8n3f7RyA-1Q21finKb8JEyakSOjXXg,696
-plain/oauth/views.py,sha256=dVlFYGsEusD2lr24eVRLVfHfEEreg_1nByepiIOoWLk,3047
+plain/oauth/views.py,sha256=J2NCa37YediBTi82CfRlmsb45hFT6gWN6zMaFHhsDMM,2410
 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
@@ -16,8 +16,8 @@ plain/oauth/migrations/0005_alter_oauthconnection_unique_together_and_more.py,sh
 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.1.dist-info/METADATA,sha256=Iemik0OPAMnSfBFMTCdu6qmDNFQlrgrZhtJiAVmH994,10304
-plain_oauth-0.19.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain_oauth-0.19.1.dist-info/licenses/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
-plain_oauth-0.19.1.dist-info/RECORD,,
+plain/oauth/templates/oauth/callback.html,sha256=4CJG0oAN0xYjw2IPkjaL7B4hwlf9um9LI4CTu50E-yE,173
+plain_oauth-0.21.0.dist-info/METADATA,sha256=mdMZjbi7Tp69z0XeUxO2jDUEdLQpZcWqT7dseHafO0Y,10365
+plain_oauth-0.21.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain_oauth-0.21.0.dist-info/licenses/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
+plain_oauth-0.21.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 %}