Add support to geocode through esri provider

README.md

@@ -415,6 +415,17 @@ Yahoo BOSS is **not a free service**. As of November 17, 2012 Yahoo no longer of
 * **Terms of Service**: ?
 * **Limitations**: ?
 
+#### ESRI (`:esri`)
+
+* **API key**: none
+* **Quota**: Required for some scenarios (see Terms of Service)
+* **Region**: world
+* **SSL support**: yes
+* **Languages**: English
+* **Documentation**: http://resources.arcgis.com/en/help/arcgis-online-geocoding-rest-api/
+* **Terms of Service**: http://www.esri.com/software/arcgis/arcgisonline/services/geoservices
+* **Limitations**: ?
+
 
 Caching
 -------

lib/geocoder/lookup.rb

@@ -21,6 +21,7 @@ module Geocoder
     #
     def street_services
       [
+        :esri,
         :google,
         :google_premier,
         :yahoo,

lib/geocoder/lookups/esri.rb

+require 'geocoder/lookups/base'
+require "geocoder/results/esri"
+require 'rack/utils'
+
+module Geocoder::Lookup
+  class Esri < Base
+    
+    def name
+      "Esri"
+    end
+
+    def query_url(query)
+      search_keyword = query.reverse_geocode? ? "reverseGeocode" : "find"
+
+      "#{protocol}://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/#{search_keyword}?" +
+        url_query_string(query)
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+
+      if (!query.reverse_geocode?)
+        return [] if doc['locations'].empty?
+      end
+
+      if (doc['error'].nil?)
+        return [ doc ]
+      else
+        return []
+      end
+    end
+
+    def query_url_params(query)
+      if query.reverse_geocode?
+        {
+          :location => query.text.reverse.join(','),
+          :outFields => :*,
+          :p => :pjson
+          }.merge(super)
+      else
+        {
+          :f => :pjson,
+          :outFields => :*,
+          :text => query.sanitized_text
+        }.merge(super)
+      end
+    end  
+
+  end
+end
\ No newline at end of file

lib/geocoder/results/esri.rb

+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Esri < Base
+
+    def address
+      address = reverse_geocode? ? 'Address' : 'Match_addr'
+      attributes[address]
+    end
+
+    def city
+      attributes['City']
+    end
+
+    def state_code
+      attributes['Region']
+    end
+
+    alias_method :state, :state_code
+
+    def country
+      country = reverse_geocode? ? "CountryCode" : "Country"
+      attributes[country]
+    end
+
+    alias_method :country_code, :country
+
+    def postal_code
+      attributes['Postal']
+    end
+
+    def coordinates
+      [geometry["y"], geometry["x"]]
+    end
+
+    private
+
+    def attributes
+      reverse_geocode? ? @data['address'] : @data['locations'].first['feature']['attributes']
+    end
+
+    def geometry
+      reverse_geocode? ? @data["location"] : @data['locations'].first['feature']["geometry"]
+    end
+
+    def reverse_geocode?
+      @data['locations'].nil?
+    end
+
+  end
+end
\ No newline at end of file

test/fixtures/esri_madison_square_garden

+{
+ "spatialReference": {
+  "wkid": 4326,
+  "latestWkid": 4326
+ },
+ "locations": [
+  {
+   "name": "Madison Square Garden",
+   "extent": {
+    "xmin": -74.000241000000003,
+    "ymin": 40.744050000000001,
+    "xmax": -73.988241000000002,
+    "ymax": 40.756050000000002
+   },
+   "feature": {
+    "geometry": {
+     "x": -73.994238897999651,
+     "y": 40.750049813000487
+    },
+    "attributes": {
+     "Loc_name": "Gaz.WorldGazetteer.POI2",
+     "Score": 100,
+     "Match_addr": "Madison Square Garden",
+     "Addr_type": "POI",
+     "Type": "Sports Complex",
+     "PlaceName": "Madison Square Garden",
+     "Rank": "18",
+     "AddBldg": "",
+     "AddNum": "",
+     "AddNumFrom": "",
+     "AddNumTo": "",
+     "Side": "",
+     "StPreDir": "",
+     "StPreType": "",
+     "StName": "",
+     "StType": "",
+     "StDir": "",
+     "Nbrhd": "",
+     "City": "New York",
+     "Subregion": "New York",
+     "Region": "New York",
+     "Postal": "10001",
+     "PostalExt": "",
+     "Country": "USA",
+     "LangCode": "",
+     "Distance": 0,
+     "X": -73.994240000000005,
+     "Y": 40.750050000000002,
+     "DisplayX": -73.994240000000005,
+     "DisplayY": 40.750050000000002,
+     "Xmin": -74.000241000000003,
+     "Xmax": -73.988241000000002,
+     "Ymin": 40.744050000000001,
+     "Ymax": 40.756050000000002
+    }
+   }
+  }
+ ]
+}
\ No newline at end of file

test/fixtures/esri_no_results

+{
+ "spatialReference": {
+  "wkid": 4326,
+  "latestWkid": 4326
+ },
+ "locations": [
+  ]
+}
\ No newline at end of file

test/fixtures/esri_reverse

+{
+ "address": {
+  "Address": "4 Avenue Gustave Eiffel",
+  "Neighborhood": "7e Arrondissement",
+  "City": "Paris",
+  "Subregion": "Paris",
+  "Region": "Île-de-France",
+  "Postal": "75007",
+  "PostalExt": null,
+  "CountryCode": "FRA",
+  "Loc_name": "FRA.PointAddress"
+ },
+ "location": {
+  "x": 2.2956200048981574,
+  "y": 48.858129997357558,
+  "spatialReference": {
+   "wkid": 4326,
+   "latestWkid": 4326
+  }
+ }
+}
\ No newline at end of file

test/lookup_test.rb

@@ -34,6 +34,7 @@ class LookupTest < Test::Unit::TestCase
   end
 
   {
+    :esri => :l,
     :bing => :key,
     :geocoder_ca => :auth,
     :google => :language,

test/services_test.rb

@@ -274,4 +274,47 @@ class ServicesTest < Test::Unit::TestCase
     assert_equal "46 West 31st Street, New York, NY, 10001, US",
       result.address
   end
+
+  # --- Esri ---
+
+  def test_esri_query_for_geocode
+    query = Geocoder::Query.new("Bluffton, SC")
+    lookup = Geocoder::Lookup.get(:esri)
+    res = lookup.query_url(query)
+    assert_equal "http://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/find?f=pjson&outFields=%2A&text=Bluffton%2C+SC",
+      res
+  end
+
+  def test_esri_query_for_reverse_geocode
+    query = Geocoder::Query.new([45.423733, -75.676333])
+    lookup = Geocoder::Lookup.get(:esri)
+    res = lookup.query_url(query)
+    assert_equal "http://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/reverseGeocode?location=-75.676333%2C45.423733&outFields=%2A&p=pjson",
+      res
+  end
+
+  def test_esri_results_component
+    Geocoder.configure(:lookup => :esri)
+    result = Geocoder.search("Madison Square Garden, New York, NY").first
+    assert_equal "10001", result.postal_code
+    assert_equal "USA", result.country
+    assert_equal "Madison Square Garden", result.address
+    assert_equal "New York", result.city
+    assert_equal "New York", result.state
+    assert_equal 40.75004981300049, result.coordinates[0]
+    assert_equal -73.99423889799965, result.coordinates[1]
+  end
+  
+  def test_esri_results_component_when_reverse_geocoding
+    Geocoder.configure(:lookup => :esri)
+    result = Geocoder.search([45.423733, -75.676333]).first
+    assert_equal "75007", result.postal_code
+    assert_equal "FRA", result.country
+    assert_equal "4 Avenue Gustave Eiffel", result.address
+    assert_equal "Paris", result.city
+    assert_equal "Île-de-France", result.state
+    assert_equal 48.858129997357558, result.coordinates[0]
+    assert_equal 2.2956200048981574, result.coordinates[1]
+  end
+
 end

test/test_helper.rb

@@ -112,6 +112,13 @@ module Geocoder
       end
     end
 
+    class Esri
+      private
+      def fixture_prefix
+        "esri"
+      end
+    end
+
     class GooglePremier
       private
       def fixture_prefix