Remove usage of one magic method.

madpilot78 · Mar 2, 2025 · 515633b · 515633b
1 parent 9d328ce
commit 515633b
Show file tree

Hide file tree

Showing 14 changed files with 53 additions and 46 deletions.
diff --git a/src/Auth/Session.php b/src/Auth/Session.php
@@ -44,14 +44,14 @@ private function login(): string
 
         $result = $this->client->get(
             ['challenge'],
-            $this->boxInfo->apiUrl . '/login/',
+            $this->boxInfo->getApiUrl() . '/login/',
         );
 
         $this->authManager->setChallenge($result['challenge']);
 
         $result = $this->client->post(
             ['session_token', 'challenge', 'permissions'],
-            $this->boxInfo->apiUrl . '/login/session/',
+            $this->boxInfo->getApiUrl() . '/login/session/',
             [
                 'json' => [
                     'app_id' => $this->config->appId,

diff --git a/src/BoxInfo.php b/src/BoxInfo.php
@@ -87,25 +87,26 @@ public function getInfo(): array
         return $this->info;
     }
 
+    public function getApiUrl(): string
+    {
+        $this->apiUrl ??= $this->makeApiUrl();
+
+        return $this->apiUrl ?? '';
+    }
+
     /**
      * @throws OutOfBoundsException
      */
-    public function __get(string $name): null|bool|int|string
+    public function getProperty(string $name): null|bool|int|string
     {
-        if ($name === 'apiUrl') {
-            $this->apiUrl ??= $this->makeApiUrl();
-
-            return $this->apiUrl;
-        }
-
         if (array_key_exists($name, $this->info)) {
             return $this->info[$name];
         }
 
         throw new OutOfBoundsException('Property ' . $name . ' not found', 101);
     }
 
-    public function __isset(string $name): bool
+    public function isPropertySet(string $name): bool
     {
         return isset($this->info[$name]);
     }

diff --git a/src/BoxInfoInterface.php b/src/BoxInfoInterface.php
@@ -9,4 +9,10 @@ interface BoxInfoInterface
     public function save(array $data): self;
 
     public function getInfo(): array;
+
+    public function getApiUrl(): string;
+
+    public function getProperty(string $name): null|bool|int|string;
+
+    public function isPropertySet(string $name): bool;
 }
diff --git a/src/Methods/AbstractMethod.php b/src/Methods/AbstractMethod.php
@@ -64,7 +64,7 @@ protected function get(?int $id, array $params): array
         $hasId = isset($id);
         return $this->client->get(
             $hasId ? static::REQUIRED_GET_ID : static::REQUIRED_GET,
-            $this->boxInfo->apiUrl . static::API . ($hasId ? $this->separator . $id : ''),
+            $this->boxInfo->getApiUrl() . static::API . ($hasId ? $this->separator . $id : ''),
             ['headers' => $this->authHeader],
         );
     }
