✨ add SymfonyClientRequestMethod

Author: garak

config/services.xml

@@ -10,6 +10,11 @@
             <argument>%beelab_recaptcha2.secret%</argument>
             <argument type="service" id="beelab_recaptcha2.google_recaptcha.request_method" />
         </service>
+        <service id="Beelab\Recaptcha2Bundle\Recaptcha\SymfonyClientRequestMethod" public="false">
+            <call method="setClient">
+                <argument type="service" id="Symfony\Contracts\HttpClient\HttpClientInterface" on-invalid="ignore"/>
+            </call>
+        </service>
         <service id="beelab_recaptcha2.type" class="Beelab\Recaptcha2Bundle\Form\Type\RecaptchaType" public="true">
             <argument>%beelab_recaptcha2.site_key%</argument>
             <tag name="form.type" alias="beelab_recaptcha2" />

docs/index.md

@@ -40,18 +40,22 @@ beelab_recaptcha2:
 If your PHP environment has restrictions about `file_get_contents()` making HTTP requests,
 you can use another `RequestMethod` from Google's Recaptcha library.
 
-Currently, this bundle supports the default `Post` and `CurlPost` methods.
-You can use the latter by adding in your `config.yml`:
+Currently, this bundle supports the default `Post` and `CurlPost` methods, and an additional
+method leveraging the [Symfony HTTP Client][1].
+You can define it by adding in your configuration:
 
 ```yaml
 # config/packages/beelab_recaptcha2.yaml
 
 beelab_recaptcha2:
-    request_method: curl_post
+    request_method: curl_post # or http_client
 ```
 
 Otherwise, the default value `post` will be used.
 
+If you want to use the `http_client` request method, you need to require `symfony/http-client`.
+
+
 ## 3. Usage
 
 In your form, use `Beelab\Recaptcha2Bundle\Form\Type\RecaptchaType` form type, as any other Symfony form type.
@@ -125,3 +129,4 @@ You can add to your `_form_theme.html.twig` file the following lines:
 {%- endblock %}
 ```
 
+[1]: https://symfony.com/doc/current/http_client.html

src/DependencyInjection/BeelabRecaptcha2Extension.php

@@ -2,6 +2,7 @@
 
 namespace Beelab\Recaptcha2Bundle\DependencyInjection;
 
+use Beelab\Recaptcha2Bundle\Recaptcha\SymfonyClientRequestMethod;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
@@ -30,6 +31,7 @@ private function getRequestMethod(string $requestMethod): string
     {
         return match ($requestMethod) {
             'curl_post' => CurlPost::class,
+            'http_client' => SymfonyClientRequestMethod::class,
             default => Post::class,
         };
     }

src/DependencyInjection/Configuration.php

@@ -14,7 +14,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         $rootNode
             ->children()
                 ->enumNode('request_method')
-                    ->values(['curl_post', 'post'])
+                    ->values(['curl_post', 'post', 'http_client'])
                     ->defaultValue('post')
                 ->end()
                 ->scalarNode('site_key')

src/Recaptcha/SymfonyClientRequestMethod.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Beelab\Recaptcha2Bundle\Recaptcha;
+
+use ReCaptcha\ReCaptcha;
+use ReCaptcha\RequestMethod;
+use ReCaptcha\RequestParameters;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+final class SymfonyClientRequestMethod implements RequestMethod
+{
+    private ?HttpClientInterface $client = null;
+
+    public function __construct(
+        private string $siteVerifyUrl = ReCaptcha::SITE_VERIFY_URL,
+    ) {
+    }
+
+    public function setClient(?HttpClientInterface $client): void
+    {
+        $this->client = $client;
+    }
+
+    public function submit(RequestParameters $params): string
+    {
+        if (null === $this->client) {
+            throw new \UnexpectedValueException('Needed service is not injected.');
+        }
+
+        $response = $this->client->request('POST', $this->siteVerifyUrl, [
+            'body' => $params->toQueryString(),
+            'headers' => [
+                'Content-Type' => 'application/x-www-form-urlencoded',
+            ],
+        ]);
+
+        if (200 !== $response->getStatusCode()) {
+            return '{"success": false, "error-codes": ["'.ReCaptcha::E_CONNECTION_FAILED.'"]}';
+        }
+
+        return $response->getContent();
+    }
+}

tests/Recaptcha/SymfonyClientRequestMethodTest.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Beelab\Recaptcha2Bundle\Tests\Recaptcha;
+
+use Beelab\Recaptcha2Bundle\Recaptcha\SymfonyClientRequestMethod;
+use PHPUnit\Framework\TestCase;
+use ReCaptcha\RequestParameters;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+final class SymfonyClientRequestMethodTest extends TestCase
+{
+    /** @var \PHPUnit\Framework\MockObject\MockObject|HttpClientInterface */
+    protected $client;
+
+    protected function setUp(): void
+    {
+        $this->client = $this->createMock(HttpClientInterface::class);
+    }
+
+    public function testServiceNotInjected(): void
+    {
+        $method = new SymfonyClientRequestMethod();
+        $this->expectException(\UnexpectedValueException::class);
+
+        $method->submit(new RequestParameters('', ''));
+    }
+
+    public function testRequestFailure(): void
+    {
+        $method = new SymfonyClientRequestMethod();
+        $method->setClient($this->client);
+        $response = $this->createMock(ResponseInterface::class);
+        $response->expects($this->once())->method('getStatusCode')->willReturn(404);
+        $this->client->expects($this->once())->method('request')->willReturn($response);
+        $content = $method->submit(new RequestParameters('', ''));
+        self::assertEquals('{"success": false, "error-codes": ["invalid-input-response"]}', $content);
+    }
+
+    public function testRequestSuccess(): void
+    {
+        $method = new SymfonyClientRequestMethod();
+        $method->setClient($this->client);
+        $response = $this->createMock(ResponseInterface::class);
+        $response->expects($this->once())->method('getStatusCode')->willReturn(200);
+        $response->expects($this->once())->method('getResponse')->willReturn('"OK"');
+        $this->client->expects($this->once())->method('request')->willReturn($response);
+        $content = $method->submit(new RequestParameters('', ''));
+        self::assertEquals('"OK"', $content);
+    }
+}