Deprecate AbstractApi::post()

kbsali · Feb 26, 2024 · c516448 · c516448
1 parent 9b03c9d
commit c516448
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,6 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Deprecated
 
 - `Redmine\Api\AbstractApi::get()` is deprecated, use `\Redmine\Http\HttpClient::request()` instead.
+- `Redmine\Api\AbstractApi::post()` is deprecated, use `\Redmine\Http\HttpClient::request()` instead.
 
 ## [v2.5.0](https://github.com/kbsali/php-redmine-api/compare/v2.4.0...v2.5.0) - 2024-02-05
 

diff --git a/src/Redmine/Api/AbstractApi.php b/src/Redmine/Api/AbstractApi.php
@@ -2,7 +2,6 @@
 
 namespace Redmine\Api;
 
-use Closure;
 use InvalidArgumentException;
 use Redmine\Api;
 use Redmine\Client\Client;
@@ -142,13 +141,17 @@ protected function get($path, $decodeIfJson = true)
     /**
      * Perform the client post() method.
      *
+     * @deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead
+     *
      * @param string $path
      * @param string $data
      *
      * @return string|SimpleXMLElement|false
      */
     protected function post($path, $data)
     {
+        @trigger_error('`' . __METHOD__ . '()` is deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead.', E_USER_DEPRECATED);
+
         $this->lastResponse = $this->getHttpClient()->request(HttpFactory::makeRequest(
             'POST',
             strval($path),

diff --git a/tests/Unit/Api/AbstractApiTest.php b/tests/Unit/Api/AbstractApiTest.php
@@ -58,7 +58,12 @@ public function testGetTriggersDeprecationWarning()
     {
         $client = $this->createMock(HttpClient::class);
 
-        $api = new class ($client) extends AbstractApi {};
+        $api = new class ($client) extends AbstractApi {
+            public function runGet($path)
+            {
+                return $this->get($path);
+            }
+        };
 
         // PHPUnit 10 compatible way to test trigger_error().
         set_error_handler(
@@ -74,10 +79,7 @@ function ($errno, $errstr): bool {
             E_USER_DEPRECATED
         );
 
-        $method = new ReflectionMethod($api, 'get');
-        $method->setAccessible(true);
-
-        $method->invoke($api, '/path.json');
+        $api->runGet('/path.json');
     }
 
     /**
@@ -92,6 +94,37 @@ public function testGetLastResponseWithHttpClientWorks()
         $this->assertInstanceOf(Response::class, $api->getLastResponse());
     }
 
+    /**
+     * @covers ::post
+     */
+    public function testPostTriggersDeprecationWarning()
+    {
+        $client = $this->createMock(HttpClient::class);
+
+        $api = new class ($client) extends AbstractApi {
+            public function runPost($path, $data)
+            {
+                return $this->post($path, $data);
+            }
+        };
+
+        // PHPUnit 10 compatible way to test trigger_error().
+        set_error_handler(
+            function ($errno, $errstr): bool {
+                $this->assertSame(
+                    '`Redmine\Api\AbstractApi::post()` is deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead.',
+                    $errstr
+                );
+
+                restore_error_handler();
+                return true;
+            },
+            E_USER_DEPRECATED
+        );
+
+        $api->runPost('/path.json', 'data');
+    }
+
     /**
      * @test
      * @dataProvider getIsNotNullReturnsCorrectBooleanData