GeoIPs::executeQuery() - Code Metrics - geocoder-php/Geocoder - Measure and Improve Code Quality continuously with Scrutinizer

GeoIPs::executeQuery() D
last analyzed 2018-04-11 17:41 UTC

↳ Parent: GeoIPs

Complexity

Conditions	22
Paths	14

Size

Total Lines	89
Code Lines	61

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	89
rs	4.6625
c	0
b	0
f	0
cc	22
eloc	61
nc	14
nop	1

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of the Geocoder package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace Geocoder\Provider\GeoIPs;

use Geocoder\Collection;
use Geocoder\Exception\InvalidArgument;
use Geocoder\Exception\InvalidCredentials;
use Geocoder\Exception\InvalidServerResponse;
use Geocoder\Exception\QuotaExceeded;
use Geocoder\Exception\UnsupportedOperation;
use Geocoder\Model\Address;
use Geocoder\Model\AddressCollection;
use Geocoder\Query\GeocodeQuery;
use Geocoder\Query\ReverseQuery;
use Geocoder\Http\Provider\AbstractHttpProvider;
use Geocoder\Provider\Provider;
use Http\Client\HttpClient;

/**
 * @author Andrea Cristaudo <[email protected]>
 * @author Arthur Bodera <[email protected]>
 *
 * @see http://www.geoips.com/en/developer/api-guide
 */
final class GeoIPs extends AbstractHttpProvider implements Provider
{
    /**
     * @var string
     */
    const GEOCODE_ENDPOINT_URL = 'https://api.geoips.com/ip/%s/key/%s/output/json/timezone/true/';

    const CODE_SUCCESS = '200_1'; // The following results has been returned.

    const CODE_NOT_FOUND = '200_2'; // No result set has been returned.

    const CODE_BAD_KEY = '400_1'; // Error in the URI - The API call should include a API key parameter.

    const CODE_BAD_IP = '400_2'; // Error in the URI - The API call should include a valid IP address.

    const CODE_NOT_AUTHORIZED = '403_1'; // The API key associated with your request was not recognized.

    const CODE_ACCOUNT_INACTIVE = '403_2'; // The API key has not been approved or has been disabled.

    const CODE_LIMIT_EXCEEDED = '403_3'; // The service you have requested is over capacity.

    /**
     * @var string
     */
    private $apiKey;

    /**
     * @param HttpClient $client An HTTP adapter
     * @param string     $apiKey An API key
     */
    public function __construct(HttpClient $client, string $apiKey)
    {
        if (empty($apiKey)) {
            throw new InvalidCredentials('No API key provided.');
        }

        $this->apiKey = $apiKey;
        parent::__construct($client);
    }

