maleo-identity 0.0.76__py3-none-any.whl → 0.0.78__py3-none-any.whl

maleo/identity/constants/user_organization.py

@@ -0,0 +1,58 @@
+from typing import Dict, List
+from maleo.soma.schemas.resource import Resource, ResourceIdentifier
+from maleo.identity.enums.user import ExpandableField as UserExpandableField
+from maleo.identity.enums.organization import (
+    ExpandableField as OrganizationExpandableField,
+)
+from maleo.identity.enums.user_organization import (
+    ExpandableField as UserOrganizationExpandableField,
+)
+
+EXPANDABLE_FIELDS_DEPENDENCIES_MAP: Dict[
+    UserOrganizationExpandableField, List[UserOrganizationExpandableField]
+] = {
+    UserOrganizationExpandableField.USER: [
+        UserOrganizationExpandableField.USER_TYPE,
+        UserOrganizationExpandableField.PROFILE,
+    ],
+    UserOrganizationExpandableField.PROFILE: [
+        UserOrganizationExpandableField.BLOOD_TYPE,
+        UserOrganizationExpandableField.GENDER,
+    ],
+    UserOrganizationExpandableField.SYSTEM_ROLES: [
+        UserOrganizationExpandableField.SYSTEM_ROLE_DETAILS
+    ],
+    UserOrganizationExpandableField.ORGANIZATION: [
+        UserOrganizationExpandableField.ORGANIZATION_TYPE,
+        UserOrganizationExpandableField.REGISTRATION_CODE,
+    ],
+}
+
+USER_EXPANDABLE_FIELDS_MAP: Dict[
+    UserOrganizationExpandableField, UserExpandableField
+] = {
+    UserOrganizationExpandableField.USER_TYPE: UserExpandableField.USER_TYPE,
+    UserOrganizationExpandableField.PROFILE: UserExpandableField.PROFILE,
+    UserOrganizationExpandableField.BLOOD_TYPE: UserExpandableField.BLOOD_TYPE,
+    UserOrganizationExpandableField.GENDER: UserExpandableField.GENDER,
+    UserOrganizationExpandableField.SYSTEM_ROLES: UserExpandableField.SYSTEM_ROLES,
+    UserOrganizationExpandableField.SYSTEM_ROLE_DETAILS: UserExpandableField.SYSTEM_ROLE_DETAILS,
+}
+
+ORGANIZATION_EXPANDABLE_FIELDS_MAP: Dict[
+    UserOrganizationExpandableField, OrganizationExpandableField
+] = {
+    UserOrganizationExpandableField.ORGANIZATION_TYPE: OrganizationExpandableField.ORGANIZATION_TYPE,
+    UserOrganizationExpandableField.REGISTRATION_CODE: OrganizationExpandableField.REGISTRATION_CODE,
+}
+
+RESOURCE = Resource(
+    identifiers=[
+        ResourceIdentifier(
+            key="user_organizations",
+            name="UserOrganizations",
+            url_slug="user-organizations",
+        )
+    ],
+    details=None,
+)

maleo/identity/constants/user_organization_role.py

