Skip to content

Commit d2e7419

Browse files
sidzsidz
authored
[IpStack] Provide Administrative area (#1246)
1 parent eb44f3f commit d2e7419

File tree

4 files changed

+38
-26
lines changed

4 files changed

+38
-26
lines changed

‎src/Provider/Ipstack/Ipstack.php‎

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,21 @@ public function geocodeQuery(GeocodeQuery $query): Collection
7373
$url = sprintf('%s&language=%s', $url, $query->getLocale());
7474
}
7575

76+
return $this->executeQuery($url);
77+
}
78+
79+
public function reverseQuery(ReverseQuery $query): Collection
80+
{
81+
throw new UnsupportedOperation('The Ipstack provider is not able to do reverse geocoding.');
82+
}
83+
84+
public function getName(): string
85+
{
86+
return 'ipstack';
87+
}
88+
89+
private function executeQuery(string $url): AddressCollection
90+
{
7691
$body = $this->getUrlContents($url);
7792
$data = json_decode($body, true);
7893

@@ -99,26 +114,17 @@ public function geocodeQuery(GeocodeQuery $query): Collection
99114
return new AddressCollection([]);
100115
}
101116

102-
$locations[] = Address::createFromArray([
103-
'providedBy' => $this->getName(),
104-
'latitude' => $data['latitude'] ?: null,
105-
'longitude' => $data['longitude'] ?: null,
106-
'locality' => $data['city'] ?: null,
107-
'postalCode' => $data['zip'] ?: null,
108-
'country' => $data['country_name'] ?: null,
109-
'countryCode' => $data['country_code'] ?: null,
117+
return new AddressCollection([
118+
Address::createFromArray([
119+
'providedBy' => $this->getName(),
120+
'latitude' => $data['latitude'] ?? null,
121+
'longitude' => $data['longitude'] ?? null,
122+
'locality' => $data['city'] ?? null,
123+
'postalCode' => $data['zip'] ?? null,
124+
'country' => $data['country_name'] ?? null,
125+
'adminLevels' => isset($data['region_name']) ? [['name' => $data['region_name'], 'level' => 1]] : [],
126+
'countryCode' => $data['country_code'] ?? null,
127+
]),
110128
]);
111-
112-
return new AddressCollection($locations);
113-
}
114-
115-
public function reverseQuery(ReverseQuery $query): Collection
116-
{
117-
throw new UnsupportedOperation('The Ipstack provider is not able to do reverse geocoding.');
118-
}
119-
120-
public function getName(): string
121-
{
122-
return 'ipstack';
123129
}
124130
}

‎src/Provider/Ipstack/Tests/.cached_responses/api.ipstack.com_8c54dbc41778b06f3d6701959abd823ece0ac790‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
s:562:"{"ip":"74.200.247.59","type":"ipv4","continent_code":"NA","continent_name":"Am\u00e9rique du Nord","country_code":"US","country_name":"\u00c9tats-Unis","region_code":null,"region_name":null,"city":null,"zip":null,"latitude":37.751,"longitude":-97.822,"location":{"geoname_id":null,"capital":"Washington D.C.","languages":[{"code":"en","name":"English","native":"English"}],"country_flag":"http:\/\/assets.ipstack.com\/flags\/us.svg","country_flag_emoji":"\ud83c\uddfa\ud83c\uddf8","country_flag_emoji_unicode":"U+1F1FA U+1F1F8","calling_code":"1","is_eu":false}}";
1+
s:1120:"{"ip":"74.200.247.59","type":"ipv4","continent_code":"NA","continent_name":"Am\u00e9rique du Nord","country_code":"US","country_name":"\u00c9tats-Unis","region_code":"NJ","region_name":"New Jersey","city":"Jersey City","zip":"07311","latitude":40.724,"longitude":-74.059,"msa":"35620","dma":"501","radius":null,"ip_routing_type":"fixed","connection_type":"tx","location":{"geoname_id":5099836,"capital":"Washington D.C.","languages":[{"code":"en","name":"English","native":"English"}],"country_flag":"https://assets.ipstack.com/flags/us.svg","country_flag_emoji":"\ud83c\uddfa\ud83c\uddf8","country_flag_emoji_unicode":"U+1F1FA U+1F1F8","calling_code":"1","is_eu":false},"time_zone":{"id":"America/New_York","current_time":"2025-02-16T06:13:52-05:00","gmt_offset":-18000,"code":"EST","is_daylight_saving":false},"currency":{"code":"USD","name":"US Dollar","plural":"US dollars","symbol":"$","symbol_native":"$"},"connection":{"asn":19994,"isp":"Rackspace Hosting","sld":null,"tld":null,"carrier":"rackspace hosting","home":false,"organization_type":"Internet Hosting Services","isic_code":"J6311","naics_code":"518210"}}";

