one-public-api 0.1.0a0__tar.gz

one_public_api-0.1.0a0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.3
+Name: one-public-api
+Version: 0.1.0a0
+Summary: This package provides the API layer of the One Public Framework.
+License: MIT License
+         
+         Copyright (c) 2025 Roba
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Author: Roba
+Author-email: roba@one-coder.com
+Requires-Python: >=3.11,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: bcrypt (>=4.3.0,<5.0.0)
+Requires-Dist: fastapi (>=0.115.12,<0.116.0)
+Requires-Dist: passlib[bcrypt] (>=1.7.4,<2.0.0)
+Requires-Dist: psycopg2-binary (>=2.9.10,<3.0.0)
+Requires-Dist: pydantic-settings (>=2.9.1,<3.0.0)
+Requires-Dist: pydantic[email] (>=2.11.7,<3.0.0)
+Requires-Dist: pyjwt (>=2.10.1,<3.0.0)
+Requires-Dist: python-multipart (>=0.0.20,<0.0.21)
+Requires-Dist: sqlmodel (>=0.0.24,<0.0.25)
+Requires-Dist: uvicorn[standard] (>=0.34.3,<0.35.0)
+Description-Content-Type: text/markdown
+
+# One Public API
+

one_public_api-0.1.0a0/README.md

@@ -0,0 +1 @@
+# One Public API

one_public_api-0.1.0a0/pyproject.toml