@@ -0,0 +1,47 @@
+from typing import Dict, List
+from maleo.soma.schemas.resource import Resource, ResourceIdentifier
+from maleo.identity.enums.user import ExpandableField as UserExpandableField
+from maleo.identity.enums.organization import (
+    ExpandableField as OrganizationExpandableField,
+)
+from maleo.identity.enums.user_organization_role import (
+    ExpandableField as UserOrganizationRoleExpandableField,
+)
+
+EXPANDABLE_FIELDS_DEPENDENCIES_MAP: Dict[
+    UserOrganizationRoleExpandableField, List[UserOrganizationRoleExpandableField]
+] = {
+    UserOrganizationRoleExpandableField.USER: [
+        UserOrganizationRoleExpandableField.USER_TYPE,
+        UserOrganizationRoleExpandableField.PROFILE,
+    ],
+    UserOrganizationRoleExpandableField.ORGANIZATION: [
+        UserOrganizationRoleExpandableField.ORGANIZATION_TYPE,
+        UserOrganizationRoleExpandableField.REGISTRATION_CODE,
+    ],
+}
+
+USER_EXPANDABLE_FIELDS_MAP: Dict[
+    UserOrganizationRoleExpandableField, UserExpandableField
+] = {
+    UserOrganizationRoleExpandableField.USER_TYPE: UserExpandableField.USER_TYPE,
+    UserOrganizationRoleExpandableField.PROFILE: UserExpandableField.PROFILE,
+}
+
+ORGANIZATION_EXPANDABLE_FIELDS_MAP: Dict[
+    UserOrganizationRoleExpandableField, OrganizationExpandableField
+] = {
+    UserOrganizationRoleExpandableField.ORGANIZATION_TYPE: OrganizationExpandableField.ORGANIZATION_TYPE,
+    UserOrganizationRoleExpandableField.REGISTRATION_CODE: OrganizationExpandableField.REGISTRATION_CODE,
+}
+
+RESOURCE = Resource(
+    identifiers=[
+        ResourceIdentifier(
+            key="user_organization_roles",
+            name="UserOrganizationRoles",
+            url_slug="user-organization-roles",
+        )
+    ],
+    details=None,
+)

maleo/identity/constants/user_profile.py

@@ -0,0 +1,26 @@
+from typing import Callable, Dict
+from maleo.soma.schemas.resource import Resource, ResourceIdentifier
+from maleo.identity.enums.user_profile import IdentifierType, ValidImageMimeType
+from maleo.identity.types.base.user_profile import IdentifierValueType
+
+IDENTIFIER_TYPE_VALUE_TYPE_MAP: Dict[
+    IdentifierType, Callable[..., IdentifierValueType]
+] = {
+    IdentifierType.USER_ID: int,
+    IdentifierType.ID_CARD: str,
+}
+
+MIME_TYPE_EXTENSION_MAP: Dict[ValidImageMimeType, str] = {
+    ValidImageMimeType.JPEG: ".jpeg",
+    ValidImageMimeType.JPG: ".jpg",
+    ValidImageMimeType.PNG: ".png",
+}
+
+RESOURCE = Resource(
+    identifiers=[
+        ResourceIdentifier(
+            key="user_profiles", name="UserProfiles", url_slug="user-profiles"
+        )
+    ],
+    details=None,
+)

maleo/identity/constants/user_system_role.py

@@ -0,0 +1,16 @@
+from typing import Dict, List
+from maleo.soma.schemas.resource import Resource, ResourceIdentifier
+from maleo.identity.enums.user_system_role import ExpandableField
+
+EXPANDABLE_FIELDS_DEPENDENCIES_MAP: Dict[ExpandableField, List[ExpandableField]] = {}
+
+RESOURCE = Resource(
+    identifiers=[
+        ResourceIdentifier(
+            key="user_system_roles",
+            name="UserSystemRoles",
+            url_slug="user-system-roles",
+        )
+    ],
+    details=None,
+)

maleo/identity/db.py

@@ -0,0 +1,4 @@
+from maleo.soma.managers.db import create_base
+
+
+MaleoIdentityBase = create_base()

maleo/identity/dtos/organization_registration_code.py

@@ -0,0 +1,12 @@
+from maleo.soma.mixins.data import DataIdentifier, DataTimestamp, DataStatus
+from maleo.identity.mixins.organization_registration_code import (
+    Code,
+    MaxUses,
+    CurrentUses,
+)
+
+
+class OrganizationRegistrationCodeDTO(
+    CurrentUses, MaxUses, Code, DataStatus, DataTimestamp, DataIdentifier
+):
+    pass

maleo/identity/enums/general.py

@@ -0,0 +1,5 @@
+from enum import StrEnum
+
+
+class ClientControllerType(StrEnum):
+    HTTP = "http"

maleo/identity/enums/organization.py

@@ -0,0 +1,12 @@
+from enum import StrEnum
+
+
+class IdentifierType(StrEnum):
+    ID = "id"
+    UUID = "uuid"
+    KEY = "key"
+
+
+class ExpandableField(StrEnum):
+    ORGANIZATION_TYPE = "organization_type"
+    REGISTRATION_CODE = "registration_code"

