plain.oauth 0.26.0__tar.gz → 0.28.0__tar.gz

{plain_oauth-0.26.0 → plain_oauth-0.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.oauth
-Version: 0.26.0
+Version: 0.28.0
 Summary: Let users log in with OAuth providers.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause

{plain_oauth-0.26.0 → plain_oauth-0.28.0}/plain/oauth/CHANGELOG.md

@@ -1,5 +1,29 @@
 # plain-oauth changelog
 
+## [0.28.0](https://github.com/dropseed/plain/releases/plain-oauth@0.28.0) (2025-09-30)
+
+### What's changed
+
+- `HttpRequest` has been renamed to `Request` throughout the OAuth provider classes ([cd46ff2](https://github.com/dropseed/plain/commit/cd46ff2003))
+
+### Upgrade instructions
+
+- If you have custom OAuth providers that override methods like `get_authorization_url_params`, `get_oauth_token`, `get_callback_url`, or any other methods that accept a request parameter, update the type hint from `HttpRequest` to `Request`
+- Update any imports of `HttpRequest` in custom OAuth provider code to import `Request` instead from `plain.http`
+
+## [0.27.0](https://github.com/dropseed/plain/releases/plain-oauth@0.27.0) (2025-09-25)
+
+### What's changed
+
+- The `OAuthConnection.check()` method has been replaced with `OAuthConnection.preflight()` as part of the new preflight system ([b0b610d](https://github.com/dropseed/plain/commit/b0b610d461))
+- Preflight check IDs have been renamed from numeric format (e.g., `plain.oauth.E001`) to descriptive names (e.g., `oauth.provider_in_db_not_in_settings`) ([cd96c97](https://github.com/dropseed/plain/commit/cd96c97b25))
+- Preflight messages now provide clearer fix instructions directly in the `fix` attribute ([c7cde12](https://github.com/dropseed/plain/commit/c7cde12149))
+
+### Upgrade instructions
+
+- If you have custom code that calls `OAuthConnection.check()`, update it to use `OAuthConnection.preflight()` instead
+- If you have code that references specific preflight check IDs (e.g., `plain.oauth.E001`), update them to use the new descriptive format (e.g., `oauth.provider_in_db_not_in_settings`)
+
 ## [0.26.0](https://github.com/dropseed/plain/releases/plain-oauth@0.26.0) (2025-09-12)
 
 ### What's changed

{plain_oauth-0.26.0 → plain_oauth-0.28.0}/plain/oauth/models.py

@@ -5,7 +5,7 @@ from plain.auth import get_user_model
 from plain.exceptions import ValidationError
 from plain.models import transaction
 from plain.models.db import IntegrityError, OperationalError, ProgrammingError
-from plain.preflight import Error
+from plain.preflight import PreflightResult
 from plain.runtime import SettingsReference
 from plain.utils import timezone
 
@@ -155,18 +155,11 @@ class OAuthConnection(models.Model):
         return connection
 
     @classmethod
-    def check(cls, **kwargs):
+    def preflight(cls):
         """
         A system check for ensuring that provider_keys in the database are also present in settings.
-
-        Note that the --database flag is required for this to work:
-          plain check --database default
         """
-        errors = super().check(**kwargs)
-
-        database = kwargs.get("database", False)
-        if not database:
-            return errors
+        errors = super().preflight()
 
         from .providers import get_provider_keys
 
@@ -183,11 +176,11 @@ class OAuthConnection(models.Model):
 
         if keys_in_db - keys_in_settings:
             errors.append(
-                Error(
-                    "The following OAuth providers are in the database but not in the settings: {}".format(
+                PreflightResult(
+                    fix="The following OAuth providers are in the database but not in the settings: {}. Add these providers to your OAUTH_LOGIN_PROVIDERS setting or remove the corresponding OAuthConnection records.".format(
                         ", ".join(keys_in_db - keys_in_settings)
                     ),
-                    id="plain.oauth.E001",
+                    id="oauth.provider_in_db_not_in_settings",
                 )
             )
 

{plain_oauth-0.26.0 → plain_oauth-0.28.0}/plain/oauth/providers.py

@@ -4,7 +4,7 @@ from typing import Any
 from urllib.parse import urlencode
 
 from plain.auth import login as auth_login
-from plain.http import HttpRequest, Response, ResponseRedirect
+from plain.http import Request, Response, ResponseRedirect
 from plain.runtime import settings
 from plain.urls import reverse
 from plain.utils.cache import add_never_cache_headers
@@ -65,7 +65,7 @@ class OAuthProvider:
         self.client_secret = client_secret
         self.scope = scope
 
-    def get_authorization_url_params(self, *, request: HttpRequest) -> dict:
+    def get_authorization_url_params(self, *, request: Request) -> dict:
         return {
             "redirect_uri": self.get_callback_url(request=request),
             "client_id": self.get_client_id(),
@@ -77,13 +77,13 @@ class OAuthProvider:
     def refresh_oauth_token(self, *, oauth_token: OAuthToken) -> OAuthToken:
         raise NotImplementedError()
 
-    def get_oauth_token(self, *, code: str, request: HttpRequest) -> OAuthToken:
+    def get_oauth_token(self, *, code: str, request: Request) -> OAuthToken:
         raise NotImplementedError()
 
     def get_oauth_user(self, *, oauth_token: OAuthToken) -> OAuthUser:
         raise NotImplementedError()
 
-    def get_authorization_url(self, *, request: HttpRequest) -> str:
+    def get_authorization_url(self, *, request: Request) -> str:
         return self.authorization_url
 
     def get_client_id(self) -> str:
@@ -95,14 +95,14 @@ class OAuthProvider:
     def get_scope(self) -> str:
         return self.scope
 
-    def get_callback_url(self, *, request: HttpRequest) -> str:
+    def get_callback_url(self, *, request: Request) -> str:
         url = reverse("oauth:callback", provider=self.provider_key)
         return request.build_absolute_uri(url)
 
     def generate_state(self) -> str:
         return get_random_string(length=32)
 
-    def check_request_state(self, *, request: HttpRequest) -> None:
+    def check_request_state(self, *, request: Request) -> None:
         if error := request.query_params.get("error"):
             raise OAuthError(error)
 
@@ -117,7 +117,7 @@ class OAuthProvider:
             raise OAuthStateMismatchError()
 
     def handle_login_request(
-        self, *, request: HttpRequest, redirect_to: str = ""
+        self, *, request: Request, redirect_to: str = ""
     ) -> Response:
         authorization_url = self.get_authorization_url(request=request)
         authorization_params = self.get_authorization_url_params(request=request)
@@ -138,11 +138,11 @@ class OAuthProvider:
         return self.get_redirect_response(redirect_url)
 
     def handle_connect_request(
-        self, *, request: HttpRequest, redirect_to: str = ""
+        self, *, request: Request, redirect_to: str = ""
     ) -> Response:
         return self.handle_login_request(request=request, redirect_to=redirect_to)
 
-    def handle_disconnect_request(self, *, request: HttpRequest) -> Response:
+    def handle_disconnect_request(self, *, request: Request) -> Response:
         provider_user_id = request.data["provider_user_id"]
         connection = OAuthConnection.query.get(
             provider_key=self.provider_key, provider_user_id=provider_user_id
@@ -151,7 +151,7 @@ class OAuthProvider:
         redirect_url = self.get_disconnect_redirect_url(request=request)
         return self.get_redirect_response(redirect_url)
 
-    def handle_callback_request(self, *, request: HttpRequest) -> Response:
+    def handle_callback_request(self, *, request: Request) -> Response:
         self.check_request_state(request=request)
 
         oauth_token = self.get_oauth_token(
@@ -181,13 +181,13 @@ class OAuthProvider:
         redirect_url = self.get_login_redirect_url(request=request)
         return self.get_redirect_response(redirect_url)
 
-    def login(self, *, request: HttpRequest, user: Any) -> None:
+    def login(self, *, request: Request, user: Any) -> None:
         auth_login(request=request, user=user)
 
-    def get_login_redirect_url(self, *, request: HttpRequest) -> str:
+    def get_login_redirect_url(self, *, request: Request) -> str:
         return request.session.pop(SESSION_NEXT_KEY, "/")
 
-    def get_disconnect_redirect_url(self, *, request: HttpRequest) -> str:
+    def get_disconnect_redirect_url(self, *, request: Request) -> str:
         return request.data.get("next", "/")
 
     def get_redirect_response(self, redirect_url: str) -> Response:

{plain_oauth-0.26.0 → plain_oauth-0.28.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.oauth"
-version = "0.26.0"
+version = "0.28.0"
 description = "Let users log in with OAuth providers."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"

{plain_oauth-0.26.0 → plain_oauth-0.28.0}/tests/test_checks.py

@@ -23,7 +23,7 @@ def test_oauth_provider_keys_check_pass(db, settings):
         access_token="test",
     )
 
-    errors = OAuthConnection.check(database=True)
+    errors = OAuthConnection.preflight()
     assert len(errors) == 0
 
 
@@ -54,9 +54,9 @@ def test_oauth_provider_keys_check_fail(db, settings):
         access_token="test",
     )
 
-    errors = OAuthConnection.check(database=True)
+    errors = OAuthConnection.preflight()
     assert len(errors) == 1
     assert (
-        errors[0].msg
-        == "The following OAuth providers are in the database but not in the settings: bar"
+        errors[0].fix
+        == "The following OAuth providers are in the database but not in the settings: bar. Add these providers to your OAUTH_LOGIN_PROVIDERS setting or remove the corresponding OAuthConnection records."
     )