Metered billing

bundle/src/Comms/Event/ToCore/Billing/RecordMeteredUsage.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Hyvor\Internal\Bundle\Comms\Event\ToCore\Billing;
+
+use Hyvor\Internal\Bundle\Comms\Event\AbstractEvent;
+use Hyvor\Internal\Component\Component;
+
+class RecordMeteredUsage extends AbstractEvent
+{
+    public function __construct(
+        private Component $component,
+        private int $organizationId,
+        private int $amount,
+        private string $idempotencyKey,
+    ) {}
+
+    public function getComponent(): Component
+    {
+        return $this->component;
+    }
+
+    public function getOrganizationId(): int
+    {
+        return $this->organizationId;
+    }
+
+    public function getAmount(): int
+    {
+        return $this->amount;
+    }
+
+    public function getIdempotencyKey(): string
+    {
+        return $this->idempotencyKey;
+    }
+
+    public function from(): array
+    {
+        return [];
+    }
+
+    public function to(): array
+    {
+        return [Component::CORE];
+    }
+}

src/Billing/Billing.php

@@ -9,6 +9,7 @@
 use Hyvor\Internal\Component\Component;
 use Hyvor\Internal\Component\InstanceUrlResolver;
 use Hyvor\Internal\InternalConfig;
+use Hyvor\Internal\Bundle\Comms\Event\ToCore\Billing\RecordMeteredUsage;
 
 class Billing implements BillingInterface
 {
@@ -17,8 +18,7 @@ public function __construct(
         private InternalConfig $internalConfig,
         private InstanceUrlResolver $instanceUrlResolver,
         private CommsInterface $comms,
-    ) {
-    }
+    ) {}
 
     /**
      * @return array{urlNew: string, urlChange: string}
@@ -95,4 +95,25 @@ public function licenses(array $organizationIds, ?Component $component = null):
         return $response->getLicenses();
     }
 
+    /**
+     * @throws CommsApiFailedException
+     */
+    public function recordMeteredUsage(
+        int $organizationId,
+        int $amount,
+        string $idempotencyKey,
+        ?Component $component = null
+    ): void {
+        $component ??= $this->internalConfig->getComponent();
+
+        $this->comms->send(
+            new RecordMeteredUsage(
+                $component,
+                $organizationId,
+                $amount,
+                $idempotencyKey
+            ),
+            Component::CORE
+        );
+    }
 }

src/Billing/BillingFake.php

@@ -14,7 +14,8 @@ class BillingFake implements BillingInterface
      * @param array<int, ResolvedLicense>|(callable(int[] $organizationIds, Component $component) : array<int, ResolvedLicense>) $licenses
      * @return void
      */