maleo/identity/enums/organization_registration_code.py

@@ -0,0 +1,8 @@
+from enum import StrEnum
+
+
+class IdentifierType(StrEnum):
+    ID = "id"
+    UUID = "uuid"
+    ORGANIZATION_ID = "organization_id"
+    CODE = "code"

maleo/identity/enums/organization_role.py

@@ -0,0 +1,7 @@
+from enum import StrEnum
+
+
+class ExpandableField(StrEnum):
+    ORGANIZATION = "organization"
+    ORGANIZATION_TYPE = "organization.organization_type"
+    REGISTRATION_CODE = "organization.registration_code"

maleo/identity/enums/user.py

@@ -0,0 +1,17 @@
+from enum import StrEnum
+
+
+class IdentifierType(StrEnum):
+    ID = "id"
+    UUID = "uuid"
+    USERNAME = "username"
+    EMAIL = "email"
+
+
+class ExpandableField(StrEnum):
+    USER_TYPE = "user_type"
+    SYSTEM_ROLES = "system_roles"
+    SYSTEM_ROLE_DETAILS = "system_roles.system_role_details"
+    PROFILE = "profile"
+    GENDER = "profile.gender"
+    BLOOD_TYPE = "profile.blood_type"

maleo/identity/enums/user_organization.py

@@ -0,0 +1,14 @@
+from enum import StrEnum
+
+
+class ExpandableField(StrEnum):
+    USER = "user"
+    USER_TYPE = "user_type"
+    SYSTEM_ROLES = "system_roles"
+    SYSTEM_ROLE_DETAILS = "system_roles.system_role_details"
+    PROFILE = "profile"
+    GENDER = "profile.gender"
+    BLOOD_TYPE = "profile.blood_type"
+    ORGANIZATION = "organization"
+    ORGANIZATION_TYPE = "organization.organization_type"
+    REGISTRATION_CODE = "organization.registration_code"

maleo/identity/enums/user_organization_role.py

@@ -0,0 +1,15 @@
+from enum import StrEnum
+
+
+class ExpandableField(StrEnum):
+    USER = "user"
+    USER_TYPE = "user.user_type"
+    SYSTEM_ROLES = "system_roles"
+    SYSTEM_ROLE_DETAILS = "system_roles.system_role_details"
+    PROFILE = "user.profile"
+    GENDER = "profile.gender"
+    BLOOD_TYPE = "profile.blood_type"
+    ORGANIZATION = "organization"
+    ORGANIZATION_TYPE = "organization.organization_type"
+    REGISTRATION_CODE = "organization.registration_code"
+    USER_ORGANIZATION = "user_organization"

maleo/identity/enums/user_profile.py

@@ -0,0 +1,17 @@
+from enum import StrEnum
+
+
+class IdentifierType(StrEnum):
+    USER_ID = "user_id"
+    ID_CARD = "id_card"
+
+
+class ValidImageMimeType(StrEnum):
+    JPEG = "image/jpeg"
+    JPG = "image/jpg"
+    PNG = "image/png"
+
+
+class ExpandableField(StrEnum):
+    GENDER = "gender"
+    BLOOD_TYPE = "blood_type"

maleo/identity/enums/user_system_role.py

@@ -0,0 +1,5 @@
+from enum import StrEnum
+
+
+class ExpandableField(StrEnum):
+    SYSTEM_ROLE = "system_role"

maleo/identity/mixins/organization.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel, Field
+from maleo.soma.mixins.parameter import Expand as BaseExpand
+from maleo.identity.enums.organization import ExpandableField
+
+
+class Expand(BaseExpand[ExpandableField]):
+    pass
+
+
+class Key(BaseModel):
+    key: str = Field(..., max_length=255, description="Organization's key")
+
+
+class Name(BaseModel):
+    name: str = Field(..., max_length=255, description="Organization's name")

maleo/identity/mixins/organization_registration_code.py

