Arcanedev\GeoIP\Drivers\IpApiDriver

Complexity

Total Complexity

7

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

83.33%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	isSecure()	0	4	1
A	init()	0	8	1
B	locate()	0	26	2
A	getHttpClientConfig()	0	20	3

<?php namespace Arcanedev\GeoIP\Drivers;

use Arcanedev\GeoIP\Entities\Continents;
use Exception;
use GuzzleHttp\Client;

/**
 * Class     IpApiDriver
 *
 * @package  Arcanedev\GeoIP\Drivers
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class IpApiDriver extends AbstractDriver
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * Http client instance.
     *
     * @var \GuzzleHttp\Client
     */
    protected $client;

    /**
     * A collection of continents.
     *
     * @var \Arcanedev\GeoIP\Entities\Continents
     */
    protected $continents;

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Init the driver.
     */
    protected function init()
    {
        $this->client = new Client(
            $this->getHttpClientConfig()
        );

        $this->continents = Continents::load();
    }

    /**
     * Locate the ip address.
     *
     * @param  string  $ipAddress
     *
     * @return \Arcanedev\GeoIP\Location
     *
     * @throws \Exception
     */
    public function locate($ipAddress)
    {
        $response = $this->client->get("json/$ipAddress");

        // Parse body content
        $data = json_decode($response->getBody());

        // Verify response status
        if ($data->status !== 'success') {
            throw new Exception("Request failed ({$data->message})");
        }

        return $this->hydrate([
            'ip'          => $ipAddress,
            'iso_code'    => $data->countryCode,
            'country'     => $data->country,
            'city'        => $data->city,
            'state'       => $data->regionName,
            'state_code'  => $data->region,
            'postal_code' => $data->zip,
            'latitude'    => $data->lat,
            'longitude'   => $data->lon,
            'timezone'    => $data->timezone,
            'continent'   => $this->continents->get($data->countryCode, 'Unknown'),
        ]);
    }

    /**
     * Get the http client config.
     *
     * @return array
     */
    private function getHttpClientConfig()
    {
        $config = [
            'base_uri' => 'http://ip-api.com/',
            'headers' => [
                'User-Agent' => 'Laravel-GeoIP',
            ],
            'query' => [
                'fields' => 16895,
            ],
        ];

        // Using the Pro service
        if ($this->getOption('key')) {
            $config['base_uri']     = $this->isSecure() ? 'https://pro.ip-api.com/' : 'http://pro.ip-api.com/';
            $config['query']['key'] = $this->getOption('key');
        }

        return $config;
    }

    /**
     * Check if secure url.
     *
     * @return bool
     */
    private function isSecure()
    {
        return (bool) $this->getOption('secure');
    }
}