WIP: licensing

api/app/settings/common.py

@@ -104,6 +104,7 @@
     "organisations",
     "organisations.invites",
     "organisations.permissions",
+    "organisations.subscriptions.licensing",  # TODO: should this be added conditionally?
     "projects",
     "sales_dashboard",
     "environments",

api/organisations/models.py

@@ -378,10 +378,18 @@ def _get_subscription_metadata_for_self_hosted(self) -> BaseSubscriptionMetadata
         if not is_enterprise():
             return FREE_PLAN_SUBSCRIPTION_METADATA
 
+        # TODO: this feels odd returning to the organisation that we likely just came
+        #  from to get to this method.
+        if hasattr(self.organisation, "licence"):
+            licence_information = self.organisation.licence.get_licence_information()
+            return BaseSubscriptionMetadata(
+                seats=licence_information.num_seats,
+                projects=licence_information.num_projects,
+            )
+
         return BaseSubscriptionMetadata(
-            seats=self.max_seats,
-            api_calls=self.max_api_calls,
-            projects=None,
+            seats=MAX_SEATS_IN_FREE_PLAN,
+            projects=settings.MAX_PROJECTS_IN_FREE_PLAN,
         )
 
     def add_single_seat(self):

api/organisations/subscriptions/licensing/__init__.py

@@ -0,0 +1 @@
+# TODO: split this into a private package?

api/organisations/subscriptions/licensing/licensing.py

@@ -0,0 +1,19 @@
+import typing
+from datetime import datetime
+
+from pydantic import BaseModel
+
+
+class LicenceInformation(BaseModel):
+    organisation_name: str
+    plan_id: str
+
+    department_name: typing.Optional[str] = None
+    expiry_date: typing.Optional[datetime] = None
+
+    # TODO: should these live in a nested object?
+    num_seats: int
+    num_projects: int  # TODO: what about Flagsmith on Flagsmith project?
+    num_api_calls: typing.Optional[
+        int
+    ] = None  # required to support private cloud installs

api/organisations/subscriptions/licensing/migrations/0001_initial.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.24 on 2024-03-15 15:52
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('organisations', '0052_create_hubspot_organisation'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='OrganisationLicence',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('content', models.TextField(blank=True)),
+                ('organisation', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, to='organisations.organisation')),
+            ],
+        ),
+    ]

api/organisations/subscriptions/licensing/models.py

@@ -0,0 +1,18 @@
+from django.db import models
+
+from organisations.subscriptions.licensing.licensing import LicenceInformation
+
+
+class OrganisationLicence(models.Model):
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    organisation = models.OneToOneField(
+        "organisations.Organisation", related_name="licence", on_delete=models.CASCADE
+    )
+
+    content = models.TextField(blank=True)
+
+    def get_licence_information(self) -> LicenceInformation:
+        # TODO: decryption
+        return LicenceInformation.parse_raw(self.content)

api/organisations/subscriptions/licensing/views.py

@@ -0,0 +1,20 @@
+from rest_framework import serializers
+from rest_framework.decorators import api_view
+from rest_framework.request import Request
+from rest_framework.response import Response
+
+from organisations.subscriptions.licensing.models import OrganisationLicence
+
+
+@api_view(http_method_names=["PUT"])
+def create_or_update_licence(
+    request: Request, organisation_id: int, **kwargs
+) -> Response:
+    if "licence" not in request.FILES:
+        raise serializers.ValidationError("No licence file provided.")
+
+    OrganisationLicence.objects.update_or_create(
+        organisation_id=organisation_id,
+        defaults={"content": request.FILES["licence"].read().decode("utf-8")},
+    )
+    return Response(200)

api/organisations/subscriptions/metadata.py

@@ -7,9 +7,9 @@ class BaseSubscriptionMetadata:
     def __init__(
         self,
         seats: int = 0,
-        api_calls: int = 0,
+        api_calls: typing.Optional[int] = None,
         projects: typing.Optional[int] = None,
-        chargebee_email=None,
+        chargebee_email: str = None,
     ):
         self.seats = seats
         self.api_calls = api_calls

api/organisations/urls.py

@@ -24,6 +24,7 @@
     UserOrganisationPermissionViewSet,
     UserPermissionGroupOrganisationPermissionViewSet,
 )
+from .subscriptions.licensing.views import create_or_update_licence
 
 router = routers.DefaultRouter()
 router.register(r"", views.OrganisationViewSet, basename="organisation")
@@ -93,6 +94,14 @@
         remove_user_as_group_admin,
         name="remove-user-group-admin",
     ),
+    # TODO:
+    #  - is this the best url?
+    #  - do we need to conditionally add this URL, or just raise exception if not valid in the view?
+    path(
+        "<int:organisation_id>/licence",
+        create_or_update_licence,
+        name="create-or-update-licence",
+    ),
 ]
 
 if settings.IS_RBAC_INSTALLED:

api/tests/unit/organisations/test_unit_organisations_views.py

@@ -1,3 +1,4 @@
+import importlib
 import json
 from datetime import datetime, timedelta
 from typing import Type
@@ -9,6 +10,7 @@
 from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.core import mail
+from django.core.files.uploadedfile import SimpleUploadedFile
 from django.db.models import Model
 from django.urls import reverse
 from django.utils import timezone
@@ -19,6 +21,7 @@
 from rest_framework import status
 from rest_framework.test import APIClient, override_settings
 
+import organisations.urls
 from environments.models import Environment
 from environments.permissions.models import UserEnvironmentPermission
 from features.models import Feature
@@ -40,6 +43,7 @@
     SUBSCRIPTION_BILLING_STATUS_ACTIVE,
     SUBSCRIPTION_BILLING_STATUS_DUNNING,
 )
+from organisations.subscriptions.licensing.models import OrganisationLicence
 from projects.models import Project, UserProjectPermission
 from segments.models import Segment
 from users.models import (
@@ -1679,3 +1683,37 @@ def test_user_from_another_organisation_cannot_list_group_summaries(
 
     # Then
     assert response.status_code == status.HTTP_403_FORBIDDEN
+
+
+def test_create_or_update_licence(
+    organisation: Organisation, admin_client: APIClient, mocker: MockerFixture
+) -> None:
+    # Given
+    mocker.patch("organisations.urls.is_enterprise", return_value=True)
+
+    importlib.reload(organisations.urls)
+
+    url = reverse(
+        "api-v1:organisations:create-or-update-licence", args=[organisation.id]
+    )
+
+    licence_data = {
+        "organisation_name": "Test Organisation",
+        "plan": "Enterprise",
+        "num_seats": 20,
+        "num_projects": 3,
+    }
+
+    licence = SimpleUploadedFile(
+        name="licence.txt",
+        content=json.dumps(licence_data).encode(),
+        content_type="text/plain",
+    )
+
+    # When
+    response = admin_client.put(url, data={"licence": licence})
+
+    # Then
+    assert response.status_code == status.HTTP_200_OK
+
+    assert OrganisationLicence.objects.filter(organisation=organisation).exists()