Merge pull request geocoder-php#473 from mattsches/master

Return ISO 3166-2 region codes for the US and the rest of the world.

Author: willdurand

src/Geocoder/Provider/FreeGeoIp.php

@@ -12,6 +12,7 @@
 
 use Geocoder\Exception\NoResult;
 use Geocoder\Exception\UnsupportedOperation;
+use Geocoder\Model\AddressCollection;
 
 /**
  * @author William Durand <william.durand1@gmail.com>
@@ -59,6 +60,8 @@ public function getName()
 
  /**
  * @param string $query
+ *
+ * @return AddressCollection
  */
  private function executeQuery($query)
  {
@@ -74,12 +77,6 @@ private function executeQuery($query)
  throw new NoResult(sprintf('Could not execute query %s', $query));
  }
 
- // it appears that for US states the region code is not returning the FIPS standard
- if ('US' === $data['country_code'] && isset($data['region_code']) && !is_numeric($data['region_code'])) {
- $newRegionCode = $this->stateToRegionCode($data['region_code']);
- $data['region_code'] = is_numeric($newRegionCode) ? $newRegionCode : null;
- }
-
  $adminLevels = [];
 
  if (! empty($data['region_name']) || ! empty($data['region_code'])) {
@@ -103,84 +100,4 @@ private function executeQuery($query)
  ))
  ]);
  }
-
- /**
- * Converts the state code to FIPS standard.
- *
- * @param string $state
- *
- * @return string|integer The FIPS code or the state code if not found
- */
- private function stateToRegionCode($state)
- {
- $codes = $this->getRegionCodes();
-
- return array_key_exists($state, $codes) ? $codes[$state] : $state;
- }
-
- /**
- * Returns an array of state codes => FIPS codes
- * @see http://www.epa.gov/enviro/html/codes/state.html
- *
- * @return array
- */
- private function getRegionCodes()
- {
- return array(
- 'AK' => 2, //ALASKA
- 'AL' => 1, //ALABAMA
- 'AR' => 5, //ARKANSAS
- 'AS' => 60, //AMERICAN SAMOA
- 'AZ' => 4, //ARIZONA
- 'CA' => 6, //CALIFORNIA
- 'CO' => 8, //COLORADO
- 'CT' => 9, //CONNECTICUT
- 'DC' => 11, //DISTRICT OF COLUMBIA
- 'DE' => 10, //DELAWARE
- 'FL' => 12, //FLORIDA
- 'GA' => 13, //GEORGIA
- 'GU' => 66, //GUAM
- 'HI' => 15, //HAWAII
- 'IA' => 19, //IOWA
- 'ID' => 16, //IDAHO
- 'IL' => 17, //ILLINOIS
- 'IN' => 18, //INDIANA
- 'KS' => 20, //KANSAS
- 'KY' => 21, //KENTUCKY
- 'LA' => 22, //LOUISIANA
- 'MA' => 25, //MASSACHUSETTS
- 'MD' => 24, //MARYLAND
- 'ME' => 23, //MAINE
- 'MI' => 26, //MICHIGAN
- 'MN' => 27, //MINNESOTA
- 'MO' => 29, //MISSOURI
- 'MS' => 28, //MISSISSIPPI
- 'MT' => 30, //MONTANA
- 'NC' => 37, //NORTH CAROLINA
- 'ND' => 38, //NORTH DAKOTA
- 'NE' => 31, //NEBRASKA
- 'NH' => 33, //NEW HAMPSHIRE
- 'NJ' => 34, //NEW JERSEY
- 'NM' => 35, //NEW MEXICO
- 'NV' => 32, //NEVADA
- 'NY' => 36, //NEW YORK
- 'OH' => 39, //OHIO
- 'OK' => 40, //OKLAHOMA
- 'OR' => 41, //OREGON
- 'PA' => 42, //PENNSYLVANIA
- 'PR' => 72, //PUERTO RICO
- 'RI' => 44, //RHODE ISLAND
- 'SC' => 45, //SOUTH CAROLINA
- 'SD' => 46, //SOUTH DAKOTA
- 'TN' => 47, //TENNESSEE
- 'TX' => 48, //TEXAS
- 'UT' => 49, //UTAH
- 'VA' => 51, //VIRGINIA
- 'VI' => 78, //VIRGIN ISLANDS
- 'VT' => 50, //VERMONT
- 'WA' => 53, //WASHINGTON
- 'WI' => 55, //WISCONSIN
- 'WV' => 54, //WEST VIRGINIA
- );
- }
 }

tests/.cached_responses/1ec836744699c92949abd980774e110560bc27b3

@@ -0,0 +1,2 @@
+s:235:"{"ip":"129.67.242.154","country_code":"GB","country_name":"United Kingdom","region_code":"ENG","region_name":"England","city":"Oxford","zip_code":"OX1","time_zone":"Europe/London","latitude":51.7158,"longitude":-1.2925,"metro_code":0}
+";

tests/.cached_responses/3117e4255511124c8c1a097f85f1cad5ae01437f

@@ -0,0 +1,2 @@
+s:235:"{"ip":"129.67.242.154","country_code":"GB","country_name":"United Kingdom","region_code":"ENG","region_name":"England","city":"Oxford","zip_code":"OX1","time_zone":"Europe/London","latitude":51.7158,"longitude":-1.2925,"metro_code":0}
+";

tests/.cached_responses/6481992b59646c5a15768a664165f44ce0dcbfad

@@ -154,7 +154,7 @@ public function testGeocodeWithUSIPv4()
  $this->assertCount(1, $results);
 
  $this->assertCount(1, $results->first()->getAdminLevels());
- $this->assertEquals('48', $results->first()->getAdminLevels()->get(1)->getCode());
+ $this->assertEquals('TX', $results->first()->getAdminLevels()->get(1)->getCode());
  }
 
  public function testGeocodeWithUSIPv6()
@@ -166,23 +166,26 @@ public function testGeocodeWithUSIPv6()
  $this->assertCount(1, $results);
 
  $this->assertCount(1, $results->first()->getAdminLevels());
- $this->assertEquals('48', $results->first()->getAdminLevels()->get(1)->getCode());
+ $this->assertEquals('TX', $results->first()->getAdminLevels()->get(1)->getCode());
  }
 
  public function testGeocodeWithUKIPv4()
  {
  $provider = new FreeGeoIp($this->getAdapter());
- $results = $provider->geocode('132.185.255.60');
+ $results = $provider->geocode('129.67.242.154');
 
  $this->assertInstanceOf('Geocoder\Model\AddressCollection', $results);
  $this->assertCount(1, $results);
  $this->assertEquals('GB', $results->first()->getCountry()->getCode());
+
+ $this->assertCount(1, $results->first()->getAdminLevels());
+ $this->assertEquals('ENG', $results->first()->getAdminLevels()->get(1)->getCode());
  }
 
  public function testGeocodeWithUKIPv6()
  {
  $provider = new FreeGeoIp($this->getAdapter());
- $results = $provider->geocode('::ffff:132.185.255.60');
+ $results = $provider->geocode('::ffff:129.67.242.154');
 
  $this->assertInstanceOf('Geocoder\Model\AddressCollection', $results);
  $this->assertCount(1, $results);