plain.oauth 0.20.0__py3-none-any.whl → 0.22.0__py3-none-any.whl

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/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/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/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/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.dist-info → plain_oauth-0.22.0.dist-info}/METADATA

@@ -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.20.0.dist-info → plain_oauth-0.22.0.dist-info}/RECORD

@@ -1,13 +1,14 @@
-plain/oauth/README.md,sha256=9_l9lOSndGBG31mD3oteT8UJMeonuCKdBreLQhUO70E,9900
+plain/oauth/CHANGELOG.md,sha256=MjX5AOMH3NglFSfsdkEq1Wjh081JiCbRQCeZSyfpSw0,431
+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=yoZsq8XgzstuwbE2ihoet0nzpw_sVZgDrwUauh6hhUs,546
-plain/oauth/models.py,sha256=ceSw9AKZMXffE4ZKZLxIbOlSyndTCHL22GCuSF3Hpmk,6880
-plain/oauth/providers.py,sha256=F5w1ZE0iEF8QZT4cdO6L7v5p2zHxby5_n-f6J0MM12E,7729
+plain/oauth/models.py,sha256=T8VqqxeYGC4xKRVzUKAnc0OU3GN0otDAShDS6CPJhJs,6754
+plain/oauth/providers.py,sha256=YDftJUMyyfXgsDCkyTNxGwrbwXAowL0Hg6KrwrAN5S0,7793
 plain/oauth/urls.py,sha256=FYzpQwhvZdcat8n3f7RyA-1Q21finKb8JEyakSOjXXg,696
-plain/oauth/views.py,sha256=I27UHQ-MgWVFRoeQUIsZZ81u2V8JXGJ6R3m2TO1lc8U,2408
+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
@@ -17,7 +18,7 @@ plain/oauth/migrations/0006_remove_oauthconnection_unique_oauth_provider_user_id
 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/callback.html,sha256=4CJG0oAN0xYjw2IPkjaL7B4hwlf9um9LI4CTu50E-yE,173
-plain_oauth-0.20.0.dist-info/METADATA,sha256=oBC0SBDaGuX3RV27Wfa-VHBymwrHRLqfjoImzOvKfIM,10304
-plain_oauth-0.20.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain_oauth-0.20.0.dist-info/licenses/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
-plain_oauth-0.20.0.dist-info/RECORD,,
+plain_oauth-0.22.0.dist-info/METADATA,sha256=Nq5PH0dTgYbkounjfFRfcTo3Nn22M3Fw6x1krqb4kPY,10365
+plain_oauth-0.22.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain_oauth-0.22.0.dist-info/licenses/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
+plain_oauth-0.22.0.dist-info/RECORD,,