Arcanedev\LaravelTracker\Detectors\GeoIpDetector

Complexity

Total Complexity

6

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getGeoliteFileName()	0	4	1
A	search()	0	13	3
A	renderData()	0	17	1

<?php namespace Arcanedev\LaravelTracker\Detectors;

use Arcanedev\LaravelTracker\Contracts\Detectors\GeoIpDetector as GeoIpDetectorContract;
use GeoIp2\Database\Reader as GeoIpReader;
use GeoIp2\Exception\AddressNotFoundException;

/**
 * Class     GeoIpDetector
 *
 * @package  Arcanedev\LaravelTracker\Detectors
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class GeoIpDetector implements GeoIpDetectorContract
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    private $reader;

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    public function __construct()
    {
        $this->reader = new GeoIpReader($this->getGeoliteFileName());
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the geoip data.
     *
     * @param  string  $ipAddress
     *
     * @return array|null
     */
    public function search($ipAddress)
    {
        try {
            if ($cityModel = $this->reader->city($ipAddress)) {
                return $this->renderData($cityModel);
            }
        }
        catch (AddressNotFoundException $e) {
            // do nothing
        }

        return null;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Render the data.
     *
     * @param  \GeoIp2\Model\City  $cityModel
     *
     * @return array
     */
    private function renderData($cityModel)
    {
        return [
            'latitude'       => $cityModel->location->latitude,
            'longitude'      => $cityModel->location->longitude,
            'country_code'   => $cityModel->country->isoCode,
            'country_code3'  => null,
            'country_name'   => $cityModel->country->name,
            'region'         => $cityModel->continent->code,
            'city'           => $cityModel->city->name,
            'postal_code'    => $cityModel->postal->code,
            'area_code'      => null,
            'dma_code'       => null,
            'metro_code'     => $cityModel->location->metroCode,
            'continent_code' => $cityModel->continent->code,
        ];
    }

    /**
     * Get the GeoLiteFileName.
     *
     * @return string
     */
    private function getGeoliteFileName()
    {
        return __DIR__ . '/../../data/GeoLite2-City.mmdb';
    }
}