plain.oauth 0.2.0__tar.gz → 0.4.0__tar.gz

{plain_oauth-0.2.0 → plain_oauth-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plain.oauth
-Version: 0.2.0
+Version: 0.4.0
 Summary: OAuth login and API access for Plain.
 Home-page: https://plainframework.com
 License: BSD-3-Clause
@@ -11,6 +11,10 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: plain (<1.0.0)
+Requires-Dist: plain.auth (<1.0.0)
+Requires-Dist: plain.models (<1.0.0)
+Requires-Dist: requests
 Project-URL: Documentation, https://plainframework.com/docs/
 Project-URL: Repository, https://github.com/dropseed/plain
 Description-Content-Type: text/markdown
@@ -108,9 +112,11 @@ class ExampleOAuthProvider(OAuthProvider):
         response.raise_for_status()
         data = response.json()
         return OAuthUser(
+            # The provider ID is required
             id=data["id"],
-            username=data["username"],
+            # And you can populate any of your User model fields with additional kwargs
             email=data["email"],
+            username=data["username"],
         )
 ```
 
@@ -223,13 +229,11 @@ Hello {{ request.user }}!
     {% for connection in request.user.oauth_connections.all %}
     <li>
         {{ connection.provider_key }} [ID: {{ connection.provider_user_id }}]
-        {% if connection.can_be_disconnected %}
         <form action="{% url 'oauth:disconnect' connection.provider_key %}" method="post">
             {{ csrf_input }}
             <input type="hidden" name="provider_user_id" value="{{ connection.provider_user_id }}">
             <button type="submit">Disconnect</button>
         </form>
-        {% endif %}
     </li>
     {% endfor %}
 </ul>

{plain_oauth-0.2.0 → plain_oauth-0.4.0}/README.md

@@ -91,9 +91,11 @@ class ExampleOAuthProvider(OAuthProvider):
         response.raise_for_status()
         data = response.json()
         return OAuthUser(
+            # The provider ID is required
             id=data["id"],
-            username=data["username"],
+            # And you can populate any of your User model fields with additional kwargs
             email=data["email"],
+            username=data["username"],
         )
 ```
 
@@ -206,13 +208,11 @@ Hello {{ request.user }}!
     {% for connection in request.user.oauth_connections.all %}
     <li>
         {{ connection.provider_key }} [ID: {{ connection.provider_user_id }}]
-        {% if connection.can_be_disconnected %}
         <form action="{% url 'oauth:disconnect' connection.provider_key %}" method="post">
             {{ csrf_input }}
             <input type="hidden" name="provider_user_id" value="{{ connection.provider_user_id }}">
             <button type="submit">Disconnect</button>
         </form>
-        {% endif %}
     </li>
     {% endfor %}
 </ul>

{plain_oauth-0.2.0 → plain_oauth-0.4.0}/plain/oauth/README.md

@@ -89,9 +89,11 @@ class ExampleOAuthProvider(OAuthProvider):
         response.raise_for_status()
         data = response.json()
         return OAuthUser(
+            # The provider ID is required
             id=data["id"],
-            username=data["username"],
+            # And you can populate any of your User model fields with additional kwargs
             email=data["email"],
+            username=data["username"],
         )
 ```
 
@@ -204,13 +206,11 @@ Hello {{ request.user }}!
     {% for connection in request.user.oauth_connections.all %}
     <li>
         {{ connection.provider_key }} [ID: {{ connection.provider_user_id }}]
-        {% if connection.can_be_disconnected %}
         <form action="{% url 'oauth:disconnect' connection.provider_key %}" method="post">
             {{ csrf_input }}
             <input type="hidden" name="provider_user_id" value="{{ connection.provider_user_id }}">
             <button type="submit">Disconnect</button>
         </form>
-        {% endif %}
     </li>
     {% endfor %}
 </ul>

{plain_oauth-0.2.0 → plain_oauth-0.4.0}/plain/oauth/migrations/0001_initial.py

@@ -22,7 +22,6 @@ class Migration(migrations.Migration):
                     models.BigAutoField(
                         auto_created=True,
                         primary_key=True,
-                        serialize=False,
                     ),
                 ),
                 ("created_at", models.DateTimeField(auto_now_add=True)),

{plain_oauth-0.2.0 → plain_oauth-0.4.0}/plain/oauth/models.py

@@ -2,6 +2,7 @@ from typing import TYPE_CHECKING
 
 from plain import models
 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
@@ -14,7 +15,7 @@ if TYPE_CHECKING:
     from .providers import OAuthToken, OAuthUser
 
 
-# django check for deploy that ensures all provider keys in db are also in settings?
+# TODO preflight check for deploy that ensures all provider keys in db are also in settings?
 
 
 class OAuthConnection(models.Model):
@@ -84,7 +85,7 @@ class OAuthConnection(models.Model):
         )
 
     @classmethod
-    def get_or_createuser(
+    def get_or_create_user(
         cls, *, provider_key: str, oauth_token: "OAuthToken", oauth_user: "OAuthUser"
     ) -> "OAuthConnection":
         try:
@@ -101,12 +102,11 @@ class OAuthConnection(models.Model):
                 # that to be taken care of on the user model itself
                 try:
                     user = get_user_model()(
-                        username=oauth_user.username,
-                        email=oauth_user.email,
+                        **oauth_user.user_model_fields,
                     )
                     user.full_clean()
                     user.save()
-                except IntegrityError:
+                except (IntegrityError, ValidationError):
                     raise OAuthUserAlreadyExistsError()
 
                 return cls.connect(

{plain_oauth-0.2.0 → plain_oauth-0.4.0}/plain/oauth/providers.py

@@ -33,13 +33,16 @@ class OAuthToken:
 
 
 class OAuthUser:
-    def __init__(self, *, id: str, email: str, username: str = ""):
-        self.id = id
-        self.username = username
-        self.email = email
+    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 __str__(self):
-        return self.email
+        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)
 
 
 class OAuthProvider:
@@ -157,7 +160,7 @@ class OAuthProvider:
             )
             user = connection.user
         else:
-            connection = OAuthConnection.get_or_createuser(
+            connection = OAuthConnection.get_or_create_user(
                 provider_key=self.provider_key,
                 oauth_token=oauth_token,
                 oauth_user=oauth_user,

{plain_oauth-0.2.0 → plain_oauth-0.4.0}/plain/oauth/views.py

@@ -2,7 +2,7 @@ import logging
 
 from plain.auth.views import AuthViewMixin
 from plain.http import ResponseBadRequest, ResponseRedirect
-from plain.templates import jinja
+from plain.templates import Template
 from plain.views import View
 
 from .exceptions import (
@@ -38,7 +38,7 @@ class OAuthCallbackView(View):
         try:
             return provider_instance.handle_callback_request(request=request)
         except OAuthUserAlreadyExistsError:
-            template = jinja.get_template("oauth/error.html")
+            template = Template("oauth/error.html")
             return ResponseBadRequest(
                 template.render(
                     {
@@ -47,7 +47,7 @@ class OAuthCallbackView(View):
                 )
             )
         except OAuthStateMismatchError:
-            template = jinja.get_template("oauth/error.html")
+            template = Template("oauth/error.html")
             return ResponseBadRequest(
                 template.render(
                     {
@@ -57,7 +57,7 @@ class OAuthCallbackView(View):
             )
         except OAuthError as e:
             logger.exception("OAuth error")
-            template = jinja.get_template("oauth/error.html")
+            template = Template("oauth/error.html")
             return ResponseBadRequest(template.render({"oauth_error": str(e)}))
 
 

{plain_oauth-0.2.0 → plain_oauth-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "plain.oauth"
-version = "0.2.0"
+version = "0.4.0"
 description = "OAuth login and API access for Plain."
 authors = ["Dave Gaeddert <dave.gaeddert@dropseed.dev>"]
 license = "BSD-3-Clause"
@@ -19,17 +19,18 @@ FAIL_INVALID_TEMPLATE_VARS = true
 
 [tool.poetry.dependencies]
 python = "^3.11"
+plain = "<1.0.0"
+"plain.auth" = "<1.0.0"
+"plain.models" = "<1.0.0"
+requests = "*"
 
-[tool.poetry.dev-dependencies]
-black = "^22.1.0"
-Django = "^4.0.0"
-pytest = "^7.1.0"
-pytest-django = "^4.5.2"
-ipdb = "^0.13.9"
-requests = "^2.27.1"
-mypy = "*"
-isort = "^5.10.1"
-python-dotenv = "^0.20.0"
+[tool.poetry.group.dev.dependencies]
+plain = {path = "../plain", develop = true}
+"plain.auth" = {path = "../plain-auth", develop = true}
+"plain.sessions" = {path = "../plain-sessions", develop = true}
+"plain.models" = {path = "../plain-models", develop = true}
+"plain.pytest" = {path = "../plain-pytest", develop = true}
+coverage = "^7.6.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]