plain.oauth 0.20.0__tar.gz → 0.22.0__tar.gz

{plain_oauth-0.20.0 → plain_oauth-0.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.oauth
-Version: 0.20.0
+Version: 0.22.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.22.0/plain/oauth/CHANGELOG.md

@@ -0,0 +1,11 @@
+# plain-oauth changelog
+
+## [0.22.0](https://github.com/dropseed/plain/releases/plain-oauth@0.22.0) (2025-06-23)
+
+### What's changed
+
+- Updated `OAuthConnection.check()` to accept a single `database` argument instead of the older `databases` list, matching the new single `DATABASE` setting used across the Plain stack ([d346d81](https://github.com/dropseed/plain/commit/d346d81))
+
+### Upgrade instructions
+
+- No changes required.

{plain_oauth-0.20.0 → plain_oauth-0.22.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.20.0 → plain_oauth-0.22.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)
@@ -164,34 +164,31 @@ class OAuthConnection(models.Model):
         """
         errors = super().check(**kwargs)
 
-        databases = kwargs.get("databases", None)
-        if not databases:
+        database = kwargs.get("database", False)
+        if not database:
             return errors
 
         from .providers import get_provider_keys
 
-        for database in databases:
-            try:
-                keys_in_db = set(
-                    cls.objects.using(database)
-                    .values_list("provider_key", flat=True)
-                    .distinct()
-                )
-            except (OperationalError, ProgrammingError):
-                # Check runs on manage.py migrate, and the table may not exist yet
-                # or it may not be installed on the particular database intentionally
-                continue
-
-            keys_in_settings = set(get_provider_keys())
-
-            if keys_in_db - keys_in_settings:
-                errors.append(
-                    Error(
-                        "The following OAuth providers are in the database but not in the settings: {}".format(
-                            ", ".join(keys_in_db - keys_in_settings)
-                        ),
-                        id="plain.oauth.E001",
-                    )
+        try:
+            keys_in_db = set(
+                cls.objects.values_list("provider_key", flat=True).distinct()
+            )
+        except (OperationalError, ProgrammingError):
+            # Check runs on manage.py migrate, and the table may not exist yet
+            # or it may not be installed on the particular database intentionally
+            return errors
+
+        keys_in_settings = set(get_provider_keys())
+
+        if keys_in_db - keys_in_settings:
+            errors.append(
+                Error(
+                    "The following OAuth providers are in the database but not in the settings: {}".format(
+                        ", ".join(keys_in_db - keys_in_settings)
+                    ),
+                    id="plain.oauth.E001",
                 )
+            )
 
         return errors

{plain_oauth-0.20.0 → plain_oauth-0.22.0}/plain/oauth/providers.py

@@ -24,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
@@ -34,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:
@@ -181,7 +181,7 @@ 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) -> Response:
+    def login(self, *, request: HttpRequest, user: Any) -> None:
         auth_login(request=request, user=user)
 
     def get_login_redirect_url(self, *, request: HttpRequest) -> str:

{plain_oauth-0.20.0 → plain_oauth-0.22.0}/plain/oauth/views.py

@@ -39,8 +39,9 @@ class OAuthCallbackView(TemplateView):
             logger.exception("OAuth error")
             self.oauth_error = e
 
-            # Return a regular template response with the error
-            return 400, super().get()
+            response = super().get()
+            response.status_code = 400
+            return response
 
     def get_template_context(self) -> dict:
         context = super().get_template_context()

{plain_oauth-0.20.0/tests/providers → plain_oauth-0.22.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.20.0/tests/providers → plain_oauth-0.22.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.20.0 → plain_oauth-0.22.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.20.0 → plain_oauth-0.22.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.oauth"
-version = "0.20.0"
+version = "0.22.0"
 description = "OAuth login and API access for Plain."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 license = "BSD-3-Clause"

{plain_oauth-0.20.0 → plain_oauth-0.22.0}/tests/app/settings.py

@@ -9,11 +9,9 @@ INSTALLED_PACKAGES = [
     "plain.oauth",
     "app.users",
 ]
-DATABASES = {
-    "default": {
-        "ENGINE": "plain.models.backends.sqlite3",
-        "NAME": ":memory:",
-    }
+DATABASE = {
+    "ENGINE": "plain.models.backends.sqlite3",
+    "NAME": ":memory:",
 }
 MIDDLEWARE = [
     "plain.sessions.middleware.SessionMiddleware",

{plain_oauth-0.20.0 → plain_oauth-0.22.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.20.0/provider_examples → plain_oauth-0.22.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.20.0/provider_examples → plain_oauth-0.22.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.20.0 → plain_oauth-0.22.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.20.0 → plain_oauth-0.22.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.20.0 → plain_oauth-0.22.0}/tests/test_checks.py

@@ -25,7 +25,7 @@ def test_oauth_provider_keys_check_pass(db, settings):
         access_token="test",
     )
 
-    errors = OAuthConnection.check(databases=["default"])
+    errors = OAuthConnection.check(database=True)
     assert len(errors) == 0
 
 
@@ -58,7 +58,7 @@ def test_oauth_provider_keys_check_fail(db, settings):
         access_token="test",
     )
 
-    errors = OAuthConnection.check(databases=["default"])
+    errors = OAuthConnection.check(database=True)
     assert len(errors) == 1
     assert (
         errors[0].msg

{plain_oauth-0.20.0 → plain_oauth-0.22.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",
+            },
         )