plain.oauth 0.19.1__tar.gz → 0.21.0__tar.gz

{plain_oauth-0.19.1 → plain_oauth-0.21.0}/PKG-INFO

@@ -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 → plain_oauth-0.21.0}/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-0.21.0/plain/oauth/exceptions.py

@@ -0,0 +1,16 @@
+class OAuthError(Exception):
+    """Base class for OAuth errors"""
+
+    message = "An error occurred during the OAuth process."
+
+
+class OAuthStateMissingError(OAuthError):
+    message = "The state parameter is missing. Please try again."
+
+
+class OAuthStateMismatchError(OAuthError):
+    message = "The state parameter did not match. Please try again."
+
+
+class OAuthUserAlreadyExistsError(OAuthError):
+    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-0.19.1 → plain_oauth-0.21.0}/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-0.19.1 → plain_oauth-0.21.0}/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-0.21.0/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-0.19.1 → plain_oauth-0.21.0}/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/tests/providers → plain_oauth-0.21.0/provider_examples}/bitbucket.py

@@ -69,7 +69,9 @@ class BitbucketOAuthProvider(OAuthProvider):
         ][0]
 
         return OAuthUser(
-            id=user_id,
-            email=confirmed_primary_email,
-            username=username,
+            provider_id=user_id,
+            user_model_fields={
+                "email": confirmed_primary_email,
+                "username": username,
+            },
         )

{plain_oauth-0.19.1/tests/providers → plain_oauth-0.21.0/provider_examples}/github.py

@@ -95,7 +95,9 @@ class GitHubOAuthProvider(OAuthProvider):
             raise OAuthError("A verified primary email address is required on GitHub")
 
         return OAuthUser(
-            id=user_id,
-            email=verified_primary_email,
-            username=username,
+            provider_id=user_id,
+            user_model_fields={
+                "email": verified_primary_email,
+                "username": username,
+            },
         )

{plain_oauth-0.19.1 → plain_oauth-0.21.0}/provider_examples/gitlab.py

@@ -51,7 +51,9 @@ class GitLabOAuthProvider(OAuthProvider):
         response.raise_for_status()
         data = response.json()
         return OAuthUser(
-            id=data["id"],
-            email=data["email"],
-            username=data["username"],
+            provider_id=data["id"],
+            user_model_fields={
+                "email": data["email"],
+                "username": data["username"],
+            },
         )

{plain_oauth-0.19.1 → plain_oauth-0.21.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.oauth"
-version = "0.19.1"
+version = "0.21.0"
 description = "OAuth login and API access for Plain."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"
@@ -13,10 +13,7 @@ dependencies = [
     "requests>=2.0.0",
 ]
 
-[tool.pytest.ini_options]
-python_files = "tests.py test_*.py *_tests.py"
-PLAIN_SETTINGS_MODULE = "tests.settings"
-FAIL_INVALID_TEMPLATE_VARS = true
+
 
 [tool.uv]
 dev-dependencies = [

{plain_oauth-0.19.1 → plain_oauth-0.21.0}/tests/provider_tests/test_github.py

@@ -13,9 +13,11 @@ class DummyGitHubOAuthProvider(GitHubOAuthProvider):
 
     def get_oauth_user(self, oauth_token):
         return OAuthUser(
-            id="99",
-            username="userone",
-            email="user@example.com",
+            provider_id="99",
+            user_model_fields={
+                "username": "userone",
+                "email": "user@example.com",
+            },
         )
 
 

{plain_oauth-0.19.1/provider_examples → plain_oauth-0.21.0/tests/providers}/bitbucket.py

@@ -69,7 +69,9 @@ class BitbucketOAuthProvider(OAuthProvider):
         ][0]
 
         return OAuthUser(
-            id=user_id,
-            email=confirmed_primary_email,
-            username=username,
+            provider_id=user_id,
+            user_model_fields={
+                "email": confirmed_primary_email,
+                "username": username,
+            },
         )

{plain_oauth-0.19.1/provider_examples → plain_oauth-0.21.0/tests/providers}/github.py

@@ -95,7 +95,9 @@ class GitHubOAuthProvider(OAuthProvider):
             raise OAuthError("A verified primary email address is required on GitHub")
 
         return OAuthUser(
-            id=user_id,
-            email=verified_primary_email,
-            username=username,
+            provider_id=user_id,
+            user_model_fields={
+                "email": verified_primary_email,
+                "username": username,
+            },
         )

{plain_oauth-0.19.1 → plain_oauth-0.21.0}/tests/providers/gitlab.py

@@ -51,7 +51,9 @@ class GitLabOAuthProvider(OAuthProvider):
         response.raise_for_status()
         data = response.json()
         return OAuthUser(
-            id=data["id"],
-            email=data["email"],
-            username=data["username"],
+            provider_id=data["id"],
+            user_model_fields={
+                "email": data["email"],
+                "username": data["username"],
+            },
         )

{plain_oauth-0.19.1 → plain_oauth-0.21.0}/tests/test_backends.py

@@ -10,9 +10,11 @@ class DummyProvider(OAuthProvider):
 
     def get_oauth_user(self, *, oauth_token):
         return OAuthUser(
-            id="dummy_user_id",
-            username="dummy_username",
-            email="dummy@example.com",
+            provider_id="dummy_user_id",
+            user_model_fields={
+                "username": "dummy_username",
+                "email": "dummy@example.com",
+            },
         )
 
     def check_request_state(self, *, request):

{plain_oauth-0.19.1 → plain_oauth-0.21.0}/tests/test_providers.py

@@ -38,9 +38,11 @@ class DummyProvider(OAuthProvider):
 
     def get_oauth_user(self, *, oauth_token: OAuthToken) -> OAuthUser:
         return OAuthUser(
-            id="dummy_id",
-            email="dummy@example.com",
-            username="dummy_username",
+            provider_id="dummy_id",
+            user_model_fields={
+                "email": "dummy@example.com",
+                "username": "dummy_username",
+            },
         )
 
 

plain_oauth-0.19.1/plain/oauth/exceptions.py

@@ -1,12 +0,0 @@
-class OAuthError(Exception):
-    """Base class for OAuth errors"""
-
-    pass
-
-
-class OAuthStateMismatchError(OAuthError):
-    pass
-
-
-class OAuthUserAlreadyExistsError(OAuthError):
-    pass

plain_oauth-0.19.1/plain/oauth/templates/oauth/error.html

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