ohmyapi 0.1.21__tar.gz → 0.1.23__tar.gz

{ohmyapi-0.1.21 → ohmyapi-0.1.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ohmyapi
-Version: 0.1.21
+Version: 0.1.23
 Summary: A Django-like but async web-framework based on FastAPI and TortoiseORM.
 License-Expression: MIT
 Keywords: fastapi,tortoise,orm,async,web-framework
@@ -157,7 +157,7 @@ class Team(Model):
 Next, create your endpoints in `tournament/routes.py`:
 
 ```python
-from ohmyapi.router import APIRouter, HTTPException
+from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
 from ohmyapi.db.exceptions import DoesNotExist
 
 from .models import Tournament
@@ -167,20 +167,25 @@ from .models import Tournament
 # Tags improve the UX of the OpenAPI docs at /docs.
 router = APIRouter(prefix="/tournament", tags=['Tournament'])
 
-
 @router.get("/")
 async def list():
     queryset = Tournament.all()
     return await Tournament.Schema.model.from_queryset(queryset)
 
 
+@router.post("/", status_code=HTTPStatus.CREATED)
+async def post(tournament: Tournament.Schema.readonly):
+    queryset = Tournament.create(**payload.model_dump())
+    return await Tournament.Schema.model.from_queryset(queryset)
+
+
 @router.get("/:id")
 async def get(id: str):
     try:
-        tournament = await Tournament.get(pk=id)
+        queryset = Tournament.get(id=id)
         return await Tournament.Schema.model.from_queryset_single(tournament)
     except DoesNotExist:
-        raise HTTPException(status_code=404, detail="item not found")
+        raise HTTPException(status_code=404, detail="not found")
 
 ...
 ```
@@ -350,28 +355,66 @@ Find your loaded project singleton via identifier: `p`
 
 ```python
 In [1]: p
-Out[1]: <ohmyapi.core.runtime.Project at 0xdeadbeefc0febabe>
+Out[1]: <ohmyapi.core.runtime.Project at 0x7f00c43dbcb0>
 
 In [2]: p.apps
 Out[2]:
-{'ohmyapi_auth': App: ohmyapi_auth
- Models:
-  - Group
-  - User
- Routes:
-  - APIRoute(path='/auth/login', name='login', methods=['POST'])
-  - APIRoute(path='/auth/refresh', name='refresh_token', methods=['POST'])
-  - APIRoute(path='/auth/introspect', name='introspect', methods=['GET'])
-  - APIRoute(path='/auth/me', name='me', methods=['GET']),
- 'tournament': App: tournament
- Models:
-  - Tournament
-  - Event
-  - Team
- Routes:
-  - APIRoute(path='/tournament/', name='list', methods=['GET'])}
-
-In [3]: from tournament.models import Tournament
+{'ohmyapi_auth': {
+   "models": [
+     "Group",
+     "User"
+   ],
+   "routes": [
+     {
+       "path": "/auth/login",
+       "name": "login",
+       "methods": [
+         "POST"
+       ],
+       "endpoint": "login",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/refresh",
+       "name": "refresh_token",
+       "methods": [
+         "POST"
+       ],
+       "endpoint": "refresh_token",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/introspect",
+       "name": "introspect",
+       "methods": [
+         "GET"
+       ],
+       "endpoint": "introspect",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/me",
+       "name": "me",
+       "methods": [
+         "GET"
+       ],
+       "endpoint": "me",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     }
+   ]
+ }}
 ```
 
 

{ohmyapi-0.1.21 → ohmyapi-0.1.23}/README.md

@@ -125,7 +125,7 @@ class Team(Model):
 Next, create your endpoints in `tournament/routes.py`:
 
 ```python
-from ohmyapi.router import APIRouter, HTTPException
+from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
 from ohmyapi.db.exceptions import DoesNotExist
 
 from .models import Tournament
@@ -135,20 +135,25 @@ from .models import Tournament
 # Tags improve the UX of the OpenAPI docs at /docs.
 router = APIRouter(prefix="/tournament", tags=['Tournament'])
 
-
 @router.get("/")
 async def list():
     queryset = Tournament.all()
     return await Tournament.Schema.model.from_queryset(queryset)
 
 
+@router.post("/", status_code=HTTPStatus.CREATED)
+async def post(tournament: Tournament.Schema.readonly):
+    queryset = Tournament.create(**payload.model_dump())
+    return await Tournament.Schema.model.from_queryset(queryset)
+
+
 @router.get("/:id")
 async def get(id: str):
     try:
-        tournament = await Tournament.get(pk=id)
+        queryset = Tournament.get(id=id)
         return await Tournament.Schema.model.from_queryset_single(tournament)
     except DoesNotExist:
-        raise HTTPException(status_code=404, detail="item not found")
+        raise HTTPException(status_code=404, detail="not found")
 
 ...
 ```
@@ -318,27 +323,65 @@ Find your loaded project singleton via identifier: `p`
 
 ```python
 In [1]: p
-Out[1]: <ohmyapi.core.runtime.Project at 0xdeadbeefc0febabe>
+Out[1]: <ohmyapi.core.runtime.Project at 0x7f00c43dbcb0>
 
 In [2]: p.apps
 Out[2]:
-{'ohmyapi_auth': App: ohmyapi_auth
- Models:
-  - Group
-  - User
- Routes:
-  - APIRoute(path='/auth/login', name='login', methods=['POST'])
-  - APIRoute(path='/auth/refresh', name='refresh_token', methods=['POST'])
-  - APIRoute(path='/auth/introspect', name='introspect', methods=['GET'])
-  - APIRoute(path='/auth/me', name='me', methods=['GET']),
- 'tournament': App: tournament
- Models:
-  - Tournament
-  - Event
-  - Team
- Routes:
-  - APIRoute(path='/tournament/', name='list', methods=['GET'])}
-
-In [3]: from tournament.models import Tournament
+{'ohmyapi_auth': {
+   "models": [
+     "Group",
+     "User"
+   ],
+   "routes": [
+     {
+       "path": "/auth/login",
+       "name": "login",
+       "methods": [
+         "POST"
+       ],
+       "endpoint": "login",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/refresh",
+       "name": "refresh_token",
+       "methods": [
+         "POST"
+       ],
+       "endpoint": "refresh_token",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/introspect",
+       "name": "introspect",
+       "methods": [
+         "GET"
+       ],
+       "endpoint": "introspect",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/me",
+       "name": "me",
+       "methods": [
+         "GET"
+       ],
+       "endpoint": "me",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     }
+   ]
+ }}
 ```
 

{ohmyapi-0.1.21 → ohmyapi-0.1.23}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ohmyapi"
-version = "0.1.21"
+version = "0.1.23"
 description = "A Django-like but async web-framework based on FastAPI and TortoiseORM."
 license = "MIT"
 keywords = ["fastapi", "tortoise", "orm", "async", "web-framework"]

{ohmyapi-0.1.21 → ohmyapi-0.1.23}/src/ohmyapi/builtin/auth/routes.py

@@ -26,9 +26,64 @@ REFRESH_TOKEN_EXPIRE_SECONDS = getattr(
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/login")
 
 
-def create_token(data: dict, expires_in: int) -> str:
-    to_encode = data.copy()
-    to_encode.update({"exp": int(time.time()) + expires_in})
+class ClaimsUser(BaseModel):
+    username: str
+    email: str
+    is_admin: bool
+    is_staff: bool
+
+
+class Claims(BaseModel):
+    type: str
+    sub: str
+    user: ClaimsUser
+    roles: List[str]
+    exp: str
+
+
+class AccessToken(BaseModel):
+    token_type: str
+    access_token: str
+
+
+class RefreshToken(AccessToken):
+    refresh_token: str
+
+
+class LoginRequest(BaseModel):
+    username: str
+    password: str
+
+
+class TokenType(str, Enum):
+    """
+    Helper for indicating the token type when generating claims.
+    """
+
+    access = "access"
+    refresh = "refresh"
+
+
+def claims(
+    token_type: TokenType, user: User, groups: List[Group] = []
+) -> Claims:
+    return Claims(
+        type=token_type,
+        sub=str(user.id),
+        user=ClaimsUser(
+            username=user.username,
+            email=user.email,
+            is_admin=user.is_admin,
+            is_staff=user.is_staff,
+        ),
+        roles=[g.name for g in groups],
+        exp="",
+    )
+
+
+def create_token(claims: Claims, expires_in: int) -> str:
+    to_encode = claims.model_dump()
+    to_encode['exp'] = int(time.time()) + expires_in
     token = jwt.encode(to_encode, JWT_SECRET, algorithm=JWT_ALGORITHM)
     if isinstance(token, bytes):
         token = token.decode("utf-8")
@@ -48,29 +103,6 @@ def decode_token(token: str) -> Dict:
         )
 
 
-class TokenType(str, Enum):
-    """
-    Helper for indicating the token type when generating claims.
-    """
-
-    access = "access"
-    refresh = "refresh"
-
-
-def claims(
-    token_type: TokenType, user: User, groups: List[Group] = []
-) -> Dict[str, Any]:
-    return {
-        "type": token_type,
-        "sub": str(user.id),
-        "user": {
-            "username": user.username,
-            "email": user.email,
-        },
-        "roles": [g.name for g in groups],
-    }
-
-
 async def get_token(token: str = Depends(oauth2_scheme)) -> Dict:
     """Dependency: token introspection"""
     payload = decode_token(token)
@@ -127,12 +159,7 @@ async def require_group(
     return current_user
 
 
-class LoginRequest(BaseModel):
-    username: str
-    password: str
-
-
-@router.post("/login")
+@router.post("/login", response_model=RefreshToken)
 async def login(form_data: LoginRequest = Body(...)):
     """Login with username & password, returns access and refresh tokens."""
     user = await User.authenticate(form_data.username, form_data.password)
@@ -148,14 +175,14 @@ async def login(form_data: LoginRequest = Body(...)):
         claims(TokenType.refresh, user), REFRESH_TOKEN_EXPIRE_SECONDS
     )
 
-    return {
-        "access_token": access_token,
-        "refresh_token": refresh_token,
-        "token_type": "bearer",
-    }
+    return RefreshToken(
+        token_type="bearer",
+        access_token=access_token,
+        refresh_token=refresh_token,
+    )
 
 
-@router.post("/refresh")
+@router.post("/refresh", response_model=AccessToken)
 async def refresh_token(refresh_token: str):
     """Exchange refresh token for new access token."""
     payload = decode_token(refresh_token)
@@ -174,15 +201,15 @@ async def refresh_token(refresh_token: str):
     new_access = create_token(
         claims(TokenType.access, user), ACCESS_TOKEN_EXPIRE_SECONDS
     )
-    return {"access_token": new_access, "token_type": "bearer"}
+    return AccessToken(token_type="bearer", access_token=access_token)
 
 
-@router.get("/introspect")
+@router.get("/introspect", response_model=Dict[str, Any])
 async def introspect(token: Dict = Depends(get_token)):
     return token
 
 
-@router.get("/me")
+@router.get("/me", response_model=User.Schema.model)
 async def me(user: User = Depends(get_current_user)):
     """Return the currently authenticated user."""
-    return User.Schema.one.from_orm(user)
+    return await User.Schema.model.from_tortoise_orm(user)

ohmyapi-0.1.23/src/ohmyapi/builtin/demo/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from . import routes

ohmyapi-0.1.23/src/ohmyapi/builtin/demo/models.py

@@ -0,0 +1,50 @@
+from ohmyapi.db import Model, field
+from ohmyapi_auth.models import User
+
+from datetime import datetime
+from decimal import Decimal
+from uuid import UUID
+
+
+class Team(Model):
+    id: UUID = field.data.UUIDField(primary_key=True)
+    name: str = field.TextField()
+    members: field.ManyToManyRelation[User] = field.ManyToManyField(
+        'ohmyapi_auth.User',
+        related_name="tournament_teams",
+        through='user_tournament_teams',
+    )
+
+    def __str__(self):
+        return self.name
+
+
+class Tournament(Model):
+    id: UUID = field.data.UUIDField(primary_key=True)
+    name: str = field.TextField()
+    created: datetime = field.DatetimeField(auto_now_add=True)
+
+    def __str__(self):
+        return self.name
+
+
+class Event(Model):
+    id: UUID = field.data.UUIDField(primary_key=True)
+    name: str = field.TextField()
+    tournament: field.ForeignKeyRelation[Tournament] = field.ForeignKeyField(
+        'ohmyapi_demo.Tournament',
+        related_name='events',
+    )
+    participants: field.ManyToManyRelation[Team] = field.ManyToManyField(
+        'ohmyapi_demo.Team',
+        related_name='events',
+        through='event_team',
+    )
+    modified: datetime = field.DatetimeField(auto_now=True)
+    prize: Decimal = field.DecimalField(max_digits=10, decimal_places=2, null=True)
+
+    class Schema:
+        exclude = ['tournament_id']
+
+    def __str__(self):
+        return self.name

ohmyapi-0.1.23/src/ohmyapi/builtin/demo/routes.py

@@ -0,0 +1,54 @@
+from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
+from ohmyapi.db.exceptions import DoesNotExist
+
+from . import models
+
+from typing import List
+
+# Expose your app's routes via `router = fastapi.APIRouter`.
+# Use prefixes wisely to avoid cross-app namespace-collisions.
+# Tags improve the UX of the OpenAPI docs at /docs.
+router = APIRouter(prefix="/tournemant")
+
+
+@router.get("/",
+            tags=["tournament"],
+            response_model=List[models.Tournament.Schema.model])
+async def list():
+    """List all tournaments."""
+    return await models.Tournament.Schema.model.from_queryset(Tournament.all())
+
+
+@router.post("/",
+             tags=["tournament"],
+             status_code=HTTPStatus.CREATED)
+async def post(tournament: models.Tournament.Schema.readonly):
+    """Create tournament."""
+    return await models.Tournament.Schema.model.from_queryset(models.Tournament.create(**tournament.model_dump()))
+
+
+@router.get("/{id}",
+            tags=["tournament"],
+            response_model=models.Tournament.Schema.model)
+async def get(id: str):
+    """Get tournament by id."""
+    return await models.Tournament.Schema.model.from_queryset(models.Tournament.get(id=id))
+
+
+@router.put("/{id}",
+            tags=["tournament"],
+            response_model=models.Tournament.Schema.model,
+            status_code=HTTPStatus.ACCEPTED)
+async def put(tournament: models.Tournament.Schema.model):
+    """Update tournament."""
+    return await models.Tournament.Schema.model.from_queryset(models.Tournament.update(**tournament.model_dump()))
+
+
+@router.delete("/{id}", tags=["tournament"])
+async def delete(id: str):
+    try:
+        tournament = await models.Tournament.get(id=id)
+        return await tournament.delete()
+    except DoesNotExist:
+        raise HTTPException(status_code=HTTPStatus.NOT_FOUND, detail="not found")
+

ohmyapi-0.1.23/src/ohmyapi/core/templates/app/routes.py.j2

@@ -0,0 +1,41 @@
+from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
+
+from . import models
+
+from typing import List
+
+# Expose your app's routes via `router = fastapi.APIRouter`.
+# Use prefixes wisely to avoid cross-app namespace-collisions.
+# Tags improve the UX of the OpenAPI docs at /docs.
+router = APIRouter(prefix="/{{ app_name }}", tags=['{{ app_name }}'])
+
+
+
+@router.get("/")
+async def list():
+    """List all ..."""
+    return []
+
+
+@router.post("/")
+async def post():
+    """Create ..."""
+    return HTTPException(status_code=HTTPStatus.CREATED)
+
+
+@router.get("/{id}")
+async def get(id: str):
+    """Get single ..."""
+    return {}
+
+
+@router.put("/{id}")
+async def put(id: str):
+    """Update ..."""
+    return HTTPException(status_code=HTTPStatus.ACCEPTED)
+
+
+@router.delete("/{id}")
+async def delete(id: str):
+    return HTTPException(status_code=HTTPStatus.ACCEPTED)
+

{ohmyapi-0.1.21 → ohmyapi-0.1.23}/src/ohmyapi/router.py

@@ -1 +1,2 @@
 from fastapi import APIRouter, Depends, HTTPException
+from http import HTTPStatus

ohmyapi-0.1.21/src/ohmyapi/core/templates/app/routes.py.j2

@@ -1,17 +0,0 @@
-from ohmyapi.router import APIRouter
-
-from .models import ...
-
-# Expose your app's routes via `router = fastapi.APIRouter`.
-# Use prefixes wisely to avoid cross-app namespace-collisions.
-# Tags improve the UX of the OpenAPI docs at /docs.
-router = APIRouter(prefix="/{{ app_name }}", tags=['{{ app_name }}'])
-
-
-@router.get("/")
-def hello_world():
-    return {
-        "project": "{{ project_name }}",
-        "app": "{{ app_name }}",
-    }
-