Add middleware, method UserResetPassword, UserDelete, LockInitialize; change transport & configuration

Author: sunnyphp

src/Configuration.php

@@ -3,6 +3,7 @@
 
 namespace SunnyPHP\TTLock;
 
+use SunnyPHP\TTLock\Contract\Request\RequiredConfiguration;
 use Webmozart\Assert\Assert;
 
 /**
@@ -12,20 +13,27 @@ final class Configuration
 {
 	private const ENDPOINT = 'https://euapi.ttlock.com';
 	private string $clientId;
-	private string $clientSecret;
+	private ?string $clientSecret;
+	private ?string $accessToken;
 	private string $endpointHost;
+	private static array $toArrayFilter = [
+		'clientId' => RequiredConfiguration::CLIENT_ID,
+		'clientSecret' => RequiredConfiguration::CLIENT_SECRET,
+		'accessToken' => RequiredConfiguration::ACCESS_TOKEN,
+	];
 
 	public function __construct(
 		string $clientId,
-		string $clientSecret,
+		?string $clientSecret = null,
+		?string $accessToken = null,
 		string $endpointHost = self::ENDPOINT
 	) {
 		Assert::notEmpty($clientId, 'ClientId param should be filled');
-		Assert::notEmpty($clientSecret, 'ClientSecret param should be filled');
 		Assert::notEmpty($endpointHost, 'EndpointHost param should be filled, use default value: ' . self::ENDPOINT);
 
 		$this->clientId = $clientId;
 		$this->clientSecret = $clientSecret;
+		$this->accessToken = $accessToken;
 		$this->endpointHost = $endpointHost;
 	}
 
@@ -34,28 +42,53 @@ public function getClientId(): string
 		return $this->clientId;
 	}
 
-	public function getClientSecret(): string
+	public function getClientSecret(): ?string
 	{
 		return $this->clientSecret;
 	}
 
+	public function getAccessToken(): ?string
+	{
+		return $this->accessToken;
+	}
+
 	public function getEndpointHost(): string
 	{
 		return $this->endpointHost;
 	}
 
 	public function withClientId(string $clientId): self
 	{
-		return new self($clientId, $this->getClientSecret(), $this->getEndpointHost());
+		return new self($clientId, $this->getClientSecret(), $this->getAccessToken(), $this->getEndpointHost());
+	}
+
+	public function withClientSecret(?string $clientSecret): self
+	{
+		return new self($this->getClientId(), $clientSecret, $this->getAccessToken(), $this->getEndpointHost());
 	}
 
-	public function withClientSecret(string $clientSecret): self
+	public function withAccessToken(?string $accessToken): self
 	{
-		return new self($this->getClientId(), $clientSecret, $this->getEndpointHost());
+		return new self($this->getClientId(), $this->getClientSecret(), $accessToken, $this->getEndpointHost());
 	}
 
 	public function withEndpointHost(string $endpointHost): self
 	{
-		return new self($this->getClientId(), $this->getClientSecret(), $endpointHost);
+		return new self($this->getClientId(), $this->getClientSecret(), $this->getAccessToken(), $endpointHost);
+	}
+
+	public function toArray(?int $bitmask = null): array
+	{
+		$params = [];
+
+		foreach (self::$toArrayFilter as $key => $filterBit) {
+			if ($bitmask === null || ($bitmask & $filterBit) === $filterBit) {
+				Assert::propertyExists($this, $key);
+
+				$params[$key] = $this->{$key};
+			}
+		}
+
+		return $params;
 	}
 }

src/Contract/Middleware/BeforeResponse/BeforeResponseInterface.php

@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace SunnyPHP\TTLock\Contract\Middleware\BeforeResponse;
+
+use SunnyPHP\TTLock\Contract\Middleware\MiddlewareInterface;
+
+interface BeforeResponseInterface extends MiddlewareInterface
+{
+	public function handle(array $response, ?MiddlewareInterface $next = null): array;
+}

src/Contract/Middleware/MiddlewareInterface.php

@@ -0,0 +1,12 @@
+<?php
+declare(strict_types=1);
+
+namespace SunnyPHP\TTLock\Contract\Middleware;
+
+interface MiddlewareInterface
+{
+	/**
+	 * @return class-string
+	 */
+	public function getType(): string;
+}

