Add generic geocoder service

CHANGELOG.md

@@ -9,4 +9,7 @@ This changelog is initialized in release 1.0.0
 
 ## [Unreleased]
 
+### Added
+* Generic geocoder service
+
 [Unreleased]: https://github.com/wimski/nominatim-geocoding-api-client/compare/v1.0.0...master

README.md

@@ -74,6 +74,7 @@ $service = new NominatimGeocoderService(
 Services for the following providers are currently available:
 * [Nominatim](https://nominatim.org/release-docs/latest/api/Overview/)
 * [LocationIQ](https://locationiq.com/docs)
+* Generic: without any implementation specific headers or parameters.
 
 Custom services can easily be created by extending the `AbstractGeocoderService`
 as long as the provider implements the Nominatim spec correctly.

src/Config/GenericConfig.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wimski\Nominatim\Config;
+
+use Wimski\Nominatim\Contracts\Config\GenericConfigInterface;
+
+class GenericConfig extends AbstractConfig implements GenericConfigInterface
+{
+}

src/Contracts/Config/GenericConfigInterface.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wimski\Nominatim\Contracts\Config;
+
+interface GenericConfigInterface extends ConfigInterface
+{
+}

src/GeocoderServices/GenericGeocoderService.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wimski\Nominatim\GeocoderServices;
+
+use Wimski\Nominatim\Contracts\ClientInterface;
+use Wimski\Nominatim\Contracts\Config\ConfigInterface;
+use Wimski\Nominatim\Contracts\Config\GenericConfigInterface;
+use Wimski\Nominatim\Contracts\Transformers\GeocodingResponseTransformerInterface;
+
+class GenericGeocoderService extends AbstractGeocoderService
+{
+    public function __construct(
+        ClientInterface $client,
+        GeocodingResponseTransformerInterface $responseTransformer,
+        protected GenericConfigInterface $config,
+    ) {
+        parent::__construct($client, $responseTransformer);
+    }
+
+    protected function getConfig(): ConfigInterface
+    {
+        return $this->config;
+    }
+}

tests/Config/GenericConfigTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wimski\Nominatim\Tests\Config;
+
+use Wimski\Nominatim\Config\GenericConfig;
+use Wimski\Nominatim\Tests\AbstractTest;
+
+class GenericConfigTest extends AbstractTest
+{
+    /**
+     * @test
+     */
+    public function it_returns_set_data(): void
+    {
+        $config = new GenericConfig(
+            'https://nominatim.myserver.com',
+            '/fowarding',
+            '/reversing',
+            'nl',
+        );
+
+        static::assertSame('https://nominatim.myserver.com', $config->getUrl());
+        static::assertSame('/fowarding', $config->getForwardGeocodingEndpoint());
+        static::assertSame('/reversing', $config->getReverseGeocodingEndpoint());
+        static::assertSame('nl', $config->getLanguage());
+    }
+}

tests/GeocoderServices/GenericGeocoderServiceTest.php

@@ -0,0 +1,135 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wimski\Nominatim\Tests\GeocoderServices;
+
+use Mockery;
+use Mockery\MockInterface;
+use Psr\Http\Message\ResponseInterface;
+use Wimski\Nominatim\Contracts\ClientInterface;
+use Wimski\Nominatim\Contracts\Config\GenericConfigInterface;
+use Wimski\Nominatim\Contracts\RequestParameters\ForwardGeocodingRequestParametersInterface;
+use Wimski\Nominatim\Contracts\RequestParameters\ReverseGeocodingRequestParametersInterface;
+use Wimski\Nominatim\Contracts\Responses\ForwardGeocodingResponseInterface;
+use Wimski\Nominatim\Contracts\Responses\ReverseGeocodingResponseInterface;
+use Wimski\Nominatim\Contracts\Transformers\GeocodingResponseTransformerInterface;
+use Wimski\Nominatim\GeocoderServices\GenericGeocoderService;
+use Wimski\Nominatim\Tests\AbstractTest;
+
+class GenericGeocoderServiceTest extends AbstractTest
+{
+    protected GenericGeocoderService $service;
+
+    /**
+     * @var ClientInterface|MockInterface
+     */
+    protected $client;
+
+    /**
+     * @var GeocodingResponseTransformerInterface|MockInterface
+     */
+    protected $responseTransformer;
+
+    /**
+     * @var GenericConfigInterface|MockInterface
+     */
+    protected $config;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->client              = Mockery::mock(ClientInterface::class);
+        $this->responseTransformer = Mockery::mock(GeocodingResponseTransformerInterface::class);
+        $this->config              = Mockery::mock(GenericConfigInterface::class);
+
+        $this->config
+            ->shouldReceive('getUrl')->once()->andReturn('https://generic.server/')->getMock()
+            ->shouldReceive('getLanguage')->once()->andReturn('nl')->getMock();
+
+        $this->service = new GenericGeocoderService(
+            $this->client,
+            $this->responseTransformer,
+            $this->config,
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function it_makes_a_forward_geocoding_request(): void
+    {
+        $response = Mockery::mock(ResponseInterface::class);
+
+        $this->config
+            ->shouldReceive('getForwardGeocodingEndpoint')
+            ->once()
+            ->andReturn('/forwards');
+
+        $this->client
+            ->shouldReceive('request')
+            ->once()
+            ->with('https://generic.server/forwards', [
+                'Accept-Language' => 'nl',
+            ], [
+                'param'  => 'value',
+                'format' => 'json',
+            ])
+            ->andReturn($response);
+
+        $this->responseTransformer
+            ->shouldReceive('transformForwardResponse')
+            ->once()
+            ->with($response)
+            ->andReturn(Mockery::mock(ForwardGeocodingResponseInterface::class));
+
+        /** @var ForwardGeocodingRequestParametersInterface|MockInterface $parameters */
+        $parameters = Mockery::mock(ForwardGeocodingRequestParametersInterface::class)
+            ->shouldReceive('toArray')
+            ->once()
+            ->andReturn(['param' => 'value'])
+            ->getMock();
+
+        $this->service->requestForwardGeocoding($parameters);
+    }
+
+    /**
+     * @test
+     */
+    public function it_makes_a_reverse_geocoding_request(): void
+    {
+        $response = Mockery::mock(ResponseInterface::class);
+
+        $this->config
+            ->shouldReceive('getReverseGeocodingEndpoint')
+            ->once()
+            ->andReturn('/reversed');
+
+        $this->client
+            ->shouldReceive('request')
+            ->once()
+            ->with('https://generic.server/reversed', [
+                'Accept-Language' => 'nl',
+            ], [
+                'param'  => 'value',
+                'format' => 'json',
+            ])
+            ->andReturn($response);
+
+        $this->responseTransformer
+            ->shouldReceive('transformReverseResponse')
+            ->once()
+            ->with($response)
+            ->andReturn(Mockery::mock(ReverseGeocodingResponseInterface::class));
+
+        /** @var ReverseGeocodingRequestParametersInterface|MockInterface $parameters */
+        $parameters = Mockery::mock(ReverseGeocodingRequestParametersInterface::class)
+            ->shouldReceive('toArray')
+            ->once()
+            ->andReturn(['param' => 'value'])
+            ->getMock();
+
+        $this->service->requestReverseGeocoding($parameters);
+    }
+}