Add custom data handler event

- Added custom data handle event (LicenseChecked) and listener config.
- Moved license check action to own controller.
- Improved source code.

Author: relliv

README.md

@@ -143,6 +143,43 @@ $licenseStatus = LicenseService::setLicenseStatus($licenseKey, "suspended");
 
 You can only set `active`, `inactive`, `suspended` status.
 
+## 🪢 Events
+
+### 🪡 LicenseChecked Event
+
+You can send custom data with connector and on the license server-side, you can catch this custom data. First you need to create a listener for this event.
+
+```bash
+php artisan make:listener LicenseCheckedListener --event=LicenseChecked
+```
+
+Add class `LicenseChecked` with `LaravelReady\LicenseServer\Events\LicenseChecked` namespace.
+
+Finally, you can retrieve custom data from event.
+
+```php
+<?php
+
+namespace App\Listeners;
+
+use LaravelReady\LicenseServer\Events\LicenseChecked;
+
+class LicenseCheckedListener
+{
+    public function __construct()
+    {
+        //
+    }
+
+    public function handle(LicenseChecked $event)
+    {
+        // $event->license,
+        // $event->data,
+    }
+}
+
+```
+
 ## Ready to Use API
 
 Ready to use API is included with simple resource methods. API endpoint is `/api/license-server/licenses`.

composer.json

@@ -3,7 +3,7 @@
     "description": "License server for Laravel",
     "type": "library",
     "license": "MIT",
-    "version": "1.0.3",
+    "version": "1.1.3",
     "keywords": [
         "laravel",
         "license",

config/license-server.php

@@ -64,4 +64,21 @@
         'auth:sanctum',
         'throttle:api',
     ],
+
+    /**
+     * Event listeners for License Server
+     */
+    'listeners' => [
+        /**
+         * License checked event listener
+         *
+         * You can use this event to do something when a license is checked.
+         * Also you can handle custom data with this listener.
+         *
+         * See the documentation for more information.
+         *
+         * Default: null
+         */
+        'license_checked' => null
+    ]
 ];

routes/api-public.php

@@ -1,9 +1,10 @@
 <?php
 
+use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Route;
 
-use LaravelReady\LicenseServer\Services\LicenseService;
 use LaravelReady\LicenseServer\Http\Controllers\Api\AuthController;
+use LaravelReady\LicenseServer\Http\Controllers\Api\LicenseValidateController;
 
 /**
  * Public routes for License Server connector package
@@ -25,13 +26,5 @@
         Route::middleware([
             'auth:sanctum',
             'ls-license-guard',
-        ])->get('license', function () {
-            $license = auth()->user();
-
-            unset($license['id']);
-            unset($license['user_id']);
-            unset($license['created_by']);
-
-            return $license;
-        });
+        ])->post('license', [LicenseValidateController::class, 'licenseValidate']);
     });

src/EventServiceProvider.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace LaravelReady\LicenseServer;
+
+use Illuminate\Support\Facades\Config;
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+
+use LaravelReady\LicenseServer\Events\LicenseChecked;
+use LaravelReady\LicenseServer\Exceptions\ListenerNotFoundException;
+
+final class EventServiceProvider extends ServiceProvider
+{
+    public function __construct($app)
+    {
+        parent::__construct($app);
+
+        $eventListeners = [];
+
+        $licenseCheckedListener = Config::get('license-server.listeners.license_checked');
+
+        if ($licenseCheckedListener) {
+            if (!class_exists($licenseCheckedListener)) {
+                throw new ListenerNotFoundException('LicenseChecked listener class not found');
+            }
+
+            $eventListeners[LicenseChecked::class] = [
+                $licenseCheckedListener
+            ];
+        }
+
+        $this->listen = $eventListeners;
+    }
+
+    /**
+     * Register any events for your application.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        parent::boot();
+    }
+}

src/Events/LicenseChecked.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace LaravelReady\LicenseServer\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+use LaravelReady\LicenseServer\Models\License;
+
+class LicenseChecked
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    public function __construct(License $license, array|null $data = [])
+    {
+        $this->license = $license;
+        $this->data = $data;
+    }
+}

src/Exceptions/ListenerNotFoundException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace LaravelReady\LicenseServer\Exceptions;
+
+use Exception;
+
+final class ListenerNotFoundException extends Exception
+{
+}

src/Http/Controllers/Api/AuthController.php

@@ -7,9 +7,9 @@
 use LaravelReady\LicenseServer\Models\IpAddress;
 use LaravelReady\UltimateSupport\Support\IpSupport;
 use LaravelReady\LicenseServer\Services\LicenseService;
-use LaravelReady\LicenseServer\Http\Controllers\ApiBaseController;
+use LaravelReady\LicenseServer\Http\Controllers\BaseController;
 
-class AuthController extends ApiBaseController
+class AuthController extends BaseController
 {
     /**
      * Login with sanctum

src/Http/Controllers/Api/LicenseController.php

@@ -6,9 +6,9 @@
 
 use LaravelReady\LicenseServer\Models\License;
 use LaravelReady\LicenseServer\Http\Requests\LicenseUpdateRequest;
-use LaravelReady\LicenseServer\Http\Controllers\ApiBaseController;
+use LaravelReady\LicenseServer\Http\Controllers\BaseController;
 
-class LicenseController extends ApiBaseController
+class LicenseController extends BaseController
 {
     /**
      * Display a listing of the resource.

src/Http/Controllers/Api/LicenseValidateController.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace LaravelReady\LicenseServer\Http\Controllers\Api;
+
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Event;
+
+use LaravelReady\LicenseServer\Models\License;
+use LaravelReady\LicenseServer\Events\LicenseChecked;
+use LaravelReady\LicenseServer\Http\Controllers\BaseController;
+
+class LicenseValidateController extends BaseController
+{
+    /**
+     * Validate given license
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function licenseValidate(Request $request, License $license)
+    {
+        $_license = $license->select(
+            'domain',
+            'license_key',
+            'status',
+            'expiration_date',
+            'is_trial',
+            'is_lifetime',
+            'deleted_at',
+            'created_at',
+            'updated_at'
+        )->where('id', auth()->user()->id)->first();
+
+        $data = $request->input();
+
+        Event::dispatch(new LicenseChecked($_license, $data));
+
+        return $_license;
+    }
+}