Moved Ip resolvers to the Resolver subnamespace

module/IpGeolocation/test/Resolver/ChainIpLocationResolverTest.php

@@ -0,0 +1,77 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\IpGeolocation\Resolver;
+
+use PHPUnit\Framework\TestCase;
+use Prophecy\Prophecy\ObjectProphecy;
+use Shlinkio\Shlink\Common\Exception\WrongIpException;
+use Shlinkio\Shlink\IpGeolocation\Model\Location;
+use Shlinkio\Shlink\IpGeolocation\Resolver\ChainIpLocationResolver;
+use Shlinkio\Shlink\IpGeolocation\Resolver\IpLocationResolverInterface;
+
+class ChainIpLocationResolverTest extends TestCase
+{
+    /** @var ChainIpLocationResolver */
+    private $resolver;
+    /** @var ObjectProphecy */
+    private $firstInnerResolver;
+    /** @var ObjectProphecy */
+    private $secondInnerResolver;
+
+    public function setUp(): void
+    {
+        $this->firstInnerResolver = $this->prophesize(IpLocationResolverInterface::class);
+        $this->secondInnerResolver = $this->prophesize(IpLocationResolverInterface::class);
+
+        $this->resolver = new ChainIpLocationResolver(
+            $this->firstInnerResolver->reveal(),
+            $this->secondInnerResolver->reveal()
+        );
+    }
+
+    /** @test */
+    public function throwsExceptionWhenNoInnerResolverCanHandleTheResolution()
+    {
+        $ipAddress = '1.2.3.4';
+
+        $firstResolve = $this->firstInnerResolver->resolveIpLocation($ipAddress)->willThrow(WrongIpException::class);
+        $secondResolve = $this->secondInnerResolver->resolveIpLocation($ipAddress)->willThrow(WrongIpException::class);
+
+        $this->expectException(WrongIpException::class);
+        $firstResolve->shouldBeCalledOnce();
+        $secondResolve->shouldBeCalledOnce();
+
+        $this->resolver->resolveIpLocation($ipAddress);
+    }
+
+    /** @test */
+    public function returnsResultOfFirstInnerResolver(): void
+    {
+        $ipAddress = '1.2.3.4';
+
+        $firstResolve = $this->firstInnerResolver->resolveIpLocation($ipAddress)->willReturn(Location::emptyInstance());
+        $secondResolve = $this->secondInnerResolver->resolveIpLocation($ipAddress)->willThrow(WrongIpException::class);
+
+        $this->resolver->resolveIpLocation($ipAddress);
+
+        $firstResolve->shouldHaveBeenCalledOnce();
+        $secondResolve->shouldNotHaveBeenCalled();
+    }
+
+    /** @test */
+    public function returnsResultOfSecondInnerResolver(): void
+    {
+        $ipAddress = '1.2.3.4';
+
+        $firstResolve = $this->firstInnerResolver->resolveIpLocation($ipAddress)->willThrow(WrongIpException::class);
+        $secondResolve = $this->secondInnerResolver->resolveIpLocation($ipAddress)->willReturn(
+            Location::emptyInstance()
+        );
+
+        $this->resolver->resolveIpLocation($ipAddress);
+
+        $firstResolve->shouldHaveBeenCalledOnce();
+        $secondResolve->shouldHaveBeenCalledOnce();
+    }
+}

module/IpGeolocation/test/Resolver/EmptyIpLocationResolverTest.php

@@ -0,0 +1,41 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\IpGeolocation\Resolver;
+
+use PHPUnit\Framework\TestCase;
+use Shlinkio\Shlink\Common\Util\StringUtilsTrait;
+use Shlinkio\Shlink\IpGeolocation\Model\Location;
+use Shlinkio\Shlink\IpGeolocation\Resolver\EmptyIpLocationResolver;
+
+use function Functional\map;
+use function range;
+
+class EmptyIpLocationResolverTest extends TestCase
+{
+    use StringUtilsTrait;
+
+    /** @var EmptyIpLocationResolver */
+    private $resolver;
+
+    public function setUp(): void
+    {
+        $this->resolver = new EmptyIpLocationResolver();
+    }
+
+    /**
+     * @test
+     * @dataProvider provideEmptyResponses
+     */
+    public function alwaysReturnsAnEmptyLocation(string $ipAddress): void
+    {
+        $this->assertEquals(Location::emptyInstance(), $this->resolver->resolveIpLocation($ipAddress));
+    }
+
+    public function provideEmptyResponses(): array
+    {
+        return map(range(0, 5), function () {
+            return [$this->generateRandomString(15)];
+        });
+    }
+}

