flask-appbuilder 3.2.1__py3-none-any.whl → 5.0.2__py3-none-any.whl

flask_appbuilder/security/sqla/apis/user/schema.py

@@ -0,0 +1,97 @@
+from flask_appbuilder.security.sqla.models import User
+from marshmallow import fields, Schema, validates_schema, ValidationError
+from marshmallow.validate import Length
+
+from .validator import PasswordComplexityValidator
+
+active_description = (
+    "Is user active?" "It's not a good policy to remove a user, just make it inactive"
+)
+email_description = "The user's email"
+first_name_description = "The user's first name"
+last_name_description = "The user's last name"
+password_description = "The user's password for authentication"
+roles_description = "The user's roles"
+username_description = "The user's username"
+
+
+class UserPostSchema(Schema):
+    model_cls = User
+    active = fields.Boolean(
+        required=False, dump_default=True, metadata={"description": active_description}
+    )
+    email = fields.String(required=True, metadata={"description": email_description})
+    first_name = fields.String(
+        required=True, metadata={"description": first_name_description}
+    )
+    last_name = fields.String(
+        required=True, metadata={"description": last_name_description}
+    )
+    password = fields.String(
+        required=True,
+        validate=[PasswordComplexityValidator()],
+        metadata={"description": password_description},
+    )
+    roles = fields.List(
+        fields.Integer,
+        required=False,
+        metadata={"description": roles_description},
+    )
+    groups = fields.List(
+        fields.Integer,
+        required=False,
+        metadata={"description": roles_description},
+    )
+    username = fields.String(
+        required=True,
+        validate=[Length(1, 250)],
+        metadata={"description": username_description},
+    )
+
+    @validates_schema
+    def validate_roles_or_groups_present(self, data, **kwargs):
+        """
+        Ensure at least one of 'roles' or 'groups' is present and non-empty.
+        """
+        roles = data.get("roles") or []
+        groups = data.get("groups") or []
+
+        if not roles and not groups:
+            raise ValidationError(
+                "At least one of 'roles' or 'groups' must be provided and non-empty."
+            )
+
+
+class UserPutSchema(Schema):
+    model_cls = User
+
+    active = fields.Boolean(
+        required=False, metadata={"description": active_description}
+    )
+    email = fields.String(required=False, metadata={"description": email_description})
+    first_name = fields.String(
+        required=False, metadata={"description": first_name_description}
+    )
+    last_name = fields.String(
+        required=False, metadata={"description": last_name_description}
+    )
+    password = fields.String(
+        required=False,
+        validate=[PasswordComplexityValidator()],
+        metadata={"description": password_description},
+    )
+    roles = fields.List(
+        fields.Integer,
+        required=False,
+        metadata={"description": roles_description},
+    )
+    groups = fields.List(
+        fields.Integer,
+        required=False,
+        metadata={"description": roles_description},
+    )
+    username = fields.String(
+        required=False,
+        validate=[Length(1, 250)],
+        metadata={"description": username_description},
+    )

flask_appbuilder/security/sqla/apis/user/validator.py

@@ -0,0 +1,27 @@
+from flask import current_app
+from flask_appbuilder.exceptions import PasswordComplexityValidationError
+from flask_appbuilder.validators import default_password_complexity
+from marshmallow.exceptions import ValidationError
+from marshmallow.validate import Validator
+
+
+class PasswordComplexityValidator(Validator):
+    """Validator for password."""
+
+    def __call__(self, value: str) -> str:
+        if current_app.config.get("FAB_PASSWORD_COMPLEXITY_ENABLED", False):
+            password_complexity_validator = current_app.config.get(
+                "FAB_PASSWORD_COMPLEXITY_VALIDATOR", None
+            )
+            if password_complexity_validator is not None:
+                try:
+                    password_complexity_validator(value)
+                except PasswordComplexityValidationError as exc:
+                    raise ValidationError(str(exc))
+            else:
+                try:
+                    default_password_complexity(value)
+                except PasswordComplexityValidationError as exc:
+                    raise ValidationError(str(exc))
+
+        return value

flask_appbuilder/security/sqla/apis/view_menu/__init__.py

@@ -0,0 +1 @@
+from .api import ViewMenuApi  # noqa: F401

flask_appbuilder/security/sqla/apis/view_menu/api.py

@@ -0,0 +1,18 @@
+from flask_appbuilder import ModelRestApi
+from flask_appbuilder.models.sqla.interface import SQLAInterface
+from flask_appbuilder.security.sqla.models import ViewMenu
+
+
+class ViewMenuApi(ModelRestApi):
+    resource_name = "security/resources"
+    openapi_spec_tag = "Security Resources (View Menus)"
+
+    class_permission_name = "ViewMenu"
+    datamodel = SQLAInterface(ViewMenu)
+    allow_browser_login = True
+
+    list_columns = ["id", "name"]
+    show_columns = list_columns
+    add_columns = ["name"]
+    edit_columns = add_columns
+    search_columns = list_columns