Fix typo for singular getMessageActions

pubnub · Jan 9, 2025 · 994ac54 · 994ac54
1 parent 277ad5a
commit 994ac54
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 15 deletions.
diff --git a/src/PubNub/Endpoints/MessageActions/GetMessageAction.php b/src/PubNub/Endpoints/MessageActions/GetMessageAction.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace PubNub\Endpoints\MessageActions;
+
+use PubNub\PubNub;
+use PubNub\Endpoints\MessageActions\GetMessageActions;
+
+// TODO: Remove in 8.0.0
+/** @package PubNub\Endpoints\MessageActions */
+class GetMessageAction extends GetMessageActions
+{
+    public function __construct(PubNub $pubnub)
+    {
+        trigger_error("This class is deprecated. Please use GetMessageActions instead.", E_USER_DEPRECATED);
+        parent::__construct($pubnub);
+    }
+}
diff --git a/src/PubNub/Endpoints/MessageActions/GetMessageActions.php b/src/PubNub/Endpoints/MessageActions/GetMessageActions.php
@@ -8,7 +8,7 @@
 use PubNub\Enums\PNOperationType;
 use PubNub\Exceptions\PubNubValidationException;
 use PubNub\Exceptions\PubNubBuildRequestException;
-use PubNub\Models\Consumer\MessageActions\PNGetMessageActionResult;
+use PubNub\Models\Consumer\MessageActions\PNGetMessageActionsResult;
 
 /** @package PubNub\Endpoints\MessageActions */
 class GetMessageActions extends Endpoint
@@ -17,7 +17,7 @@ class GetMessageActions extends Endpoint
     protected int $endpointConnectTimeout;
     protected int $endpointRequestTimeout;
     protected string $endpointHttpMethod = PNHttpMethod::GET;
-    protected int $endpointOperationType = PNOperationType::PNGetMessageActionOperation;
+    protected int $endpointOperationType = PNOperationType::PNGetMessageActionsOperation;
     protected string $endpointName = "Get Message Actions";
 
     protected const GET_PATH = "/v1/message-actions/%s/channel/%s";
@@ -135,19 +135,19 @@ protected function buildPath()
     }
 
     /**
-     * @return PNGetMessageActionResult
+     * @return PNGetMessageActionsResult
      */
-    public function sync(): PNGetMessageActionResult
+    public function sync(): PNGetMessageActionsResult
     {
         return parent::sync();
     }
 
     /**
      * @param array<string, string> $json Decoded json
-     * @return PNGetMessageActionResult
+     * @return PNGetMessageActionsResult
      */
-    protected function createResponse($json): PNGetMessageActionResult
+    protected function createResponse($json): PNGetMessageActionsResult
     {
-        return PNGetMessageActionResult::fromJson($json);
+        return PNGetMessageActionsResult::fromJson($json);
     }
 }
diff --git a/src/PubNub/Endpoints/MessageActions/RemoveMessageAction.php b/src/PubNub/Endpoints/MessageActions/RemoveMessageAction.php
@@ -17,7 +17,7 @@ class RemoveMessageAction extends Endpoint
     protected int $endpointConnectTimeout;
     protected int $endpointRequestTimeout;
     protected string $endpointHttpMethod = PNHttpMethod::DELETE;
-    protected int $endpointOperationType = PNOperationType::PNGetMessageActionOperation;
+    protected int $endpointOperationType = PNOperationType::PNRemoveMessageActionOperation;
     protected string $endpointName = "Get Message Actions";
 
     protected const DELETE_PATH = "/v1/message-actions/%s/channel/%s/message/%s/action/%s";

diff --git a/src/PubNub/Enums/PNOperationType.php b/src/PubNub/Enums/PNOperationType.php
@@ -72,5 +72,6 @@ class PNOperationType
     const PNSendFileNotification = 52;
 
     const PNAddMessageActionOperation = 53;
-    const PNGetMessageActionOperation = 54;
+    const PNGetMessageActionsOperation = 54;
+    const PNRemoveMessageActionOperation = 55;
 }
