Merge remote-tracking branch 'upstream/master' into pr-osparc-redirect-service-restart-containers

Author: Andrei Neagu

api/specs/web-server/_catalog_licensed_items.py renamed to api/specs/web-server/_licensed_items.py

@@ -14,10 +14,8 @@
 from models_library.generics import Envelope
 from models_library.rest_error import EnvelopedError
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.catalog.licenses._exceptions_handlers import (
-    _TO_HTTP_ERROR_MAP,
-)
-from simcore_service_webserver.catalog.licenses._models import (
+from simcore_service_webserver.licenses._exceptions_handlers import _TO_HTTP_ERROR_MAP
+from simcore_service_webserver.licenses._models import (
     LicensedItemsBodyParams,
     LicensedItemsListQueryParams,
     LicensedItemsPathParams,

api/specs/web-server/_licensed_items_purchases.py

@@ -0,0 +1,57 @@
+""" Helper script to generate OAS automatically
+"""
+
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
+from typing import Annotated
+
+from _common import as_query
+from fastapi import APIRouter, Depends
+from models_library.api_schemas_webserver.licensed_items_purchases import (
+    LicensedItemPurchaseGet,
+)
+from models_library.generics import Envelope
+from models_library.rest_error import EnvelopedError
+from models_library.rest_pagination import Page
+from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.licenses._exceptions_handlers import _TO_HTTP_ERROR_MAP
+from simcore_service_webserver.licenses._models import (
+    LicensedItemsPurchasesListQueryParams,
+    LicensedItemsPurchasesPathParams,
+)
+from simcore_service_webserver.wallets._handlers import WalletsPathParams
+
+router = APIRouter(
+    prefix=f"/{API_VTAG}",
+    tags=[
+        "licenses",
+    ],
+    responses={
+        i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values()
+    },
+)
+
+
+@router.get(
+    "/wallets/{wallet_id}/licensed-items-purchases",
+    response_model=Page[LicensedItemPurchaseGet],
+    tags=["wallets"],
+)
+async def list_wallet_licensed_items_purchases(
+    _path: Annotated[WalletsPathParams, Depends()],
+    _query: Annotated[as_query(LicensedItemsPurchasesListQueryParams), Depends()],
+):
+    ...
+
+
+@router.get(
+    "/licensed-items-purchases/{licensed_item_purchase_id}",
+    response_model=Envelope[LicensedItemPurchaseGet],
+)
+async def get_licensed_item_purchase(
+    _path: Annotated[LicensedItemsPurchasesPathParams, Depends()],
+):
+    ...

api/specs/web-server/openapi.py

@@ -32,11 +32,12 @@
         "_announcements",
         "_catalog",
         "_catalog_tags",  # MUST BE after _catalog
-        "_catalog_licensed_items",
         "_computations",
         "_exporter",
         "_folders",
         "_long_running_tasks",
+        "_licensed_items",
+        "_licensed_items_purchases",
         "_metamodeling",
         "_nih_sparc",
         "_nih_sparc_redirections",

packages/models-library/src/models_library/api_schemas_resource_usage_tracker/licensed_items_purchases.py

@@ -0,0 +1,56 @@
+from datetime import datetime
+from decimal import Decimal
+from typing import NamedTuple
+
+from models_library.licensed_items import LicensedItemID
+from models_library.products import ProductName
+from models_library.resource_tracker import PricingUnitCostId
+from models_library.resource_tracker_licensed_items_purchases import (
+    LicensedItemPurchaseID,
+)
+from models_library.users import UserID
+from models_library.wallets import WalletID
+from pydantic import BaseModel, ConfigDict, PositiveInt
+
+
+class LicensedItemPurchaseGet(BaseModel):
+    licensed_item_purchase_id: LicensedItemPurchaseID
+    product_name: ProductName
+    licensed_item_id: LicensedItemID
+    wallet_id: WalletID
+    wallet_name: str
+    pricing_unit_cost_id: PricingUnitCostId
+    pricing_unit_cost: Decimal
+    start_at: datetime
+    expire_at: datetime
+    num_of_seats: int
+    purchased_by_user: UserID
+    purchased_at: datetime
+    modified: datetime
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    "licensed_item_purchase_id": "beb16d18-d57d-44aa-a638-9727fa4a72ef",
+                    "product_name": "osparc",
+                    "licensed_item_id": "303942ef-6d31-4ba8-afbe-dbb1fce2a953",
+                    "wallet_id": 1,
+                    "wallet_name": "My Wallet",
+                    "pricing_unit_cost_id": 1,
+                    "pricing_unit_cost": 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,
+                    "purchased_at": "2023-01-11 13:11:47.293595",
+                    "modified": "2023-01-11 13:11:47.293595",
+                }
+            ]
+        }
+    )
+
+
+class LicensedItemsPurchasesPage(NamedTuple):
+    items: list[LicensedItemPurchaseGet]
+    total: PositiveInt