    /**
     * {@inheritdoc}
     */
    public function geocodeQuery(GeocodeQuery $query): Collection
    {
        $address = $query->getText();
        if (!filter_var($address, FILTER_VALIDATE_IP)) {
            throw new UnsupportedOperation('The GeoIPs provider does not support street addresses, only IPv4 addresses.');
        }

        if (filter_var($address, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
            throw new UnsupportedOperation('The GeoIPs provider does not support IPv6 addresses, only IPv4 addresses.');
        }

        if ('127.0.0.1' === $address) {
            return new AddressCollection([$this->getLocationForLocalhost()]);
        }

        $query = sprintf(self::GEOCODE_ENDPOINT_URL, $address, $this->apiKey);

        return $this->executeQuery($query);
    }

    /**
     * {@inheritdoc}
     */
    public function reverseQuery(ReverseQuery $query): Collection
    {
        throw new UnsupportedOperation('The GeoIPs provider is not able to do reverse geocoding.');
    }

    /**
     * {@inheritdoc}
     */
    public function getName(): string
    {
        return 'geo_ips';
    }

    /**
     * @param string $url
     *
     * @return AddressCollection
     */
    private function executeQuery(string $url): AddressCollection
    {
        $content = $this->getUrlContents($url);
        $json = json_decode($content, true);

        if (isset($json['error'])) {
            switch ($json['error']['code']) {
                case static::CODE_BAD_IP:
                    throw new InvalidArgument('The API call should include a valid IP address.');
                case static::CODE_BAD_KEY:
                    throw new InvalidCredentials('The API call should include a API key parameter.');
                case static::CODE_NOT_AUTHORIZED:
                    throw new InvalidCredentials('The API key associated with your request was not recognized.');
                case static::CODE_ACCOUNT_INACTIVE:
                    throw new InvalidCredentials('The API key has not been approved or has been disabled.');
                case static::CODE_LIMIT_EXCEEDED:
                    throw new QuotaExceeded('The service you have requested is over capacity.');
                default:
                    throw new InvalidServerResponse(sprintf(
                        'GeoIPs error %s%s%s%s - query: %s',
                        $json['error']['code'],
                        isset($json['error']['status']) ? ', '.$json['error']['status'] : '',
                        isset($json['error']['message']) ? ', '.$json['error']['message'] : '',
                        isset($json['error']['notes']) ? ', '.$json['error']['notes'] : '',
                        $url
                    ));
            }
        }

        if (!is_array($json) || empty($json) || empty($json['response']) || empty($json['response']['code'])) {
            throw InvalidServerResponse::create($url);
        }

        $response = $json['response'];

        // Check response code
        switch ($response['code']) {
            case static::CODE_SUCCESS:
                // everything is ok
                break;
            case static::CODE_NOT_FOUND:
                return new AddressCollection([]);
            default:
                throw new InvalidServerResponse(sprintf(
                    'The GeoIPs API returned unknown result code "%s" for query: "%s".',
                    $response['code'],
                    $url
                ));
        }

        // Make sure that we do have proper result array
        if (empty($response['location']) || !is_array($response['location'])) {
            return new AddressCollection([]);
        }

        $location = array_map(function ($value) {
            return '' === $value ? null : $value;
        }, $response['location']);

        $adminLevels = [];

        if (null !== $location['region_name'] || null !== $location['region_code']) {
            $adminLevels[] = [
                'name' => $location['region_name'],
                'code' => $location['region_code'],
                'level' => 1,
            ];
        }

        if (null !== $location['county_name']) {
            $adminLevels[] = [
                'name' => $location['county_name'],
                'level' => 2,
            ];
        }

        $results = Address::createFromArray([
            'providedBy' => $this->getName(),
            'country' => $location['country_name'],
            'countryCode' => $location['country_code'],
            'adminLevels' => $adminLevels,
            'locality' => $location['city_name'],
            'latitude' => $location['latitude'],
            'longitude' => $location['longitude'],
            'timezone' => $location['timezone'],
        ]);

        return new AddressCollection([$results]);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Geocoder package.
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*
10			* @license MIT License
11			*/
12
13			namespace Geocoder\Provider\GeoIPs;
14
15			use Geocoder\Collection;
16			use Geocoder\Exception\InvalidArgument;
17			use Geocoder\Exception\InvalidCredentials;
18			use Geocoder\Exception\InvalidServerResponse;
19			use Geocoder\Exception\QuotaExceeded;
20			use Geocoder\Exception\UnsupportedOperation;
21			use Geocoder\Model\Address;
22			use Geocoder\Model\AddressCollection;
23			use Geocoder\Query\GeocodeQuery;
24			use Geocoder\Query\ReverseQuery;
25			use Geocoder\Http\Provider\AbstractHttpProvider;
26			use Geocoder\Provider\Provider;
27			use Http\Client\HttpClient;
28
29			/**
30			* @author Andrea Cristaudo <[email protected]>
31			* @author Arthur Bodera <[email protected]>
32			*
33			* @see http://www.geoips.com/en/developer/api-guide
34			*/
35			final class GeoIPs extends AbstractHttpProvider implements Provider
36			{
37			/**
38			* @var string
39			*/
40			const GEOCODE_ENDPOINT_URL = 'https://api.geoips.com/ip/%s/key/%s/output/json/timezone/true/';
41
42			const CODE_SUCCESS = '200_1'; // The following results has been returned.
43
44			const CODE_NOT_FOUND = '200_2'; // No result set has been returned.
45
46			const CODE_BAD_KEY = '400_1'; // Error in the URI - The API call should include a API key parameter.
47
48			const CODE_BAD_IP = '400_2'; // Error in the URI - The API call should include a valid IP address.
49
50			const CODE_NOT_AUTHORIZED = '403_1'; // The API key associated with your request was not recognized.
51
52			const CODE_ACCOUNT_INACTIVE = '403_2'; // The API key has not been approved or has been disabled.
53
54			const CODE_LIMIT_EXCEEDED = '403_3'; // The service you have requested is over capacity.
55
56			/**
57			* @var string
58			*/
59			private $apiKey;
60
61			/**
62			* @param HttpClient $client An HTTP adapter
63			* @param string $apiKey An API key
64			*/
65			public function __construct(HttpClient $client, string $apiKey)
66			{
67			if (empty($apiKey)) {
68			throw new InvalidCredentials('No API key provided.');
69			}
70
71			$this->apiKey = $apiKey;
72			parent::__construct($client);
73			}
74
75			/**
76			* {@inheritdoc}
77			*/
78			public function geocodeQuery(GeocodeQuery $query): Collection
79			{
80			$address = $query->getText();
81			if (!filter_var($address, FILTER_VALIDATE_IP)) {
82			throw new UnsupportedOperation('The GeoIPs provider does not support street addresses, only IPv4 addresses.');
83			}
84
85			if (filter_var($address, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
86			throw new UnsupportedOperation('The GeoIPs provider does not support IPv6 addresses, only IPv4 addresses.');
87			}
88
89			if ('127.0.0.1' === $address) {
90			return new AddressCollection([$this->getLocationForLocalhost()]);
91			}
92
93			$query = sprintf(self::GEOCODE_ENDPOINT_URL, $address, $this->apiKey);
94
95			return $this->executeQuery($query);
96			}
97
98			/**
99			* {@inheritdoc}
100			*/
101			public function reverseQuery(ReverseQuery $query): Collection
102			{
103			throw new UnsupportedOperation('The GeoIPs provider is not able to do reverse geocoding.');
104			}
105
106			/**
107			* {@inheritdoc}
108			*/
109			public function getName(): string
110			{
111			return 'geo_ips';
112			}
113
114			/**
115			* @param string $url
116			*
117			* @return AddressCollection
118			*/
119			private function executeQuery(string $url): AddressCollection
120			{
121			$content = $this->getUrlContents($url);
122			$json = json_decode($content, true);
123
124			if (isset($json['error'])) {
125			switch ($json['error']['code']) {
126			case static::CODE_BAD_IP:
127			throw new InvalidArgument('The API call should include a valid IP address.');
128			case static::CODE_BAD_KEY:
129			throw new InvalidCredentials('The API call should include a API key parameter.');
130			case static::CODE_NOT_AUTHORIZED:
131			throw new InvalidCredentials('The API key associated with your request was not recognized.');
132			case static::CODE_ACCOUNT_INACTIVE:
133			throw new InvalidCredentials('The API key has not been approved or has been disabled.');
134			case static::CODE_LIMIT_EXCEEDED:
135			throw new QuotaExceeded('The service you have requested is over capacity.');
136			default:
137			throw new InvalidServerResponse(sprintf(
138			'GeoIPs error %s%s%s%s - query: %s',
139			$json['error']['code'],
140			isset($json['error']['status']) ? ', '.$json['error']['status'] : '',
141			isset($json['error']['message']) ? ', '.$json['error']['message'] : '',
142			isset($json['error']['notes']) ? ', '.$json['error']['notes'] : '',
143			$url
144			));
145			}
146			}
147
148			if (!is_array($json) \|\| empty($json) \|\| empty($json['response']) \|\| empty($json['response']['code'])) {
149			throw InvalidServerResponse::create($url);
150			}
151
152			$response = $json['response'];
153
154			// Check response code
155			switch ($response['code']) {
156			case static::CODE_SUCCESS:
157			// everything is ok
158			break;
159			case static::CODE_NOT_FOUND:
160			return new AddressCollection([]);
161			default:
162			throw new InvalidServerResponse(sprintf(
163			'The GeoIPs API returned unknown result code "%s" for query: "%s".',
164			$response['code'],
165			$url
166			));
167			}
168
169			// Make sure that we do have proper result array
170			if (empty($response['location']) \|\| !is_array($response['location'])) {
171			return new AddressCollection([]);
172			}
173
174			$location = array_map(function ($value) {
175			return '' === $value ? null : $value;
176			}, $response['location']);
177
178			$adminLevels = [];
179
180			if (null !== $location['region_name'] \|\| null !== $location['region_code']) {
181			$adminLevels[] = [
182			'name' => $location['region_name'],
183			'code' => $location['region_code'],
184			'level' => 1,
185			];
186			}
187
188			if (null !== $location['county_name']) {
189			$adminLevels[] = [
190			'name' => $location['county_name'],
191			'level' => 2,
192			];
193			}
194
195			$results = Address::createFromArray([
196			'providedBy' => $this->getName(),
197			'country' => $location['country_name'],
198			'countryCode' => $location['country_code'],
199			'adminLevels' => $adminLevels,
200			'locality' => $location['city_name'],
201			'latitude' => $location['latitude'],
202			'longitude' => $location['longitude'],
203			'timezone' => $location['timezone'],
204			]);
205
206			return new AddressCollection([$results]);
207			}
208			}
209

geocoder-php / Geocoder

GitHub Access Token became invalid

GeoIPs::executeQuery() D last analyzed 2018-04-11 17:41 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

GeoIPs::executeQuery() D
last analyzed 2018-04-11 17:41 UTC