diff --git a/...ssageActions/PNGetMessageActionResult.php → ...sageActions/PNGetMessageActionsResult.php b/...ssageActions/PNGetMessageActionResult.php → ...sageActions/PNGetMessageActionsResult.php
@@ -4,7 +4,7 @@
 
 use PubNub\Models\Consumer\MessageActions\PNMessageAction;
 
-class PNGetMessageActionResult extends PNMessageAction
+class PNGetMessageActionsResult extends PNMessageAction
 {
     /**
      *
@@ -15,7 +15,7 @@ class PNGetMessageActionResult extends PNMessageAction
     /**
      *
      * @param mixed $json
-     * @return PNGetMessageActionResult
+     * @return PNGetMessageActionsResult
           */
     public static function fromJson(mixed $json): self
     {

diff --git a/src/PubNub/PubNub.php b/src/PubNub/PubNub.php
@@ -3,6 +3,7 @@
 namespace PubNub;
 
 use Monolog\Logger;
+use PHPUnit\Framework\Error\Deprecated;
 use PubNub\Builders\SubscribeBuilder;
 use PubNub\Callbacks\SubscribeCallback;
 use PubNub\Endpoints\Access\Audit;
@@ -56,6 +57,7 @@
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\NullLogger;
 use PubNub\Endpoints\FileSharing\{SendFile, DeleteFile, DownloadFile, GetFileDownloadUrl, ListFiles};
+use PubNub\Endpoints\MessageActions\GetMessageAction;
 use PubNub\Models\Consumer\AccessManager\PNAccessManagerTokenResult;
 
 class PubNub implements LoggerAwareInterface
@@ -616,6 +618,13 @@ public function addMessageAction(): AddMessageAction
         return new AddMessageAction($this);
     }
 
+    // TODO: Remove in 8.0.0
+    public function getMessageAction(): GetMessageAction
+    {
+        trigger_error("This method is deprecated. Use getMessageActions()", E_USER_DEPRECATED);
+        return new GetMessageAction($this);
+    }
+
     public function getMessageActions(): GetMessageActions
     {
         return new GetMessageActions($this);

diff --git a/tests/integrational/MessageActionsTest.php b/tests/integrational/MessageActionsTest.php
@@ -3,7 +3,7 @@
 namespace Tests\Integrational;
 
 use PubNub\Models\Consumer\MessageActions\PNAddMessageActionResult;
-use PubNub\Models\Consumer\MessageActions\PNGetMessageActionResult;
+use PubNub\Models\Consumer\MessageActions\PNGetMessageActionsResult;
 use PubNub\Models\Consumer\MessageActions\PNMessageAction;
 use PubNub\Models\Consumer\MessageActions\PNRemoveMessageActionResult;
 
@@ -56,15 +56,15 @@ public function testAddMessageAction(): void
         $this->assertEquals($this->messageTimetoken, $addMessageActionResult->messageTimetoken);
     }
 
-    public function testGetMessageAction(): void
+    public function testGetMessageActions(): void
     {
         $addMessageActionResult = $this->addTestMessageAction();
         $getMessageActionsResult = $this->pubnub->getMessageActions()
             ->channel($this->channelName)
             ->sync();
 
         $this->assertNotNull($getMessageActionsResult);
-        $this->assertInstanceOf(PNGetMessageActionResult::class, $getMessageActionsResult);
+        $this->assertInstanceOf(PNGetMessageActionsResult::class, $getMessageActionsResult);
         $this->assertNotEmpty($getMessageActionsResult->actions);
         $this->assertCount(1, $getMessageActionsResult->actions);
 
@@ -85,7 +85,7 @@ public function testDeleteMessageAction(): void
             ->sync();
 
         $this->assertNotNull($getMessageActionsResult);
-        $this->assertInstanceOf(PNGetMessageActionResult::class, $getMessageActionsResult);
+        $this->assertInstanceOf(PNGetMessageActionsResult::class, $getMessageActionsResult);
         $this->assertNotEmpty($getMessageActionsResult->actions);
         $this->assertCount(1, $getMessageActionsResult->actions);