square-administration 1.0.0__tar.gz

square_administration-1.0.0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.1
+Name: square_administration
+Version: 1.0.0
+Summary: common business layer for my personal server.
+Home-page: https://github.com/thepmsquare/square_administration
+Author: thePmSquare
+Author-email: thepmsquare@gmail.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Description-Content-Type: text/markdown
+
+# square_administration
+
+## about
+
+administration business layer for my personal server.
+
+## Installation
+
+```shell
+pip install square_administration
+```
+
+## env
+
+- python>=3.12.0
+
+## changelog
+
+### v1.0.0
+
+- initial implementation.
+
+## Feedback is appreciated. Thank you!
+

square_administration-1.0.0/README.md

@@ -0,0 +1,23 @@
+# square_administration
+
+## about
+
+administration business layer for my personal server.
+
+## Installation
+
+```shell
+pip install square_administration
+```
+
+## env
+
+- python>=3.12.0
+
+## changelog
+
+### v1.0.0
+
+- initial implementation.
+
+## Feedback is appreciated. Thank you!

square_administration-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

square_administration-1.0.0/setup.py

@@ -0,0 +1,38 @@
+from setuptools import find_packages, setup
+
+package_name = "square_administration"
+
+setup(
+    name=package_name,
+    version="1.0.0",
+    packages=find_packages(),
+    package_data={
+        package_name: ["data/*"],
+    },
+    install_requires=[
+        "uvicorn>=0.24.0.post1",
+        "fastapi>=0.104.1",
+        "pydantic>=2.5.3",
+        "requests>=2.32.3",
+        "bcrypt>=4.2.0",
+        "square_commons>=1.0.0",
+        "square_logger>=1.0.0",
+        "square_database_helper>=2.0.0",
+        "square_database_structure>=1.0.0",
+        "square_authentication_helper>=2.1.0",
+    ],
+    extras_require={},
+    author="thePmSquare",
+    author_email="thepmsquare@gmail.com",
+    description="common business layer for my personal server.",
+    long_description=open("README.md", "r").read(),
+    long_description_content_type="text/markdown",
+    url=f"https://github.com/thepmsquare/{package_name}",
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.9",
+    ],
+)

square_administration-1.0.0/square_administration/configuration.py

