Stripe webhooks, updated docs, updated SubscriptionService, added cus…

…tomer portal URL

common/config/params.php

@@ -77,5 +77,10 @@
         'publishable_key' => '',
         'secret_key' => '',
         'pricing_table_id' => '',
+        /**
+         * Pricing table -> Customer portal
+         * Example: https://billing.stripe.com/p/login/test_cN24i5ffoeQQg5qaEE
+         */
+        'customer_portal_url' => '',
     ],
 ];

common/models/SubscriptionWebhook.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace common\models;
+
+use common\models\base\BaseSubscriptionWebhook;
+
+class SubscriptionWebhook extends BaseSubscriptionWebhook
+{
+    public const PAYMENT_METHOD_STRIPE = 'stripe';
+
+    public const STATUS_RECEIVED = 'received';
+    public const STATUS_PROCESSING = 'processing';
+    public const STATUS_SUCCESS = 'success';
+    public const STATUS_FAILED = 'failed';
+
+    #############
+    # Statuses: #
+    #############
+
+    public static function getStatuses(): array
+    {
+        return [
+            self::STATUS_RECEIVED => 'Received',
+            self::STATUS_PROCESSING => 'Processing',
+            self::STATUS_SUCCESS => 'Success',
+            self::STATUS_FAILED => 'Failed',
+        ];
+    }
+
+    public function isReceived(): bool
+    {
+        return $this->status === self::STATUS_RECEIVED;
+    }
+
+    public function isProcessing(): bool
+    {
+        return $this->status === self::STATUS_PROCESSING;
+    }
+
+    public function isSuccess(): bool
+    {
+        return $this->status === self::STATUS_SUCCESS;
+    }
+
+    public function isFailed(): bool
+    {
+        return $this->status === self::STATUS_FAILED;
+    }
+
+    public function setReceived(bool $withSave = true): void
+    {
+        $this->status = self::STATUS_RECEIVED;
+
+        if ($withSave) {
+            $this->save();
+        }
+    }
+
+    public function setProcessing(bool $withSave = true): void
+    {
+        $this->status = self::STATUS_PROCESSING;
+
+        if ($withSave) {
+            $this->save();
+        }
+    }
+
+    public function setSuccess(bool $withSave = true): void
+    {
+        $this->status = self::STATUS_SUCCESS;
+
+        if ($withSave) {
+            $this->save();
+        }
+    }
+
+    public function setFailed(bool $withSave = true): void
+    {
+        $this->status = self::STATUS_FAILED;
+
+        if ($withSave) {
+            $this->save();
+        }
+    }
+}