@@ -0,0 +1,14 @@
+from pydantic import BaseModel, Field
+from uuid import UUID
+
+
+class Code(BaseModel):
+    code: UUID = Field(..., description="Registration code")
+
+
+class MaxUses(BaseModel):
+    max_uses: int = Field(1, ge=1, description="Max code uses")
+
+
+class CurrentUses(BaseModel):
+    current_uses: int = Field(0, ge=0, description="Current code uses")

maleo/identity/mixins/organization_role.py

@@ -0,0 +1,15 @@
+from pydantic import BaseModel, Field
+from maleo.soma.mixins.parameter import Expand as BaseExpand
+from maleo.identity.enums.organization_role import ExpandableField
+
+
+class Expand(BaseExpand[ExpandableField]):
+    pass
+
+
+class Key(BaseModel):
+    key: str = Field(..., max_length=50, description="Organization role's key")
+
+
+class Name(BaseModel):
+    name: str = Field(..., max_length=50, description="Organization role's name")

maleo/identity/mixins/user.py

@@ -0,0 +1,47 @@
+from pydantic import BaseModel, Field
+from uuid import UUID
+from maleo.soma.mixins.parameter import Expand as BaseExpand
+from maleo.soma.types.base import OptionalListOfStrings
+from maleo.identity.enums.user import ExpandableField
+
+
+class Expand(BaseExpand[ExpandableField]):
+    pass
+
+
+class Username(BaseModel):
+    username: str = Field(..., max_length=50, description="User's username")
+
+
+class OptionalListOfUsernames(BaseModel):
+    usernames: OptionalListOfStrings = Field(None, description="Specific usernames")
+
+
+class Email(BaseModel):
+    email: str = Field(..., max_length=255, description="User's email")
+
+
+class OptionalListOfEmails(BaseModel):
+    emails: OptionalListOfStrings = Field(None, description="Specific emails")
+
+
+class Phone(BaseModel):
+    phone: str = Field(..., min_length=4, max_length=15, description="User's phone")
+
+
+class OptionalListOfPhones(BaseModel):
+    phones: OptionalListOfStrings = Field(None, description="Specific phones")
+
+
+class Password(BaseModel):
+    password: str = Field(..., max_length=255, description="User's password")
+
+
+class PasswordConfirmation(BaseModel):
+    password_confirmation: str = Field(
+        ..., max_length=255, description="User's password confirmation"
+    )
+
+
+class RegistrationCode(BaseModel):
+    registration_code: UUID = Field(..., description="Registration code")

maleo/identity/mixins/user_organization.py

@@ -0,0 +1,6 @@
+from maleo.soma.mixins.parameter import Expand as BaseExpand
+from maleo.identity.enums.user_organization import ExpandableField
+
+
+class Expand(BaseExpand[ExpandableField]):
+    pass

maleo/identity/mixins/user_organization_role.py

@@ -0,0 +1,6 @@
+from maleo.soma.mixins.parameter import Expand as BaseExpand
+from maleo.identity.enums.user_organization_role import ExpandableField
+
+
+class Expand(BaseExpand[ExpandableField]):
+    pass

maleo/identity/mixins/user_profile.py

