Refactoring base url #38

Author: BushlanovDev

README.md

@@ -85,7 +85,7 @@ $client = new \BushlanovDev\MaxMessengerBot\Client(
     httpClient: $guzzle,
     requestFactory: $httpFactory,
     streamFactory: $httpFactory,
-    baseUrl: 'https://platform-api2.max.ru',
+    baseUrl: BushlanovDev\MaxMessengerBot\Api::API_BASE_URL,
 );
 
 $api = new BushlanovDev\MaxMessengerBot\Api(

docs/README.md

@@ -99,7 +99,7 @@ $client = new \BushlanovDev\MaxMessengerBot\Client(
     httpClient: $guzzle,
     requestFactory: $httpFactory,
     streamFactory: $httpFactory,
-    baseUrl: 'https://platform-api2.max.ru',
+    baseUrl: BushlanovDev\MaxMessengerBot\Api::API_BASE_URL,
 );
 
 $api = new BushlanovDev\MaxMessengerBot\Api(

src/Api.php

@@ -48,11 +48,11 @@
  */
 class Api
 {
-    public const string LIBRARY_VERSION = '1.6.5';
+    public const string API_BASE_URL = 'https://platform-api2.max.ru';
 
-    public const string API_VERSION = '1.2.5';
+    public const string LIBRARY_VERSION = '1.6.6';
 
-    private const string API_BASE_URL = 'https://platform-api2.max.ru';
+    public const string API_VERSION = '1.2.5';
 
     private const string METHOD_GET = 'GET';
     private const string METHOD_POST = 'POST';

src/Enums/ChatAdminPermission.php

@@ -17,8 +17,8 @@ enum ChatAdminPermission: string
     case Write = 'write';
     case CanCall = 'can_call';
     case EditLink = 'edit_link';
-    case PostEditDeleteMessage = 'post_edit_delete_message';
-    case EditMessage = 'edit_message';
+    case PostEditDeleteMessage = 'post_edit_delete_message';  // @deprecated use write
+    case EditMessage = 'edit_message'; // @deprecated use edit
     case DeleteMessage = 'delete_message';
     case Delete = 'delete';
     case Edit = 'edit';

src/Laravel/MaxBotServiceProvider.php

@@ -76,7 +76,7 @@ public function register(): void
                 $guzzle,
                 $httpFactory,
                 $httpFactory,
-                $config->get('maxbot.base_url', 'https://platform-api2.max.ru'),
+                empty($config->get('maxbot.base_url')) ? Api::API_BASE_URL : $config->get('maxbot.base_url'),
                 $config->get('maxbot.api_version'),
                 $logger,
             );

src/Laravel/config/maxbot.php

@@ -36,7 +36,7 @@
     | Configuration for the Max Bot API connection.
     |
     */
-    'base_url' => env('MAXBOT_BASE_URL', 'https://botapi.max.ru'),
+    'base_url' => env('MAXBOT_BASE_URL', \BushlanovDev\MaxMessengerBot\Api::API_BASE_URL),
     'api_version' => env('MAXBOT_API_VERSION'),
 
     /*

tests/ClientTest.php

@@ -37,8 +37,8 @@
 final class ClientTest extends TestCase
 {
     private const string FAKE_TOKEN = '12345:abcdef';
-    private const string API_VERSION = '0.0.6';
-    private const string API_BASE_URL = 'https://platform-api.max.ru';
+    private const string API_VERSION = '1.2.5';
+    private const string API_BASE_URL = 'https://platform-api2.max.ru';
 
     private MockObject&ClientInterface $httpClientMock;
     private MockObject&RequestFactoryInterface $requestFactoryMock;

tests/Laravel/MaxBotServiceProviderTest.php

@@ -182,6 +182,30 @@ public function clientIsConfiguredCorrectlyFromConfig(): void
         $this->assertSame('test-version', $apiVersionProp->getValue($client));
     }
 
+    /**
+     * @return array<string, array{0: mixed}>
+     */
+    public static function falsyBaseUrlProvider(): array
+    {
+        return [
+            'null (MAXBOT_BASE_URL unset)' => [null],
+            'empty string' => [''],
+        ];
+    }
+
+    #[Test]
+    #[DataProvider('falsyBaseUrlProvider')]
+    public function clientFallsBackToApiBaseUrlConstantWhenBaseUrlIsFalsy(mixed $falsyBaseUrl): void
+    {
+        $this->app['config']->set('maxbot.base_url', $falsyBaseUrl);
+
+        /** @var Client $client */
+        $client = $this->app->make(ClientApiInterface::class);
+
+        $baseUrlProp = (new ReflectionClass($client))->getProperty('baseUrl');
+        $this->assertSame(Api::API_BASE_URL, $baseUrlProp->getValue($client));
+    }
+
     #[Test]
     public function clientIsConfiguredWithApplicationLoggerWhenLoggingIsEnabled(): void
     {