Naive, initial implementation

Author: MrMatAP

migrations/versions/db0d3f70134d_scaffolding.py

@@ -0,0 +1,42 @@
+"""newest
+
+Revision ID: db0d3f70134d
+Revises: 
+Create Date: 2022-04-30 15:34:25.368352
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'db0d3f70134d'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('owners',
+    sa.Column('id', sa.BigInteger().with_variant(sa.Integer(), 'sqlite'), nullable=False),
+    sa.Column('client_id', sa.String(length=255), nullable=False),
+    sa.Column('name', sa.String(length=255), nullable=False),
+    sa.PrimaryKeyConstraint('id'),
+    sa.UniqueConstraint('client_id')
+    )
+    op.create_table('resources',
+    sa.Column('id', sa.BigInteger().with_variant(sa.Integer(), 'sqlite'), nullable=False),
+    sa.Column('owner_id', sa.Integer(), nullable=False),
+    sa.Column('name', sa.String(length=255), nullable=False),
+    sa.ForeignKeyConstraint(['owner_id'], ['owners.id'], ),
+    sa.PrimaryKeyConstraint('id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('resources')
+    op.drop_table('owners')
+    # ### end Alembic commands ###

mrmat_python_api_fastapi/apis/__init__.py

@@ -19,3 +19,13 @@
 #  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.
+
+from pydantic import BaseModel
+
+
+class StatusSchema(BaseModel):
+    """
+    A generic message class
+    """
+    code: int
+    msg: str

mrmat_python_api_fastapi/apis/resource/v1/api.py

@@ -20,53 +20,154 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 
-from fastapi import APIRouter, Depends
+from typing import Union, List
+from fastapi import APIRouter, Depends, status
+from fastapi.responses import JSONResponse, Response
 from sqlalchemy.orm import Session
 
 from mrmat_python_api_fastapi.db import get_db
-from .db import Resource
-from .schema import ResourceSchema
+from mrmat_python_api_fastapi.apis import StatusSchema
+from .db import Resource, Owner
+from .schema import ResourceSchema, ResourceInputSchema, OwnerSchema, OwnerInputSchema
 
 router = APIRouter()
 
 
-@router.get('/',
+@router.get('/resources',
             name='list_resources',
             summary='List all known resources',
             description='Returns all currently known resources and their metadata',
-            response_model=list[ResourceSchema])
+            response_model=List[ResourceSchema])
 async def get_all(db: Session = Depends(get_db)):
-    resources = db.query(Resource).all()
-    return resources
+    return db.query(Resource).all()
 
 
-@router.get('/{resource_id}',
+@router.get('/resources/{identity}',
             name='get_resource',
             summary='Get a single resource',
-            description='Return a single resource identified by its resource id')
-async def get(resource_id: int):
-    pass
+            description='Return a single resource identified by its resource id',
+            response_model=Union[ResourceSchema, StatusSchema])
+async def get(identity: int, db: Session = Depends(get_db)):
+    resource = db.query(Resource).get(identity).one_or_none()
+    if not resource:
+        return JSONResponse(status_code=404,
+                            content=StatusSchema(code=404, msg='Not found').dict())
+    return resource
 
 
-@router.post('/',
+@router.post('/resources',
              name='create_resource',
              summary='Create a resource',
-             description='Create a resource owned by the authenticated user')
-async def create():
-    pass
+             description='Create a resource owned by the authenticated user',
+             response_model=Union[ResourceSchema, StatusSchema])
+async def create(data: ResourceInputSchema, db: Session = Depends(get_db)):
+    resource = Resource(name=data.name)
+    db.add(resource)
+    db.commit()
+    return resource
 
 
-@router.put('/{resource_id}',
+@router.put('/resources/{identity}',
             name='modify_resource',
             summary='Modify a resource',
-            description='Modify a resource by its resource id')
-async def modify(resource_id: int):
-    pass
+            description='Modify a resource by its resource id',
+            response_model=Union[ResourceSchema, StatusSchema])
+async def modify(identity: int, data: ResourceInputSchema, db: Session = Depends(get_db)):
+    resource = db.query(Resource).get(identity)
+    if not resource:
+        return JSONResponse(status_code=404,
+                            content=StatusSchema(code=404, msg='Not found').dict())
+    resource.name = data.name
+    db.add(resource)
+    db.commit()
+    return resource
 
 
-@router.delete('/{resource_id}',
+@router.delete('/resources/{identity}',
                name='remove_resource',
                summary='Remove a resource',
-               description='Remove a resource by its resource id')
-async def remove(resource_id: int):
-    pass
+               description='Remove a resource by its resource id',
+               status_code=204,
+               responses={
+                   status.HTTP_204_NO_CONTENT: {'description': 'The resource was removed'},
+                   status.HTTP_410_GONE: {'description': 'The resource was already gone'}
+               })
+async def remove(identity: int, response: Response, db: Session = Depends(get_db)):
+    resource = db.query(Resource).get(identity)
+    if not resource:
+        return JSONResponse(status_code=204,
+                            content=StatusSchema(code=404, msg='Not found').dict())
+    db.delete(resource)
+    db.commit()
+    response.status_code = 410
+    return {}
+
+
+
+@router.get('/owners',
+            name='list_owners',
+            summary='List all known owners',
+            description='Returns all currently known owners and their metadata',
+            response_model=List[OwnerSchema])
+async def get_all(db: Session = Depends(get_db)):
+    return db.query(Owner).all()
+
+
+@router.get('/owners/{identity}',
+            name='get_owner',
+            summary='Get a single owner',
+            description='Return a single owner identified by its owner id',
+            response_model=Union[OwnerSchema, StatusSchema])
+async def get(identity: int, db: Session = Depends(get_db)):
+    owner = db.query(Owner).get(identity)
+    if not owner:
+        return JSONResponse(status_code=404,
+                            content=StatusSchema(code=404, msg='Not found').dict())
+    return owner
+
+
+@router.post('/owners',
+             name='create_owner',
+             summary='Create a owner',
+             description='Create a owner',
+             response_model=Union[OwnerSchema, StatusSchema])
+async def create(data: OwnerInputSchema, db: Session = Depends(get_db)):
+    owner = Owner(name=data.name, client_id='TODO')
+    db.add(owner)
+    db.commit()
+    return owner
+
+
+@router.put('/owners/{identity}',
+            name='modify_owner',
+            summary='Modify a owner',
+            description='Modify a owner by its owner id',
+            response_model=Union[OwnerSchema, StatusSchema])
+async def modify(identity: int, data: ResourceInputSchema, db: Session = Depends(get_db)):
+    owner = db.query(Owner).get(identity)
+    if not owner:
+        return JSONResponse(status_code=404,
+                            content=StatusSchema(code=404, msg='Not found').dict())
+    owner.name = data.name
+    db.add(owner)
+    db.commit()
+    return owner
+
+
+@router.delete('/owners/{identity}',
+               name='remove_owner',
+               summary='Remove a owner',
+               description='Remove a owner by its owner id',
+               status_code=204,
+               responses={
+                   status.HTTP_204_NO_CONTENT: {'description': 'The owner was removed'},
+                   status.HTTP_410_GONE: {'description': 'The owner was already gone'}
+               })
+async def remove(identity: int, response: Response, db: Session = Depends(get_db)):
+    owner = db.query(Owner).get(identity)
+    if not owner:
+        response.status_code = status.HTTP_410_GONE
+        return
+    db.delete(owner)
+    db.commit()
+    response.status_code = status.HTTP_204_NO_CONTENT

mrmat_python_api_fastapi/apis/resource/v1/db.py

@@ -21,7 +21,7 @@
 #  SOFTWARE.
 
 from sqlalchemy import ForeignKey, Column, Integer, String, UniqueConstraint, BigInteger
-from sqlalchemy.orm import relationship
+from sqlalchemy.orm import relationship, Session
 
 from mrmat_python_api_fastapi import Base
 

mrmat_python_api_fastapi/apis/resource/v1/schema.py

@@ -23,16 +23,22 @@
 from pydantic import BaseModel
 
 
-class OwnerSchema(BaseModel):
-    id: int
+class OwnerInputSchema(BaseModel):
     name: str
 
+
+class OwnerSchema(OwnerInputSchema):
+    id: int
+
     class Config:
         orm_mode = True
 
 
-class ResourceSchema(BaseModel):
-    id: int
+class ResourceInputSchema(BaseModel):
+    name: str
+
+
+class ResourceSchema(ResourceInputSchema):
     name: str
 
     class Config:

mrmat_python_api_fastapi/config.py

@@ -27,14 +27,17 @@
 
 
 class Config:
+    """
+    A class to deal with application configuration
+    """
     secret_key: str = secrets.token_urlsafe(16)
     db_url: str = 'sqlite://'
 
     @staticmethod
     def from_json_file(file: Optional[os.PathLike] = os.getenv('APP_CONFIG')):
         runtime_config = Config()
         if file and os.path.exists(file):
-            with open(file, 'r') as c:
+            with open(file, 'r', encoding='UTF-8') as c:
                 file_config = json.load(c)
             runtime_config.secret_key = file_config.get('secret_key', secrets.token_urlsafe(16))
             runtime_config.db_url = file_config.get('db_url', 'sqlite://')