@@ -0,0 +1,81 @@
+from pydantic import BaseModel, Field
+from typing import Optional
+from maleo.soma.mixins.parameter import Expand as BaseExpand
+from maleo.soma.types.base import OptionalDate, OptionalString
+from maleo.identity.enums.user_profile import ExpandableField
+
+
+class Expand(BaseExpand[ExpandableField]):
+    pass
+
+
+class IdCard(BaseModel):
+    id_card: str = Field(..., max_length=16, description="User's ID Card")
+
+
+class OptionalIdCard(BaseModel):
+    id_card: OptionalString = Field(
+        None, max_length=16, description="Optional User's ID Card"
+    )
+
+
+class LeadingTitle(BaseModel):
+    leading_title: OptionalString = Field(
+        None, max_length=25, description="User's leading title"
+    )
+
+
+class FirstName(BaseModel):
+    first_name: str = Field(..., max_length=50, description="User's first name")
+
+
+class MiddleName(BaseModel):
+    middle_name: OptionalString = Field(
+        None, max_length=50, description="User's middle name"
+    )
+
+
+class LastName(BaseModel):
+    last_name: str = Field(..., max_length=50, description="User's last name")
+
+
+class EndingTitle(BaseModel):
+    ending_title: OptionalString = Field(
+        None, max_length=25, description="User's ending title"
+    )
+
+
+class FullName(BaseModel):
+    full_name: str = Field(..., max_length=200, description="User's full name")
+
+
+class BirthPlace(BaseModel):
+    birth_place: OptionalString = Field(
+        None, max_length=50, description="User's birth place"
+    )
+
+
+class BirthDate(BaseModel):
+    birth_date: OptionalDate = Field(None, description="User's birth date")
+
+
+class AvatarName(BaseModel):
+    avatar_name: str = Field(..., description="User's avatar's name")
+
+
+class OptionalAvatarUrl(BaseModel):
+    avatar_url: OptionalString = Field(None, description="Avatar's URL")
+
+
+class OptionalAvatar(BaseModel):
+    avatar: Optional[bytes] = Field(None, description="Optional Avatar")
+
+
+class OptionalAvatarName(BaseModel):
+    avatar_name: OptionalString = Field(None, description="Optional avatar's name")
+
+
+class OptionalAvatarContentType(BaseModel):
+    content_type: OptionalString = Field(
+        None, description="Optional avatar's content type"
+    )

maleo/identity/mixins/user_system_role.py

@@ -0,0 +1,6 @@
+from maleo.soma.mixins.parameter import Expand as BaseExpand
+from maleo.identity.enums.user_system_role import ExpandableField
+
+
+class Expand(BaseExpand[ExpandableField]):
+    pass

maleo/identity/models/organization.py

@@ -0,0 +1,62 @@
+from sqlalchemy import Column, ForeignKey
+from sqlalchemy.orm import relationship
+from sqlalchemy.types import Integer, String, Enum, UUID
+from uuid import uuid4
+from maleo.soma.models.table import DataTable
+from maleo.metadata.enums.organization_type import OrganizationType
+from maleo.identity.db import MaleoIdentityBase
+
+
+class OrganizationsMixin:
+    organization_type = Column(
+        name="organization_type",
+        type_=Enum(OrganizationType, name="organization_type"),
+        default=OrganizationType.REGULAR,
+        nullable=False,
+    )
+    parent_id = Column(
+        "parent_id",
+        Integer,
+        ForeignKey("organizations.id", ondelete="SET NULL", onupdate="CASCADE"),
+    )
+    key = Column(name="key", type_=String(255), unique=True, nullable=False)
+    name = Column(name="name", type_=String(255), nullable=False)
+    secret = Column(
+        name="secret", type_=UUID, default=uuid4, unique=True, nullable=False
+    )
+
+
+class OrganizationsTable(OrganizationsMixin, DataTable, MaleoIdentityBase):
+    __tablename__ = "organizations"
+    parent = relationship(
+        "OrganizationsTable",
+        remote_side="OrganizationsTable.id",
+        # back_populates="children"
+    )
+    # children = relationship(
+    #     "OrganizationsTable",
+    #     back_populates="parent",
+    #     cascade="all",
+    #     lazy="select",
+    #     foreign_keys="[OrganizationsTable.parent_id]",
+    #     order_by="OrganizationsTable.id"
+    # )
+    registration_code = relationship(
+        "OrganizationRegistrationCodesTable",
+        back_populates="organization",
+        cascade="all",
+        lazy="select",
+        uselist=False,
+    )
+    user_organization = relationship(
+        "UserOrganizationsTable",
+        back_populates="organization",
+        cascade="all, delete-orphan",
+        uselist=False,
+    )
+    organization_roles = relationship(
+        "OrganizationRolesTable",
+        back_populates="organization",
+        cascade="all, delete-orphan",
+        uselist=False,
+    )

maleo/identity/models/organization_registration_code.py