@@ -80,7 +80,7 @@ protected function set(null|int|string $id, array $params): ?array
 
         if (empty(static::REQUIRED_SET)) {
             $response = $this->client->post(
-                $this->boxInfo->apiUrl . static::API . (isset($id) ? $this->separator . $id : ''),
+                $this->boxInfo->getApiUrl() . static::API . (isset($id) ? $this->separator . $id : ''),
                 [
                     'headers' => $this->authHeader,
                     'json' => $params,
@@ -95,7 +95,7 @@ protected function set(null|int|string $id, array $params): ?array
         } else {
             return $this->client->post(
                 static::REQUIRED_SET,
-                $this->boxInfo->apiUrl . static::API . (isset($id) ? $this->separator . $id : ''),
+                $this->boxInfo->getApiUrl() . static::API . (isset($id) ? $this->separator . $id : ''),
                 [
                     'headers' => $this->authHeader,
                     'json' => $params,
@@ -112,7 +112,7 @@ protected function update(?int $id, array $params): ?array
 
         if (empty(static::REQUIRED_PUT)) {
             $response = $this->client->put(
-                $this->boxInfo->apiUrl . static::API . (isset($id) ? $this->separator . $id : ''),
+                $this->boxInfo->getApiUrl() . static::API . (isset($id) ? $this->separator . $id : ''),
                 [
                     'headers' => $this->authHeader,
                     'json' => $params,
@@ -127,7 +127,7 @@ protected function update(?int $id, array $params): ?array
         } else {
             return $this->client->put(
                 static::REQUIRED_PUT,
-                $this->boxInfo->apiUrl . static::API . (isset($id) ? $this->separator . $id : ''),
+                $this->boxInfo->getApiUrl() . static::API . (isset($id) ? $this->separator . $id : ''),
                 [
                     'headers' => $this->authHeader,
                     'json' => $params,
@@ -143,7 +143,7 @@ protected function delete(int $id, array $params): void
         }
 
         $response = $this->client->delete(
-            $this->boxInfo->apiUrl . static::API . $this->separator . $id,
+            $this->boxInfo->getApiUrl() . static::API . $this->separator . $id,
             ['headers' => $this->authHeader],
         );
 

diff --git a/src/Methods/Discover.php b/src/Methods/Discover.php
@@ -28,7 +28,7 @@ public function run(string $action = 'get', array|int|string $id = [], array $pa
             '/api_version',
         ));
 
-        if (!$this->boxInfo->https_available) {
+        if (!$this->boxInfo->getProperty('https_available')) {
             throw new NotSupportedException('Only https enabled boxes supported.');
         }
 

diff --git a/src/Methods/Logout.php b/src/Methods/Logout.php
@@ -11,7 +11,7 @@ class Logout extends AbstractMethod implements MethodInterface
     public function run(string $action = 'get', array|int|string $id = [], array $params = []): ?array
     {
         $response = $this->client->get(
-            $this->boxInfo->apiUrl . '/login/logout',
+            $this->boxInfo->getApiUrl() . '/login/logout',
             ['headers' => $this->authSession->getAuthHeader()],
         );
 

diff --git a/src/Methods/Register.php b/src/Methods/Register.php
@@ -36,7 +36,7 @@ public function run(bool $quiet = true, bool $skipSleep = false): ?string
 
         $result = $this->client->post(
             ['app_token', 'track_id'],
-            $this->boxInfo->apiUrl . '/login/authorize',
+            $this->boxInfo->getApiUrl() . '/login/authorize',
             [
                 'json' => [
                     'app_id' => $this->config->appId,
@@ -68,7 +68,7 @@ private function poll(bool $quiet = true, bool $skipSleep = false): string
         for ($i = 0; $i < self::POLL_MAX; $i++) {
             $result = $this->client->get(
                 ['status', 'challenge'],
-                $this->boxInfo->apiUrl . '/login/authorize/' . $this->trackId,
+                $this->boxInfo->getApiUrl() . '/login/authorize/' . $this->trackId,
             );
 
             $this->authManager->setChallenge($result['challenge']);

diff --git a/tests/Unit/Auth/SessionTest.php b/tests/Unit/Auth/SessionTest.php
@@ -64,7 +64,7 @@ public function testGetAuthMissingChallenge(): void
             ->method('setPermissions')
             ->with($this->equalTo(self::PERMISSIONS))
             ->willReturnSelf();
-        $this->boxInfoStub->method('__get')->willReturn(self::MOCK_URL);
+        $this->boxInfoStub->method('getApiUrl')->willReturn(self::MOCK_URL);
         $this->httpClientStub->method('__call')->willReturn(
             [
                 'logged_in' => false,
@@ -106,7 +106,7 @@ public function testGetAuthWithChallenge(): void
             ->method('setPermissions')
             ->with($this->equalTo(self::PERMISSIONS))
             ->willReturnSelf();
-        $this->boxInfoStub->method('__get')->willReturn(self::MOCK_URL);
+        $this->boxInfoStub->method('getApiUrl')->willReturn(self::MOCK_URL);
         $this->httpClientStub->method('__call')->willReturn([
             'session_token' => self::SESSION_TOKEN,
             'challenge' => self::CHALLENGE,

diff --git a/tests/Unit/BoxInfoTest.php b/tests/Unit/BoxInfoTest.php
@@ -64,37 +64,37 @@ public function testSavingBoxinfoMissing(): void
         $this->boxInfo->save($info);
     }
 
-    public function testBoxInfoGetValue(): void
+    public function testBoxInfoGetProperty(): void
     {
         $this->assertInstanceOf(
             BoxInfo::class,
             $this->boxInfo->save(self::INFO),
         );
 
-        $this->assertEquals(self::INFO['api_domain'], $this->boxInfo->api_domain);
-        $this->assertTrue($this->boxInfo->https_available);
+        $this->assertEquals(self::INFO['api_domain'], $this->boxInfo->getProperty('api_domain'));
+        $this->assertTrue($this->boxInfo->getProperty('https_available'));
     }
 
-    public function testBoxInfoIsset(): void
+    public function testBoxInfoIsPropertySet(): void
     {
         $this->assertInstanceOf(
             BoxInfo::class,
             $this->boxInfo->save(self::INFO),
         );
 
-        $this->assertTrue(isset($this->boxInfo->api_domain));
-        $this->assertFalse(isset($this->boxInfo->notset));
+        $this->assertTrue($this->boxInfo->isPropertySet('api_domain'));
+        $this->assertFalse($this->boxInfo->isPropertySet('notset'));
     }
 
-    public function testBoxInfoGetValueNotSaved(): void
+    public function testBoxInfoGetPropertyNotSaved(): void
     {
         $this->assertInstanceOf(
             BoxInfo::class,
             $this->boxInfo->save(self::INFO),
         );
 
         $this->expectException(OutOfBoundsException::class);
-        $result = $this->boxInfo->foo;
+        $result = $this->boxInfo->getProperty('foo');
     }
 
     public function testBoxInfoGetApiUrlHttps(): void
@@ -107,7 +107,7 @@ public function testBoxInfoGetApiUrlHttps(): void
 
         $this->assertEquals(
             'https://' . self::INFO['api_domain'] . self::INFO['api_base_url'] . 'v' . $major,
-            $this->boxInfo->apiUrl,
+            $this->boxInfo->getApiUrl(),
         );
     }
 
@@ -124,7 +124,7 @@ public function testBoxInfoGetApiUrlHttp(): void
 
         $this->assertEquals(
             'http://' . $info['api_domain'] . $info['api_base_url'] . 'v' . $major,
-            $this->boxInfo->apiUrl,
+            $this->boxInfo->getApiUrl(),
         );
     }
 
@@ -139,7 +139,7 @@ public function testBoxInfoGetApiUrlNonLocal(): void
 
         $this->assertEquals(
             'https://' . self::INFO['api_domain'] . ':' . self::INFO['https_port'] . self::INFO['api_base_url'] . 'v' . $major,
-            $this->boxInfo->apiUrl,
+            $this->boxInfo->getApiUrl(),
         );
     }
 
@@ -152,7 +152,7 @@ public function testBoxInfoNonDefaultHostname(): void
             $this->boxInfo->save(self::INFO),
         );
 
-        $this->assertEquals($custom, $this->boxInfo->api_domain);
+        $this->assertEquals($custom, $this->boxInfo->getProperty('api_domain'));
     }
 
     public function testBoxInfoGetInfo(): void

diff --git a/tests/Unit/Methods/DiscoverTest.php b/tests/Unit/Methods/DiscoverTest.php
@@ -42,7 +42,7 @@ protected function setUp(): void
     public function testDiscoverSuccess(): void
     {
         $this->boxInfoStub
-            ->method('__get')
+            ->method('getProperty')
             ->willReturn(true);
 
         $this->assertNull($this->discover->run());
@@ -51,7 +51,7 @@ public function testDiscoverSuccess(): void
     public function testDiscoverNoHttps(): void
     {
         $this->boxInfoStub
-            ->method('__get')
+            ->method('getProperty')
             ->willReturn(false);
 
         $this->expectException(NotSupportedException::class);

diff --git a/tests/Unit/Methods/FwRedirTest.php b/tests/Unit/Methods/FwRedirTest.php
@@ -209,7 +209,7 @@ public function testGetFwRedirs(): void
                 $this->equalTo('get'),
                 $this->equalTo([
                     [''],
-                    $this->boxInfoStub->apiUrl . '/fw/redir/',
+                    $this->boxInfoStub->getApiUrl() . '/fw/redir/',
                     ['headers' => $this->authSessionStub->getAuthHeader()],
                 ]),
             )
@@ -227,7 +227,7 @@ public function testGetFwRedir(): void
                 $this->equalTo('get'),
                 $this->equalTo([
                     self::REQUIREDARGS,
-                    $this->boxInfoStub->apiUrl . '/fw/redir/1',
+                    $this->boxInfoStub->getApiUrl() . '/fw/redir/1',
                     ['headers' => $this->authSessionStub->getAuthHeader()],
                 ]),
             )
@@ -245,7 +245,7 @@ public function testSetFwRedir(): void
                 $this->equalTo('post'),
                 $this->equalTo([
                     self::REQUIREDARGS,
-                    $this->boxInfoStub->apiUrl . '/fw/redir/',
+                    $this->boxInfoStub->getApiUrl() . '/fw/redir/',
                     [
                         'headers' => $this->authSessionStub->getAuthHeader(),
                         'json' => self::FWREDIRSET,
@@ -287,7 +287,7 @@ public function testUpdateFwRedir(): void
                 $this->equalTo('put'),
                 $this->equalTo([
                     self::REQUIREDARGS,
-                    $this->boxInfoStub->apiUrl . '/fw/redir/1',
+                    $this->boxInfoStub->getApiUrl() . '/fw/redir/1',
                     [
                         'headers' => $this->authSessionStub->getAuthHeader(),
                         'json' => ['enabled' => false],
@@ -325,7 +325,7 @@ public function testDeleteFwRedir(): void
             ->with(
                 $this->equalTo('delete'),
                 $this->equalTo([
-                    $this->boxInfoStub->apiUrl . '/fw/redir/3',
+                    $this->boxInfoStub->getApiUrl() . '/fw/redir/3',
                     ['headers' => $this->authSessionStub->getAuthHeader()],
                 ]),
             )

diff --git a/tests/Unit/Methods/LanBrowserInterfacesTest.php b/tests/Unit/Methods/LanBrowserInterfacesTest.php
@@ -62,7 +62,7 @@ public function testGetLanBroserInterfaces(): void
                 $this->equalTo('get'),
                 $this->equalTo([
                     [''],
-                    $this->boxInfoStub->apiUrl . '/lan/browser/interfaces/',
+                    $this->boxInfoStub->getApiUrl() . '/lan/browser/interfaces/',
                     ['headers' => $this->authSessionStub->getAuthHeader()],
                 ]),
             )

diff --git a/tests/Unit/Methods/LanWolTest.php b/tests/Unit/Methods/LanWolTest.php
@@ -53,7 +53,7 @@ public function testSetLanWol(): void
             ->with(
                 $this->equalTo('post'),
                 $this->equalTo([
-                    $this->boxInfoStub->apiUrl . '/lan/wol/pub',
+                    $this->boxInfoStub->getApiUrl() . '/lan/wol/pub',
                     [
                         'headers' => $this->authSessionStub->getAuthHeader(),
                         'json' => self::LANWOLSET,

diff --git a/tests/Unit/Methods/LanguageTest.php b/tests/Unit/Methods/LanguageTest.php
@@ -60,7 +60,7 @@ public function testGetLanguage(): void
                 $this->equalTo('get'),
                 $this->equalTo([
                     ['lang', 'avalaible'],
-                    $this->boxInfoStub->apiUrl . '/lang',
+                    $this->boxInfoStub->getApiUrl() . '/lang',
                     ['headers' => $this->authSessionStub->getAuthHeader()],
                 ]),
             )
@@ -77,7 +77,7 @@ public function testSetLanguage(): void
             ->with(
                 $this->equalTo('post'),
                 $this->equalTo([
-                    $this->boxInfoStub->apiUrl . '/lang',
+                    $this->boxInfoStub->getApiUrl() . '/lang',
                     [
                         'headers' => $this->authSessionStub->getAuthHeader(),
                         'json' => ['lang' => 'eng'],
@@ -115,7 +115,7 @@ public function testSetLanguageFail(): void
             ->with(
                 $this->equalTo('post'),
                 $this->equalTo([
-                    $this->boxInfoStub->apiUrl . '/lang',
+                    $this->boxInfoStub->getApiUrl() . '/lang',
                     [
                         'headers' => $this->authSessionStub->getAuthHeader(),
                         'json' => ['lang' => 'eng'],