scruby 2.7.0__py3-none-any.whl → 2.7.2__py3-none-any.whl

scruby/db.py

@@ -46,7 +46,7 @@ class Scruby(
         #
         if __debug__:
             if ScrubyModel not in class_model.__bases__:
-                msg = "Scruby => Argument `class_model` does not contain the base class `ScrubyModel`."
+                msg = "Argument `class_model` does not contain the base class `ScrubyModel`."
                 raise AssertionError(msg)
             if "key" not in self.key_list:
                 msg = f"Model: {class_model.__name__} => The `key` field is missing."

scruby/models/__init__.py

@@ -0,0 +1,15 @@
+# Scruby - Asynchronous library for building and managing a hybrid database, by scheme of key-value.
+# Copyright (c) 2025 Gennady Kostyunin
+# SPDX-License-Identifier: MIT
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""Models."""
+
+from __future__ import annotations
+
+__all__ = (
+    "ScrubyModel",
+    "CryptModel",
+)
+
+from scruby.models.crypt_model import CryptModel
+from scruby.models.scruby_model import ScrubyModel

scruby/{models.py → models/crypt_model.py}

@@ -1,42 +1,17 @@
-"""Scruby Models.
+"""Crypt Model.
 
-The module contains the following classes:
-
-- `ScrubyModel` - A base class for creating Scruby models.
-- `CryptModel` - Add password support to the Scruby model.
+For operations with passwords in Scruby models.
 """
 
 from __future__ import annotations
 
-__all__ = ("ScrubyModel",)
+__all__ = ("CryptModel",)
 
 
-from datetime import datetime
 from typing import Annotated
 
 import bcrypt
-from pydantic import BaseModel, ConfigDict, Field, SecretStr
-
-
-class ScrubyModel(BaseModel):
-    """A base class for creating Scruby models."""
-
-    model_config = ConfigDict(strict=True)
-
-    created_at: Annotated[
-        datetime | None,
-        Field(
-            title="Created at",
-            default=None,
-        ),
-    ]
-    updated_at: Annotated[
-        datetime | None,
-        Field(
-            title="Updated at",
-            default=None,
-        ),
-    ]
+from pydantic import BaseModel, Field, SecretStr
 
 
 class CryptModel(BaseModel):
@@ -59,7 +34,7 @@ class CryptModel(BaseModel):
     ]
 
     def hash_raw_password(self, password: str | SecretStr) -> str:
-        """Takes a string and converts it to a hash.
+        """Takes the raw password string and converts it into a hash.
 
         Uses the bcrypt library.
 
@@ -79,7 +54,7 @@ class CryptModel(BaseModel):
         return hashed_bytes.decode("utf-8")
 
     def set_password(self, password: str | SecretStr) -> None:
-        """Converts the value to a hash and adds it to the password field.
+        """Converts the raw password to a hash and adds it to the password field.
 
         Uses the bcrypt library.
 
@@ -89,10 +64,16 @@ class CryptModel(BaseModel):
         Returns:
             None
         """
-        assert isinstance(password, (str, SecretStr)), "Valid type: str | SecretStr"
+        assert isinstance(password, (str, SecretStr)), "Valid type: str | SecretStr."
+        #
+        # Throw an exception if the password is present
+        if bool(self.password):
+            msg = "The password already exists. To update it, use the `update_password` method."
+            raise ValueError(msg)
         #
         hashed_password = self.hash_raw_password(password)
-        # To temporarily bypass the `frozen=True` limitation
+        # Set user password.
+        # Hint: To temporarily bypass the `frozen=True` limitation.
         object.__setattr__(self, "password", hashed_password)  # noqa: PLC2801
 
     def password_is_valid(self, password: str | SecretStr) -> bool:
@@ -107,7 +88,7 @@ class CryptModel(BaseModel):
         Returns:
             True if the passwords are the same and False if they are not the same.
         """
-        assert isinstance(password, (str, SecretStr)), "Valid type: str | SecretStr"
+        assert isinstance(password, (str, SecretStr)), "Valid type: str | SecretStr."
         #
         if not bool(self.password):
             return False