@@ -0,0 +1,119 @@
+import os
+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_logger.main import SquareLogger
+
+try:
+    config_file_path = (
+        os.path.dirname(os.path.abspath(__file__))
+        + os.sep
+        + "data"
+        + os.sep
+        + "config.ini"
+    )
+    ldict_configuration = ConfigReader(config_file_path).read_configuration()
+
+    # get all vars and typecast
+    # ===========================================
+    # general
+    config_str_module_name = ldict_configuration["GENERAL"]["MODULE_NAME"]
+    config_str_app_name = ldict_configuration["GENERAL"]["APP_NAME"]
+    # ===========================================
+
+    # ===========================================
+    # environment
+    config_str_host_ip = ldict_configuration["ENVIRONMENT"]["HOST_IP"]
+    config_int_host_port = int(ldict_configuration["ENVIRONMENT"]["HOST_PORT"])
+    config_str_log_file_name = ldict_configuration["ENVIRONMENT"]["LOG_FILE_NAME"]
+    config_str_admin_password_hash = ldict_configuration["ENVIRONMENT"][
+        "ADMIN_PASSWORD_HASH"
+    ]
+
+    config_str_ssl_crt_file_path = ldict_configuration["ENVIRONMENT"][
+        "SSL_CRT_FILE_PATH"
+    ]
+    config_str_ssl_key_file_path = ldict_configuration["ENVIRONMENT"][
+        "SSL_KEY_FILE_PATH"
+    ]
+    # ===========================================
+
+    # ===========================================
+    # square_logger
+    config_int_log_level = int(ldict_configuration["SQUARE_LOGGER"]["LOG_LEVEL"])
+    config_str_log_path = ldict_configuration["SQUARE_LOGGER"]["LOG_PATH"]
+    config_int_log_backup_count = int(
+        ldict_configuration["SQUARE_LOGGER"]["LOG_BACKUP_COUNT"]
+    )
+    # ===========================================
+
+    # ===========================================
+    # square_database_helper
+
+    config_str_square_database_protocol = ldict_configuration["SQUARE_DATABASE_HELPER"][
+        "SQUARE_DATABASE_PROTOCOL"
+    ]
+    config_str_square_database_ip = ldict_configuration["SQUARE_DATABASE_HELPER"][
+        "SQUARE_DATABASE_IP"
+    ]
+    config_int_square_database_port = int(
+        ldict_configuration["SQUARE_DATABASE_HELPER"]["SQUARE_DATABASE_PORT"]
+    )
+    # ===========================================
+    # ===========================================
+    # square_authentication_helper
+
+    config_str_square_authentication_protocol = ldict_configuration[
+        "SQUARE_AUTHENTICATION_HELPER"
+    ]["SQUARE_AUTHENTICATION_PROTOCOL"]
+    config_str_square_authentication_ip = ldict_configuration[
+        "SQUARE_AUTHENTICATION_HELPER"
+    ]["SQUARE_AUTHENTICATION_IP"]
+    config_int_square_authentication_port = int(
+        ldict_configuration["SQUARE_AUTHENTICATION_HELPER"][
+            "SQUARE_AUTHENTICATION_PORT"
+        ]
+    )
+    # ===========================================
+    # Initialize logger
+    global_object_square_logger = SquareLogger(
+        pstr_log_file_name=config_str_log_file_name,
+        pint_log_level=config_int_log_level,
+        pstr_log_path=config_str_log_path,
+        pint_log_backup_count=config_int_log_backup_count,
+    )
+
+    global_object_square_database_helper = SquareDatabaseHelper(
+        param_str_square_database_ip=config_str_square_database_ip,
+        param_int_square_database_port=config_int_square_database_port,
+        param_str_square_database_protocol=config_str_square_database_protocol,
+    )
+    global_object_square_authentication_helper = SquareAuthenticationHelper(
+        param_str_square_authentication_protocol=config_str_square_authentication_protocol,
+        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"
+        "Error details: " + str(e) + "\033[0m"
+    )
+    sys.exit()

square_administration-1.0.0/square_administration/data/config.ini

