plain.oauth 0.29.1__tar.gz → 0.29.2__tar.gz

{plain_oauth-0.29.1 → plain_oauth-0.29.2}/PKG-INFO

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

{plain_oauth-0.29.1 → plain_oauth-0.29.2}/plain/oauth/CHANGELOG.md

@@ -1,5 +1,16 @@
 # plain-oauth changelog
 
+## [0.29.2](https://github.com/dropseed/plain/releases/plain-oauth@0.29.2) (2025-10-06)
+
+### What's changed
+
+- Added type annotations to improve IDE and type checker friendliness ([35fb8c4](https://github.com/dropseed/plain/commit/35fb8c4))
+- Updated provider examples (Bitbucket, GitHub, GitLab) with proper type annotations ([50463b0](https://github.com/dropseed/plain/commit/50463b0))
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.29.1](https://github.com/dropseed/plain/releases/plain-oauth@0.29.1) (2025-10-02)
 
 ### What's changed

{plain_oauth-0.29.1 → plain_oauth-0.29.2}/plain/oauth/models.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from plain import models
 from plain.auth import get_user_model
@@ -50,7 +50,7 @@ class OAuthConnection(models.Model):
         ]
         ordering = ("provider_key",)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.provider_key}[{self.user}:{self.provider_user_id}]"
 
     def refresh_access_token(self) -> None:
@@ -69,13 +69,13 @@ class OAuthConnection(models.Model):
         self.set_token_fields(refreshed_oauth_token)
         self.save()
 
-    def set_token_fields(self, oauth_token: "OAuthToken"):
+    def set_token_fields(self, oauth_token: "OAuthToken") -> None:
         self.access_token = oauth_token.access_token
         self.refresh_token = oauth_token.refresh_token
         self.access_token_expires_at = oauth_token.access_token_expires_at
         self.refresh_token_expires_at = oauth_token.refresh_token_expires_at
 
-    def set_user_fields(self, oauth_user: "OAuthUser"):
+    def set_user_fields(self, oauth_user: "OAuthUser") -> None:
         self.provider_user_id = oauth_user.provider_id
 
     def access_token_expired(self) -> bool:
@@ -125,7 +125,7 @@ class OAuthConnection(models.Model):
     def connect(
         cls,
         *,
-        user,
+        user: Any,
         provider_key: str,
         oauth_token: "OAuthToken",
         oauth_user: "OAuthUser",
@@ -155,7 +155,7 @@ class OAuthConnection(models.Model):
         return connection
 
     @classmethod
-    def preflight(cls):
+    def preflight(cls) -> list[PreflightResult]:
         """
         A system check for ensuring that provider_keys in the database are also present in settings.
         """

{plain_oauth-0.29.1 → plain_oauth-0.29.2}/plain/oauth/providers.py

@@ -40,7 +40,7 @@ class OAuthUser:
         self.provider_id = provider_id  # ID on the provider's system
         self.user_model_fields = user_model_fields or {}
 
-    def __str__(self):
+    def __str__(self) -> str:
         if "email" in self.user_model_fields:
             return self.user_model_fields["email"]
         if "username" in self.user_model_fields:

{plain_oauth-0.29.1 → plain_oauth-0.29.2}/plain/oauth/views.py

@@ -2,7 +2,7 @@ import logging
 
 from plain.auth.requests import get_request_user
 from plain.auth.views import AuthViewMixin
-from plain.http import ResponseRedirect
+from plain.http import Response, ResponseRedirect
 from plain.views import TemplateView, View
 
 from .exceptions import (
@@ -14,7 +14,7 @@ logger = logging.getLogger(__name__)
 
 
 class OAuthLoginView(View):
-    def post(self):
+    def post(self) -> Response:
         request = self.request
         provider = self.url_kwargs["provider"]
         if get_request_user(request):
@@ -31,7 +31,7 @@ class OAuthCallbackView(TemplateView):
 
     template_name = "oauth/callback.html"
 
-    def get(self):
+    def get(self) -> Response:
         provider = self.url_kwargs["provider"]
         provider_instance = get_oauth_provider_instance(provider_key=provider)
         try:
@@ -51,7 +51,7 @@ class OAuthCallbackView(TemplateView):
 
 
 class OAuthConnectView(AuthViewMixin, View):
-    def post(self):
+    def post(self) -> Response:
         request = self.request
         provider = self.url_kwargs["provider"]
         provider_instance = get_oauth_provider_instance(provider_key=provider)
@@ -59,7 +59,7 @@ class OAuthConnectView(AuthViewMixin, View):
 
 
 class OAuthDisconnectView(AuthViewMixin, View):
-    def post(self):
+    def post(self) -> Response:
         request = self.request
         provider = self.url_kwargs["provider"]
         provider_instance = get_oauth_provider_instance(provider_key=provider)

{plain_oauth-0.29.1/tests/providers → plain_oauth-0.29.2/provider_examples}/bitbucket.py

@@ -1,15 +1,21 @@
+from __future__ import annotations
+
 import datetime
+from typing import TYPE_CHECKING, Any
 
 import requests
 
 from plain.oauth.providers import OAuthProvider, OAuthToken, OAuthUser
 from plain.utils import timezone
 
+if TYPE_CHECKING:
+    from plain.http import Request
+
 
 class BitbucketOAuthProvider(OAuthProvider):
     authorization_url = "https://bitbucket.org/site/oauth2/authorize"
 
-    def _get_token(self, request_data):
+    def _get_token(self, request_data: dict[str, Any]) -> OAuthToken:
         response = requests.post(
             "https://bitbucket.org/site/oauth2/access_token",
             auth=(self.get_client_id(), self.get_client_secret()),
@@ -27,7 +33,7 @@ class BitbucketOAuthProvider(OAuthProvider):
             + datetime.timedelta(seconds=data["expires_in"]),
         )
 
-    def get_oauth_token(self, *, code, request):
+    def get_oauth_token(self, *, code: str, request: Request) -> OAuthToken:
         return self._get_token(
             {
                 "grant_type": "authorization_code",
@@ -36,7 +42,7 @@ class BitbucketOAuthProvider(OAuthProvider):
             }
         )
 
-    def refresh_oauth_token(self, *, oauth_token):
+    def refresh_oauth_token(self, *, oauth_token: OAuthToken) -> OAuthToken:
         return self._get_token(
             {
                 "grant_type": "refresh_token",
@@ -44,7 +50,7 @@ class BitbucketOAuthProvider(OAuthProvider):
             }
         )
 
-    def get_oauth_user(self, *, oauth_token):
+    def get_oauth_user(self, *, oauth_token: OAuthToken) -> OAuthUser:
         response = requests.get(
             "https://api.bitbucket.org/2.0/user",
             headers={

{plain_oauth-0.29.1/tests/providers → plain_oauth-0.29.2/provider_examples}/github.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 import datetime
+from typing import TYPE_CHECKING, Any
 
 import requests
 
@@ -6,6 +9,9 @@ from plain.oauth.exceptions import OAuthError
 from plain.oauth.providers import OAuthProvider, OAuthToken, OAuthUser
 from plain.utils import timezone
 
+if TYPE_CHECKING:
+    from plain.http import Request
+
 
 class GitHubOAuthProvider(OAuthProvider):
     authorization_url = "https://github.com/login/oauth/authorize"
@@ -14,7 +20,7 @@ class GitHubOAuthProvider(OAuthProvider):
     github_user_url = "https://api.github.com/user"
     github_emails_url = "https://api.github.com/user/emails"
 
-    def _get_token(self, request_data):
+    def _get_token(self, request_data: dict[str, Any]) -> OAuthToken:
         response = requests.post(
             self.github_token_url,
             headers={
@@ -45,7 +51,7 @@ class GitHubOAuthProvider(OAuthProvider):
 
         return oauth_token
 
-    def get_oauth_token(self, *, code, request):
+    def get_oauth_token(self, *, code: str, request: Request) -> OAuthToken:
         return self._get_token(
             {
                 "client_id": self.get_client_id(),
@@ -54,7 +60,7 @@ class GitHubOAuthProvider(OAuthProvider):
             }
         )
 
-    def refresh_oauth_token(self, *, oauth_token):
+    def refresh_oauth_token(self, *, oauth_token: OAuthToken) -> OAuthToken:
         return self._get_token(
             {
                 "client_id": self.get_client_id(),
@@ -64,7 +70,7 @@ class GitHubOAuthProvider(OAuthProvider):
             }
         )
 
-    def get_oauth_user(self, *, oauth_token):
+    def get_oauth_user(self, *, oauth_token: OAuthToken) -> OAuthUser:
         response = requests.get(
             self.github_user_url,
             headers={

{plain_oauth-0.29.1/tests/providers → plain_oauth-0.29.2/provider_examples}/gitlab.py

@@ -1,12 +1,19 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
 import requests
 
 from plain.oauth.providers import OAuthProvider, OAuthToken, OAuthUser
 
+if TYPE_CHECKING:
+    from plain.http import Request
+
 
 class GitLabOAuthProvider(OAuthProvider):
     authorization_url = "https://gitlab.com/oauth/authorize"
 
-    def _get_token(self, request_data):
+    def _get_token(self, request_data: dict[str, Any]) -> OAuthToken:
         request_data["client_id"] = self.get_client_id()
         request_data["client_secret"] = self.get_client_secret()
         response = requests.post(
@@ -24,7 +31,7 @@ class GitLabOAuthProvider(OAuthProvider):
             # expires_in is missing in response?
         )
 
-    def get_oauth_token(self, *, code, request):
+    def get_oauth_token(self, *, code: str, request: Request) -> OAuthToken:
         return self._get_token(
             {
                 "grant_type": "authorization_code",
@@ -33,7 +40,7 @@ class GitLabOAuthProvider(OAuthProvider):
             }
         )
 
-    def refresh_oauth_token(self, *, oauth_token):
+    def refresh_oauth_token(self, *, oauth_token: OAuthToken) -> OAuthToken:
         return self._get_token(
             {
                 "grant_type": "refresh_token",
@@ -41,7 +48,7 @@ class GitLabOAuthProvider(OAuthProvider):
             }
         )
 
-    def get_oauth_user(self, *, oauth_token):
+    def get_oauth_user(self, *, oauth_token: OAuthToken) -> OAuthUser:
         response = requests.get(
             "https://gitlab.com/api/v4/user",
             headers={

{plain_oauth-0.29.1 → plain_oauth-0.29.2}/pyproject.toml

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