src/Contract/Request/Lock/InitializeInterface.php

@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+namespace SunnyPHP\TTLock\Contract\Request\Lock;
+
+use DateTimeImmutable;
+use SunnyPHP\TTLock\Contract\Request\RequestInterface;
+
+interface InitializeInterface extends RequestInterface
+{
+	public function getLockData(): string;
+
+	public function getLockAlias(): ?string;
+
+	public function getGroupId(): ?int;
+
+	public function getNbInitSuccess(): ?bool;
+
+	public function getCurrentTime(): DateTimeImmutable;
+}

src/Contract/Request/RequestInterface.php

@@ -6,10 +6,10 @@
 interface RequestInterface
 {
 	/**
-	 * Returns True if client credentials required (clientId, clientSecret)
-	 * @return bool
+	 * Returns required configuration bitmask
+	 * @return int
 	 */
-	public function isClientCredentialsRequired(): bool;
+	public function getRequiredConfiguration(): int;
 
 	/**
 	 * Endpoint request URL part

src/Contract/Request/RequiredConfiguration.php

@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace SunnyPHP\TTLock\Contract\Request;
+
+final class RequiredConfiguration
+{
+	public const CLIENT_ID = 1 << 0;
+	public const CLIENT_SECRET = 1 << 1;
+	public const ACCESS_TOKEN = 1 << 2;
+}

src/Contract/Request/User/DeleteInterface.php

@@ -0,0 +1,22 @@
+<?php
+declare(strict_types=1);
+
+namespace SunnyPHP\TTLock\Contract\Request\User;
+
+use DateTimeImmutable;
+use SunnyPHP\TTLock\Contract\Request\RequestInterface;
+
+interface DeleteInterface extends RequestInterface
+{
+	/**
+	 * Username for delete (only numbers and english letters)
+	 * @return string
+	 */
+	public function getUsername(): string;
+
+	/**
+	 * Current time
+	 * @return DateTimeImmutable
+	 */
+	public function getCurrentTime(): DateTimeImmutable;
+}

src/Contract/Request/User/ResetPasswordInterface.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace SunnyPHP\TTLock\Contract\Request\User;
+
+use DateTimeImmutable;
+use SunnyPHP\TTLock\Contract\Request\RequestInterface;
+
+interface ResetPasswordInterface extends RequestInterface
+{
+	/**
+	 * Username (only numbers and english letters)
+	 * @return string
+	 */
+	public function getUsername(): string;
+
+	/**
+	 * New password (32 chars, low case, md5 encrypted)
+	 * @return string
+	 */
+	public function getPassword(): string;
+
+	/**
+	 * Current time
+	 * @return DateTimeImmutable
+	 */
+	public function getCurrentTime(): DateTimeImmutable;
+}

src/Contract/Response/Common/SuccessResponseInterface.php

@@ -0,0 +1,14 @@
+<?php
+declare(strict_types=1);
+
+namespace SunnyPHP\TTLock\Contract\Response\Common;
+
+use SunnyPHP\TTLock\Contract\Response\ResponseInterface;
+
+/**
+ * No data, no error, just success execution
+ */
+interface SuccessResponseInterface extends ResponseInterface
+{
+
+}

src/Contract/Response/Lock/InitializeInterface.php

@@ -0,0 +1,13 @@
+<?php
+declare(strict_types=1);
+
+namespace SunnyPHP\TTLock\Contract\Response\Lock;
+
+use SunnyPHP\TTLock\Contract\Response\ResponseInterface;
+
+interface InitializeInterface extends ResponseInterface
+{
+	public function getLockId(): int;
+
+	public function getKeyId(): int;
+}