Add sendchatmessage api endpoint (#204)

* Implement SendChatMessage api

* Update src/Parameters/SendChatMessageParameters.php

Co-authored-by: Felix Jacobi <felix@jacobi-hamburg.net>

* Rectored code

* Fixed PHPStan

---------

Co-authored-by: Felix Jacobi <felix@jacobi-hamburg.net>

Author: samuelwei

src/BigBlueButton.php

@@ -45,6 +45,7 @@
 use BigBlueButton\Parameters\JoinMeetingParameters;
 use BigBlueButton\Parameters\PublishRecordingsParameters;
 use BigBlueButton\Parameters\PutRecordingTextTrackParameters;
+use BigBlueButton\Parameters\SendChatMessageParameters;
 use BigBlueButton\Parameters\UpdateRecordingsParameters;
 use BigBlueButton\Responses\ApiVersionResponse;
 use BigBlueButton\Responses\CreateMeetingResponse;
@@ -62,6 +63,7 @@
 use BigBlueButton\Responses\JoinMeetingResponse;
 use BigBlueButton\Responses\PublishRecordingsResponse;
 use BigBlueButton\Responses\PutRecordingTextTrackResponse;
+use BigBlueButton\Responses\SendChatMessageResponse;
 use BigBlueButton\Responses\UpdateRecordingsResponse;
 use BigBlueButton\Util\UrlBuilder;
 
@@ -478,6 +480,23 @@ public function insertDocument(InsertDocumentParameters $insertDocumentParams):
         return new InsertDocumentResponse($xml);
     }
 
+    public function getSendChatMessageUrl(SendChatMessageParameters $sendChatMessageParams): string
+    {
+        return $this->urlBuilder->buildUrl(ApiMethod::SEND_CHAT_MESSAGE, $sendChatMessageParams->getHTTPQuery());
+    }
+
+    /**
+     * @throws NetworkException
+     * @throws ParsingException
+     * @throws RuntimeException
+     */
+    public function getSendChatMessage(SendChatMessageParameters $sendChatMessageParams): SendChatMessageResponse
+    {
+        $xml = $this->processXmlResponse($this->getSendChatMessageUrl($sendChatMessageParams));
+
+        return new SendChatMessageResponse($xml);
+    }
+
     /* ____________________ SPECIAL METHODS ___________________ */
 
     public function getJSessionId(): ?string

src/Enum/ApiMethod.php

@@ -45,4 +45,5 @@ enum ApiMethod: string
     case HOOKS_LIST = 'hooks/list';
     case HOOKS_DESTROY = 'hooks/destroy';
     case INSERT_DOCUMENT = 'insertDocument';
+    case SEND_CHAT_MESSAGE = 'sendChatMessage';
 }

src/Http/Transport/CurlTransport.php

@@ -88,9 +88,8 @@ public function request(TransportRequest $request): TransportResponse
 
         $ch = curl_init();
         // @codeCoverageIgnoreStart
-        /* @phpstan-ignore-next-line */
         if (!$ch) {
-            throw new RuntimeException('Could not create curl instance. Error: '.curl_error($ch));
+            throw new RuntimeException('Could not create curl instance.');
         }
         // @codeCoverageIgnoreEnd
 

src/Parameters/SendChatMessageParameters.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of littleredbutton/bigbluebutton-api-php.
+ *
+ * littleredbutton/bigbluebutton-api-php is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * littleredbutton/bigbluebutton-api-php is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with littleredbutton/bigbluebutton-api-php. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace BigBlueButton\Parameters;
+
+/**
+ * Class SendChatMessageParameters.
+ *
+ * @method string      getMeetingID()
+ * @method $this       setMeetingID(string $id)
+ * @method string      getMessage()
+ * @method $this       setMessage(string $message)
+ * @method string|null getUserName()
+ * @method $this       setUserName(string $userName)
+ */
+final class SendChatMessageParameters extends BaseParameters
+{
+    public function __construct(protected string $meetingID, protected string $message, protected ?string $userName = null)
+    {
+    }
+}

src/Responses/SendChatMessageResponse.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of littleredbutton/bigbluebutton-api-php.
+ *
+ * littleredbutton/bigbluebutton-api-php is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * littleredbutton/bigbluebutton-api-php is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with littleredbutton/bigbluebutton-api-php. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace BigBlueButton\Responses;
+
+final class SendChatMessageResponse extends BaseResponse
+{
+}