[update] 実装修正 for v3.0

.gitignore

@@ -2,6 +2,7 @@
 .idea/
 .phpcs.xml
 .phpcs-cache
+.phpunit.cache
 build/
 docker/
 vendor/

README.md

@@ -16,6 +16,7 @@ $ composer require chanshige/sesame
 
 Usage
 --
+
 ```injectablephp
 <?php
 // initialize

src/Action/AbstractAction.php

@@ -4,8 +4,10 @@
 
 namespace Chanshige\SmartLock\Sesame\Action;
 
+use Chanshige\SmartLock\Sesame\Extend\Signature;
 use Chanshige\SmartLock\Sesame\Interface\ActionInterface;
 use Chanshige\SmartLock\Sesame\Interface\DeviceInterface;
+use Chanshige\SmartLock\Sesame\Interface\NowInterface;
 use Koriym\HttpConstants\Method;
 
 abstract class AbstractAction implements ActionInterface
@@ -23,9 +25,9 @@ public function uuid(): string
         return $this->device->uuid();
     }
 
-    public function sign(callable|null $generate = null): string
+    public function secretKey(): string
     {
-        return $this->device->sign($generate);
+        return $this->device->secretKey();
     }
 
     abstract public function method(): string;
@@ -34,4 +36,10 @@ abstract public function path(): string;
 
     /** @return array<string, string|int>|array{} */
     abstract public function payload(): array;
+
+    /** @SuppressWarnings(PHPMD.StaticAccess) */
+    protected function sign(NowInterface $now): string
+    {
+        return Signature::generate($this->secretKey(), $now);
+    }
 }

src/Action/CmdCode.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Chanshige\SmartLock\Sesame\Action;
+
+final class CmdCode
+{
+    public const TOGGLE = 88;
+    public const LOCK = 82;
+    public const UNLOCK = 83;
+}

src/Action/History.php

@@ -4,7 +4,6 @@
 
 namespace Chanshige\SmartLock\Sesame\Action;
 
-use BadFunctionCallException;
 use Chanshige\SmartLock\Sesame\Interface\DeviceInterface;
 
 use function assert;
@@ -31,13 +30,6 @@ public function path(): string
         return '/history';
     }
 
-    public function sign(callable|null $generate = null): string
-    {
-        assert($generate === null);
-
-        throw new BadFunctionCallException('This method is not supported.');
-    }
-
     /** {@inheritdoc} */
     public function payload(): array
     {

src/Action/Lock.php

@@ -4,16 +4,22 @@
 
 namespace Chanshige\SmartLock\Sesame\Action;
 
+use Chanshige\SmartLock\Sesame\Extend\Now;
 use Chanshige\SmartLock\Sesame\Interface\DeviceInterface;
+use Chanshige\SmartLock\Sesame\Interface\NowInterface;
 
+use function assert;
 use function base64_encode;
 
 final class Lock extends AbstractAction
 {
     public function __construct(
         private readonly DeviceInterface $device,
         private readonly string $comment = 'WebAPI',
+        private readonly NowInterface $now = new Now(),
     ) {
+        assert($this->device instanceof DeviceInterface);
+
         parent::__construct($device);
     }
 
@@ -31,9 +37,9 @@ public function path(): string
     public function payload(): array
     {
         return [
-            'cmd' => Cmd::LOCK->value,
+            'cmd' => CmdCode::LOCK,
             'history' => base64_encode($this->comment),
-            'sign' => $this->device->sign(),
+            'sign' => $this->sign($this->now),
         ];
     }
 }

src/Action/Status.php

@@ -4,10 +4,6 @@
 
 namespace Chanshige\SmartLock\Sesame\Action;
 
-use BadFunctionCallException;
-
-use function assert;
-
 final class Status extends AbstractAction
 {
     public function method(): string
@@ -20,13 +16,6 @@ public function path(): string
         return '';
     }
 
-    public function sign(callable|null $generate = null): string
-    {
-        assert($generate === null);
-
-        throw new BadFunctionCallException('This method is not supported.');
-    }
-
     /** @return array{} */
     public function payload(): array
     {

src/Action/Toggle.php

@@ -4,16 +4,22 @@
 
 namespace Chanshige\SmartLock\Sesame\Action;
 
+use Chanshige\SmartLock\Sesame\Extend\Now;
 use Chanshige\SmartLock\Sesame\Interface\DeviceInterface;
+use Chanshige\SmartLock\Sesame\Interface\NowInterface;
 
+use function assert;
 use function base64_encode;
 
 final class Toggle extends AbstractAction
 {
     public function __construct(
         private readonly DeviceInterface $device,
         private readonly string $comment = 'WebAPI',
+        private readonly NowInterface $now = new Now(),
     ) {
+        assert($this->device instanceof DeviceInterface);
+
         parent::__construct($device);
     }
 
@@ -31,9 +37,9 @@ public function path(): string
     public function payload(): array
     {
         return [
-            'cmd' => Cmd::TOGGLE->value,
+            'cmd' => CmdCode::TOGGLE,
             'history' => base64_encode($this->comment),
-            'sign' => $this->device->sign(),
+            'sign' => $this->sign($this->now),
         ];
     }
 }

src/Action/Unlock.php

@@ -4,16 +4,22 @@
 
 namespace Chanshige\SmartLock\Sesame\Action;
 
+use Chanshige\SmartLock\Sesame\Extend\Now;
 use Chanshige\SmartLock\Sesame\Interface\DeviceInterface;
+use Chanshige\SmartLock\Sesame\Interface\NowInterface;
 
+use function assert;
 use function base64_encode;
 
 final class Unlock extends AbstractAction
 {
     public function __construct(
         private readonly DeviceInterface $device,
         private readonly string $comment = 'WebAPI',
+        private readonly NowInterface $now = new Now(),
     ) {
+        assert($this->device instanceof DeviceInterface);
+
         parent::__construct($device);
     }
 
@@ -31,9 +37,9 @@ public function path(): string
     public function payload(): array
     {
         return [
-            'cmd' => Cmd::UNLOCK->value,
+            'cmd' => CmdCode::UNLOCK,
             'history' => base64_encode($this->comment),
-            'sign' => $this->device->sign(),
+            'sign' => $this->sign($this->now),
         ];
     }
 }

src/Client.php

@@ -7,11 +7,10 @@
 use Chanshige\SmartLock\Sesame\Exception\ClientException;
 use Chanshige\SmartLock\Sesame\Exception\SesameException;
 use Chanshige\SmartLock\Sesame\Http\GuzzleHttpFactory;
-use Chanshige\SmartLock\Sesame\Http\ResponseInterface;
 use Chanshige\SmartLock\Sesame\Interface\ActionInterface;
 use Chanshige\SmartLock\Sesame\Interface\ClientInterface;
-use Chanshige\SmartLock\Sesame\Interface\DeviceInterface;
 use Chanshige\SmartLock\Sesame\Interface\HttpInterface;
+use Chanshige\SmartLock\Sesame\Interface\ResponseInterface;
 
 use function sprintf;
 
@@ -35,31 +34,6 @@ public function __invoke(ActionInterface $action): ResponseInterface
         }
     }
 
-    public function status(DeviceInterface $device): ResponseInterface
-    {
-        return $this(new Action\Status($device));
-    }
-
-    public function history(DeviceInterface $device, int $page = 0, int $lg = 50): ResponseInterface
-    {
-        return $this(new Action\History($device, $page, $lg));
-    }
-
-    public function lock(DeviceInterface $device, string $note = 'WebAPI'): ResponseInterface
-    {
-        return $this(new Action\Lock($device, $note));
-    }
-
-    public function unLock(DeviceInterface $device, string $note = 'WebAPI'): ResponseInterface
-    {
-        return $this(new Action\Unlock($device, $note));
-    }
-
-    public function toggle(DeviceInterface $device, string $note = 'WebAPI'): ResponseInterface
-    {
-        return $this(new Action\Toggle($device, $note));
-    }
-
     /**
      * @param array<string, mixed> $options
      *

src/Device.php

@@ -4,19 +4,13 @@
 
 namespace Chanshige\SmartLock\Sesame;
 
-use Chanshige\SmartLock\Sesame\Extend\Now;
-use Chanshige\SmartLock\Sesame\Extend\Signature;
 use Chanshige\SmartLock\Sesame\Interface\DeviceInterface;
-use Chanshige\SmartLock\Sesame\Interface\NowInterface;
 
-use function is_callable;
-
-final readonly class Device implements DeviceInterface
+readonly class Device implements DeviceInterface
 {
     public function __construct(
         private string $uuid,
         private string $secretKey,
-        private NowInterface|null $now = new Now(),
     ) {
     }
 
@@ -25,13 +19,8 @@ public function uuid(): string
         return $this->uuid;
     }
 
-    /** @SuppressWarnings(PHPMD.StaticAccess) */
-    public function sign(callable|null $generate = null): string
+    public function secretKey(): string
     {
-        if (! is_callable($generate)) {
-            return $this->sign(Signature::generate(...));
-        }
-
-        return $generate($this->secretKey, $this->now);
+        return $this->secretKey;
     }
 }

src/Enum/Status.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Chanshige\SmartLock\Sesame\Enum;
+
+enum Status: string
+{
+    case LOCKED = 'locked';
+    case UNLOCKED = 'unlocked';
+
+    /** @note サムターンが施錠・解錠判定範囲外の場合。半ロックとか？ */
+    case MOVED = 'moved';
+
+    public function message(): string
+    {
+        return match ($this) {
+            self::LOCKED => '施錠',
+            self::UNLOCKED => '解錠',
+            self::MOVED => 'サムターン位置確認',
+        };
+    }
+
+    public function equals(Status $status): bool
+    {
+        return $this === $status;
+    }
+
+    public function next(): self
+    {
+        return match ($this) {
+            self::LOCKED => self::UNLOCKED,
+            self::UNLOCKED, self::MOVED => self::LOCKED,
+        };
+    }
+}

src/Extend/AesCmac.php

@@ -7,9 +7,15 @@
 use Crypto\CMAC;
 use Crypto\MACException;
 use InvalidArgumentException;
+use LogicException;
 
+use function extension_loaded;
 use function hex2bin;
 
+if (! extension_loaded('crypto')) {
+    throw new LogicException('You cannot use the "Chanshige\SmartLock\Sesame\Extend\AesCmac" as the "crypto" extension is not installed.');
+}
+
 final class AesCmac
 {
     /**

src/Http/GuzzleHttp.php

@@ -6,6 +6,8 @@
 
 use Chanshige\SmartLock\Sesame\Exception\ClientException;
 use Chanshige\SmartLock\Sesame\Interface\HttpInterface;
+use Chanshige\SmartLock\Sesame\Interface\ResponseFactoryInterface;
+use Chanshige\SmartLock\Sesame\Interface\ResponseInterface;
 use GuzzleHttp\ClientInterface as GuzzleClientInterface;
 use GuzzleHttp\Exception\GuzzleException;
 use GuzzleHttp\RequestOptions;