square-administration 3.1.0__tar.gz → 3.2.0__tar.gz

{square_administration-3.1.0 → square_administration-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: square_administration
-Version: 3.1.0
+Version: 3.2.0
 Summary: common business layer for my personal server.
 Home-page: https://github.com/thepmsquare/square_administration
 Author: thePmSquare
@@ -32,6 +32,21 @@ pip install square_administration
 
 ## changelog
 
+### v3.2.0
+
+- move global_int_app_id getting logic from configuration.py to utils->common
+- env
+    - add DB_IP, DB_PORT, DB_USERNAME, DB_PASSWORD
+    - add config.testing.ini
+    - file path reading through os.path.join method.
+- testing
+    - add conftest file to create and cleanup test database, also to patch config file.
+    - update existing tests to use the new fixtures.
+
+### v3.1.1
+
+- bump square_logger to 2.0.0
+
 ### v3.1.0
 
 - add pytest as dependency.

{square_administration-3.1.0 → square_administration-3.2.0}/README.md

@@ -16,6 +16,21 @@ pip install square_administration
 
 ## changelog
 
+### v3.2.0
+
+- move global_int_app_id getting logic from configuration.py to utils->common
+- env
+    - add DB_IP, DB_PORT, DB_USERNAME, DB_PASSWORD
+    - add config.testing.ini
+    - file path reading through os.path.join method.
+- testing
+    - add conftest file to create and cleanup test database, also to patch config file.
+    - update existing tests to use the new fixtures.
+
+### v3.1.1
+
+- bump square_logger to 2.0.0
+
 ### v3.1.0
 
 - add pytest as dependency.

{square_administration-3.1.0 → square_administration-3.2.0}/setup.py

@@ -4,7 +4,7 @@ package_name = "square_administration"
 
 setup(
     name=package_name,
-    version="3.1.0",
+    version="3.2.0",
     packages=find_packages(),
     package_data={
         package_name: ["data/*"],
@@ -18,7 +18,7 @@ setup(
         "pytest>=8.0.0",
         "httpx>=0.27.2",
         "square_commons>=1.0.0",
-        "square_logger>=1.0.0",
+        "square_logger>=2.0.0",
         "square_database_helper>=2.0.0",
         "square_database_structure>=1.0.0",
         "square_authentication_helper>=2.1.0",

{square_administration-3.1.0 → square_administration-3.2.0}/square_administration/configuration.py

@@ -3,20 +3,12 @@ import sys
 
 from square_authentication_helper import SquareAuthenticationHelper
 from square_commons import ConfigReader
-from square_database_helper import SquareDatabaseHelper, FiltersV0
-from square_database_helper.pydantic_models import FilterConditionsV0
-from square_database_structure.square import global_string_database_name
-from square_database_structure.square.public import global_string_schema_name
-from square_database_structure.square.public.tables import App
+from square_database_helper import SquareDatabaseHelper
 from square_logger.main import SquareLogger
 
 try:
-    config_file_path = (
-        os.path.dirname(os.path.abspath(__file__))
-        + os.sep
-        + "data"
-        + os.sep
-        + "config.ini"
+    config_file_path = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)), "data", "config.ini"
     )
     ldict_configuration = ConfigReader(config_file_path).read_configuration()
 
@@ -43,6 +35,13 @@ try:
         "SSL_KEY_FILE_PATH"
     ]
     config_str_cookie_domain = ldict_configuration["ENVIRONMENT"]["COOKIE_DOMAIN"]
+    config_str_db_ip = ldict_configuration["ENVIRONMENT"]["DB_IP"]
+
+    config_int_db_port = int(ldict_configuration["ENVIRONMENT"]["DB_PORT"])
+
+    config_str_db_username = ldict_configuration["ENVIRONMENT"]["DB_USERNAME"]
+
+    config_str_db_password = ldict_configuration["ENVIRONMENT"]["DB_PASSWORD"]
     # ===========================================
 
     # ===========================================
@@ -100,18 +99,7 @@ try:
         param_str_square_authentication_ip=config_str_square_authentication_ip,
         param_int_square_authentication_port=config_int_square_authentication_port,
     )
