[Notifier] Fix Smsmode HttpClient mandatory headers

inwebo · inwebo · commit 1ed73feccf37 · 2023-09-12T08:59:02.000+02:00
As mentioned in the documentation https://dev.smsmode.com/sms/v1/home in section Content-Type & URL Encoding. HTTP request and response bodies are JSON objects, which is why Accept and Content-Type headers are mandatory and are implicitly added when the request is executed with the TEST button. If the Accept header is missing, a Not Acceptable (406) HTTP status code is returned. (Accept: application/json) The Content-Type header is only needed with POST and PATCH methods. If it is missing, an Unsupported Media Type (415)
diff --git a/src/Symfony/Component/Notifier/Bridge/Smsmode/SmsmodeTransport.php b/src/Symfony/Component/Notifier/Bridge/Smsmode/SmsmodeTransport.php
@@ -69,7 +69,11 @@ protected function doSend(MessageInterface $message): SentMessage
         }
 
         $response = $this->client->request('POST', $endpoint, [
-            'headers' => ['X-Api-Key' => $this->apiKey],
+            'headers' => [
+                'X-Api-Key' => $this->apiKey,
+                'Content-type' => 'application/json',
+                'Accept' => 'application/json',
+            ],
             'json' => array_filter($options),
         ]);
 
diff --git a/src/Symfony/Component/Notifier/Bridge/Smsmode/Tests/SmsmodeTransportTest.php b/src/Symfony/Component/Notifier/Bridge/Smsmode/Tests/SmsmodeTransportTest.php
@@ -12,11 +12,11 @@
 namespace Symfony\Component\Notifier\Bridge\Smsmode\Tests;
 
 use Symfony\Component\HttpClient\MockHttpClient;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Notifier\Bridge\Smsmode\SmsmodeOptions;
 use Symfony\Component\Notifier\Bridge\Smsmode\SmsmodeTransport;
 use Symfony\Component\Notifier\Exception\InvalidArgumentException;
 use Symfony\Component\Notifier\Message\ChatMessage;
-use Symfony\Component\Notifier\Message\MessageInterface;
 use Symfony\Component\Notifier\Message\SmsMessage;
 use Symfony\Component\Notifier\Test\TransportTestCase;
 use Symfony\Component\Notifier\Tests\Transport\DummyMessage;
@@ -25,6 +25,8 @@
 
 final class SmsmodeTransportTest extends TransportTestCase
 {
+    private const DEFAULT_URL = "https://rest.smsmode.com/sms/v1/messages";
+
     public static function createTransport(HttpClientInterface $client = null, string $from = 'test_from'): SmsmodeTransport
     {
         return new SmsmodeTransport('test_api_key', $from, $client ?? new MockHttpClient());
@@ -81,6 +83,44 @@ public function testNoInvalidArgumentExceptionIsThrownIfFromIsValid(string $from
         self::assertSame('foo', $sentMessage->getMessageId());
     }
 
+    public function testIfMandatoryHttpClientRequestHeaderContentTypeIsMissing()
+    {
+        $response = $this->createMock(ResponseInterface::class);
+        $response->expects(self::exactly(2))->method('getStatusCode')->willReturn(Response::HTTP_UNSUPPORTED_MEDIA_TYPE);
+
+        $options = [
+            'headers' => [
+                'X-Api-Key' => 'test_api_key',
+                'Accept' => 'application/json',
+            ],
+        ];
+
+        $client = new MockHttpClient($response);
+
+        $response = $client->request('POST', self::DEFAULT_URL, $options);
+
+        self::assertEquals(Response::HTTP_UNSUPPORTED_MEDIA_TYPE, $response->getStatusCode());
+    }
+
+    public function testIfMandatoryHttpClientRequestHeaderAcceptIsMissing()
+    {
+        $response = $this->createMock(ResponseInterface::class);
+        $response->expects(self::exactly(2))->method('getStatusCode')->willReturn(Response::HTTP_NOT_ACCEPTABLE);
+
+        $options = [
+            'headers' => [
+                'X-Api-Key' => 'test_api_key',
+                'Content-type' => 'application/json',
+            ],
+        ];
+
+        $client = new MockHttpClient($response);
+
+        $response = $client->request('POST', self::DEFAULT_URL, $options);
+
+        self::assertEquals(Response::HTTP_NOT_ACCEPTABLE, $response->getStatusCode());
+    }
+
     public static function toStringProvider(): iterable
     {
         yield ['smsmode://rest.smsmode.com?from=test_from', self::createTransport()];