@@ -0,0 +1,45 @@
+[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
+
+[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 = localhost
+SQUARE_DATABASE_PORT = 10010
+
+[SQUARE_AUTHENTICATION_HELPER]
+
+SQUARE_AUTHENTICATION_PROTOCOL = http
+SQUARE_AUTHENTICATION_IP = localhost
+SQUARE_AUTHENTICATION_PORT = 10011

square_administration-1.0.0/square_administration/main.py

@@ -0,0 +1,59 @@
+import os.path
+
+from fastapi import FastAPI, status
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
+from square_commons import get_api_output_in_standard_format
+from uvicorn import run
+
+from square_administration.configuration import (
+    config_int_host_port,
+    config_str_host_ip,
+    global_object_square_logger,
+    config_str_module_name,
+    config_str_ssl_key_file_path,
+    config_str_ssl_crt_file_path,
+)
+from square_administration.routes import core, authentication
+
+app = FastAPI()
+
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+app.include_router(core.router)
+app.include_router(authentication.router)
+
+
+@app.get("/")
+@global_object_square_logger.async_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)
+
+
+if __name__ == "__main__":
+    try:
+        if os.path.exists(config_str_ssl_key_file_path) and os.path.exists(
+            config_str_ssl_crt_file_path
+        ):
+            run(
+                app,
+                host=config_str_host_ip,
+                port=config_int_host_port,
+                ssl_certfile=config_str_ssl_crt_file_path,
+                ssl_keyfile=config_str_ssl_key_file_path,
+            )
+        else:
+            run(
+                app,
+                host=config_str_host_ip,
+                port=config_int_host_port,
+            )
+
+    except Exception as exc:
+        global_object_square_logger.logger.critical(exc, exc_info=True)

square_administration-1.0.0/square_administration/messages.py

@@ -0,0 +1,13 @@
+messages = {
+    "REGISTRATION_SUCCESSFUL": "registration was successful. welcome aboard!",
+    "LOGIN_SUCCESSFUL": "you have logged in successfully.",
+    "LOGOUT_SUCCESSFUL": "you have logged out successfully.",
+    "INCORRECT_USERNAME": "the username you entered does not exist.",
+    "INCORRECT_PASSWORD": "the password you entered is incorrect. please try again.",
+    "GENERIC_CREATION_SUCCESSFUL": "records created successfully.",
+    "GENERIC_READ_SUCCESSFUL": "data retrieved successfully.",
+    "GENERIC_UPDATE_SUCCESSFUL": "your information has been updated successfully.",
+    "GENERIC_DELETE_SUCCESSFUL": "your records have been deleted successfully.",
+    "GENERIC_400": "the request is invalid or cannot be processed.",
+    "GENERIC_500": "an internal server error occurred. please try again later.",
+}

square_administration-1.0.0/square_administration/pydantic_models/authentication.py

@@ -0,0 +1,12 @@
+from pydantic import BaseModel
+
+
+class RegisterUsernameV0(BaseModel):
+    username: str
+    password: str
+    admin_password: str
+
+
+class LoginUsernameV0(BaseModel):
+    username: str
+    password: str

square_administration-1.0.0/square_administration/routes/authentication.py

@@ -0,0 +1,239 @@
+import json
+from typing import Annotated
+
+import bcrypt
+from fastapi import APIRouter, status, HTTPException, Header
+from fastapi.responses import JSONResponse
+from requests import HTTPError
+from square_commons import get_api_output_in_standard_format
+
+from square_administration.configuration import (
+    global_object_square_logger,
+    config_str_admin_password_hash,
+    global_object_square_authentication_helper,
+    global_int_app_id,
+)
+from square_administration.messages import messages
+from square_administration.pydantic_models.authentication import (
+    RegisterUsernameV0,
+    LoginUsernameV0,
+)
+
+router = APIRouter(
+    tags=["authentication"],
+)
+
+
+@router.post("/register_username/v0")
+@global_object_square_logger.async_auto_logger
+async def register_username_v0(
+    body: RegisterUsernameV0,
+):
+    username = body.username
+    password = body.password
+    admin_password = body.admin_password
+
+    username = username.lower()
+    try:
+        """
+        validation
+        """
+
+        # validation for admin_password
+        if not (
+            bcrypt.checkpw(
+                admin_password.encode("utf-8"),
+                config_str_admin_password_hash.encode("utf-8"),
+            )
+        ):
+            output_content = get_api_output_in_standard_format(
+                message=messages["INCORRECT_PASSWORD"],
+                log=f"incorrect admin password.",
+            )
+            return JSONResponse(
+                status_code=status.HTTP_400_BAD_REQUEST,
+                content=output_content,
+            )
+
+        """
+        main process
+        """
+        response = global_object_square_authentication_helper.register_username_v0(
+            username=username,
+            password=password,
+            app_id=global_int_app_id,
+        )
+        """
+        return value
+        """
+        output_content = get_api_output_in_standard_format(
+            message=messages["REGISTRATION_SUCCESSFUL"],
+            data={"main": response["data"]["main"]},
+        )
+        return JSONResponse(
+            status_code=status.HTTP_201_CREATED,
+            content=output_content,
+        )
+    except HTTPError as http_error:
+        global_object_square_logger.logger.error(http_error, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_error.response.status_code,
+            content=json.loads(http_error.response.content),
+        )
+    except HTTPException as http_exception:
+        global_object_square_logger.logger.error(http_exception, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_exception.status_code, content=http_exception.detail
+        )
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"],
+            log=str(e),
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.post("/login_username/v0")
+@global_object_square_logger.async_auto_logger
+async def login_username_v0(
+    body: LoginUsernameV0,
+):
+    username = body.username
+    password = body.password
+
+    try:
+        """
+        validation
+        """
+        # pass
+        """
+        main process
+        """
+        response = global_object_square_authentication_helper.login_username_v0(
+            username=username,
+            password=password,
+            app_id=global_int_app_id,
+            assign_app_id_if_missing=False,
+        )
+        """
+        return value
+        """
+        output_content = get_api_output_in_standard_format(
+            message=messages["LOGIN_SUCCESSFUL"],
+            data={"main": response["data"]["main"]},
+        )
+        return JSONResponse(
+            status_code=status.HTTP_200_OK,
+            content=output_content,
+        )
+    except HTTPError as http_error:
+        global_object_square_logger.logger.error(http_error, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_error.response.status_code,
+            content=json.loads(http_error.response.content),
+        )
+    except HTTPException as http_exception:
+        global_object_square_logger.logger.error(http_exception, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_exception.status_code, content=http_exception.detail
+        )
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"],
+            log=str(e),
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )
+
+
+@router.patch("/remove_app_for_self/v0")
+@global_object_square_logger.async_auto_logger
+async def remove_app_for_self_v0(
+    access_token: Annotated[str, Header()],
+):
+
+    try:
+        """
+        validation
+        """
+        # pass
+        """
+        main process
+        """
+        response = global_object_square_authentication_helper.update_user_app_ids_v0(
+            access_token=access_token,
+            app_ids_to_add=[],
+            app_ids_to_remove=[global_int_app_id],
+        )
+        """
+        return value
+        """
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_UPDATE_SUCCESSFUL"],
+            data={"main": response["data"]["main"]},
+        )
+        return JSONResponse(
+            status_code=status.HTTP_200_OK,
+            content=output_content,
+        )
+    except HTTPError as http_error:
+        global_object_square_logger.logger.error(http_error, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_error.response.status_code,
+            content=json.loads(http_error.response.content),
+        )
+    except HTTPException as http_exception:
+        global_object_square_logger.logger.error(http_exception, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        return JSONResponse(
+            status_code=http_exception.status_code, content=http_exception.detail
+        )
+    except Exception as e:
+        global_object_square_logger.logger.error(e, exc_info=True)
+        """
+        rollback logic
+        """
+        # pass
+        output_content = get_api_output_in_standard_format(
+            message=messages["GENERIC_500"],
+            log=str(e),
+        )
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, content=output_content
+        )