packages/models-library/src/models_library/api_schemas_webserver/groups.py

@@ -2,6 +2,7 @@
 from typing import Annotated, Any, Self, TypeVar
 
 from common_library.basic_types import DEFAULT_FACTORY
+from models_library.groups import EVERYONE_GROUP_ID
 from pydantic import (
     AnyHttpUrl,
     AnyUrl,
@@ -14,16 +15,16 @@
     model_validator,
 )
 
-from ..basic_types import IDStr
 from ..emails import LowerCaseEmailStr
 from ..groups import (
     AccessRightsDict,
     Group,
+    GroupID,
     GroupMember,
     StandardGroupCreate,
     StandardGroupUpdate,
 )
-from ..users import UserID
+from ..users import UserID, UserNameID
 from ..utils.common_validators import create__check_only_one_is_set__root_validator
 from ._base import InputSchema, OutputSchema
 
@@ -55,7 +56,7 @@ class GroupAccessRights(BaseModel):
 
 
 class GroupGet(OutputSchema):
-    gid: int = Field(..., description="the group ID")
+    gid: GroupID = Field(..., description="the group ID")
     label: str = Field(..., description="the group name")
     description: str = Field(..., description="the group description")
     thumbnail: AnyUrl | None = Field(
@@ -114,7 +115,7 @@ def from_model(cls, group: Group, access_rights: AccessRightsDict) -> Self:
                     "accessRights": {"read": True, "write": False, "delete": False},
                 },
                 {
-                    "gid": "0",
+                    "gid": "1",
                     "label": "All",
                     "description": "Open to all users",
                     "accessRights": {"read": True, "write": True, "delete": True},
@@ -214,7 +215,7 @@ class MyGroupsGet(OutputSchema):
                     },
                 ],
                 "all": {
-                    "gid": "0",
+                    "gid": EVERYONE_GROUP_ID,
                     "label": "All",
                     "description": "Open to all users",
                     "accessRights": {"read": True, "write": False, "delete": False},
@@ -228,13 +229,11 @@ class GroupUserGet(BaseModel):
     # OutputSchema
 
     # Identifiers
-    id: Annotated[
-        str | None, Field(description="the user id", coerce_numbers_to_str=True)
-    ] = None
-    user_name: Annotated[IDStr, Field(alias="userName")]
+    id: Annotated[UserID | None, Field(description="the user's id")] = None
+    user_name: Annotated[UserNameID, Field(alias="userName")]
     gid: Annotated[
-        str | None,
-        Field(description="the user primary gid", coerce_numbers_to_str=True),
+        GroupID | None,
+        Field(description="the user primary gid"),
     ] = None
 
     # Private Profile
@@ -296,7 +295,7 @@ class GroupUserAdd(InputSchema):
     """
 
     uid: UserID | None = None
-    user_name: Annotated[IDStr | None, Field(alias="userName")] = None
+    user_name: Annotated[UserNameID | None, Field(alias="userName")] = None
     email: Annotated[
         LowerCaseEmailStr | None,
         Field(

packages/models-library/src/models_library/api_schemas_webserver/licensed_items_purchases.py

@@ -0,0 +1,35 @@
+from datetime import datetime
+from decimal import Decimal
+from typing import NamedTuple
+
+from models_library.licensed_items import LicensedItemID
+from models_library.products import ProductName
+from models_library.resource_tracker import PricingUnitCostId
+from models_library.resource_tracker_licensed_items_purchases import (
+    LicensedItemPurchaseID,
+)
+from models_library.users import UserID
+from models_library.wallets import WalletID
+from pydantic import PositiveInt
+
+from ._base import OutputSchema
+
+
+class LicensedItemPurchaseGet(OutputSchema):
+    licensed_item_purchase_id: LicensedItemPurchaseID
+    product_name: ProductName
+    licensed_item_id: LicensedItemID
+    wallet_id: WalletID
+    pricing_unit_cost_id: PricingUnitCostId
+    pricing_unit_cost: Decimal
+    start_at: datetime
+    expire_at: datetime
+    num_of_seats: int
+    purchased_by_user: UserID
+    purchased_at: datetime
+    modified_at: datetime
+
+
+class LicensedItemPurchaseGetPage(NamedTuple):
+    items: list[LicensedItemPurchaseGet]
+    total: PositiveInt

packages/models-library/src/models_library/api_schemas_webserver/wallets.py

@@ -20,18 +20,59 @@ class WalletGet(OutputSchema):
     created: datetime
     modified: datetime
 
-    model_config = ConfigDict(from_attributes=True, frozen=False)
+    model_config = ConfigDict(
+        from_attributes=True,
+        frozen=False,
+        json_schema_extra={
+            "examples": [
+                {
+                    "wallet_id": 1,
+                    "name": "My wallet",
+                    "description": "My description",
+                    "owner": 1,
+                    "thumbnail": "https://example.com/payment-method/form",
+                    "status": "ACTIVE",
+                    "created": "2024-03-25T00:00:00",
+                    "modified": "2024-03-25T00:00:00",
+                }
+            ]
+        },
+    )
 
 
 class WalletGetWithAvailableCredits(WalletGet):
     available_credits: Decimal
 
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    **WalletGet.model_config["json_schema_extra"]["examples"][0],  # type: ignore
+                    "available_credits": 10.5,
+                }
+            ]
+        }
+    )
+
 
 class WalletGetPermissions(WalletGet):
     read: bool
     write: bool
     delete: bool
 
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    **WalletGet.model_config["json_schema_extra"]["examples"][0],  # type: ignore
+                    "read": True,
+                    "write": True,
+                    "delete": True,
+                }
+            ]
+        }
+    )
+
 
 class CreateWalletBodyParams(OutputSchema):
     name: str

packages/models-library/src/models_library/groups.py

@@ -13,6 +13,9 @@
 EVERYONE_GROUP_ID: Final[int] = 1
 
 
+__all__: tuple[str, ...] = ("GroupID",)
+
+
 class GroupTypeInModel(str, enum.Enum):
     """
     standard: standard group, e.g. any group that is not a primary group or special group such as the everyone group

packages/models-library/src/models_library/resource_tracker.py

@@ -48,6 +48,7 @@ class CreditTransactionStatus(StrAutoEnum):
 class CreditClassification(StrAutoEnum):
     ADD_WALLET_TOP_UP = auto()  # user top up credits
     DEDUCT_SERVICE_RUN = auto()  # computational/dynamic service run costs)
+    DEDUCT_LICENSE_PURCHASE = auto()
 
 
 class PricingPlanClassification(StrAutoEnum):

packages/models-library/src/models_library/resource_tracker_licensed_items_purchases.py

@@ -0,0 +1,33 @@
+from datetime import datetime
+from decimal import Decimal
+from typing import TypeAlias
+from uuid import UUID
+
+from pydantic import BaseModel, ConfigDict
+
+from .licensed_items import LicensedItemID
+from .products import ProductName
+from .resource_tracker import PricingPlanId, PricingUnitCostId, PricingUnitId
+from .users import UserID
+from .wallets import WalletID
+
+LicensedItemPurchaseID: TypeAlias = UUID
+
+
+class LicensedItemsPurchasesCreate(BaseModel):
+    product_name: ProductName
+    licensed_item_id: LicensedItemID
+    wallet_id: WalletID
+    wallet_name: str
+    pricing_plan_id: PricingPlanId
+    pricing_unit_id: PricingUnitId
+    pricing_unit_cost_id: PricingUnitCostId
+    pricing_unit_cost: Decimal
+    start_at: datetime
+    expire_at: datetime
+    num_of_seats: int
+    purchased_by_user: UserID
+    user_email: str
+    purchased_at: datetime
+
+    model_config = ConfigDict(from_attributes=True)