plain.oauth 0.25.1__tar.gz → 0.27.0__tar.gz

{plain_oauth-0.25.1 → plain_oauth-0.27.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: plain.oauth
-Version: 0.25.1
+Version: 0.27.0
 Summary: Let users log in with OAuth providers.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
 License-File: LICENSE
-Requires-Python: >=3.11
+Requires-Python: >=3.13
 Requires-Dist: plain-auth<1.0.0
 Requires-Dist: plain-models<1.0.0
 Requires-Dist: plain<1.0.0

{plain_oauth-0.25.1 → plain_oauth-0.27.0}/plain/oauth/CHANGELOG.md

@@ -1,5 +1,29 @@
 # plain-oauth changelog
 
+## [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
+
+- Model queries now use `.query` instead of `.objects` ([037a239](https://github.com/dropseed/plain/commit/037a239ef4))
+- Minimum Python version increased to 3.13 ([d86e307](https://github.com/dropseed/plain/commit/d86e307efb))
+
+### Upgrade instructions
+
+- Update any custom code that references `OAuthConnection.objects` to use `OAuthConnection.query` instead
+
 ## [0.25.1](https://github.com/dropseed/plain/releases/plain-oauth@0.25.1) (2025-08-22)
 
 ### What's changed

{plain_oauth-0.25.1 → plain_oauth-0.27.0}/plain/oauth/admin.py

@@ -15,7 +15,7 @@ class ProvidersChartCard(ChartCard):
 
     def get_chart_data(self) -> dict:
         results = (
-            OAuthConnection.objects.all()
+            OAuthConnection.query.all()
             .values("provider_key")
             .annotate(count=Count("id"))
         )

{plain_oauth-0.25.1 → plain_oauth-0.27.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
 
@@ -95,7 +95,7 @@ class OAuthConnection(models.Model):
         cls, *, provider_key: str, oauth_token: "OAuthToken", oauth_user: "OAuthUser"
     ) -> "OAuthConnection":
         try:
-            connection = cls.objects.get(
+            connection = cls.query.get(
                 provider_key=provider_key,
                 provider_user_id=oauth_user.provider_id,
             )
@@ -134,7 +134,7 @@ class OAuthConnection(models.Model):
         Connect will either create a new connection or update an existing connection
         """
         try:
-            connection = cls.objects.get(
+            connection = cls.query.get(
                 user=user,
                 provider_key=provider_key,
                 provider_user_id=oauth_user.provider_id,
@@ -155,24 +155,17 @@ 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
 
         try:
             keys_in_db = set(
-                cls.objects.values_list("provider_key", flat=True).distinct()
+                cls.query.values_list("provider_key", flat=True).distinct()
             )
         except (OperationalError, ProgrammingError):
             # Check runs on plain migrate, and the table may not exist yet
@@ -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.25.1 → plain_oauth-0.27.0}/plain/oauth/providers.py

@@ -144,7 +144,7 @@ class OAuthProvider:
 
     def handle_disconnect_request(self, *, request: HttpRequest) -> Response:
         provider_user_id = request.data["provider_user_id"]
-        connection = OAuthConnection.objects.get(
+        connection = OAuthConnection.query.get(
             provider_key=self.provider_key, provider_user_id=provider_user_id
         )
         connection.delete()

{plain_oauth-0.25.1 → plain_oauth-0.27.0}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "plain.oauth"
-version = "0.25.1"
+version = "0.27.0"
 description = "Let users log in with OAuth providers."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"
 readme = "README.md"
-requires-python = ">=3.11"
+requires-python = ">=3.13"
 dependencies = [
     "plain<1.0.0",
     "plain.auth<1.0.0",

{plain_oauth-0.25.1 → plain_oauth-0.27.0}/tests/app/templates/index.html

@@ -5,7 +5,7 @@ Hello {{ request.user }}!
 
 <h2>Existing connections</h2>
 <ul>
-    {% for connection in request.user.oauth_connections.all() %}
+    {% for connection in request.user.oauth_connections.query.all() %}
     <li>
         {{ connection.provider_key }} [ID: {{ connection.provider_user_id }}]
         <form action="{{ url('oauth:disconnect', connection.provider_key) }}" method="post">

{plain_oauth-0.25.1 → plain_oauth-0.27.0}/tests/provider_tests/test_github.py

@@ -62,7 +62,7 @@ def test_github_provider(db, settings):
     user = response.user
     assert user.username == "userone"
     assert user.email == "user@example.com"
-    connections = user.oauth_connections.all()
+    connections = user.oauth_connections.query.all()
     assert len(connections) == 1
     assert connections[0].provider_key == "github"
     assert connections[0].provider_user_id == "99"

{plain_oauth-0.25.1 → plain_oauth-0.27.0}/tests/test_checks.py

@@ -14,18 +14,16 @@ def test_oauth_provider_keys_check_pass(db, settings):
         },
     }
 
-    user = get_user_model().objects.create(
-        username="test_user", email="test@example.com"
-    )
+    user = get_user_model().query.create(username="test_user", email="test@example.com")
 
-    OAuthConnection.objects.create(
+    OAuthConnection.query.create(
         user=user,
         provider_key="google",
         provider_user_id="test_provider_user_id",
         access_token="test",
     )
 
-    errors = OAuthConnection.check(database=True)
+    errors = OAuthConnection.preflight()
     assert len(errors) == 0
 
 
@@ -41,26 +39,24 @@ def test_oauth_provider_keys_check_fail(db, settings):
         },
     }
 
-    user = get_user_model().objects.create(
-        username="test_user", email="test@example.com"
-    )
+    user = get_user_model().query.create(username="test_user", email="test@example.com")
 
-    OAuthConnection.objects.create(
+    OAuthConnection.query.create(
         user=user,
         provider_key="google",
         provider_user_id="test_provider_user_id",
         access_token="test",
     )
-    OAuthConnection.objects.create(
+    OAuthConnection.query.create(
         user=user,
         provider_key="bar",
         provider_user_id="test_provider_user_id",
         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."
     )

{plain_oauth-0.25.1 → plain_oauth-0.27.0}/tests/test_providers.py

@@ -60,8 +60,8 @@ def test_dummy_signup(db, settings):
 
     client = Client()
 
-    assert get_user_model().objects.count() == 0
-    assert OAuthConnection.objects.count() == 0
+    assert get_user_model().query.count() == 0
+    assert OAuthConnection.query.count() == 0
 
     # Login required for this view
     response = client.get("/")
@@ -90,7 +90,7 @@ def test_dummy_signup(db, settings):
     user = response.user
     assert user.username == "dummy_username"
     assert user.email == "dummy@example.com"
-    connections = user.oauth_connections.all()
+    connections = user.oauth_connections.query.all()
     assert len(connections) == 1
     assert connections[0].provider_key == "dummy"
     assert connections[0].provider_user_id == "dummy_id"
@@ -103,8 +103,8 @@ def test_dummy_signup(db, settings):
         2020, 1, 2, 0, 0, tzinfo=datetime.UTC
     )
 
-    assert get_user_model().objects.count() == 1
-    assert OAuthConnection.objects.count() == 1
+    assert get_user_model().query.count() == 1
+    assert OAuthConnection.query.count() == 1
 
 
 def test_dummy_login_connection(db, settings):
@@ -121,14 +121,14 @@ def test_dummy_login_connection(db, settings):
 
     client = Client()
 
-    assert get_user_model().objects.count() == 0
-    assert OAuthConnection.objects.count() == 0
+    assert get_user_model().query.count() == 0
+    assert OAuthConnection.query.count() == 0
 
     # Create a user
-    user = get_user_model().objects.create(
+    user = get_user_model().query.create(
         username="dummy_username", email="dummy@example.com"
     )
-    OAuthConnection.objects.create(
+    OAuthConnection.query.create(
         user=user,
         provider_key="dummy",
         provider_user_id="dummy_id",
@@ -142,8 +142,8 @@ def test_dummy_login_connection(db, settings):
         ),
     )
 
-    assert get_user_model().objects.count() == 1
-    assert OAuthConnection.objects.count() == 1
+    assert get_user_model().query.count() == 1
+    assert OAuthConnection.query.count() == 1
 
     # Login required for this view
     response = client.get("/")
@@ -172,7 +172,7 @@ def test_dummy_login_connection(db, settings):
     user = response.user
     assert user.username == "dummy_username"
     assert user.email == "dummy@example.com"
-    connections = user.oauth_connections.all()
+    connections = user.oauth_connections.query.all()
     assert len(connections) == 1
     assert connections[0].provider_key == "dummy"
     assert connections[0].provider_user_id == "dummy_id"
@@ -185,8 +185,8 @@ def test_dummy_login_connection(db, settings):
         2020, 1, 2, 0, 0, tzinfo=datetime.UTC
     )
 
-    assert get_user_model().objects.count() == 1
-    assert OAuthConnection.objects.count() == 1
+    assert get_user_model().query.count() == 1
+    assert OAuthConnection.query.count() == 1
 
 
 def test_dummy_login_without_connection(db, settings):
@@ -203,16 +203,14 @@ def test_dummy_login_without_connection(db, settings):
 
     client = Client()
 
-    assert get_user_model().objects.count() == 0
-    assert OAuthConnection.objects.count() == 0
+    assert get_user_model().query.count() == 0
+    assert OAuthConnection.query.count() == 0
 
     # Create a user
-    get_user_model().objects.create(
-        username="dummy_username", email="dummy@example.com"
-    )
+    get_user_model().query.create(username="dummy_username", email="dummy@example.com")
 
-    assert get_user_model().objects.count() == 1
-    assert OAuthConnection.objects.count() == 0
+    assert get_user_model().query.count() == 1
+    assert OAuthConnection.query.count() == 0
 
     # Login required for this view
     response = client.get("/")
@@ -247,16 +245,16 @@ def test_dummy_connect(db, settings):
 
     client = Client()
 
-    assert get_user_model().objects.count() == 0
-    assert OAuthConnection.objects.count() == 0
+    assert get_user_model().query.count() == 0
+    assert OAuthConnection.query.count() == 0
 
     # Create a user
-    user = get_user_model().objects.create(
+    user = get_user_model().query.create(
         username="dummy_username", email="dummy@example.com"
     )
 
-    assert get_user_model().objects.count() == 1
-    assert OAuthConnection.objects.count() == 0
+    assert get_user_model().query.count() == 1
+    assert OAuthConnection.query.count() == 0
 
     client.force_login(user)
 
@@ -277,7 +275,7 @@ def test_dummy_connect(db, settings):
 
     # Check the user and connection that was created
     user = response.user
-    connections = user.oauth_connections.all()
+    connections = user.oauth_connections.query.all()
     assert len(connections) == 1
     assert connections[0].provider_key == "dummy"
     assert connections[0].provider_user_id == "dummy_id"
@@ -290,8 +288,8 @@ def test_dummy_connect(db, settings):
         2020, 1, 2, 0, 0, tzinfo=datetime.UTC
     )
 
-    assert get_user_model().objects.count() == 1
-    assert OAuthConnection.objects.count() == 1
+    assert get_user_model().query.count() == 1
+    assert OAuthConnection.query.count() == 1
 
 
 # def test_dummy_disconnect_to_password(db, client, settings):
@@ -306,14 +304,14 @@ def test_dummy_connect(db, settings):
 #         }
 #     }
 
-#     assert get_user_model().objects.count() == 0
-#     assert OAuthConnection.objects.count() == 0
+#     assert get_user_model().query.count() == 0
+#     assert OAuthConnection.query.count() == 0
 
 #     # Create a user
-#     user = get_user_model().objects.create(
+#     user = get_user_model().query.create(
 #         username="dummy_username", email="dummy@example.com", password="dummy_password"
 #     )
-#     OAuthConnection.objects.create(
+#     OAuthConnection.query.create(
 #         user=user,
 #         provider_key="dummy",
 #         provider_user_id="dummy_id",
@@ -327,8 +325,8 @@ def test_dummy_connect(db, settings):
 #         ),
 #     )
 
-#     assert get_user_model().objects.count() == 1
-#     assert OAuthConnection.objects.count() == 1
+#     assert get_user_model().query.count() == 1
+#     assert OAuthConnection.query.count() == 1
 
 #     client.force_login(user)
 
@@ -339,8 +337,8 @@ def test_dummy_connect(db, settings):
 #     assert response.status_code == 302
 #     assert response.url == "/"
 
-#     assert get_user_model().objects.count() == 1
-#     assert OAuthConnection.objects.count() == 0
+#     assert get_user_model().query.count() == 1
+#     assert OAuthConnection.query.count() == 0
 
 
 # def test_dummy_disconnect_to_connection(db, client, settings):
@@ -355,14 +353,14 @@ def test_dummy_connect(db, settings):
 #         }
 #     }
 
-#     assert get_user_model().objects.count() == 0
-#     assert OAuthConnection.objects.count() == 0
+#     assert get_user_model().query.count() == 0
+#     assert OAuthConnection.query.count() == 0
 
 #     # Create a user
-#     user = get_user_model().objects.create(
+#     user = get_user_model().query.create(
 #         username="dummy_username", email="dummy@example.com"
 #     )
-#     OAuthConnection.objects.create(
+#     OAuthConnection.query.create(
 #         user=user,
 #         provider_key="dummy",
 #         provider_user_id="dummy_id",
@@ -375,7 +373,7 @@ def test_dummy_connect(db, settings):
 #             2020, 1, 2, 0, 0, tzinfo=datetime.timezone.utc
 #         ),
 #     )
-#     OAuthConnection.objects.create(
+#     OAuthConnection.query.create(
 #         user=user,
 #         provider_key="dummy",
 #         provider_user_id="dummy_id2",
@@ -389,8 +387,8 @@ def test_dummy_connect(db, settings):
 #         ),
 #     )
 
-#     assert get_user_model().objects.count() == 1
-#     assert OAuthConnection.objects.count() == 2
+#     assert get_user_model().query.count() == 1
+#     assert OAuthConnection.query.count() == 2
 
 #     client.force_login(user)
 
@@ -401,8 +399,8 @@ def test_dummy_connect(db, settings):
 #     assert response.status_code == 302
 #     assert response.url == "/"
 
-#     assert get_user_model().objects.count() == 1
-#     assert OAuthConnection.objects.count() == 1
+#     assert get_user_model().query.count() == 1
+#     assert OAuthConnection.query.count() == 1
 
 
 # def test_dummy_disconnect_last(db, client, settings):
@@ -417,14 +415,14 @@ def test_dummy_connect(db, settings):
 #         }
 #     }
 
-#     assert get_user_model().objects.count() == 0
-#     assert OAuthConnection.objects.count() == 0
+#     assert get_user_model().query.count() == 0
+#     assert OAuthConnection.query.count() == 0
 
 #     # Create a user
-#     user = get_user_model().objects.create(
+#     user = get_user_model().query.create(
 #         username="dummy_username", email="dummy@example.com"
 #     )
-#     OAuthConnection.objects.create(
+#     OAuthConnection.query.create(
 #         user=user,
 #         provider_key="dummy",
 #         provider_user_id="dummy_id",
@@ -438,8 +436,8 @@ def test_dummy_connect(db, settings):
 #         ),
 #     )
 
-#     assert get_user_model().objects.count() == 1
-#     assert OAuthConnection.objects.count() == 1
+#     assert get_user_model().query.count() == 1
+#     assert OAuthConnection.query.count() == 1
 
 #     client.force_login(user)
 
@@ -450,8 +448,8 @@ def test_dummy_connect(db, settings):
 #     assert response.status_code == 400
 #     assert response.templates[0].name == "oauth/error.html"
 
-#     assert get_user_model().objects.count() == 1
-#     assert OAuthConnection.objects.count() == 1
+#     assert get_user_model().query.count() == 1
+#     assert OAuthConnection.query.count() == 1
 
 
 def test_dummy_refresh(db, settings, monkeypatch):
@@ -466,10 +464,10 @@ def test_dummy_refresh(db, settings, monkeypatch):
         }
     }
 
-    user = get_user_model().objects.create(
+    user = get_user_model().query.create(
         username="dummy_username", email="dummy@example.com"
     )
-    connection = OAuthConnection.objects.create(
+    connection = OAuthConnection.query.create(
         user=user,
         provider_key="dummy",
         provider_user_id="dummy_id",