square_administration-1.0.0/square_administration/routes/core.py

@@ -0,0 +1,5 @@
+from fastapi import APIRouter
+
+router = APIRouter(
+    tags=["core"],
+)

square_administration-1.0.0/square_administration.egg-info/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.1
+Name: square-administration
+Version: 1.0.0
+Summary: common business layer for my personal server.
+Home-page: https://github.com/thepmsquare/square_administration
+Author: thePmSquare
+Author-email: thepmsquare@gmail.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Description-Content-Type: text/markdown
+
+# square_administration
+
+## about
+
+administration business layer for my personal server.
+
+## Installation
+
+```shell
+pip install square_administration
+```
+
+## env
+
+- python>=3.12.0
+
+## changelog
+
+### v1.0.0
+
+- initial implementation.
+
+## Feedback is appreciated. Thank you!
+

square_administration-1.0.0/square_administration.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+README.md
+setup.py
+square_administration/__init__.py
+square_administration/configuration.py
+square_administration/main.py
+square_administration/messages.py
+square_administration.egg-info/PKG-INFO
+square_administration.egg-info/SOURCES.txt
+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/pydantic_models/__init__.py
+square_administration/pydantic_models/authentication.py
+square_administration/pydantic_models/core.py
+square_administration/routes/__init__.py
+square_administration/routes/authentication.py
+square_administration/routes/core.py
+square_administration/utils/__init__.py

square_administration-1.0.0/square_administration.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

square_administration-1.0.0/square_administration.egg-info/requires.txt

@@ -0,0 +1,10 @@
+uvicorn>=0.24.0.post1
+fastapi>=0.104.1
+pydantic>=2.5.3
+requests>=2.32.3
+bcrypt>=4.2.0
+square_commons>=1.0.0
+square_logger>=1.0.0
+square_database_helper>=2.0.0
+square_database_structure>=1.0.0
+square_authentication_helper>=2.1.0

square_administration-1.0.0/square_administration.egg-info/top_level.txt

@@ -0,0 +1 @@
+square_administration