-    # get app id
-    global_int_app_id = global_object_square_database_helper.get_rows_v0(
-        database_name=global_string_database_name,
-        schema_name=global_string_schema_name,
-        table_name=App.__tablename__,
-        filters=FiltersV0(
-            root={
-                App.app_name.name: FilterConditionsV0(eq=config_str_app_name),
-            }
-        ),
-        columns=[App.app_id.name],
-    )["data"]["main"][0][App.app_id.name]
+
 except Exception as e:
     print(
         "\033[91mMissing or incorrect config.ini file.\n"

{square_administration-3.1.0 → square_administration-3.2.0}/square_administration/data/config.ini

@@ -16,6 +16,11 @@ SSL_KEY_FILE_PATH = ssl.key
 
 COOKIE_DOMAIN = localhost
 
+DB_IP = localhost
+DB_PORT = 10001
+DB_USERNAME = postgres
+DB_PASSWORD = dummy
+
 [SQUARE_LOGGER]
 
 # | Log Level | Value |

square_administration-3.2.0/square_administration/data/config.testing.ini

@@ -0,0 +1,53 @@
+[GENERAL]
+MODULE_NAME = square_administration
+APP_NAME = square_admin
+
+[ENVIRONMENT]
+HOST_IP = 0.0.0.0
+HOST_PORT = 10111
+
+LOG_FILE_NAME = square_administration
+
+ADMIN_PASSWORD_HASH = $2b$12$tDw4ZR0guiF5s5oVve5PcuELhlWO.lUH.OChPoeWVn95ac7QJlndq
+
+# absolute path (mandatory only for http)
+SSL_CRT_FILE_PATH = ssl.crt
+SSL_KEY_FILE_PATH = ssl.key
+
+COOKIE_DOMAIN = localhost
+
+DB_IP = raspi.thepmsquare.com
+DB_PORT = 15432
+DB_USERNAME = postgres
+DB_PASSWORD = testing_password
+
+
+[SQUARE_LOGGER]
+
+# | Log Level | Value |
+# | --------- | ----- |
+# | CRITICAL  | 50    |
+# | ERROR     | 40    |
+# | WARNING   | 30    |
+# | INFO      | 20    |
+# | DEBUG     | 10    |
+# | NOTSET    | 0     |
+
+LOG_LEVEL = 20
+# absolute or relative path
+LOG_PATH = logs
+# number of backup log files to keep during rotation
+# if backupCount is zero, rollover never occurs.
+LOG_BACKUP_COUNT = 3
+
+[SQUARE_DATABASE_HELPER]
+
+SQUARE_DATABASE_PROTOCOL = http
+SQUARE_DATABASE_IP = raspi.thepmsquare.com
+SQUARE_DATABASE_PORT = 20010
+
+[SQUARE_AUTHENTICATION_HELPER]
+
+SQUARE_AUTHENTICATION_PROTOCOL = http
+SQUARE_AUTHENTICATION_IP = raspi.thepmsquare.com
+SQUARE_AUTHENTICATION_PORT = 20011

{square_administration-3.1.0 → square_administration-3.2.0}/square_administration/main.py

@@ -30,7 +30,7 @@ app.include_router(authentication.router)
 
 
 @app.get("/")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def root():
     output_content = get_api_output_in_standard_format(log=config_str_module_name)
     return JSONResponse(status_code=status.HTTP_200_OK, content=output_content)

{square_administration-3.1.0 → square_administration-3.2.0}/square_administration/routes/authentication.py

@@ -18,7 +18,6 @@ from square_administration.configuration import (
     global_object_square_logger,
     config_str_admin_password_hash,
     global_object_square_authentication_helper,
-    global_int_app_id,
     config_str_cookie_domain,
     global_object_square_database_helper,
 )
@@ -28,7 +27,7 @@ from square_administration.pydantic_models.authentication import (
     LoginUsernameV0,
     RemoveAppForSelfV0,
 )
-from square_administration.utils.common import is_https
+from square_administration.utils.common import is_https, global_int_app_id
 
 router = APIRouter(
     tags=["authentication"],
@@ -36,7 +35,7 @@ router = APIRouter(
 
 
 @router.post("/register_username/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def register_username_v0(
     body: RegisterUsernameV0,
 ):
@@ -137,7 +136,7 @@ async def register_username_v0(
 
 
 @router.post("/login_username/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def login_username_v0(
     body: LoginUsernameV0,
 ):
@@ -221,7 +220,7 @@ async def login_username_v0(
 
 
 @router.patch("/remove_app_for_self/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def remove_app_for_self_v0(
     access_token: Annotated[str, Header()],
     body: RemoveAppForSelfV0,
@@ -318,7 +317,7 @@ async def remove_app_for_self_v0(
 
 
 @router.delete("/logout/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def logout_v0(request: Request):
 
     try:
@@ -401,7 +400,7 @@ async def logout_v0(request: Request):
 
 
 @router.get("/generate_access_token/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def generate_access_token_v0(
     request: Request,
 ):

{square_administration-3.1.0 → square_administration-3.2.0}/square_administration/routes/core.py

@@ -20,10 +20,10 @@ from square_administration.configuration import (
     global_object_square_logger,
     global_object_square_database_helper,
     global_object_square_authentication_helper,
-    global_int_app_id,
 )
 from square_administration.messages import messages
 from square_administration.pydantic_models.core import GetAllGreetingsV0
+from square_administration.utils.common import global_int_app_id
 
 router = APIRouter(
     tags=["core"],
@@ -31,7 +31,7 @@ router = APIRouter(
 
 
 @router.post("/get_all_greetings/v0")
-@global_object_square_logger.async_auto_logger
+@global_object_square_logger.auto_logger()
 async def get_all_greetings_v0(
     access_token: Annotated[str, Header()], body: GetAllGreetingsV0
 ):

square_administration-3.2.0/square_administration/utils/common.py

@@ -0,0 +1,36 @@
+import os
+
+from square_database_helper import FiltersV0
+from square_database_helper.pydantic_models import FilterConditionsV0
+from square_database_structure.square import global_string_database_name
+from square_database_structure.square.public import global_string_schema_name
+from square_database_structure.square.public.tables import App
+
+from square_administration.configuration import (
+    config_str_ssl_key_file_path,
+    config_str_ssl_crt_file_path,
+    global_object_square_logger,
+    global_object_square_database_helper,
+    config_str_app_name,
+)
+
+
+@global_object_square_logger.auto_logger()
+def is_https() -> bool:
+    return os.path.exists(config_str_ssl_key_file_path) and os.path.exists(
+        config_str_ssl_crt_file_path
+    )
+
+
+# get app id
+global_int_app_id = global_object_square_database_helper.get_rows_v0(
+    database_name=global_string_database_name,
+    schema_name=global_string_schema_name,
+    table_name=App.__tablename__,
+    filters=FiltersV0(
+        root={
+            App.app_name.name: FilterConditionsV0(eq=config_str_app_name),
+        }
+    ),
+    columns=[App.app_id.name],
+)["data"]["main"][0][App.app_id.name]

{square_administration-3.1.0 → square_administration-3.2.0}/square_administration.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: square-administration
-Version: 3.1.0
+Version: 3.2.0
 Summary: common business layer for my personal server.
 Home-page: https://github.com/thepmsquare/square_administration
 Author: thePmSquare
@@ -32,6 +32,21 @@ pip install square_administration
 
 ## changelog
 
+### v3.2.0
+
+- move global_int_app_id getting logic from configuration.py to utils->common
+- env
+    - add DB_IP, DB_PORT, DB_USERNAME, DB_PASSWORD
+    - add config.testing.ini
+    - file path reading through os.path.join method.
+- testing
+    - add conftest file to create and cleanup test database, also to patch config file.
+    - update existing tests to use the new fixtures.
+
+### v3.1.1
+
+- bump square_logger to 2.0.0
+
 ### v3.1.0
 
 - add pytest as dependency.

{square_administration-3.1.0 → square_administration-3.2.0}/square_administration.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ square_administration.egg-info/dependency_links.txt
 square_administration.egg-info/requires.txt
 square_administration.egg-info/top_level.txt
 square_administration/data/config.ini
+square_administration/data/config.testing.ini
 square_administration/pydantic_models/__init__.py
 square_administration/pydantic_models/authentication.py
 square_administration/pydantic_models/core.py

{square_administration-3.1.0 → square_administration-3.2.0}/square_administration.egg-info/requires.txt

@@ -6,7 +6,7 @@ bcrypt>=4.2.0
 pytest>=8.0.0
 httpx>=0.27.2
 square_commons>=1.0.0
-square_logger>=1.0.0
+square_logger>=2.0.0
 square_database_helper>=2.0.0
 square_database_structure>=1.0.0
 square_authentication_helper>=2.1.0

square_administration-3.2.0/tests/conftest.py

@@ -0,0 +1,61 @@
+import os
+
+import pytest
+from fastapi.testclient import TestClient
+
+
+def patched_join(*args):
+
+    *rest, last = args
+    if last == "config.ini":
+        last = "config.testing.ini"
+
+    return original_join(*rest, last)
+
+
+original_join = os.path.join
+
+
+@pytest.fixture
+def get_patched_configuration(monkeypatch, tmp_path):
+    monkeypatch.setattr(os.path, "join", patched_join)
+    import square_administration.configuration
+
+    return square_administration.configuration
+
+
+@pytest.fixture
+def create_client_and_cleanup(get_patched_configuration):
+    from square_database_structure import create_database_and_tables
+
+    create_database_and_tables(
+        db_username=get_patched_configuration.config_str_db_username,
+        db_port=get_patched_configuration.config_int_db_port,
+        db_password=get_patched_configuration.config_str_db_password,
+        db_ip=get_patched_configuration.config_str_db_ip,
+    )
+    from square_administration.main import (
+        app,
+    )
+
+    client = TestClient(app)
+    yield client
+    from sqlalchemy import text, create_engine
+    from square_database_structure.main import global_list_create
+
+    local_str_postgres_url = (
+        f"postgresql://{get_patched_configuration.config_str_db_username}:{get_patched_configuration.config_str_db_password}@"
+        f"{get_patched_configuration.config_str_db_ip}:{str(get_patched_configuration.config_int_db_port)}/"
+    )
+
+    postgres_engine = create_engine(local_str_postgres_url)
+
+    with postgres_engine.connect() as postgres_connection:
+
+        postgres_connection.execute(text("commit"))
+
+        for database in global_list_create:
+
+            postgres_connection.execute(
+                text(f"DROP DATABASE {database['database']} WITH (FORCE)")
+            )

square_administration-3.2.0/tests/test_1.py

@@ -0,0 +1,10 @@
+from square_commons import get_api_output_in_standard_format
+
+
+def test_read_main(get_patched_configuration, create_client_and_cleanup):
+    client = create_client_and_cleanup
+    response = client.get("/")
+    assert response.status_code == 200
+    assert response.json() == get_api_output_in_standard_format(
+        log=get_patched_configuration.config_str_module_name
+    )

square_administration-3.1.0/square_administration/utils/common.py

@@ -1,14 +0,0 @@
-import os
-
-from square_administration.configuration import (
-    config_str_ssl_key_file_path,
-    config_str_ssl_crt_file_path,
-    global_object_square_logger,
-)
-
-
-@global_object_square_logger.auto_logger
-def is_https() -> bool:
-    return os.path.exists(config_str_ssl_key_file_path) and os.path.exists(
-        config_str_ssl_crt_file_path
-    )

square_administration-3.1.0/tests/conftest.py

@@ -1,11 +0,0 @@
-import pytest
-
-
-@pytest.fixture
-def set_env(monkeypatch):
-    monkeypatch.setenv("SQUARE_DATABASE_PROTOCOL", "http")
-    monkeypatch.setenv("SQUARE_DATABASE_IP", "raspi.thepmsquare.com")
-    monkeypatch.setenv("SQUARE_DATABASE_PORT", "20010")
-    monkeypatch.setenv("SQUARE_AUTHENTICATION_PROTOCOL", "http")
-    monkeypatch.setenv("SQUARE_AUTHENTICATION_IP", "raspi.thepmsquare.com")
-    monkeypatch.setenv("SQUARE_AUTHENTICATION_PORT", "20011")

square_administration-3.1.0/tests/test_1.py

@@ -1,16 +0,0 @@
-from fastapi.testclient import TestClient
-from square_commons import get_api_output_in_standard_format
-
-
-def test_read_main(set_env):
-    from square_administration.configuration import config_str_module_name
-    from square_administration.main import (
-        app,
-    )
-
-    client = TestClient(app)
-    response = client.get("/")
-    assert response.status_code == 200
-    assert response.json() == get_api_output_in_standard_format(
-        log=config_str_module_name
-    )