@@ -0,0 +1,33 @@
+from sqlalchemy import Column, ForeignKey
+from sqlalchemy.orm import relationship
+from sqlalchemy.types import Integer, UUID
+from uuid import uuid4
+from maleo.soma.models.table import DataTable
+from maleo.identity.db import MaleoIdentityBase
+
+
+class OrganizationRegistrationCodesMixin:
+    # Foreign Key OrganizationsTable
+    organization_id = Column(
+        Integer,
+        ForeignKey("organizations.id", ondelete="CASCADE", onupdate="CASCADE"),
+        unique=True,
+        nullable=False,
+    )
+    code = Column(name="code", type_=UUID, default=uuid4, unique=True, nullable=False)
+    max_uses = Column(name="max_uses", type_=Integer, nullable=False, default=1)
+    current_uses = Column(name="current_uses", type_=Integer, nullable=False, default=0)
+
+
+class OrganizationRegistrationCodesTable(
+    OrganizationRegistrationCodesMixin, DataTable, MaleoIdentityBase
+):
+    __tablename__ = "organization_registration_codes"
+
+    organization = relationship(
+        "OrganizationsTable",
+        back_populates="registration_code",
+        cascade="all",
+        lazy="select",
+        uselist=False,
+    )

maleo/identity/models/organization_role.py

@@ -0,0 +1,37 @@
+from sqlalchemy import Column, ForeignKey
+from sqlalchemy.orm import relationship
+from sqlalchemy.types import Integer, String, Boolean
+from maleo.soma.models.table import DataTable
+from maleo.identity.db import MaleoIdentityBase
+
+
+class OrganizationRolesMixin:
+    # Foreign Key OrganizationsTable
+    organization_id = Column(
+        Integer,
+        ForeignKey("organizations.id", ondelete="CASCADE", onupdate="CASCADE"),
+        nullable=False,
+    )
+    is_default = Column(name="is_default", type_=Boolean, nullable=False, default=False)
+    order = Column(name="order", type_=Integer)
+    key = Column(name="key", type_=String(50), nullable=False)
+    name = Column(name="name", type_=String(50), nullable=False)
+
+
+class OrganizationRolesTable(OrganizationRolesMixin, DataTable, MaleoIdentityBase):
+    __tablename__ = "organization_roles"
+
+    organization = relationship(
+        "OrganizationsTable",
+        back_populates="organization_roles",
+        cascade="all",
+        lazy="select",
+        uselist=False,
+    )
+
+    user_organization_roles = relationship(
+        "UserOrganizationRolesTable",
+        back_populates="organization_role",
+        cascade="all, delete-orphan",
+        lazy="select",
+    )

maleo/identity/models/user.py

@@ -0,0 +1,39 @@
+from sqlalchemy import Column
+from sqlalchemy.orm import relationship
+from sqlalchemy.types import String, Enum
+from maleo.soma.models.table import DataTable
+from maleo.metadata.enums.user_type import UserType
+from maleo.identity.db import MaleoIdentityBase
+
+
+class UsersMixin:
+    user_type = Column(
+        name="user_type",
+        type_=Enum(UserType, name="user_type"),
+        default=UserType.REGULAR,
+        nullable=False,
+    )
+    username = Column(name="username", type_=String(50), unique=True, nullable=False)
+    email = Column(name="email", type_=String(255), unique=True, nullable=False)
+    phone = Column(name="phone", type_=String(15), nullable=False)
+    password = Column(name="password", type_=String(255), nullable=False)
+
+
+class UsersTable(UsersMixin, DataTable, MaleoIdentityBase):
+    __tablename__ = "users"
+
+    profile = relationship(
+        "UserProfilesTable",
+        back_populates="user",
+        uselist=False,
+        cascade="all, delete-orphan",
+    )
+    system_roles = relationship(
+        "UserSystemRolesTable", back_populates="user", cascade="all, delete-orphan"
+    )
+    user_organization = relationship(
+        "UserOrganizationsTable",
+        back_populates="user",
+        cascade="all, delete-orphan",
+        uselist=False,
+    )