@@ -132,15 +113,23 @@ class CryptModel(BaseModel):
             ValueError: If the current password cannot be updated because it is missing.
             ValueError: If the old password does not match the current one.
         """
-        assert isinstance(old_password, (str, SecretStr)), "Valid type: str | SecretStr"
-        assert isinstance(new_password, (str, SecretStr)), "Valid type: str | SecretStr"
+        if __debug__:
+            if not isinstance(old_password, (str, SecretStr)):
+                msg = "Argument: `old_password` => Valid type: str | SecretStr."
+                raise AssertionError(msg)
+            if not isinstance(new_password, (str, SecretStr)):
+                msg = "Argument: `new_password` => Valid type: str | SecretStr."
+                raise AssertionError(msg)
         #
         # Throw an exception if the current password is missing
-        if self.password is None:
-            msg = "The current password cannot be updated because it is missing"
+        if not bool(self.password):
+            msg = "The current password cannot be updated because it is missing."
             raise ValueError(msg)
         # Throw an exception if the old password does not match the current one
         if not self.password_is_valid(old_password):
-            raise ValueError("Old password doesn't match")
+            raise ValueError("Old password doesn't match.")
+        # Pre-reset the password to default state.
+        # Hint: To temporarily bypass the `frozen=True` limitation.
+        object.__setattr__(self, "password", None)  # noqa: PLC2801
         # Replace the current password with a new one
         self.set_password(new_password)

scruby/models/scruby_model.py

@@ -0,0 +1,32 @@
+"""Scruby Model."""
+
+from __future__ import annotations
+
+__all__ = ("ScrubyModel",)
+
+
+from datetime import datetime
+from typing import Annotated
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class ScrubyModel(BaseModel):
+    """A base class for creating Scruby models."""
+
+    model_config = ConfigDict(strict=True)
+
+    created_at: Annotated[
+        datetime | None,
+        Field(
+            title="Created at",
+            default=None,
+        ),
+    ]
+    updated_at: Annotated[
+        datetime | None,
+        Field(
+            title="Updated at",
+            default=None,
+        ),
+    ]

{scruby-2.7.0.dist-info → scruby-2.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scruby
-Version: 2.7.0
+Version: 2.7.2
 Summary: Asynchronous library for building and managing a hybrid database, by scheme of key-value.
 Project-URL: Bug Tracker, https://github.com/kebasyaty/scruby/issues
 Project-URL: Changelog, https://github.com/kebasyaty/scruby/blob/v2/CHANGELOG.md
@@ -147,7 +147,6 @@ from scruby import Scruby, ScrubyModel
 
 class User(ScrubyModel):
     """User model."""
-    username: str
     first_name: str
     last_name: str
     birthday: datetime
@@ -220,6 +219,92 @@ async def main() -> None:
     Scruby.napalm()
 
 
+if __name__ == "__main__":
+    anyio.run(main)
+```
+
+```python
+"""Operations with passwords.
+
+To operations with a password, use only special methods.
+Do not use this field directly.
+"""
+
+import anyio
+from datetime import datetime
+from zoneinfo import ZoneInfo
+from typing import Annotated
+from pydantic import EmailStr, Field
+from pydantic_extra_types.phone_numbers import PhoneNumber, PhoneNumberValidator
+from scruby import CryptModel, Scruby, ScrubyModel
+
+
+class User(ScrubyModel, CryptModel):
+    """User model."""
+
+    username: str
+    first_name: str
+    last_name: str
+    birthday: datetime
+    email: EmailStr
+    phone: Annotated[
+        PhoneNumber,
+        PhoneNumberValidator(number_format="E164"),
+        Field(strict=False),
+    ]
+    # key is always at bottom
+    key: Annotated[
+        str,
+        Field(
+            frozen=True,
+            default_factory=lambda data: data["username"],
+        ),
+    ]
+
+
+async def main() -> None:
+    """Example."""
+    # Activate database.
+    Scruby.run()
+
+    # Create/get the `User` collection.
+    user_coll = Scruby(User)
+
+    # Create user
+    user = User(
+        username="user_1",
+        first_name="John",
+        last_name="Smith",
+        birthday=datetime(1970, 1, 1, tzinfo=ZoneInfo("UTC")),
+        email="John_Smith@gmail.com",
+        phone="+447986123456",
+    )
+
+    test_pass = "user_pass_123"
+
+    # Add user password
+    user.set_password(test_pass)
+
+    # Add user to collection
+    await user_coll.add_doc(user)
+
+    # Get user details
+    user_details = await user_coll.get_doc("user_1")
+
+    # Check a password
+    user_details.password_is_valid(test_pass)  # True
+
+    # Update existing password
+    user_details.update_password(test_pass, new_test_pass)
+
+    # Update user data in a collection
+    await user_coll.update_doc(user_details)
+
+    # Full database deletion.
+    # Hint: The main purpose is tests.
+    Scruby.napalm()
+
+
 if __name__ == "__main__":
     anyio.run(main)
 ```

{scruby-2.7.0.dist-info → scruby-2.7.2.dist-info}/RECORD

@@ -2,11 +2,10 @@ scruby/__init__.py,sha256=rHX2oQahEBft6ZDh1lLE2YxP5ZoMfP4m7PBBUfEGuJw,1399
 scruby/aggregation.py,sha256=NBFxQqyRqUG2KIuD9fbl4uzSHJWTaskjiZ1YNBa-Zbo,3575
 scruby/cache.py,sha256=DRcTdQbh1DhTQDGK5oC_mZrjcQg6g06vJ1e61RfNX94,3864
 scruby/config.py,sha256=clGj5_CyHEejmQUvtV0fD9PoQoPeYoh0Wge_i2BIMsg,5255
-scruby/db.py,sha256=QlIiGJYgbVO2jKTglvrkUQVtONLQeBpkIyeUQS2xTEU,8433
+scruby/db.py,sha256=J1WldCYoWtNTo1T6QGQ4n0rVYR6D8Kv6oesOBUejn60,8423
 scruby/errors.py,sha256=lTWiHzyO5Es9Nkf7quODJjONGn6ifcL95qlpA4epQQM,1386
 scruby/meta.py,sha256=6HPgqqlKH7Vo6ibyGzxR3DzNcnc_DmjaP5q8s6kl4yA,1230
 scruby/migration.py,sha256=mmJkqVBd_eoufWD8YsRq09VCZFZzEwfxsU1gtvJnjvU,1730
-scruby/models.py,sha256=d5YFbfyAxIjXXlO-LJsyMTu0biJ2YqdmlTVw22QPN2Y,4437
 scruby/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scruby/utils.py,sha256=boobO6lHOElF38fe8gRDV_gnrhuwPkP9yI8rONAJzZ4,2475
 scruby/mixins/__init__.py,sha256=nT79e80zXliuTGhR9CFosI2-3PQUCKwXbR7wPiFwgrU,669
@@ -17,8 +16,11 @@ scruby/mixins/delete.py,sha256=InKVIud_ZYx9-CchUz_IygQDXMynNi4jQ0HKYeHC_R8,4328
 scruby/mixins/find.py,sha256=YlK8L5R5qnjooDR_WDkd6ckPgE8dNTTee31S4P8-Wuo,10504
 scruby/mixins/keys.py,sha256=sd8vcM0YXouVwwgsQwtYFaV3RyAEfygpPf4a77_hN6A,11305
 scruby/mixins/update.py,sha256=TyxvxB-gNijlfzTmhwrq0ydvu0C3R-RihW5h5tJ96bM,4964
-scruby-2.7.0.dist-info/METADATA,sha256=PJqezaUXh9nNn5w4Stf-4caeg6WyiXKq9DNmfIm7gtY,13369
-scruby-2.7.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-scruby-2.7.0.dist-info/licenses/GPL-3.0-LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-scruby-2.7.0.dist-info/licenses/MIT-LICENSE,sha256=mS0Wz0yGNB63gEcWEnuIb_lldDYV0sjRaO-o_GL6CWE,1074
-scruby-2.7.0.dist-info/RECORD,,
+scruby/models/__init__.py,sha256=Xqk48ZYWzmrygqoi7R9O8dJdd40ochwTg-vmCDkZUY8,418
+scruby/models/crypt_model.py,sha256=6ia-fZzvPh0fxDIkBXp1m3E538xtjeI0OoxaY25tnNE,4564
+scruby/models/scruby_model.py,sha256=u9uAF1_aBvaooSeKPzQRmVYHPy4XWusLX85xfzc6oVM,608
+scruby-2.7.2.dist-info/METADATA,sha256=2thGMIKe3ytqOQgHERbvC5ef74T_0JDozEjpJ8QgX1I,15272
+scruby-2.7.2.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+scruby-2.7.2.dist-info/licenses/GPL-3.0-LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+scruby-2.7.2.dist-info/licenses/MIT-LICENSE,sha256=mS0Wz0yGNB63gEcWEnuIb_lldDYV0sjRaO-o_GL6CWE,1074
+scruby-2.7.2.dist-info/RECORD,,