common/models/base/BaseSubscriptionWebhook.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace common\models\base;
+
+use Yii;
+use yii\db\ActiveRecord;
+
+/**
+ * This is the model class for table "subscription_webhook".
+ *
+ * @property int $id
+ * @property string $payment_method
+ * @property string $status
+ * @property string $event
+ * @property string $payload
+ * @property string $meta
+ * @property string $created_date
+ * @property string $updated_date
+ */
+class BaseSubscriptionWebhook extends ActiveRecord
+{
+    /**
+     * {@inheritdoc}
+     */
+    public static function tableName(): string
+    {
+        return 'subscription_webhook';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rules(): array
+    {
+        return [
+            [['payment_method', 'status', 'event', 'payload'], 'required'],
+            [['payload', 'meta'], 'string'],
+            [['created_date', 'updated_date'], 'safe'],
+            [['payment_method', 'status', 'event'], 'string', 'max' => 64],
+        ];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function attributeLabels(): array
+    {
+        return [
+            'id' => 'ID',
+            'payment_method' => 'Payment Method',
+            'status' => 'Status',
+            'event' => 'Event',
+            'payload' => 'Payload',
+            'meta' => 'Meta',
+            'created_date' => 'Created Date',
+            'updated_date' => 'Updated Date',
+        ];
+    }
+}

common/services/subscription/SubscriptionService.php

@@ -2,6 +2,7 @@
 
 namespace common\services\subscription;
 
+use Yii;
 use Stripe\StripeClient;
 use common\models\Customer;
 
@@ -12,9 +13,29 @@
 class SubscriptionService
 {
     protected Customer $customer;
+    protected StripeClient $stripeClient;
 
     public function __construct(Customer $customer)
     {
         $this->customer = $customer;
+        $this->stripeClient = new StripeClient(Yii::$app->params['stripe']['secret_key']);
+    }
+
+    public function getCustomer(): Customer
+    {
+        return $this->customer;
+    }
+
+    public function hasActiveSubscription(): bool
+    {
+        return 0;
+    }
+
+    /**
+     * @see https://stripe.com/docs/billing/subscriptions/build-subscriptions?ui=elements#create-customer
+     */
+    public function createStripeCustomer()
+    {
+
     }
 }

console/migrations/m230401_140923_stripe_webhooks_table.php

@@ -0,0 +1,46 @@
+<?php
+
+use yii\db\Migration;
+
+/**
+ * Class m230401_140923_stripe_webhooks_table
+ */
+class m230401_140923_stripe_webhooks_table extends Migration
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function safeUp()
+    {
+        $this->execute("
+            CREATE TABLE `subscription_webhook` (
+              `id` int NOT NULL AUTO_INCREMENT,
+              `payment_method` varchar(64) COLLATE utf8mb4_unicode_ci NOT NULL,
+              `status` varchar(64) COLLATE utf8mb4_unicode_ci NOT NULL,
+              `event` varchar(64) COLLATE utf8mb4_unicode_ci NOT NULL,
+              `payload` mediumtext COLLATE utf8mb4_unicode_ci NOT NULL,
+                `meta` MEDIUMTEXT NULL DEFAULT NULL, 
+                `created_date` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP, 
+                `updated_date` DATETIME NULL DEFAULT NULL,
+              PRIMARY KEY (`id`)
+            ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+        ");
+
+        $this->execute("
+            ALTER TABLE `subscription_webhook` 
+                CHANGE `updated_date` `updated_date` DATETIME on update CURRENT_TIMESTAMP NULL DEFAULT CURRENT_TIMESTAMP;
+        ");
+
+        $this->execute("
+            ALTER TABLE `subscription_webhook` ADD INDEX(`status`);
+        ");
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function safeDown()
+    {
+        $this->dropTable("{{%subscription_webhook}}");
+    }
+}

frontend/controllers/SubscriptionController.php

@@ -2,24 +2,19 @@
 
 namespace frontend\controllers;
 
-use frontend\models\Customer;
 use Yii;
+use frontend\models\Customer;
 use common\services\subscription\SubscriptionService;
 
 class SubscriptionController extends Controller
 {
-
-    /**
-     * Lists all AliasParent models.
-     * @return mixed
-     */
-    public function actionIndex()
+    public function actionIndex(): string
     {
         $customer = Customer::findOne(1);
         $subscriptionService = new SubscriptionService($customer);
 
         return $this->render('index', [
-
+            'subscriptionService' => $subscriptionService,
         ]);
     }
 }

frontend/controllers/SubscriptionWebhookController.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace frontend\controllers;
+
+use Yii;
+use yii\web\{Response, BadRequestHttpException, ServerErrorHttpException};
+use yii\helpers\Json;
+use common\models\SubscriptionWebhook;
+
+/**
+ * Class SubscriptionWebhookController
+ * @package frontend\controllers
+ */
+class SubscriptionWebhookController extends Controller
+{
+    /**
+     * @throws BadRequestHttpException
+     */
+    public function beforeAction($action): bool
+    {
+        $this->enableCsrfValidation = false;
+        Yii::$app->response->format = Response::FORMAT_JSON;
+        return parent::beforeAction($action);
+    }
+
+    /**
+     * @throws ServerErrorHttpException
+     */
+    public function actionStripe(): array
+    {
+        //file_put_contents('stripe.txt', Yii::$app->request->rawBody);
+
+        if (!Yii::$app->request->rawBody) {
+            throw new ServerErrorHttpException('No request body.');
+        }
+
+        $data = Json::decode(Yii::$app->request->rawBody);
+
+        if (!isset($data['type'])) {
+            throw new ServerErrorHttpException('Event type is not valid.');
+        }
+
+        $subscriptionWebhook = $this->getNewSubscriptionWebhookObject(SubscriptionWebhook::PAYMENT_METHOD_STRIPE);
+        $subscriptionWebhook->event = $data['type'];
+        $subscriptionWebhook->payload = Yii::$app->request->rawBody;
+
+        if (!$subscriptionWebhook->save()) {
+            throw new ServerErrorHttpException('Event not saved.');
+        }
+
+        return [
+            'status' => 200,
+            'result' => 'success',
+        ];
+    }
+
+    protected function getNewSubscriptionWebhookObject(string $paymentMethodName): SubscriptionWebhook
+    {
+        $subscriptionWebhook = new SubscriptionWebhook();
+        $subscriptionWebhook->payment_method = $paymentMethodName;
+        $subscriptionWebhook->status = SubscriptionWebhook::STATUS_RECEIVED;
+
+        return $subscriptionWebhook;
+    }
+}

frontend/views/subscription/_stripe-widget.php

@@ -1,5 +1,16 @@
+<?php
+    use yii\web\View;
+    use common\services\subscription\SubscriptionService;
+
+    /* @var $this View */
+    /* @var $subscriptionService SubscriptionService */
+?>
 
 <script async src="https://js.stripe.com/v3/pricing-table.js"></script>
-<stripe-pricing-table pricing-table-id="<?= Yii::$app->params['stripe']['pricing_table_id'] ?>"
-                      publishable-key="<?= Yii::$app->params['stripe']['publishable_key'] ?>">
+
+<stripe-pricing-table
+        pricing-table-id="<?= Yii::$app->params['stripe']['pricing_table_id'] ?>"
+        publishable-key="<?= Yii::$app->params['stripe']['publishable_key'] ?>"
+        client-reference-id="<?= $subscriptionService->getCustomer()->id ?>"
+        customer-email="<?= $subscriptionService->getCustomer()->email ?>"
 </stripe-pricing-table>

frontend/views/subscription/_subscribed.php

@@ -0,0 +1,11 @@
+<?php
+    use yii\web\View;
+    use common\services\subscription\SubscriptionService;
+
+    /* @var $this View */
+    /* @var $subscriptionService SubscriptionService */
+?>
+
+<h2>Your current subscription:</h2>
+
+<a href="<?= Yii::$app->params['stripe']['customer_portal_url'] ?>" target="_blank">Manage subscription</a>

frontend/views/subscription/index.php

@@ -1,4 +1,23 @@
-<script async src="https://js.stripe.com/v3/pricing-table.js"></script>
-<stripe-pricing-table pricing-table-id="prctbl_1MmNdnAVtR6J0zbouXceXi2G"
-                      publishable-key="pk_test_UdowAZ9Ju8kv7WWAHoG4UzbT">
-</stripe-pricing-table>
+<?php
+    use yii\web\View;
+    use common\services\subscription\SubscriptionService;
+
+    /* @var $this View */
+    /* @var $subscriptionService SubscriptionService */
+
+    $title = 'Subscription';
+    $this->params['breadcrumbs'][] = $title;
+    $this->title = $title . ' - ' . Yii::$app->name;
+?>
+
+<div>
+    <?php if (!$subscriptionService->hasActiveSubscription()) { ?>
+        <?= $this->render('_stripe-widget', [
+            'subscriptionService' => $subscriptionService,
+        ]) ?>
+    <?php } else { ?>
+        <?= $this->render('_subscribed', [
+            'subscriptionService' => $subscriptionService,
+        ]) ?>
+    <?php } ?>
+</div>