module/IpGeolocation/test/Resolver/GeoLite2LocationResolverTest.php

@@ -0,0 +1,66 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\IpGeolocation\Resolver;
+
+use GeoIp2\Database\Reader;
+use GeoIp2\Exception\AddressNotFoundException;
+use GeoIp2\Model\City;
+use MaxMind\Db\Reader\InvalidDatabaseException;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Prophecy\ObjectProphecy;
+use Shlinkio\Shlink\Common\Exception\WrongIpException;
+use Shlinkio\Shlink\IpGeolocation\Model\Location;
+use Shlinkio\Shlink\IpGeolocation\Resolver\GeoLite2LocationResolver;
+
+class GeoLite2LocationResolverTest extends TestCase
+{
+    /** @var GeoLite2LocationResolver */
+    private $resolver;
+    /** @var ObjectProphecy */
+    private $reader;
+
+    public function setUp(): void
+    {
+        $this->reader = $this->prophesize(Reader::class);
+        $this->resolver = new GeoLite2LocationResolver($this->reader->reveal());
+    }
+
+    /**
+     * @test
+     * @dataProvider provideReaderExceptions
+     */
+    public function exceptionIsThrownIfReaderThrowsException(string $e, string $message): void
+    {
+        $ipAddress = '1.2.3.4';
+
+        $cityMethod = $this->reader->city($ipAddress)->willThrow($e);
+
+        $this->expectException(WrongIpException::class);
+        $this->expectExceptionMessage($message);
+        $this->expectExceptionCode(0);
+        $cityMethod->shouldBeCalledOnce();
+
+        $this->resolver->resolveIpLocation($ipAddress);
+    }
+
+    public function provideReaderExceptions(): iterable
+    {
+        yield 'invalid IP address' => [AddressNotFoundException::class, 'Provided IP "1.2.3.4" is invalid'];
+        yield 'invalid geolite DB' => [InvalidDatabaseException::class, 'Provided GeoLite2 db file is invalid'];
+    }
+
+    /** @test */
+    public function resolvedCityIsProperlyMapped(): void
+    {
+        $ipAddress = '1.2.3.4';
+        $city = new City([]);
+
+        $cityMethod = $this->reader->city($ipAddress)->willReturn($city);
+
+        $result = $this->resolver->resolveIpLocation($ipAddress);
+
+        $this->assertEquals(Location::emptyInstance(), $result);
+        $cityMethod->shouldHaveBeenCalledOnce();
+    }
+}

module/IpGeolocation/test/Resolver/IpApiLocationResolverTest.php

@@ -0,0 +1,56 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\IpGeolocation\Resolver;
+
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\TransferException;
+use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Prophecy\ObjectProphecy;
+use Shlinkio\Shlink\Common\Exception\WrongIpException;
+use Shlinkio\Shlink\IpGeolocation\Model\Location;
+use Shlinkio\Shlink\IpGeolocation\Resolver\IpApiLocationResolver;
+
+use function json_encode;
+
+class IpApiLocationResolverTest extends TestCase
+{
+    /** @var IpApiLocationResolver */
+    private $ipResolver;
+    /** @var ObjectProphecy */
+    private $client;
+
+    public function setUp(): void
+    {
+        $this->client = $this->prophesize(Client::class);
+        $this->ipResolver = new IpApiLocationResolver($this->client->reveal());
+    }
+
+    /** @test */
+    public function correctIpReturnsDecodedInfo(): void
+    {
+        $actual = [
+            'countryCode' => 'bar',
+            'lat' => 5,
+            'lon' => 10,
+        ];
+        $expected = new Location('bar', '', '', '', 5, 10, '');
+        $response = new Response();
+        $response->getBody()->write(json_encode($actual));
+        $response->getBody()->rewind();
+
+        $this->client->get('http://ip-api.com/json/1.2.3.4')->willReturn($response)
+                                                            ->shouldBeCalledOnce();
+        $this->assertEquals($expected, $this->ipResolver->resolveIpLocation('1.2.3.4'));
+    }
+
+    /** @test */
+    public function guzzleExceptionThrowsShlinkException(): void
+    {
+        $this->client->get('http://ip-api.com/json/1.2.3.4')->willThrow(new TransferException())
+                                                            ->shouldBeCalledOnce();
+        $this->expectException(WrongIpException::class);
+        $this->ipResolver->resolveIpLocation('1.2.3.4');
+    }
+}