‎src/Provider/Ipstack/Tests/.cached_responses/api.ipstack.com_f92238d9cf3edf827c645b7d7b20046b310dbf29‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
s:552:"{"ip":"74.200.247.59","type":"ipv4","continent_code":"NA","continent_name":"North America","country_code":"US","country_name":"United States","region_code":null,"region_name":null,"city":null,"zip":null,"latitude":37.751,"longitude":-97.822,"location":{"geoname_id":null,"capital":"Washington D.C.","languages":[{"code":"en","name":"English","native":"English"}],"country_flag":"http:\/\/assets.ipstack.com\/flags\/us.svg","country_flag_emoji":"\ud83c\uddfa\ud83c\uddf8","country_flag_emoji_unicode":"U+1F1FA U+1F1F8","calling_code":"1","is_eu":false}}";
1+
s:1110:"{"ip":"74.200.247.59","type":"ipv4","continent_code":"NA","continent_name":"North America","country_code":"US","country_name":"United States","region_code":"NJ","region_name":"New Jersey","city":"Jersey City","zip":"07311","latitude":40.724,"longitude":-74.059,"msa":"35620","dma":"501","radius":null,"ip_routing_type":"fixed","connection_type":"tx","location":{"geoname_id":5099836,"capital":"Washington D.C.","languages":[{"code":"en","name":"English","native":"English"}],"country_flag":"https://assets.ipstack.com/flags/us.svg","country_flag_emoji":"\ud83c\uddfa\ud83c\uddf8","country_flag_emoji_unicode":"U+1F1FA U+1F1F8","calling_code":"1","is_eu":false},"time_zone":{"id":"America/New_York","current_time":"2025-02-16T06:03:06-05:00","gmt_offset":-18000,"code":"EST","is_daylight_saving":false},"currency":{"code":"USD","name":"US Dollar","plural":"US dollars","symbol":"$","symbol_native":"$"},"connection":{"asn":19994,"isp":"Rackspace Hosting","sld":null,"tld":null,"carrier":"rackspace hosting","home":false,"organization_type":"Internet Hosting Services","isic_code":"J6311","naics_code":"518210"}}";

‎src/Provider/Ipstack/Tests/IpstackTest.php‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ public function testGeocodeWithLocalhostIPv4(): void
6464
$this->assertInstanceOf('\Geocoder\Model\Address', $result);
6565
$this->assertEquals('localhost', $result->getLocality());
6666
$this->assertEquals('localhost', $result->getCountry()->getName());
67+
$this->assertEmpty($result->getAdminLevels());
6768
}
6869

6970
public function testGeocodeWithLocalhostIPv6(): void
@@ -79,6 +80,7 @@ public function testGeocodeWithLocalhostIPv6(): void
7980
$this->assertInstanceOf('\Geocoder\Model\Address', $result);
8081
$this->assertEquals('localhost', $result->getLocality());
8182
$this->assertEquals('localhost', $result->getCountry()->getName());
83+
$this->assertEmpty($result->getAdminLevels());
8284
}
8385

8486
public function testGeocodeWithRealIPv4(): void
@@ -92,10 +94,12 @@ public function testGeocodeWithRealIPv4(): void
9294
/** @var Location $result */
9395
$result = $results->first();
9496
$this->assertInstanceOf('\Geocoder\Model\Address', $result);
95-
$this->assertEqualsWithDelta(37.751, $result->getCoordinates()->getLatitude(), 0.01);
96-
$this->assertEqualsWithDelta(-97.822, $result->getCoordinates()->getLongitude(), 0.01);
97+
$this->assertEqualsWithDelta(40.724, $result->getCoordinates()->getLatitude(), 0.01);
98+
$this->assertEqualsWithDelta(-74.059, $result->getCoordinates()->getLongitude(), 0.01);
9799
$this->assertEquals('United States', $result->getCountry()->getName());
98100
$this->assertEquals('US', $result->getCountry()->getCode());
101+
$this->assertCount(1, $result->getAdminLevels());
102+
$this->assertEquals('New Jersey', $result->getAdminLevels()->get(1)->getName());
99103
}
100104

101105
public function testGeocodeWithRealIPv4InFrench(): void
@@ -109,10 +113,12 @@ public function testGeocodeWithRealIPv4InFrench(): void
109113
/** @var Location $result */
110114
$result = $results->first();
111115
$this->assertInstanceOf('\Geocoder\Model\Address', $result);
112-
$this->assertEqualsWithDelta(37.751, $result->getCoordinates()->getLatitude(), 0.01);
113-
$this->assertEqualsWithDelta(-97.822, $result->getCoordinates()->getLongitude(), 0.01);
116+
$this->assertEqualsWithDelta(40.724, $result->getCoordinates()->getLatitude(), 0.01);
117+
$this->assertEqualsWithDelta(-74.059, $result->getCoordinates()->getLongitude(), 0.01);
114118
$this->assertEquals('États-Unis', $result->getCountry()->getName());
115119
$this->assertEquals('US', $result->getCountry()->getCode());
120+
$this->assertCount(1, $result->getAdminLevels());
121+
$this->assertEquals('New Jersey', $result->getAdminLevels()->get(1)->getName());
116122
}
117123

118124
public function testReverse(): void

0 commit comments

Comments
 (0)