Merge pull request #1461 from maximilientyc/master

Control Google places search API price

lib/geocoder/lookups/google.rb

@@ -44,10 +44,15 @@ def valid_response?(response)
       super(response) and ['OK', 'ZERO_RESULTS'].include?(status)
     end
 
+    def result_root_attr
+      'results'
+    end
+
     def results(query)
       return [] unless doc = fetch_data(query)
-      case doc['status']; when "OK" # OK status implies >0 results
-        return doc['results']
+      case doc['status']
+      when "OK" # OK status implies >0 results
+        return doc[result_root_attr]
       when "OVER_QUERY_LIMIT"
         raise_error(Geocoder::OverQueryLimitError) ||
           Geocoder.log(:warn, "#{name} API error: over query limit.")

lib/geocoder/lookups/google_places_details.rb

@@ -22,21 +22,15 @@ def base_query_url(query)
         "#{protocol}://maps.googleapis.com/maps/api/place/details/json?"
       end
 
+      def result_root_attr
+        'result'
+      end
+
       def results(query)
-        return [] unless doc = fetch_data(query)
-
-        case doc["status"]
-        when "OK"
-          return [doc["result"]]
-        when "OVER_QUERY_LIMIT"
-          raise_error(Geocoder::OverQueryLimitError) || Geocoder.log(:warn, "Google Places Details API error: over query limit.")
-        when "REQUEST_DENIED"
-          raise_error(Geocoder::RequestDenied) || Geocoder.log(:warn, "Google Places Details API error: request denied.")
-        when "INVALID_REQUEST"
-          raise_error(Geocoder::InvalidRequest) || Geocoder.log(:warn, "Google Places Details API error: invalid request.")
-        end
-
-        []
+        result = super(query)
+        return [result] unless result.is_a? Array
+
+        result
       end
 
       def query_url_google_params(query)

lib/geocoder/lookups/google_places_search.rb

@@ -18,16 +18,42 @@ def supported_protocols
 
       private
 
+      def result_root_attr
+        'candidates'
+      end
+
       def base_query_url(query)
-        "#{protocol}://maps.googleapis.com/maps/api/place/textsearch/json?"
+        "#{protocol}://maps.googleapis.com/maps/api/place/findplacefromtext/json?"
       end
 
       def query_url_google_params(query)
         {
-          query: query.text,
+          input: query.text,
+          inputtype: 'textquery',
+          fields: fields(query),
           language: query.language || configuration.language
         }
       end
+
+      def fields(query)
+        query_fields = query.options[:fields]
+        return format_fields(query_fields) if query_fields
+
+        default_fields
+      end
+
+      def default_fields
+        legacy = %w[id reference]
+        basic = %w[business_status formatted_address geometry icon name 
+          photos place_id plus_code types]
+        contact = %w[opening_hours]
+        atmosphere = %W[price_level rating user_ratings_total]
+        format_fields(legacy, basic, contact, atmosphere)
+      end
+
+      def format_fields(*fields)
+        fields.flatten.join(',')
+      end
     end
   end
 end

lib/geocoder/lookups/google_premier.rb

@@ -21,6 +21,10 @@ def query_url(query)
 
     private # ---------------------------------------------------------------
 
+    def result_root_attr
+      'results'
+    end
+
     def cache_key(query)
       "#{protocol}://maps.googleapis.com/maps/api/geocode/json?" + hash_to_query(cache_key_params(query))
     end

test/fixtures/google_places_search_madison_square_garden

@@ -1,6 +1,5 @@
 {
-   "html_attributions" : [],
-   "results" : [
+   "candidates" : [
       {
          "formatted_address" : "4 Pennsylvania Plaza, New York, NY 10001, United States",
          "geometry" : {

test/unit/lookups/google_places_search_test.rb

@@ -33,9 +33,39 @@ def test_google_places_search_query_url_contains_language
     assert_match(/language=de/, url)
   end
 
+  def test_google_places_search_query_url_contains_input
+    url = lookup.query_url(Geocoder::Query.new("some-address"))
+    assert_match(/input=some-address/, url)
+  end
+
+  def test_google_places_search_query_url_contains_input_typer
+    url = lookup.query_url(Geocoder::Query.new("some-address"))
+    assert_match(/inputtype=textquery/, url)
+  end
+
   def test_google_places_search_query_url_always_uses_https
     url = lookup.query_url(Geocoder::Query.new("some-address"))
-    assert_match(%r(^https://), url)
+    assert_match(%r{^https://}, url)
+  end
+
+  def test_google_places_search_query_url_contains_every_field_available_by_default
+    url = lookup.query_url(Geocoder::Query.new("some-address"))
+    fields = %w[id reference business_status formatted_address geometry icon name 
+      photos place_id plus_code types opening_hours price_level rating 
+      user_ratings_total]
+    assert_match(/fields=#{fields.join('%2C')}/, url)
+  end
+
+  def test_google_places_search_query_url_contains_specific_fields_when_given
+    fields = %w[formatted_address place_id]
+    url = lookup.query_url(Geocoder::Query.new("some-address", fields: fields))
+
+    assert_match(/fields=#{fields.join('%2C')}/, url)
+  end
+
+  def test_google_places_search_query_url_uses_find_place_service
+    url = lookup.query_url(Geocoder::Query.new("some-address"))
+    assert_match(%r{//maps.googleapis.com/maps/api/place/findplacefromtext/}, url)
   end
 
   private