oselya/ip-geolocation-bundle

Symfony IP geolocation bundle

0.0.4 2024-01-02 10:55 UTC

Requires

• php: >=8.1
• geoip2/geoip2: ^2.12
• guzzlehttp/guzzle: ^7.4
• symfony/cache: ^6.0|^7.0
• symfony/config: ^6.0|^7.0
• symfony/console: ^6.0|^7.0
• symfony/dependency-injection: ^6.0|^7.0
• symfony/deprecation-contracts: ^3.0
• symfony/http-kernel: ^6.0|^7.0
• symfony/intl: ^6.0|^7.0
• symfony/yaml: ^6.0|^7.0

Requires (Dev)

• phpunit/phpunit: ^9.5
• symfony/phpunit-bridge: ^6.0|^7.0

MIT

README

Install

composer req oselya/ip-geolocation-bundle

Before we get started, there is a small amount of configuration needed

# app/config/ip_geolocation.yaml

ip_geolocation:
  cache_ttl: -1
  maxmind:
    city_path: 'GeoLite2-City.mmdb'
  ip_api_com:
    access_key: 'qwerty'

Cli command

$ bin/console app:ip:location 92.253.204.162
+----------------+-----------+---------+-----------------+-----------------+
| IP             | Continent | Country | Latitude        | Longitude       |
+----------------+-----------+---------+-----------------+-----------------+
| 92.253.204.162 | EU        | UA      | 48.342449188232 | 24.575370788574 |
+----------------+-----------+---------+-----------------+-----------------+

Service

<?php

declare(strict_types=1);

namespace Oselya\IpGeolocationBundle\Command;

use Oselya\IpGeolocationBundle\GeoIpProvider\GeoIpProviderInterface;
use Oselya\IpGeolocationBundle\ValueObject\Ip;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class IpGeolocationCommand extends Command
{
    public function __construct(private readonly GeoIpProviderInterface $provider)
    {
        parent::__construct();
    }

    protected function configure(): void
    {
        $this
            ->setName('app:ip:location')
            ->addArgument('ip', InputArgument::REQUIRED, 'The IP address.')
            ->setDescription('This command allows you to lookup location of IP addresses.');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $location = $this->provider->ipLookup(new Ip($input->getArgument('ip')));

        $table = new Table($output);
        $table
            ->setHeaders(['IP', 'Continent', 'Country', 'Latitude', 'Longitude'])
            ->setRows([
                [
                    $input->getArgument('ip'),
                    $location->getContinent(),
                    $location->getCountry(),
                    $location->getLatitude(),
                    $location->getLongitude(),
                ],
            ]);
        $table->render();

        return Command::SUCCESS;
    }
}