Adjusted files for isort & autopep

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

creyPY/fastapi/db/__init__.py

@@ -1,3 +1,8 @@
-from .async_session import *  # noqa
+try:
-from .helpers import *  # noqa
+    import sqlalchemy
-from .session import *  # noqa
+
+    from .async_session import *
+    from .helpers import *
+    from .session import *
+except ImportError:
+    print("SQLAlchemy not installed. Database functionality will be disabled.")

creyPY/fastapi/db/async_session.py

@@ -1,15 +1,14 @@
 from typing import AsyncGenerator
 
-from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
+from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
-from sqlalchemy.orm import sessionmaker
 
-from .common import SQLALCHEMY_DATABASE_URL, name
+from .common import SQLALCHEMY_DATABASE_URL, name, ssl_mode
 
 async_engine = create_async_engine(
-    SQLALCHEMY_DATABASE_URL + name, pool_pre_ping=True, connect_args={"sslmode": "require"}
+    SQLALCHEMY_DATABASE_URL + name, pool_pre_ping=True, connect_args={"sslmode": ssl_mode}
 )
 
-AsyncSessionLocal = sessionmaker(
+AsyncSessionLocal = async_sessionmaker(
     bind=async_engine,
     class_=AsyncSession,
     expire_on_commit=False,

creyPY/fastapi/db/common.py

@@ -10,4 +10,6 @@ password = os.getenv("POSTGRES_PASSWORD", "root")
 port = os.getenv("POSTGRES_PORT", "5432")
 name = os.getenv("POSTGRES_DB", "fastapi")
 
+ssl_mode = os.getenv("SSL_MODE", "require")
+
 SQLALCHEMY_DATABASE_URL = f"postgresql+psycopg://{user}:{password}@{host}:{port}/"

creyPY/fastapi/db/session.py

@@ -4,10 +4,10 @@ from sqlalchemy import create_engine
 from sqlalchemy.orm import sessionmaker
 from sqlalchemy.orm.session import Session
 
-from .common import SQLALCHEMY_DATABASE_URL, name
+from .common import SQLALCHEMY_DATABASE_URL, name, ssl_mode
 
 engine = create_engine(
-    SQLALCHEMY_DATABASE_URL + name, pool_pre_ping=True, connect_args={"sslmode": "require"}
+    SQLALCHEMY_DATABASE_URL + name, pool_pre_ping=True, connect_args={"sslmode": ssl_mode}
 )
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 

creyPY/fastapi/models/__init__.py

@@ -1 +1,2 @@
 from .base import *  # noqa
+from .mixins import *  # noqa

creyPY/fastapi/models/base.py

@@ -7,9 +7,11 @@ from sqlalchemy.ext.declarative import declared_attr
 from sqlalchemy.orm import as_declarative
 from sqlalchemy.sql import func
 
+from .mixins import AutoAnnotateMixin, AutoInitMixin
+
 
 @as_declarative()
-class Base:
+class Base(AutoAnnotateMixin, AutoInitMixin):
     __abstract__ = True
     # Primary key as uuid
     id = Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
@@ -19,10 +21,21 @@ class Base:
 
     __name__: str
 
-    # TODO: Add default representation string
     # TODO: Add automated foreign key resolution
 
     # Generate __tablename__ automatically
     @declared_attr
     def __tablename__(cls) -> str:
         return cls.__name__.lower()
+
+    def __str__(self) -> str:
+        # if the object has a name, title or similar attribute, return it
+        if hasattr(self, "name"):
+            return str(self.name)  # type: ignore
+
+        # if the object has a title attribute, return it
+        if hasattr(self, "title"):
+            return str(self.title)  # type: ignore
+
+        # otherwise return the object's id
+        return str(self.id)

creyPY/fastapi/models/mixins.py

@@ -0,0 +1,36 @@
+from sqlalchemy import Column
+from sqlalchemy.orm import Mapped
+
+
+class AutoAnnotateMixin:
+    @classmethod
+    def __init_subclass__(cls) -> None:
+        super().__init_subclass__()
+        annotations = {}
+        for key, value in cls.__dict__.items():
+            if isinstance(value, Column):
+                annotations[key] = Mapped[value.type.python_type]
+        cls.__annotations__ = annotations
+
+
+class AutoInitMixin:
+    @classmethod
+    def __init_subclass__(cls) -> None:
+        super().__init_subclass__()
+        init_params = []
+        for key, value in cls.__dict__.items():
+            if isinstance(value, Column):
+                if not value.nullable and not value.default and not value.server_default:
+                    init_params.append((key, value.type.python_type))
+
+        def __init__(self, **kwargs):
+            super(cls, self).__init__()
+            for key, _ in init_params:
+                if key not in kwargs:
+                    raise TypeError(f"Missing required argument: {key}")
+                setattr(self, key, kwargs[key])
+            for key, value in kwargs.items():
+                if key not in init_params and hasattr(self.__class__, key):
+                    setattr(self, key, value)
+
+        cls.__init__ = __init__

creyPY/fastapi/pagination.py

@@ -1,27 +1,26 @@
+from contextlib import suppress
 from math import ceil
 from typing import Any, Generic, Optional, Self, Sequence, TypeVar, Union, overload
-from contextlib import suppress
+
-from pydantic import BaseModel
+from fastapi import Query
-from fastapi_pagination import Params
+from fastapi_pagination.api import apply_items_transformer, create_page
-from fastapi_pagination.bases import AbstractPage, AbstractParams
+from fastapi_pagination.bases import AbstractPage, AbstractParams, RawParams
+from fastapi_pagination.ext.sqlalchemy import create_paginate_query
 from fastapi_pagination.types import (
+    AdditionalData,
+    AsyncItemsTransformer,
     GreaterEqualOne,
     GreaterEqualZero,
-    AdditionalData,
-    SyncItemsTransformer,
-    AsyncItemsTransformer,
     ItemsTransformer,
+    SyncItemsTransformer,
 )
-from fastapi_pagination.api import create_page, apply_items_transformer
 from fastapi_pagination.utils import verify_params
-from fastapi_pagination.ext.sqlalchemy import create_paginate_query
+from pydantic import BaseModel
-from fastapi_pagination.bases import AbstractParams, RawParams
 from pydantic.json_schema import SkipJsonSchema
-from sqlalchemy.sql.selectable import Select
+from sqlalchemy import func, select
-from sqlalchemy.orm.session import Session
-from sqlalchemy import select, func
 from sqlalchemy.ext.asyncio import AsyncSession, async_scoped_session
-from fastapi import Query
+from sqlalchemy.orm.session import Session
+from sqlalchemy.sql.selectable import Select
 from sqlalchemy.util import await_only, greenlet_spawn
 
 T = TypeVar("T")
@@ -29,7 +28,7 @@ T = TypeVar("T")
 
 class PaginationParams(BaseModel, AbstractParams):
     page: int = Query(1, ge=1, description="Page number")
-    size: int = Query(50, ge=1, le=100, description="Page size")
+    size: int = Query(50, ge=1, description="Page size")
     pagination: bool = Query(True, description="Toggle pagination")
 
     def to_raw_params(self) -> RawParams:
@@ -62,7 +61,7 @@ class Page(AbstractPage[T], Generic[T]):
         total: Optional[int] = None,
         **kwargs: Any,
     ) -> Self:
-        if not isinstance(params, Params):
+        if not isinstance(params, PaginationParams):
             raise TypeError("Page should be used with Params")
 
         size = params.size or total or len(items)
@@ -170,9 +169,9 @@ def _paginate(
     total = connection.scalar(count_query)
 
     if params.pagination is False and total > 0:
-        params = Params(page=1, size=total)
+        params = PaginationParams(page=1, size=total)
     else:
-        params = Params(page=params.page, size=params.size)
+        params = PaginationParams(page=params.page, size=params.size)
 
     query = create_paginate_query(query, params)
     items = connection.execute(query).all()

creyPY/fastapi/testing_unit.py

@@ -0,0 +1,196 @@
+import json
+import unittest
+from typing import Type
+
+from httpx import ASGITransport, AsyncClient, Response
+from sqlalchemy import create_engine, text
+from sqlalchemy.ext.asyncio import create_async_engine
+from sqlalchemy_utils import create_database, database_exists, drop_database
+
+from creyPY.fastapi.models.base import Base
+
+
+class AbstractTestAPI(unittest.IsolatedAsyncioTestCase):
+    client: AsyncClient
+    default_headers: dict = {}
+
+    @classmethod
+    def setUpClass(cls, app, headers={}) -> None:
+        cls.client = AsyncClient(
+            transport=ASGITransport(app=app), base_url="http://testserver", follow_redirects=True
+        )
+        cls.default_headers = headers
+
+    @classmethod
+    def setup_database(
+        cls,
+        sync_db_url: str,
+        async_db_url: str,
+        base: Type[Base],
+        btree_gist: bool = False,
+        ssl_mode: str = "require",
+    ):
+        cls.engine_s = create_engine(
+            sync_db_url,
+            echo=False,
+            pool_pre_ping=True,
+            connect_args={"sslmode": ssl_mode},
+        )
+        if database_exists(cls.engine_s.url):
+            drop_database(cls.engine_s.url)
+        create_database(cls.engine_s.url)
+
+        if btree_gist:
+            with cls.engine_s.begin() as conn:
+                conn.execute(text("CREATE EXTENSION IF NOT EXISTS btree_gist"))
+
+        # Migrate
+        base.metadata.create_all(cls.engine_s)
+
+        cls.engine = create_async_engine(
+            async_db_url,
+            echo=False,
+            pool_pre_ping=True,
+            connect_args={"sslmode": ssl_mode},
+        )
+
+    async def get(self, url: str, r_code: int = 200, parse_json=True) -> dict | bytes:
+        re = await self.client.get(url, headers=self.default_headers)
+        if re.status_code != r_code:
+            print(re.content)
+        self.assertEqual(r_code, re.status_code)
+        return re.json() if parse_json else re.content
+
+    async def delete(self, url: str, r_code: int = 204) -> dict | None:
+        re = await self.client.delete(url, headers=self.default_headers)
+        if re.status_code != r_code:
+            print(re.content)
+        self.assertEqual(r_code, re.status_code)
+        return re.json() if r_code != 204 else None
+
+    async def post(
+        self, url: str, obj: dict | str = {}, r_code: int = 201, raw_response=False, *args, **kwargs
+    ):
+        re = await self.client.post(
+            url,
+            data=json.dumps(obj) if isinstance(obj, dict) else obj,
+            headers=self.default_headers | {"Content-Type": "application/json"},
+            *args,
+            **kwargs,
+        )
+        if re.status_code != r_code:
+            print(re.content)
+        if not raw_response:
+            self.assertEqual(r_code, re.status_code)
+        return re.json() if not raw_response else re
+
+    async def post_file(
+        self, url: str, file, r_code: int = 201, raw_response=False, *args, **kwargs
+    ) -> dict | bytes | Response:
+        re = await self.client.post(
+            url,
+            files={"file": file},
+            headers=self.default_headers,
+            *args,
+            **kwargs,
+        )
+        if re.status_code != r_code:
+            print(re.content)
+        self.assertEqual(r_code, re.status_code)
+        return re.json() if not raw_response else re
+
+    async def patch(
+        self, url: str, obj: dict | str = {}, r_code: int = 200, raw_response=False, *args, **kwargs
+    ) -> dict | bytes | Response:
+        re = await self.client.patch(
+            url,
+            data=json.dumps(obj) if isinstance(obj, dict) else obj,
+            headers=self.default_headers | {"Content-Type": "application/json"},
+            *args,
+            **kwargs,
+        )
+        if re.status_code != r_code:
+            print(re.content)
+        self.assertEqual(r_code, re.status_code)
+        return re.json() if not raw_response else re
+
+    async def put(
+        self, url: str, obj: dict | str = {}, r_code: int = 200, raw_response=False, *args, **kwargs
+    ) -> dict | bytes | Response:
+        re = await self.client.put(
+            url,
+            data=json.dumps(obj) if isinstance(obj, dict) else obj,
+            headers=self.default_headers
+            | {
+                "Content-Type": "application/json",
+                "accept": "application/json",
+            },
+            *args,
+            **kwargs,
+        )
+        if re.status_code != r_code:
+            print(re.content)
+        self.assertEqual(r_code, re.status_code)
+        return re.json() if not raw_response else re
+
+    async def obj_lifecycle(
+        self,
+        input_obj: dict,
+        url: str,
+        pagination: bool = True,
+        id_field: str = "id",
+        created_at_check: bool = True,
+        patch: dict | None = None,
+    ):
+        # GET LIST
+        re = await self.get(url)
+        if pagination:
+            self.assertEqual(re["total"], 0)
+            self.assertEqual(len(re["results"]), 0)
+        else:
+            self.assertEqual(len(re), 0)
+
+        # CREATE
+        re = await self.post(url, obj=input_obj)
+        self.assertIn(id_field, re)
+        self.assertIsNotNone(re[id_field])
+
+        if created_at_check:
+            self.assertIn("created_at", re)
+            self.assertIsNotNone(re["created_at"])
+
+        obj_id = str(re[id_field])
+
+        # GET
+        re = await self.get(f"{url}{obj_id}/")
+        self.assertEqual(re[id_field], obj_id)
+
+        # PATCH
+        if patch:
+            for key, value in patch.items():
+                input_obj[key] = value
+            re = await self.patch(f"{url}{obj_id}/", obj=input_obj)
+            for key, value in patch.items():
+                self.assertEqual(re[key], value)
+
+        # GET LIST
+        re = await self.get(url)
+        if pagination:
+            self.assertEqual(re["total"], 1)
+            self.assertEqual(len(re["results"]), 1)
+        else:
+            self.assertEqual(len(re), 1)
+
+        # DELETE
+        await self.delete(f"{url}{obj_id}")
+
+        # GET LIST
+        re = await self.get(url)
+        if pagination:
+            self.assertEqual(re["total"], 0)
+            self.assertEqual(len(re["results"]), 0)
+        else:
+            self.assertEqual(len(re), 0)
+
+        # GET
+        await self.get(f"{url}{obj_id}", parse_json=False, r_code=404)

creyPY/helpers.py

@@ -1,5 +1,7 @@
 import secrets
 import string
+import csv
+from pathlib import Path
 
 
 def create_random_password(length: int = 12) -> str:
@@ -14,3 +16,11 @@ def create_random_password(length: int = 12) -> str:
     password += [secrets.choice(all_characters) for _ in range(length - 4)]
     secrets.SystemRandom().shuffle(password)
     return "".join(password)
+
+
+def data_to_csv(file: Path, data: list) -> None:
+
+    with file.open(mode="w", newline="", encoding="utf-8") as f:
+        writer = csv.DictWriter(f, fieldnames=data[0].keys(), delimiter=";")
+        writer.writeheader()
+        writer.writerows(data)

creyPY/services/__init__.py

@@ -1 +1,2 @@
 from .auth0 import *  # noqa
+from .stripe import *  # noqa

creyPY/services/auth0/__init__.py

@@ -1,3 +1,4 @@
 from .exceptions import *  # noqa
 from .manage import *  # noqa
+from .testing import *  # noqa
 from .utils import *  # noqa

creyPY/services/auth0/testing.py

@@ -0,0 +1,93 @@
+USER_OBJ = {
+    "auth0|testing": {
+        "created_at": "2023-08-15T13:25:31.507Z",
+        "email": "test@test.org",
+        "email_verified": True,
+        "identities": [
+            {
+                "connection": "Username-Password-Authentication",
+                "provider": "auth0",
+                "user_id": "testing",
+                "isSocial": False,
+            }
+        ],
+        "name": "Test Tester",
+        "nickname": "testing",
+        "picture": "https://avatars.githubusercontent.com/u/15138480?v=4",
+        "updated_at": "2024-01-17T12:36:37.300Z",
+        "user_id": "auth0|testing",
+        "user_metadata": {},
+        "last_password_reset": "2024-01-17T11:42:08.761Z",
+        "last_ip": "127.0.0.1",
+        "last_login": "2024-01-17T11:43:09.620Z",
+        "logins_count": 1,
+    },
+    "auth0|new_user": {
+        "created_at": "2023-08-15T13:25:31.507Z",
+        "email": "test2@test.org",
+        "email_verified": True,
+        "identities": [
+            {
+                "connection": "Username-Password-Authentication",
+                "provider": "auth0",
+                "user_id": "testing",
+                "isSocial": False,
+            }
+        ],
+        "name": "Test Tester 2",
+        "nickname": "testing 2",
+        "picture": "https://avatars.githubusercontent.com/u/15138481?v=4",
+        "updated_at": "2024-01-17T12:36:37.303Z",
+        "user_id": "auth0|new_user",
+        "user_metadata": {},
+        "last_password_reset": "2024-01-17T11:42:08.759Z",
+        "last_ip": "127.0.0.1",
+        "last_login": "2024-01-17T11:43:09.618Z",
+        "logins_count": 1,
+    },
+}
+
+
+def get_user_auth0(sub, *args, **kwargs) -> dict:
+    return USER_OBJ[sub]
+
+
+def patch_user_auth0(input_obj: dict, sub, *args, **kwargs) -> dict:
+    USER_OBJ[sub].update(input_obj)
+    return get_user_auth0(sub)
+
+
+def get_user_auth0_metadata(sub, *args, **kwargs) -> dict:
+    return USER_OBJ[sub]["user_metadata"]
+
+
+def check_company_auth0(*args, **kwargs) -> bool:
+    return True
+
+
+def auth0_sub_to_profile(sub: str) -> dict:
+    return {
+        "email": USER_OBJ[sub]["email"],
+        "name": USER_OBJ[sub]["name"],
+        "picture": USER_OBJ[sub]["picture"],
+        "company_ids": USER_OBJ[sub]["user_metadata"]["company_ids"],
+    }
+
+
+def auth0_sub_to_public(sub: str) -> dict:
+    return {
+        "email": USER_OBJ[sub]["email"],
+        "name": USER_OBJ[sub]["name"],
+        "picture": USER_OBJ[sub]["picture"],
+    }
+
+
+def patch_user_auth0_metadata(input_obj: dict, sub, *args, **kwargs) -> dict:
+    USER_OBJ[sub]["user_metadata"].update(input_obj)
+    return get_user_auth0_metadata(sub)
+
+
+def set_company_id(sub: str, company_id: str):
+    if sub not in USER_OBJ:
+        USER_OBJ[sub] = {}
+    USER_OBJ[sub]["user_metadata"] = {"company_ids": [company_id]}

creyPY/services/auth0/utils.py

@@ -101,7 +101,7 @@ def request_verification_mail(sub: str) -> None:
     return re.json()
 
 
-def create_user_invite(email: str) -> dict:
+def create_user_invite(email: str, company_id: str) -> dict:
     re = requests.post(
         f"https://{AUTH0_DOMAIN}/api/v2/users",
         headers={"Authorization": f"Bearer {get_management_token()}"},
@@ -111,6 +111,7 @@ def create_user_invite(email: str) -> dict:
             "password": create_random_password(),
             "verify_email": False,
             "app_metadata": {"invitedToMyApp": True},
+            "user_metadata": {"company_ids": [company_id]},
         },
         timeout=5,
     )

creyPY/services/stripe/__init__.py

@@ -0,0 +1 @@
+from .testing import *  # noqa

creyPY/services/stripe/testing.py

@@ -0,0 +1,23 @@
+class ItemReturn:
+    quantity = 1
+
+
+class SubscriptionItem:
+    def retrieve(self, id: str = ""):
+        return ItemReturn
+
+    def modify(self, id: str, quantity: int):
+        return ItemReturn
+
+
+class StripeAPI:
+    def __init__(self, key: str):
+        pass
+
+    @property
+    def SubscriptionItem(self):
+        return SubscriptionItem
+
+
+def get_stripe_api():
+    return StripeAPI("test")

creyPY/services/stripe/utils.py

@@ -0,0 +1,11 @@
+import os
+
+import stripe
+from dotenv import load_dotenv
+
+load_dotenv()
+
+
+def get_stripe_api():
+    stripe.api_key = os.getenv("STRIPE_API_KEY", "")
+    return stripe

requirements.stripe.txt

@@ -0,0 +1 @@
+stripe==11.6.0 # Stripe

setup.py

@@ -14,6 +14,9 @@ with open("requirements.pg.txt") as f:
 with open("requirements.auth0.txt") as f:
     auth0_requirements = f.read().splitlines()
 
+with open("requirements.stripe.txt") as f:
+    stripe_requirements = f.read().splitlines()
+
 
 def get_latest_git_tag() -> str:
     try:
@@ -36,7 +39,7 @@ setup(
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     author="Conrad Großer",
-    author_email="conrad@noah.tech",
+    author_email="code@grosser.group",
     packages=find_packages(),
     url="https://github.com/creyD/creyPY",
     license="MIT",
@@ -46,7 +49,8 @@ setup(
         "build": build_requirements,
         "postgres": pg_requirements,
         "auth0": auth0_requirements,
-        "all": build_requirements + pg_requirements + auth0_requirements,
+        "stripe": stripe_requirements,
+        "all": build_requirements + pg_requirements + auth0_requirements + stripe_requirements,
     },
     keywords=[
         "creyPY",

test.py

@@ -7,9 +7,7 @@ from sqlalchemy import create_engine
 from sqlalchemy.orm import sessionmaker
 
 from creyPY.fastapi.app import generate_unique_id
-from creyPY.fastapi.crud import (
+from creyPY.fastapi.crud import get_object_or_404
-    get_object_or_404,
-)
 from creyPY.fastapi.models.base import Base
 
 
@@ -65,7 +63,7 @@ class TestMyFunction(unittest.TestCase):
     def test_get_object_or_404_existing_object(self):
         # Arrange
         obj_id = UUID("123e4567-e89b-12d3-a456-426614174000")
-        obj = MockDBClass(obj_id)
+        obj = MockDBClass(id=obj_id)
         self.db.add(obj)
         self.db.commit()