-    public static function enable(array|callable $licenses): void {
+    public static function enable(array|callable $licenses): void
+    {
         app()->singleton(Billing::class, function () use ($licenses) {
             return new BillingFake(
                 app(InternalConfig::class),
@@ -48,8 +49,7 @@ public function __construct(
          * @param array<int, ResolvedLicense>|(callable(int[] $organizationIds, Component $component) : array<int, ResolvedLicense>)|null $licenses
          */
         private readonly mixed $licenses = null
-    ) {
-    }
+    ) {}
 
     public function license(int $organizationId, ?Component $component = null): ResolvedLicense
     {
@@ -83,4 +83,21 @@ public function licenses(array $organizationIds, ?Component $component = null):
         return ($this->licenses)($organizationIds, $component);
     }
 
+    public array $recordedUsage = [];
+
+    public function recordMeteredUsage(
+        int $organizationId,
+        int $amount,
+        string $idempotencyKey,
+        ?Component $component = null
+    ): void {
+        $component ??= $this->internalConfig->getComponent();
+
+        $this->recordedUsage[] = [
+            'organizationId' => $organizationId,
+            'amount' => $amount,
+            'idempotencyKey' => $idempotencyKey,
+            'component' => $component,
+        ];
+    }
 }

src/Billing/BillingInterface.php

@@ -19,4 +19,16 @@ public function license(int $organizationId, ?Component $component = null): Reso
      * @throws CommsApiFailedException
      */
     public function licenses(array $organizationIds, ?Component $component = null): array;
+
+    /**
+     * @param string $idempotencyKey A unique key within the component to ensure the same usage isn't recorded twice.
+     *  ex: orgId + date
+     * @throws CommsApiFailedException
+     */
+    public function recordMeteredUsage(
+        int $organizationId,
+        int $amount,
+        string $idempotencyKey,
+        ?Component $component = null
+    ): void;
 }

src/Billing/License/FortguardLicense.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Hyvor\Internal\Billing\License;
+
+final class FortguardLicense extends License
+{
+
+    public function __construct(
+        public int $credits
+    ) {}
+
+    public static function trial(): static
+    {
+        return new self(credits: 2000);
+    }
+}

src/Billing/License/Plan/FortguardPlan.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Hyvor\Internal\Billing\License\Plan;
+
+use Hyvor\Internal\Billing\License\FortguardLicense;
+
+// 20k 
+// 50k - 40k
+
+// 1st - 50k
+
+// 50k 50€
+// 20k - 40k
+
+/**
+ * @extends PlanAbstract<FortguardLicense>
+ */
+class FortguardPlan extends PlanAbstract
+{
+
+    protected function config(): void
+    {
+        // Meters
+        $this->meter(
+            name: 'base_credits',
+            nameReadable: 'Extra Credits',
+            property: 'credits',
+            pricePerUnit: 0.0004, // 4 per 10,000
+        );
+
+        // Version 1
+        $this->version(1, function () {
+            $this->plan(
+                'base',
+                30,
+                new FortguardLicense(credits: 150_000),
+                nameReadable: 'Base',
+                meterName: 'base_credits',
+            );
+        });
+    }
+}

src/Billing/License/Plan/Meter.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Hyvor\Internal\Billing\License\Plan;
+
+class Meter
+{
+    public function __construct(
+        public string $name,
+        public string $property,
+        public string $nameReadable,
+        public float $pricePerUnit,
+    ) {}
+}

src/Billing/License/Plan/Plan.php

@@ -32,8 +32,12 @@ public function __construct(
          * Usually, if one plan has a group, all plans should have a group
          */
         public ?string $group = null,
+
+        /**
+         * Meter for usage-based billing
+         */
+        public ?Meter $meter = null,
     ) {
         $this->nameReadable = $nameReadable ?? ucfirst($this->name);
     }
-
 }

src/Billing/License/Plan/PlanAbstract.php

@@ -15,6 +15,11 @@ abstract class PlanAbstract
      */
     private array $versions;
 
+    /**
+     * @var array<string, Meter>
+     */
+    private array $meters = [];
+
     // this only helps with config() method. Do not use for anything else.
     private ?int $currentVersionForConfig = null;
 
@@ -48,15 +53,23 @@ protected function plan(
         License $license,
         ?string $nameReadable = null,
         ?string $group = null,
+        ?string $meterName = null,
     ): void {
         assert($this->currentVersionForConfig !== null);
+
+        $meter = $meterName ? $this->meters[$meterName] : null;
+        if ($meter) {
+            assert(property_exists($license, $meter->property));
+        }
+
         $plan = new Plan(
             $this->currentVersionForConfig,
             $name,
             $monthlyPrice,
             $license,
             $nameReadable,
             $group,
+            $meter,
         );
 
         $currentVersionPlans = $this->versions[$this->currentVersionForConfig];
@@ -65,6 +78,24 @@ protected function plan(
         $this->versions[$this->currentVersionForConfig] = $currentVersionPlans;
     }
 
+    protected function meter(
+        string $name,
+        string $nameReadable,
+        string $property,
+        float $pricePerUnit,
+    ): void {
+        if (isset($this->meters[$name])) {
+            throw new \Exception("Meter with name $name already exists");
+        }
+
+        $this->meters[$name] = new Meter(
+            name: $name,
+            property: $property,
+            nameReadable: $nameReadable,
+            pricePerUnit: $pricePerUnit,
+        );
+    }
+
     /**
      * @return array<int, array<string, Plan<T>>>
      */
@@ -107,4 +138,11 @@ public function tryGetPlan(string $name, ?int $version = null): ?Plan
         return $this->versions[$version][$name] ?? null;
     }
 
+    /**
+     * @return array<string, Meter>
+     */
+    public function getMeters(): array
+    {
+        return $this->meters;
+    }
 }