feat: POST bills

README.md

@@ -58,7 +58,13 @@ It likely means your `.env` is out of date. Perform a comparison between your `.
 Before committing, run lint.sh:
 
 ```sh
+# this will not checking the safety and include bandit checks
 poetry run scripts/lint.sh
+
+# include safety checks
+poetry run scripts/lint.sh --include-safety
+# exclude the bandit checks
+poetry run scripts/lint.sh --skip-bandit
 ```
 
 ### Formatting code

openapi.yml

@@ -1,5 +1,64 @@
 components:
   schemas:
+    Bill:
+      properties:
+        created:
+          description: Created at
+          format: date-time
+          title: Created
+          type: string
+        id:
+          description: Bill ID
+          maxLength: 32
+          title: Id
+          type: string
+        sub_bills:
+          items:
+            $ref: '#/components/schemas/SubBillSpec'
+          title: Sub Bills
+          type: array
+        total:
+          description: Total
+          title: Total
+          type: number
+        updated:
+          description: Updated at
+          format: date-time
+          title: Updated
+          type: string
+      required:
+      - total
+      - sub_bills
+      - created
+      - updated
+      - id
+      title: Bill
+      type: object
+    BillSpec:
+      properties:
+        sub_bills:
+          items:
+            $ref: '#/components/schemas/SubBillSpec'
+          title: Sub Bills
+          type: array
+        total:
+          description: Total
+          title: Total
+          type: number
+      required:
+      - total
+      - sub_bills
+      title: BillSpec
+      type: object
+    HTTPValidationError:
+      properties:
+        detail:
+          items:
+            $ref: '#/components/schemas/ValidationError'
+          title: Detail
+          type: array
+      title: HTTPValidationError
+      type: object
     Health:
       properties:
         db:
@@ -8,11 +67,70 @@ components:
           type: boolean
       title: Health
       type: object
+    SubBillSpec:
+      properties:
+        amount:
+          title: Amount
+          type: number
+        reference:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Reference
+      required:
+      - amount
+      title: SubBillSpec
+      type: object
+    ValidationError:
+      properties:
+        loc:
+          items:
+            anyOf:
+            - type: string
+            - type: integer
+          title: Location
+          type: array
+        msg:
+          title: Message
+          type: string
+        type:
+          title: Error Type
+          type: string
+      required:
+      - loc
+      - msg
+      - type
+      title: ValidationError
+      type: object
 info:
   title: Uselevers Backend
   version: 1.0.0-dev
 openapi: 3.1.0
 paths:
+  /api/v1/bills:
+    post:
+      description: Create new bill.
+      operationId: create_bills
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/BillSpec'
+        required: true
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Bill'
+          description: Successful Response
+        '422':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      summary: Create Bills
   /health:
     get:
       description: Perform internal health checks

scripts/lint.sh

@@ -8,7 +8,13 @@ ruff .
 ruff format . --check
 flake8 .
 black --check --diff .
-bandit -c .bandit.yml -r *
+
+# Check if --skip-bandit argument is provided
+if [[ "$1" == "--skip-bandit" ]]; then
+    echo "Skipping bandit check"
+else
+    bandit -c .bandit.yml -r *
+fi
 
 if [[ -n "$1" && "$1" == "--include-safety" ]]; then
     echo "Running safety check..."

uselevers/bills/exceptions.py

@@ -0,0 +1,32 @@
+from fastapi import HTTPException, status
+
+from uselevers.core.exceptions import HTTPExceptionExtra, HTTPSimpleError
+
+
+class ReferenceValueConflict(HTTPException, HTTPExceptionExtra):
+    def __init__(self) -> None:
+        super().__init__(
+            status_code=self.status_code,
+            detail=HTTPSimpleError(
+                message="Bill reference conflict",
+                errors={
+                    "reference": [
+                        "Bill reference value already exists. "
+                        "Please select another value."
+                    ]
+                },
+            ).model_dump(),
+        )
+
+    model = HTTPSimpleError
+    status_code = status.HTTP_409_CONFLICT
+    examples = {
+        "detail": {
+            "message": "Bill reference conflict",
+            "errors": {
+                "reference": [
+                    "Bill reference value already exists. Please select another value."
+                ]
+            },
+        }
+    }

uselevers/bills/queries.py

@@ -0,0 +1,18 @@
+from sqlalchemy.orm import Session
+
+from . import models, schemas
+
+
+def save_billspec(db: Session, bill_data: schemas.BillSpec) -> models.Bill:
+    # Create a new instance of models.Bill directly
+    bill = models.Bill(total=bill_data.total)
+    # Process sub_bills
+    for sub_bill_data in bill_data.sub_bills:
+        sub_bill = models.SubBill(
+            amount=sub_bill_data.amount, reference=sub_bill_data.reference
+        )
+        bill.sub_bills.append(sub_bill)
+
+    db.add(bill)
+    db.flush()
+    return bill

uselevers/bills/schemas.py

@@ -1,13 +1,42 @@
 from typing import Annotated
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, validator
 
 from uselevers.core.models import id_len
 from uselevers.core.schemas import MixinCreatedUpdated
 
 
+def check_positive_value(value: float) -> float:
+    if isinstance(value, float) and value < 0:
+        raise ValueError(
+            "Value must be a positive number or greater than or equal to 0.0"
+        )
+    return value
+
+
+class SubBillSpec(BaseModel):
+    amount: float
+    reference: str | None = None
+
+    @validator("amount")
+    def check_amount(cls, value: float) -> float:
+        return check_positive_value(value)
+
+
 class BillSpec(BaseModel):
     total: Annotated[float, Field(description="Total")]
+    sub_bills: list[SubBillSpec]
+
+    @validator("total")
+    def check_total(cls, value: float) -> float:
+        # TODO: validate total should be equal with the total of sub_bill amounts
+        return check_positive_value(value)
+
+    @validator("sub_bills")
+    def check_sub_bills(cls, value: list[SubBillSpec]) -> list[SubBillSpec]:
+        if not value:
+            raise ValueError("At least one sub bill is required")
+        return value
 
 
 class Bill(MixinCreatedUpdated, BillSpec, BaseModel):

uselevers/bills/tests/test_models_bills.py

@@ -1,14 +1,13 @@
-from typing import Annotated
+from typing import Any
 
 import pytest
-from fastapi import Depends
-from fastapi.encoders import jsonable_encoder
+from pydantic import ValidationError
 from sqlalchemy.exc import IntegrityError
 from sqlalchemy.orm import Session
 
 from uselevers.bills.models import Bill
-from uselevers.bills.schemas import BillSpec
-from uselevers.core import deps
+from uselevers.bills.queries import save_billspec
+from uselevers.bills.schemas import BillSpec, SubBillSpec
 from uselevers.tests.conftest import SessionTest, alembic_engine, db  # noqa: F401,F811
 
 
@@ -22,19 +21,19 @@
     ],
 )
 def test_crud_bills(
-    db: Annotated[Session, Depends(deps.get_db)],  # noqa: F811
+    db: Session,  # noqa: F811
     total: float,
 ) -> None:
     bill_create = BillSpec(
         total=total,
+        sub_bills=[
+            SubBillSpec(amount=1, reference="INV-1"),
+        ],
     )
     with db.begin():
         # test create
         assert db.query(Bill).count() == 0
-        instance = Bill(**jsonable_encoder(bill_create))
-        db.add(instance)
-        # write the object to the database
-        db.flush()
+        instance = save_billspec(db, bill_create)
         assert db.query(Bill).count() == 1
 
         # test read
@@ -67,19 +66,28 @@ def test_crud_bills(
         assert db.query(Bill).count() == 0
 
 
+@pytest.mark.parametrize(
+    "total",
+    [
+        (-1),
+    ],
+)
 def test_create_bill_with_invalid_total(
-    db: Annotated[Session, Depends(deps.get_db)],  # noqa: F811
+    db: Session,  # noqa: F811
+    total: Any,
 ) -> None:
-    bill_create = BillSpec(
-        total=-1,
-    )
-    with db.begin():
-        # test create
-        assert db.query(Bill).count() == 0
-        with pytest.raises(IntegrityError):
-            instance = Bill(**jsonable_encoder(bill_create))
-            db.add(instance)
-            db.flush()
+    with pytest.raises(ValidationError):
+        bill_create = BillSpec(
+            total=total,
+            sub_bills=[
+                SubBillSpec(amount=1, reference="ref-1"),
+            ],
+        )
+        with db.begin():
+            # test create
+            assert db.query(Bill).count() == 0
+            with pytest.raises(IntegrityError):
+                save_billspec(db, bill_create)
 
     with db.begin():
         assert db.query(Bill).count() == 0