@@ -0,0 +1,68 @@
+[project]
+name = "one-public-api"
+version = "0.1.0-alpha"
+description = "This package provides the API layer of the One Public Framework."
+license = {file = "../LICENSE"}
+authors = [
+    {name = "Roba",email = "roba@one-coder.com"}
+]
+readme = "README.md"
+requires-python = ">=3.11,<4.0"
+
+[tool.poetry]
+name = "one-public-api"
+version = "0.1.0-alpha"
+description = "This package provides the API layer of the One Public Framework."
+authors = ["Roba <roba@one-coder.com>"]
+packages = [{ include = "one_public_api", from = "src" }]
+include = ["src/one_public_api/locales/**/*.mo"]
+
+[tool.poetry.dependencies]
+python = ">=3.11,<4.0"
+fastapi = ">=0.115.12,<0.116.0"
+pydantic = { version = ">=2.11.7,<3.0.0", extras = ["email"] }
+pydantic-settings = ">=2.9.1,<3.0.0"
+python-multipart = ">=0.0.20,<0.0.21"
+psycopg2-binary = ">=2.9.10,<3.0.0"
+sqlmodel = ">=0.0.24,<0.0.25"
+uvicorn = { version = ">=0.34.3,<0.35.0", extras = ["standard"] }
+passlib = {extras = ["bcrypt"], version = "^1.7.4"}
+bcrypt = "^4.3.0"
+pyjwt = "^2.10.1"
+
+[tool.poetry.group.dev.dependencies]
+alembic = "^1.16.1"
+babel = "^2.17.0"
+docformatter = "^1.7.7"
+httpx = "^0.28.1"
+mypy = "^1.16.0"
+pre-commit = "^4.2.0"
+pytest = "^8.4.0"
+ruff = "^0.11.13"
+types-passlib = "^1.7.7.20250602"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.mypy]
+mypy_path = "src"
+python_version = "3.11"
+strict = true
+exclude = [".venv", "migrations/versions", "tests"]
+
+[tool.black]
+line-length = 88
+target-version = ["py311"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+exclude = [".venv", "__pycache__", "migrations"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.docformatter]
+pre-summary-newline = true
+recursive = true

one_public_api-0.1.0a0/src/one_public_api/__init__.py

@@ -0,0 +1,3 @@
+from one_public_api.main import app
+
+__all__ = ["app"]

one_public_api-0.1.0a0/src/one_public_api/common/constants.py

@@ -0,0 +1,163 @@
+# ===== Constant Definitions ===========================================================
+import importlib.resources
+import os
+from pathlib import Path
+from typing import List, Tuple
+
+# Version of the One Public API
+VERSION: str = "0.1.0-alpha"
+# Default Language
+DEFAULT_LANGUAGE: str = "en"
+# Default path for locale files
+DEFAULT_LOCALES_PATH: str = "locales"
+
+# ----- Encoding Constants -------------------------------------------------------------
+# Encoding format: UTF-8
+ENCODE_UTF8: str = "utf-8"
+
+# ----- File Settings ------------------------------------------------------------------
+# Log File Extension
+EXT_LOG = ".log"
+# SQLite File Extension
+EXT_SQLITE = ".sqlite3"
+
+# ----- Security Settings --------------------------------------------------------------
+# Access token expiration time (in minutes)
+ACCESS_TOKEN_EXPIRE = 15
+# Refresh token expiration time (in minutes)
+REFRESH_TOKEN_EXPIRE = 30 * 24 * 60
+# Algorithm used to sign the JWT tokens (e.g., HS256, RS256)
+JWT_ALGORITHM = "HS256"
+
+# File name for .env files
+FILES_ENV: List[str] = [".env", ".env.dev", ".env.test", ".env.stage", ".env.prod"]
+
+# Folder for localization resources
+FOLDER_LOCALES: str = "locales"
+# Output folder for log files
+FOLDER_LOGS: str = "logs"
+# Root folder of the source code
+FOLDER_SRC: str = "src"
+# Root folder of the OPA
+FOLDER_OPA: str = "one_public_api"
+
+# Absolute Path of Application directory
+PATH_APP: str = str(Path(__file__).resolve().parent.parent.parent.parent.parent)
+# Absolute Path of backend directory
+PATH_ROOT: str = str(Path(__file__).resolve().parent.parent.parent.parent)
+# Absolute Path of log directory
+PATH_LOG: str = os.path.join(PATH_APP, FOLDER_LOGS)
+# Absolute Path of src directory
+PATH_SRC: str = os.path.join(PATH_ROOT, FOLDER_SRC)
+# Absolute Path of OPA directory
+PATH_OPA = importlib.resources.files("one_public_api")
+# Absolute Path of language package directory
+PATH_LOCALES = PATH_OPA.joinpath(FOLDER_LOCALES)
+# Environment File Path
+# Files listed later have higher priority; earlier ones are ignored if multiple exists.
+PATHS_ENV: Tuple[str, ...] = tuple(os.path.join(PATH_APP, env) for env in FILES_ENV)
+
+# ----- Database Settings --------------------------------------------------------------
+# The default number of connections to allow in connection pool "overflow"
+DB_DEFAULT_MAX_OVERFLOW_SIZE: int = 10
+# The default number of connections to keep open inside the connection pool.
+DB_DEFAULT_POOL_SIZE: int = 5
+# The default number of seconds to wait before giving up on getting a connection from
+# the pool.
+DB_DEFAULT_TIMEOUT: int = 30
+
+# The default number of rows to return in a query result.
+DB_DEFAULT_LIMIT: int = 10
+# The maximum number of rows to return in a query result.
+DB_MAX_LIMIT: int = 100
+
+# Table name prefix for system tables
+DB_PREFIX_SYS: str = "sys_"
+
+# ----- API URL Settings ---------------------------------------------------------------
+# Common router path: blank
+ROUTER_COMMON_BLANK = ""
+# Common router path: ID
+ROUTER_COMMON_WITH_ID = "/{target_id}"
+# Common router path: admin
+ROUTER_COMMON_ADMIN = "/admin"
+# Common router path: admin with ID
+ROUTER_COMMON_ADMIN_WITH_ID = "/admin/{target_id}"
+
+# Signup API router path
+ROUTER_AUTH_SIGNUP = "/signup"
+# Login API router path
+ROUTER_AUTH_LOGIN = "/login"
+# Refresh Token API router path
+ROUTER_AUTH_REFRESH = "/refresh"
+# Profile API router path
+ROUTER_AUTH_PROFILE = "/me"
+# Logout API router path
+ROUTER_AUTH_LOGOUT = "/logout"
+
+# Path prefix for the authentication API router
+ROUTER_PREFIX_AUTHENTICATION = "/auth"
+# Path prefix for the feature API router
+ROUTER_PREFIX_FEATURE = "/features"
+# Path prefix for the configuration API router
+ROUTER_PREFIX_CONFIGURATION = "/configurations"
+# Path prefix for the user API router
+ROUTER_PREFIX_USER = "/users"
+
+# ----- Log Settings -------------------------------------------------------------------
+# Default logging level for the API.
+LOG_DEFAULT_LEVEL: str = "DEBUG"
+# Default path for the log files.
+LOG_DEFAULT_PATH: str = "logs/"
+# Default name for the logger instance.
+LOG_DEFAULT_NAME: str = "api"
+# Defines the rotation policy for log files.
+LOG_DEFAULT_ROTATING_WHEN: str = "D"
+# Number of backup log files to be kept after rotation.
+LOG_DEFAULT_ROTATING_BACKUP_COUNT: int = 7
+# Specifies the default format of log messages.
+LOG_DEFAULT_FORMAT: str = "%(asctime)s %(levelname)s\t%(name)s %(message)s"
+
+# ----- Various Strings ----------------------------------------------------------------
+# Text Logo
+CHAR_LOGO: str = (
+    "S3U7S1U6S1U700S2P1S7P1S3U2S1B1S4U3P100S2P1S3"
+    "H1S3P1S4U2L1S4U3P100S2P1U7P1U3P1S2P1U3P1S4"
+)
+
+# Prefix for items loadable from the .env file
+CHAR_PREFIX_ENV: str = "API_"
+# Newline character
+CHAR_NEW_LINE: str = "\n"
+# Key name used to store or retrieve the refresh token in cookies
+CHAR_REFRESH_TOKEN_KEY = "refresh_token"
+
+# Authenticate Header Name
+HEADER_NAME_AUTHENTICATE = "WWW-Authenticate"
+# Language Header Name
+HEADER_NAME_LANGUAGE = "Accept-Language"
+
+# ----- Various Numeric Values ---------------------------------------------------------
+MAX_LENGTH_3: int = 3
+MAX_LENGTH_6: int = 6
+MAX_LENGTH_13: int = 13
+MAX_LENGTH_55: int = 55
+MAX_LENGTH_64: int = 64
+MAX_LENGTH_100: int = 100
+MAX_LENGTH_255: int = 255
+MAX_LENGTH_500: int = 500
+MAX_LENGTH_1000: int = 1000
+
+# Maximum number of allowed failed login attempts before locking the account
+MAX_LOGIN_FAILED_TIMES: int = 5
+
+# ----- System Messages ----------------------------------------------------------------
+# Debug Messages
+MSG_D0000000: str = "Settings: %s"
+
+# Error Messages
+MSG_E0000001: str = "Implemented Error: %s"
+MSG_E0000002: str = "Cannot write to the log file: %s permission denied."
+MSG_E0000003: str = "Logger initialization failed: invalid configuration %s."
+MSG_E0000004: str = "Logger initialization failed."
+MSG_E0010001: str = "Unsupported Database Engine: %s"

one_public_api-0.1.0a0/src/one_public_api/common/init_data.py

@@ -0,0 +1,77 @@
+from typing import Any, Dict, List
+
+from fastapi import FastAPI, HTTPException
+from sqlmodel import Session
+
+from one_public_api.common.utility.str import get_hashed_password
+from one_public_api.crud.data_creator import DataCreator
+from one_public_api.crud.data_reader import DataReader
+from one_public_api.models import Configuration, Feature, User
+from one_public_api.models.system.configuration_model import ConfigurationType
+from one_public_api.routers.base_route import BaseRoute
+
+
+def init_configurations(session: Session) -> None:
+    configurations: List[Dict[str, Any]] = [
+        {
+            "name": "Application Name",
+            "key": "app_name",
+            "value": "One Public Framework",
+            "type": ConfigurationType.SYS,
+        },
+        {
+            "name": "Application URL",
+            "key": "app_url",
+            "value": "http://localhost:5173",
+            "type": ConfigurationType.SYS,
+        },
+        {
+            "name": "Time Zone",
+            "key": "time_zone",
+            "value": "Asia/Tokyo",
+            "type": ConfigurationType.SYS,
+        },
+        {
+            "name": "Language",
+            "key": "language",
+            "value": "en",
+            "type": ConfigurationType.SYS,
+        },
+    ]
+
+    dc = DataCreator(session)
+    dc.all_if_not_exists(Configuration, configurations)
+    session.commit()
+
+
+def init_features(app: FastAPI, session: Session) -> None:
+    features: List[Dict[str, Any]] = []
+    for route in app.routes:
+        if isinstance(route, BaseRoute):
+            features.append(
+                {
+                    "name": getattr(route, "name"),
+                    "description": getattr(route, "description"),
+                }
+            )
+
+    dc = DataCreator(session)
+    dc.all_if_not_exists(Feature, features)
+    session.commit()
+
+
+def init_users(session: Session) -> None:
+    try:
+        dr = DataReader(session)
+        dr.one(User, {"name": "admin"})
+    except HTTPException:
+        users: List[Dict[str, Any]] = [
+            {
+                "name": "admin",
+                "password": get_hashed_password("<PASSWORD>"),
+                "email": "test@test.com",
+            }
+        ]
+        dc = DataCreator(session)
+        dc.all_if_not_exists(User, users)
+        session.commit()

one_public_api-0.1.0a0/src/one_public_api/common/query_param.py

@@ -0,0 +1,52 @@
+from typing import List
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from one_public_api.common import constants
+from one_public_api.common.utility.str import to_camel
+from one_public_api.core.i18n import translate as _
+
+
+class QueryParam(BaseModel):
+    """
+    Represents query parameters for database queries.
+
+    This class is used to encapsulate query parameters such as pagination settings,
+    sorting, and keyword filtering. It ensures that the provided parameters adhere
+    to specified constraints and formats.
+
+    Attributes
+    ----------
+    offset : int
+        The offset from where to start fetching results. Must be greater than or
+        equal to 0. Default is 0.
+    limit : int
+        The maximum number of results to fetch. Must be greater than 0 and less
+        than or equal to the defined maximum limit (constants.DB_MAX_LIMIT). Default
+        is constants.DB_DEFAULT_LIMIT.
+    order_by : List[str]
+        A list of fields to order the query results by. Default is an empty list.
+    keywords : List[str]
+        A list of keywords for filtering query results. Default is an empty list.
+    """
+
+    offset: int = Field(
+        default=0,
+        ge=0,
+        description=_("Offset from where to start"),
+    )
+    limit: int = Field(
+        default=constants.DB_DEFAULT_LIMIT,
+        gt=0,
+        le=constants.DB_MAX_LIMIT,
+        description=_("Limit"),
+    )
+    order_by: List[str] = Field(default=[], description=_("Order by"))
+    keywords: List[str] = Field(default=[], description=_("Keywords"))
+    # filtering: Dict[str, Any] = Field()
+
+    model_config = ConfigDict(
+        alias_generator=to_camel,
+        populate_by_name=True,
+        extra="forbid",
+    )

one_public_api-0.1.0a0/src/one_public_api/common/tools.py

@@ -0,0 +1,96 @@
+import glob
+import importlib.util
+from typing import Any, Awaitable, Callable, List, TypeVar, cast
+
+import jwt
+from fastapi import Request, Response
+from pydantic.generics import GenericModel
+from sqlmodel import SQLModel
+
+from one_public_api.common import constants
+from one_public_api.core.settings import settings
+from one_public_api.schemas.response_schema import MessageSchema, ResponseSchema
+
+T = TypeVar("T", bound=SQLModel)
+
+
+def create_response_data(
+    schema: GenericModel,
+    results: Any | List[Any] | None = None,
+    count: int | None = None,
+    detail: List[MessageSchema] | None = None,
+) -> ResponseSchema[T]:
+    """
+    Creates a response data object compliant with the `ResponseSchema[T]`
+    model.
+
+    This method validates the provided results data against the
+    specified schema and then encapsulates it in a standardized response
+    object. It supports single or multiple data results by handling both
+    individual and list inputs. Optionally, it includes additional metadata
+    such as count and detailed message schema.
+
+    Parameters
+    ----------
+    schema : GenericModel
+        The schema model used to validate the provided results data. This should be
+        callable with a
+        `model_validate` method to perform validation.
+    results : Any or List[Any] or None
+        The data object(s) to be validated and included in the response. It can be a
+        single instance,
+        a list of instances, or None.
+    count : int or None, optional
+        The count metadata is typically used to indicate the total number of items in a
+        paginated context, or can be None if not applicable.
+    detail : List[MessageSchema] or None, optional
+        A list of detail messages that provide additional information regarding the
+        response or process, or can be None if no details are provided.
+
+    Returns
+    -------
+    ResponseSchema[T]
+        A response object containing the validated results data, optional count
+        metadata, and optional detailed messages.
+    """
+
+    if type(results) is list:
+        rst = [getattr(schema, "model_validate")(d) for d in results]
+    elif results is None:
+        rst = None
+    else:
+        rst = getattr(schema, "model_validate")(results)
+
+    rsp: ResponseSchema[T] = ResponseSchema(results=rst, count=count, detail=detail)
+
+    return rsp
+
+
+def get_username_from_token(token: str) -> str | None:
+    payload = jwt.decode(
+        token, settings.SECRET_KEY, algorithms=[constants.JWT_ALGORITHM]
+    )
+    return str(payload.get("sub")) if payload.get("sub") else None
+
+
+def load_route_handler(
+    input_dir: str, module_name: str, handler_name: str
+) -> (
+    Callable[[Request, Callable[[Request], Awaitable[Response]]], Awaitable[Response]]
+    | None
+):
+    for file in glob.glob(input_dir, recursive=True):
+        spec = importlib.util.spec_from_file_location(module_name, file)
+        if spec:
+            mod = importlib.util.module_from_spec(spec)
+            if spec.loader and mod:
+                spec.loader.exec_module(mod)
+                return cast(
+                    Callable[
+                        [Request, Callable[[Request], Awaitable[Response]]],
+                        Awaitable[Response],
+                    ],
+                    getattr(mod, handler_name),
+                )
+
+    return None

one_public_api-0.1.0a0/src/one_public_api/common/utility/files.py

@@ -0,0 +1,23 @@
+import os
+
+
+def is_path_exists(path: str) -> bool:
+    """
+    Checks the existence of a specified file system path.
+
+    This function determines whether a given file system path exists. It leverages
+    the `os.path.exists` method to perform this check. The function returns a
+    boolean value indicating the presence or absence of the specified path.
+
+    Parameters
+    ----------
+    path : str
+        The file system path to be checked for existence.
+
+    Returns
+    -------
+    bool
+        True if the specified path exists, otherwise False.
+    """
+
+    return os.path.exists(path)

one_public_api-0.1.0a0/src/one_public_api/common/utility/str.py

@@ -0,0 +1,59 @@
+from typing import List
+
+from passlib.context import CryptContext
+
+
+def convert_text_logo(text: str, with_version: bool = True) -> str:
+    """
+    Converts a text representation of a logo based on a mapping system into a
+    graphic-like string format.
+
+    This function takes an input string composed of specific codes that represent
+    various graphic characters and uses a mapping system to convert these codes
+    into a logo-like visual representation. The output string can optionally
+    include a version placeholder.
+
+    Parameters
+    ----------
+    text : str
+        A string representation of the logo code, where each two-character code
+        represents a mapping from the `b` list to the `a` list. The first
+        character of the code determines the character from `a` through its index
+        in `b`, and the second character determines the repetition count.
+    with_version : bool, optionally
+        If True, appends a version placeholder to the resulting logo.
+
+    Returns
+    -------
+    str
+        The generated logo as a string based on the input code. Returns an empty
+        string if the input contains invalid mappings.
+    """
+
+    b: List[str] = ["S", "U", "H", "P", "L", "B"]
+    a: List[str] = [" ", "_", "-", "|", "/", "\\"]
+
+    logo: str = ""
+
+    try:
+        for i in range(0, len(text), 2):
+            tmp = text[i : i + 2]
+            if tmp == "00":
+                logo += "\n"
+            else:
+                logo += a[b.index(tmp[0])] * int(tmp[1])
+    except ValueError:
+        logo = ""
+
+    if with_version:
+        logo += " v%s"
+    return logo
+
+
+def to_camel(string: str) -> str:
+    parts = string.split("_")
+    return parts[0] + "".join(word.capitalize() for word in parts[1:])
+
+
+def get_hashed_password(password: str) -> str:
+    return CryptContext(schemes=["bcrypt"], deprecated="auto").hash(password)

one_public_api-0.1.0a0/src/one_public_api/core/__init__.py

@@ -0,0 +1,10 @@
+from one_public_api.core.database import get_session
+from one_public_api.core.extensions import initialize, lifespan
+from one_public_api.core.i18n import translate
+
+__all__ = [
+    "get_session",
+    "initialize",
+    "lifespan",
+    "translate",
+]

one_public_api-0.1.0a0/src/one_public_api/core/database.py

@@ -0,0 +1,42 @@
+from typing import Any, Dict, Generator
+
+from sqlmodel import Session, create_engine
+
+from one_public_api.core.settings import settings
+from one_public_api.models import *  # noqa
+
+engine_options: Dict[str, Any] = {
+    "url": str(settings.db_uri),
+    "echo": settings.LOG_ECHO_SQL,
+}
+
+if settings.DB_ENGINE == "postgresql":
+    engine_options.update(
+        {
+            "max_overflow": settings.DB_MAX_OVERFLOW_SIZE,
+            "pool_size": settings.DB_POOL_SIZE,
+            "pool_timeout": settings.DB_TIMEOUT,
+        }
+    )
+
+engine = create_engine(**engine_options)
+
+session: Any = Session(engine)
+
+
+def get_session() -> Generator[Session, Any, None]:
+    """
+    Generate a session from the database engine.
+
+    This function initializes a session using the provided database engine
+    and yields it for use. The session is designed to be used as a context
+    manager, ensuring that resources are properly cleaned up after use.
+
+    Yields
+    ------
+    Generator[Session, Any, None]
+        A database session instance generated using the configured engine.
+    """
+
+    with Session(engine) as s:
+        yield s