Improve Software design

Author: ildyria

composer.json

@@ -5,7 +5,7 @@
     "license": "MIT",
     "require": {
         "php": "^8.2",
-        "illuminate/contracts": "^10.0||^11.0",
+        "illuminate/contracts": "^11.0",
         "thecodingmachine/safe": "^2.5"
     },
     "require-dev": {

config/verify.php

@@ -8,9 +8,9 @@
 
 return [
 	'validation' => [
-		ValidateHash::class => '283d910da171808f650011e41d5c23c743e90e39',
-		ValidateSignature::class => '71627830f8485d02dc48a59e2aa28cc9dea6fe3b',
-		Verify::class => 'b9e4048f3543734262582553d2202f9ef5d39b1f',
+		ValidateHash::class => 'e2511ed0f1adc865c7c8b40bec19d656323d81f6',
+		ValidateSignature::class => '1bae28471b402e73ddad2ea871b15835954822c3',
+		Verify::class => '6dd9c193b7505dff9d4ba0f19f0e2b3a3171d83a',
 		VerifySupporterStatus::class => '6358c45ed0414c1e2697e0881238659fa6221bed',
 		VerifyServiceProvider::class => '927a8f3c811fc82cb8a0ac2667c06e7d292c3633',
 	],

src/Contract/Validator.php src/Contract/ValidatorInterface.php

@@ -5,7 +5,7 @@
 /**
  * Interface to check whther a license key is valid or not.
  */
-interface Validator
+interface ValidatorInterface
 {
 	/**
 	 * Given a license key and a verifiable string, check whether the license key is valid or not.

src/Contract/VerifyInterface.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace LycheeVerify\Contract;
+
+use LycheeVerify\Exceptions\SupporterOnlyOperationException;
+
+interface VerifyInterface
+{
+	/**
+	 * Check if the installation is verified.
+	 *
+	 * @return Status
+	 */
+	public function get_status(): Status;
+
+	/**
+	 * Check the status of the installation and validate.
+	 *
+	 * @param Status $required_status (default to SUPPORTER_EDITION)
+	 *
+	 * @return bool
+	 */
+	public function check(Status $required_status = Status::SUPPORTER_EDITION): bool;
+
+	/**
+	 * Returns true if the user is a supporter (or plus registered user).
+	 *
+	 * @return bool
+	 */
+	public function is_supporter(): bool;
+
+	/**
+	 * Return true of the user is a plus registered user.
+	 *
+	 * @return bool
+	 */
+	public function is_plus(): bool;
+
+	/**
+	 * Authorize the operation if the installation is verified.
+	 * Otherwise throw an exception.
+	 *
+	 * @param Status $required_status (default to SUPPORTER_EDITION)
+	 *
+	 * @return void
+	 *
+	 * @throws SupporterOnlyOperationException
+	 */
+	public function authorize(Status $required_status = Status::SUPPORTER_EDITION): void;
+
+	/**
+	 * Fork depending whether the installation is verified or not.
+	 *
+	 * @template T
+	 *
+	 * @param T|\Closure(): T $valIfTrue       what happens or Value if we features are enabled
+	 * @param T|\Closure(): T $valIfFalse      what happens or Value if we features are disabled
+	 * @param Status          $required_status
+	 *
+	 * @return T
+	 */
+	public function when(mixed $valIfTrue, mixed $valIfFalse, Status $required_status = Status::SUPPORTER_EDITION): mixed;
+
+	/**
+	 * Validate installation.
+	 *
+	 * @return bool
+	 */
+	public function validate(): bool;
+}

src/Validators/ValidateHash.php

@@ -4,12 +4,12 @@
 
 use Illuminate\Support\Facades\Hash;
 use LycheeVerify\Contract\Status;
-use LycheeVerify\Contract\Validator;
+use LycheeVerify\Contract\ValidatorInterface;
 
 /**
  * This is the validator for supporters.
  */
-class ValidateHash implements Validator
+class ValidateHash implements ValidatorInterface
 {
 	private string $hash;
 

src/Validators/ValidateSignature.php

@@ -4,7 +4,7 @@
 
 use Illuminate\Support\Facades\Log;
 use LycheeVerify\Contract\Status;
-use LycheeVerify\Contract\Validator;
+use LycheeVerify\Contract\ValidatorInterface;
 use function Safe\base64_decode;
 use Safe\Exceptions\OpensslException;
 use function Safe\openssl_pkey_get_public;
@@ -13,7 +13,7 @@
 /**
  * This is the validator for the premium users.
  */
-class ValidateSignature implements Validator
+class ValidateSignature implements ValidatorInterface
 {
 	private string $public_key;
 

src/Verify.php

@@ -4,13 +4,14 @@
 
 use Illuminate\Support\Facades\DB;
 use LycheeVerify\Contract\Status;
+use LycheeVerify\Contract\VerifyInterface;
 use LycheeVerify\Exceptions\SupporterOnlyOperationException;
 use LycheeVerify\Validators\ValidateHash;
 use LycheeVerify\Validators\ValidateSignature;
 use function Safe\json_encode;
 use function Safe\preg_replace;
 
-class Verify
+class Verify implements VerifyInterface
 {
 	private string $config_email;
 	private string $license_key;