diff --git a/.gitignore b/.gitignore index 51b1799..75c04b7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,39 @@ -# Python +# Pyenv / Virtual Environment +#.python-version +.venv +venv/ + +# Byte-compiled / optimized / DLL files __pycache__/ +*.py[cod] +*$py.class + +# Distribution / packaging +dist/ +build/ +*.egg-info/ +*.egg +.eggs/ + +# Environment files .env -# VS Code +# Dependency cache +pip-cache/ +.pytest_cache/ +.mypy_cache/ +.ruff_cache/ + +# IDE files +.idea/ .vscode/ +*.suo +*.ntvs* +*.njsproj +*.sln +*.sw* + +# OS files +._* +*.DS_Store +Thumbs.db diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..1e65950 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,141 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts. +# this is typically a path given in POSIX (e.g. forward slashes) +# format, relative to the token %(here)s which refers to the location of this +# ini file +script_location = %(here)s/app/db/alembic + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. for multiple paths, the path separator +# is defined by "path_separator" below. +prepend_sys_path = . + + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library. +# Any required deps can installed by adding `alembic[tz]` to the pip requirements +# string value is passed to ZoneInfo() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; This defaults +# to /versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "path_separator" +# below. +# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions + +# path_separator; This indicates what character is used to split lists of file +# paths, including version_locations and prepend_sys_path within configparser +# files such as alembic.ini. +# The default rendered in new alembic.ini files is "os", which uses os.pathsep +# to provide os-dependent path splitting. +# +# Note that in order to support legacy alembic.ini files, this default does NOT +# take place if path_separator is not present in alembic.ini. If this +# option is omitted entirely, fallback logic is as follows: +# +# 1. Parsing of the version_locations option falls back to using the legacy +# "version_path_separator" key, which if absent then falls back to the legacy +# behavior of splitting on spaces and/or commas. +# 2. Parsing of the prepend_sys_path option falls back to the legacy +# behavior of splitting on spaces, commas, or colons. +# +# Valid values for path_separator are: +# +# path_separator = : +# path_separator = ; +# path_separator = space +# path_separator = newline +# +# Use os.pathsep. Default configuration used for new projects. +path_separator = os + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +# database URL. This is consumed by the user-maintained env.py script only. +# other means of configuring database URLs may be customized within the env.py +# file. +sqlalchemy.url = driver://user:pass@localhost/dbname + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# lint with attempts to fix using "ruff" - use the exec runner, execute a binary +# hooks = ruff +# ruff.type = exec +# ruff.executable = %(here)s/.venv/bin/ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Logging configuration. This is also consumed by the user-maintained +# env.py script only. +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/app/db/alembic/README b/app/db/alembic/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/app/db/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/app/db/alembic/env.py b/app/db/alembic/env.py new file mode 100644 index 0000000..59e48c6 --- /dev/null +++ b/app/db/alembic/env.py @@ -0,0 +1,81 @@ +import os +import importlib +from logging.config import fileConfig +from sqlalchemy import engine_from_config, pool +from alembic import context +from dotenv import load_dotenv + +# Load environment variables from .env file +load_dotenv() + +config = context.config + +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +from app.db.base import Base + +def import_all_models(): + # Correct the path to the models directory + models_dir = os.path.join(os.path.dirname(__file__), "../models") + models_dir = os.path.abspath(models_dir) # Ensure it's an absolute path + + for filename in os.listdir(models_dir): + if filename.endswith(".py") and filename != "__init__.py": + module_name = f"app.db.models.{filename[:-3]}" + importlib.import_module(module_name) + +# Import all models to register them with Base +import_all_models() + +target_metadata = Base.metadata + +def get_db_url(): + user = os.getenv("POSTGRES_USER") + password = os.getenv("POSTGRES_PASSWORD") + host = os.getenv("DB_HOST", "localhost") + port = os.getenv("DB_PORT", "5432") + dbname = os.getenv("POSTGRES_DB") + driver = os.getenv("DB_DRIVER", "postgresql") + + return f"{driver}://{user}:{password}@{host}:{port}/{dbname}" + + +def run_migrations_offline() -> None: + url = get_db_url() # get URL from env variables + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online() -> None: + # override the sqlalchemy.url config with env var URL + configuration = config.get_section(config.config_ini_section) + configuration["sqlalchemy.url"] = get_db_url() + + connectable = engine_from_config( + configuration, + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/app/db/alembic/script.py.mako b/app/db/alembic/script.py.mako new file mode 100644 index 0000000..480b130 --- /dev/null +++ b/app/db/alembic/script.py.mako @@ -0,0 +1,28 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} + + +def upgrade() -> None: + """Upgrade schema.""" + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} diff --git a/app/db/alembic/versions/075b701a1a93_initial_commit.py b/app/db/alembic/versions/075b701a1a93_initial_commit.py new file mode 100644 index 0000000..13f32b7 --- /dev/null +++ b/app/db/alembic/versions/075b701a1a93_initial_commit.py @@ -0,0 +1,32 @@ +"""initial commit + +Revision ID: 075b701a1a93 +Revises: +Create Date: 2025-05-27 12:47:03.592923 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = '075b701a1a93' +down_revision: Union[str, None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + """Upgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### + + +def downgrade() -> None: + """Downgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### diff --git a/app/db/crud/orders.py b/app/db/crud/orders.py new file mode 100644 index 0000000..addd54d --- /dev/null +++ b/app/db/crud/orders.py @@ -0,0 +1,21 @@ +from sqlalchemy.orm import Session +from app.db.models.orders import Order + +def get_order_by_id(db: Session, order_id: int) -> Order | None: + return db.query(Order).filter(Order.id == order_id).first() + +def create_order(db: Session, user_id: int, total_amount, status: str = "pending") -> Order: + order = Order(user_id=user_id, total_amount=total_amount, status=status) + db.add(order) + db.commit() + db.refresh(order) + return order + +def get_orders_by_user_id(db: Session, user_id: int) -> list[Order]: + return db.query(Order).filter(Order.user_id == user_id).all() + +def delete_order_by_id(db: Session, order_id: int): + order = get_order_by_id(db, order_id) + if order: + db.delete(order) + db.commit() diff --git a/app/db/crud/users.py b/app/db/crud/users.py new file mode 100644 index 0000000..f3b4626 --- /dev/null +++ b/app/db/crud/users.py @@ -0,0 +1,51 @@ +from sqlalchemy.orm import Session +from fastapi import HTTPException, status +from app.db.models.users import User +from app.validators.users import UserUpdate + +def get_user_by_id(db: Session, user_id: int) -> User | None: + return db.query(User).filter(User.id == user_id).first() + +def get_user_by_email(db: Session, email: str) -> User | None: + return db.query(User).filter(User.email == email).first() + +def get_user_by_username(db: Session, username: str) -> User | None: + return db.query(User).filter(User.username == username).first() + +def get_all_users(db: Session): + return db.query(User).all() + +def create_user(db: Session, username: str, email: str, hashed_password: str, role: str = "customer") -> User: + user = User( + username=username, + email=email, + hashed_password=hashed_password, + role=role + ) + db.add(user) + db.commit() + db.refresh(user) + return user + +def update_user_db(db: Session, user_id: int, user_update: UserUpdate): + user = get_user_by_id(db, user_id) + if not user: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail=f"User with ID {user_id} not found" + ) + + if user_update.username is not None: + user.username = user_update.username + if user_update.email is not None: + user.email = user_update.email + + db.commit() + db.refresh(user) + return user + +def delete_user_by_id(db: Session, user_id: int): + user = get_user_by_id(db, user_id) + if user: + db.delete(user) + db.commit() diff --git a/app/db/models/orders.py b/app/db/models/orders.py index ddd59ee..eae63cb 100644 --- a/app/db/models/orders.py +++ b/app/db/models/orders.py @@ -1,6 +1,5 @@ from sqlalchemy import Column, Integer, String, DateTime, ForeignKey, Numeric, func -from sqlalchemy.orm import relationship, Session -from sqlalchemy.orm import declarative_base +from sqlalchemy.orm import relationship from app.db.base import Base class Order(Base): @@ -15,15 +14,3 @@ class Order(Base): updated_at = Column(DateTime, server_default=func.now(), onupdate=func.now()) user = relationship("User", back_populates="orders") - -# --- DB interaction functions --- - -def get_order_by_id(db: Session, order_id: int): - return db.query(Order).filter(Order.id == order_id).first() - -def create_order(db: Session, user_id: int, total_amount, status: str = "pending"): - order = Order(user_id=user_id, total_amount=total_amount, status=status) - db.add(order) - db.commit() - db.refresh(order) - return order \ No newline at end of file diff --git a/app/db/models/users.py b/app/db/models/users.py index e268d80..4f29f7b 100644 --- a/app/db/models/users.py +++ b/app/db/models/users.py @@ -1,10 +1,7 @@ from sqlalchemy import Column, Integer, String, DateTime, func -from sqlalchemy.orm import relationship, Session -from app.db.session import engine -from app.db.models.orders import Order +from sqlalchemy.orm import relationship from app.db.base import Base -from fastapi import HTTPException, status -from app.validators.users import UserUpdate +from app.db.models.orders import Order class User(Base): __tablename__ = "users" @@ -18,59 +15,3 @@ class User(Base): updated_at = Column(DateTime, server_default=func.now(), onupdate=func.now(), nullable=False) orders = relationship(Order, back_populates="user", cascade="all, delete-orphan") - - -def create_tables(): - Base.metadata.create_all(bind=engine) - - -# --- DB interaction functions --- - -def get_user_by_id(db: Session, user_id: int) -> User | None: - return db.query(User).filter(User.id == user_id).first() - -def get_user_by_email(db: Session, email: str): - return db.query(User).filter(User.email == email).first() - -def get_user_by_username(db: Session, username: str): - return db.query(User).filter(User.username == username).first() - -def create_user(db: Session, username: str, email: str, hashed_password: str, role: str = "customer") -> User: - user = User( - username=username, - email=email, - hashed_password=hashed_password, - role=role - ) - db.add(user) - db.commit() - db.refresh(user) - return user - -def get_all_users(db: Session): - return db.query(User).all() - -def delete_user_by_id(db: Session, user_id: int): - user = db.query(User).filter(User.id == user_id).first() - if user: - db.delete(user) - db.commit() - -def update_user_db(db: Session, user_id: int, user_update: UserUpdate): - user = db.query(User).filter(User.id == user_id).first() - - if not user: - raise HTTPException( - status_code=status.HTTP_404_NOT_FOUND, - detail=f"User with ID {user_id} not found" - ) - - if user_update.username is not None: - user.username = user_update.username - if user_update.email is not None: - user.email = user_update.email - - db.commit() - db.refresh(user) - return user - diff --git a/app/db/session.py b/app/db/session.py index 474a2ee..8390218 100644 --- a/app/db/session.py +++ b/app/db/session.py @@ -1,14 +1,10 @@ # app/database/session.py import os -from dotenv import load_dotenv from sqlalchemy import create_engine from sqlalchemy.orm import sessionmaker, Session from typing import Generator -# Load environment variables from .env file -load_dotenv() - DB_HOST = os.getenv("DB_HOST", "localhost") DB_PORT = os.getenv("DB_PORT", "5432") DB_USER = os.getenv("POSTGRES_USER", "postgres") diff --git a/app/services/orders.py b/app/services/orders.py new file mode 100644 index 0000000..e69de29 diff --git a/app/services/users.py b/app/services/users.py index c140e3a..f0a1f3b 100644 --- a/app/services/users.py +++ b/app/services/users.py @@ -1,6 +1,6 @@ from sqlalchemy.orm import Session from app.validators.users import UserCreate, UserUpdate -from app.db.models.users import get_user_by_email, get_user_by_username, create_user as db_create_user, get_all_users, get_user_by_id, delete_user_by_id, update_user_db +from app.db.crud.users import get_user_by_email, get_user_by_username, create_user as db_create_user, get_all_users, get_user_by_id, delete_user_by_id, update_user_db from fastapi import HTTPException, status from app.utils.hashing import hash_password diff --git a/main.py b/main.py index b376029..07f8acf 100644 --- a/main.py +++ b/main.py @@ -1,6 +1,8 @@ from fastapi import FastAPI from app.routers import users, auth -from app.db.models.users import create_tables # import the table creation func +from dotenv import load_dotenv + +load_dotenv() # Load env variables early app = FastAPI( title="User Order Management API", @@ -12,8 +14,7 @@ @app.on_event("startup") def on_startup(): - create_tables() # create tables if not exist - print("✅ Database tables are ready.") + print("🚀 App starting up...") @app.on_event("shutdown") def on_shutdown():