openapi specs

Author: matusdrobuliak66

api/specs/web-server/_licensed_items.py

@@ -9,8 +9,11 @@
 from typing import Annotated
 
 from _common import as_query
-from fastapi import APIRouter, Depends, status
+from fastapi import APIRouter, Depends
 from models_library.api_schemas_webserver.licensed_items import LicensedItemRestGet
+from models_library.api_schemas_webserver.licensed_items_purchases import (
+    LicensedItemPurchaseGet,
+)
 from models_library.rest_error import EnvelopedError
 from models_library.rest_pagination import Page
 from simcore_service_webserver._meta import API_VTAG
@@ -57,7 +60,7 @@ async def list_licensed_items(
 
 @router.post(
     "/catalog/licensed-items/{licensed_item_id}:purchase",
-    status_code=status.HTTP_204_NO_CONTENT,
+    response_model=LicensedItemPurchaseGet,
 )
 async def purchase_licensed_item(
     _path: Annotated[LicensedItemsPathParams, Depends()],

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -3146,8 +3146,12 @@ paths:
             schema:
               $ref: '#/components/schemas/LicensedItemsBodyParams'
       responses:
-        '204':
+        '200':
           description: Successful Response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LicensedItemPurchaseGet'
         '404':
           content:
             application/json:

services/web/server/src/simcore_service_webserver/licenses/_licensed_items_rest.py

@@ -2,11 +2,13 @@
 
 from aiohttp import web
 from models_library.api_schemas_webserver.licensed_items import LicensedItemRestGet
+from models_library.api_schemas_webserver.licensed_items_purchases import (
+    LicensedItemPurchaseGet,
+)
 from models_library.licenses import LicensedItemPage
 from models_library.rest_ordering import OrderBy
 from models_library.rest_pagination import Page
 from models_library.rest_pagination_utils import paginate_data
-from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
     parse_request_path_parameters_as,
@@ -18,6 +20,7 @@
 from .._meta import API_VTAG as VTAG
 from ..login.decorators import login_required
 from ..security.decorators import permission_required
+from ..utils_aiohttp import envelope_json_response
 from . import _licensed_items_service
 from ._common.exceptions_handlers import handle_plugin_requests_exceptions
 from ._common.models import (
@@ -101,11 +104,14 @@ async def purchase_licensed_item(request: web.Request):
     path_params = parse_request_path_parameters_as(LicensedItemsPathParams, request)
     body_params = await parse_request_body_as(LicensedItemsBodyParams, request)
 
-    await _licensed_items_service.purchase_licensed_item(
-        app=request.app,
-        user_id=req_ctx.user_id,
-        licensed_item_id=path_params.licensed_item_id,
-        product_name=req_ctx.product_name,
-        body_params=body_params,
+    licensed_item_purchase_get: LicensedItemPurchaseGet = (
+        await _licensed_items_service.purchase_licensed_item(
+            app=request.app,
+            user_id=req_ctx.user_id,
+            licensed_item_id=path_params.licensed_item_id,
+            product_name=req_ctx.product_name,
+            body_params=body_params,
+        )
     )
-    return web.json_response(status=status.HTTP_204_NO_CONTENT)
+
+    return envelope_json_response(licensed_item_purchase_get)

services/web/server/src/simcore_service_webserver/licenses/_licensed_items_service.py

@@ -4,6 +4,9 @@
 from datetime import UTC, datetime, timedelta
 
 from aiohttp import web
+from models_library.api_schemas_webserver import (
+    licensed_items_purchases as webserver_licensed_items_purchases,
+)
 from models_library.licenses import LicensedItem, LicensedItemID, LicensedItemPage
 from models_library.products import ProductName
 from models_library.resource_tracker_licensed_items_purchases import (
@@ -69,7 +72,7 @@ async def purchase_licensed_item(
     user_id: UserID,
     licensed_item_id: LicensedItemID,
     body_params: LicensedItemsBodyParams,
-) -> None:
+) -> webserver_licensed_items_purchases.LicensedItemPurchaseGet:
     # Check user wallet permissions
     wallet = await get_wallet_with_available_credits_by_user_and_wallet(
         app, user_id=user_id, wallet_id=body_params.wallet_id, product_name=product_name
@@ -119,10 +122,29 @@ async def purchase_licensed_item(
         pricing_unit_cost=pricing_unit.current_cost_per_unit,
         start_at=datetime.now(tz=UTC),
         expire_at=datetime.now(tz=UTC) + timedelta(days=365),
-        num_of_seats=body_params.num_of_seats,  # <-- TODO: MD: this needs to be taken from the Pricing UNIT !!!
+        num_of_seats=body_params.num_of_seats,  # <-- NOTE: MD: this needs to be taken from the Pricing UNIT
         purchased_by_user=user_id,
         user_email=user["email"],
         purchased_at=datetime.now(tz=UTC),
     )
     rpc_client = get_rabbitmq_rpc_client(app)
-    await licensed_items_purchases.create_licensed_item_purchase(rpc_client, data=_data)
+    purchased_item = await licensed_items_purchases.create_licensed_item_purchase(
+        rpc_client, data=_data
+    )
+    return webserver_licensed_items_purchases.LicensedItemPurchaseGet(
+        licensed_item_purchase_id=purchased_item.licensed_item_purchase_id,
+        product_name=purchased_item.product_name,
+        licensed_item_id=purchased_item.licensed_item_id,
+        key=purchased_item.key,
+        version=purchased_item.version,
+        wallet_id=purchased_item.wallet_id,
+        pricing_unit_cost_id=purchased_item.pricing_unit_cost_id,
+        pricing_unit_cost=purchased_item.pricing_unit_cost,
+        start_at=purchased_item.start_at,
+        expire_at=purchased_item.expire_at,
+        num_of_seats=purchased_item.num_of_seats,
+        purchased_by_user=purchased_item.purchased_by_user,
+        user_email=purchased_item.user_email,
+        purchased_at=purchased_item.purchased_at,
+        modified_at=purchased_item.modified,
+    )

services/web/server/tests/unit/with_dbs/04/licenses/test_licensed_items_rest.py

@@ -3,14 +3,21 @@
 # pylint: disable=unused-variable
 # pylint: disable=too-many-arguments
 # pylint: disable=too-many-statements
+from decimal import Decimal
 from http import HTTPStatus
 
 import pytest
 from aiohttp.test_utils import TestClient
+from models_library.api_schemas_resource_usage_tracker import (
+    licensed_items_purchases as rut_licensed_items_purchases,
+)
 from models_library.api_schemas_resource_usage_tracker.pricing_plans import (
     PricingUnitGet,
 )
 from models_library.api_schemas_webserver.licensed_items import LicensedItemRestGet
+from models_library.api_schemas_webserver.licensed_items_purchases import (
+    LicensedItemPurchaseGet,
+)
 from models_library.api_schemas_webserver.wallets import WalletGetWithAvailableCredits
 from models_library.licenses import VIP_DETAILS_EXAMPLE, LicensedResourceType
 from pytest_mock.plugin import MockerFixture
@@ -96,13 +103,29 @@ async def test_licensed_items_listing(
     assert "additionalField" not in source
     assert "additional_field" not in source
 
-    # # get
-    # url = client.app.router["get_licensed_item"].url_for(
-    #     licensed_item_id=f"{_licensed_item_id}"
-    # )
-    # resp = await client.get(f"{url}")
-    # data, _ = await assert_status(resp, status.HTTP_200_OK)
-    # assert LicensedItemRestGet(**data)
+
+_LICENSED_ITEM_PURCHASE_GET = (
+    rut_licensed_items_purchases.LicensedItemPurchaseGet.model_validate(
+        {
+            "licensed_item_purchase_id": "beb16d18-d57d-44aa-a638-9727fa4a72ef",
+            "product_name": "osparc",
+            "licensed_item_id": "303942ef-6d31-4ba8-afbe-dbb1fce2a953",
+            "key": "Duke",
+            "version": "1.0.0",
+            "wallet_id": 1,
+            "wallet_name": "My Wallet",
+            "pricing_unit_cost_id": 1,
+            "pricing_unit_cost": Decimal(10),
+            "start_at": "2023-01-11 13:11:47.293595",
+            "expire_at": "2023-01-11 13:11:47.293595",
+            "num_of_seats": 1,
+            "purchased_by_user": 1,
+            "user_email": "[email protected]",
+            "purchased_at": "2023-01-11 13:11:47.293595",
+            "modified": "2023-01-11 13:11:47.293595",
+        }
+    )
+)
 
 
 @pytest.fixture
@@ -123,7 +146,7 @@ def mock_licensed_items_purchase_functions(mocker: MockerFixture) -> tuple:
     )
     mock_create_licensed_item_purchase = mocker.patch(
         "simcore_service_webserver.licenses._licensed_items_service.licensed_items_purchases.create_licensed_item_purchase",
-        spec=True,
+        return_value=_LICENSED_ITEM_PURCHASE_GET,
     )
 
     return (
@@ -179,14 +202,6 @@ async def test_licensed_items_purchase(
             )
         )
 
-    # # get
-    # url = client.app.router["get_licensed_item"].url_for(
-    #     licensed_item_id=f"{_licensed_item_id}"
-    # )
-    # resp = await client.get(f"{url}")
-    # data, _ = await assert_status(resp, status.HTTP_200_OK)
-    # assert LicensedItemRestGet(**data)
-
     # purchase
     url = client.app.router["purchase_licensed_item"].url_for(
         licensed_item_id=f"{_licensed_item_id}"
@@ -200,5 +215,5 @@ async def test_licensed_items_purchase(
             "pricing_unit_id": 1,
         },
     )
-    await assert_status(resp, status.HTTP_204_NO_CONTENT)
-    print("yes")
+    data, _ = await assert_status(resp, status.HTTP_200_OK)
+    assert LicensedItemPurchaseGet(**data)