geocoder 1.8.3 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 447dfedeffcb5c111f6441badccf6d1c25c38a3a0fed32aaeb31151d27425a3d
-  data.tar.gz: 89b7f5b123d125ccb329d66f0172ef0a46d3176d6e215cc1a884b0a2249ae4cd
+  metadata.gz: c38644e83a9bde6c719bd519bd59c41d481d9e49e667bcbcd728ddfeffac6f4d
+  data.tar.gz: 87df789703eb008121749def42594a4a8739cbc1b722dbdca4fb0f26562ff4b8
 SHA512:
-  metadata.gz: a90b21dfcc3aeb50ac94fad6eafeec0141ba320bb638912b2e0091f80beb30b306f58cc104db8a55ab47cf8a5543edbabe9372dbda7c63dcbeb560c42b92a957
-  data.tar.gz: c0489e8f2b3c4d98cf40235e2b60fc5c8d129cd74aecc65f57bfd9adee7549db804fb0bcdf6b68c14933478fd3a0ea06124350208987a575c916a0992c28adb7
+  metadata.gz: 676238630577eb0e79b4fdc572b98a509c332d86a6a96b2076e785e965f0ebc27304d03acb4a5973fd73a7922bf11e19ee16e4a484eea301f636ed219a0d29ff
+  data.tar.gz: 16a80ebb922111745d81ffa48bd16f651934d6cbfe123fcb99ad252111ff9178ed76c999f278d7938488843f92b07de0b9f20bc2619363c2834b9aa99bf41569

data/CHANGELOG.md

@@ -3,6 +3,11 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.8.4 (2024 Dec  4)
+-------------------
+* Add support for Azure lookup (thanks github.com/AhlOct).
+* Several fixes for Mapbox and Bing lookups (thanks github.com/tmh-dev and github.com/iBlackShadow).
+
 1.8.3 (2024 May  2)
 -------------------
 * Add support for IP2Location LITE lookup (thanks github.com/ip2location).

data/README.md

@@ -375,6 +375,9 @@ Geocoder::Lookup.all_services.each{|service| Geocoder::Lookup.get(service).cache
 
 Do *not* include the prefix when passing a URL to be expired. Expiring `:all` will only expire keys with the configured prefix -- it will *not* expire every entry in your key/value store.
 
+In addition to conventional cache stores like Redis, it's possible to keep your cache in the database using `ActiveRecord`. For example see [this gist](https://gist.github.com/shqear93/4b07153b4ca7e4e4a41da492679f6c0e).
+
+
 _Before you implement caching in your app please be sure that doing so does not violate the Terms of Service for your geocoding service._
 
 Not all services support caching, [check the service limitations in the API guide for more information](https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md).

data/lib/geocoder/lookup.rb

@@ -32,6 +32,7 @@ module Geocoder
     def street_services
       @street_services ||= [
         :location_iq,
+        :azure,
         :esri,
         :google,
         :google_premier,

data/lib/geocoder/lookups/amazon_location_service.rb

@@ -11,14 +11,17 @@ module Geocoder::Lookup
       params.merge!(index_name: configuration[:index_name])
 
       # Aws::ParamValidator raises ArgumentError on unexpected keys
-      params.delete(:lookup) 
-      
+      params.delete(:lookup)
+
+      # Inherit language from configuration
+      params.merge!(language: configuration[:language])
+
       resp = if query.reverse_geocode?
         client.search_place_index_for_position(params.merge(position: query.coordinates.reverse))
       else
         client.search_place_index_for_text(params.merge(text: query.text))
       end
-      
+
       resp.results
     end
 

data/lib/geocoder/lookups/azure.rb

@@ -0,0 +1,56 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/azure'
+
+module Geocoder::Lookup
+  class Azure < Base
+    def name
+      'Azure'
+    end
+
+    def required_api_key_parts
+      ['api_key']
+    end
+
+    def supported_protocols
+      [:https]
+    end
+
+    private
+
+    def base_query_url(query)
+      host = 'atlas.microsoft.com/search/address'
+
+      if query.reverse_geocode?
+        "#{protocol}://#{host}/reverse/json?"
+      else
+        "#{protocol}://#{host}/json?"
+      end
+    end
+
+    def query_url_params(query)
+      params = {
+        'api-version' => 1.0,
+        'language' => query.options[:language] || 'en',
+        'limit' => configuration[:limit] || 10,
+        'query' => query.sanitized_text,
+        'subscription-key' => configuration.api_key
+      }
+
+      params.merge(super)
+    end
+
+    def results(query)
+      return [] unless (doc = fetch_data(query))
+
+      return doc if doc['error']
+
+      if doc['results']&.any?
+        doc['results']
+      elsif doc['addresses']&.any?
+        doc['addresses']
+      else
+        []
+      end
+    end
+  end
+end

data/lib/geocoder/lookups/bing.rb

@@ -19,7 +19,7 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
 
     def base_query_url(query)
-      text = CGI.escape(query.sanitized_text.strip)
+      text = ERB::Util.url_encode(query.sanitized_text.strip)
       url = "#{protocol}://dev.virtualearth.net/REST/v1/Locations/"
       if query.reverse_geocode?
         url + "#{text}?"

data/lib/geocoder/lookups/mapbox.rb

@@ -30,14 +30,14 @@ module Geocoder::Lookup
     end
 
     def mapbox_search_term(query)
-      require 'cgi' unless defined?(CGI) && defined?(CGI.escape)
+      require 'erb' unless defined?(ERB) && defined?(ERB::Util.url_encode)
       if query.reverse_geocode?
         lat,lon = query.coordinates
-        "#{CGI.escape lon},#{CGI.escape lat}"
+        "#{ERB::Util.url_encode lon},#{ERB::Util.url_encode lat}"
       else
         # truncate at first semicolon so Mapbox doesn't go into batch mode
         # (see Github issue #1299)
-        CGI.escape query.text.to_s.split(';').first.to_s
+        ERB::Util.url_encode query.text.to_s.split(';').first.to_s
       end
     end
 

data/lib/geocoder/lookups/photon.rb

@@ -10,7 +10,7 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
 
     def supported_protocols
-      [:https]
+      [:http, :https]
     end
 
     def base_query_url(query)

data/lib/geocoder/query.rb

@@ -23,7 +23,7 @@ module Geocoder
           text.split(/\s*,\s*/).join(',')
         end
       else
-        text
+        text.strip
       end
     end
 

data/lib/geocoder/results/azure.rb

@@ -0,0 +1,65 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Azure < Base
+    def address
+      @data['address']['freeformAddress']
+    end
+
+    def building_number
+      @data['address']['buildingNumber']
+    end
+
+    def city
+      @data['address']['municipality']
+    end
+
+    def coordinates
+      if @data['position'].is_a?(String) # reverse geocoding result
+        @data['position'].split(',').map(&:to_f)
+      elsif @data['position'].is_a?(Hash) # forward geocoding result
+        [@data['position']['lat'], @data['position']['lon']]
+      end
+    end
+
+    def country
+      @data['address']['country']
+    end
+
+    def country_code
+      @data['address']['countryCode']
+    end
+
+    def district
+      @data['address']['municipalitySubdivision']
+    end
+
+    def postal_code
+      @data['address']['postalCode']
+    end
+
+    def province
+      @data['address']['countrySubdivision']
+    end
+
+    def state
+      @data['address']['countrySubdivision']
+    end
+
+    def state_code
+      @data['address']['countrySubdivisionCode']
+    end
+
+    def street_name
+      @data['address']['streetName']
+    end
+
+    def street_number
+      @data['address']['streetNumber']
+    end
+
+    def viewport
+      @data['viewport'] || {}
+    end
+  end
+end

data/lib/geocoder/results/mapbox.rb

@@ -16,43 +16,61 @@ module Geocoder::Result
     end
 
     def city
-      context_part('place')
+      data_part('place') || context_part('place')
     end
 
     def state
-      context_part('region')
+      data_part('region') || context_part('region')
     end
 
     def state_code
-      value = context_part('region', 'short_code')
+      if id_matches_name?(data['id'], 'region')
+        value = data['properties']['short_code']
+      else
+        value = context_part('region', 'short_code')
+      end
+
       value.split('-').last unless value.nil?
     end
 
     def postal_code
-      context_part('postcode')
+      data_part('postcode') || context_part('postcode')
     end
 
     def country
-      context_part('country')
+      data_part('country') || context_part('country')
     end
 
     def country_code
-      value = context_part('country', 'short_code')
+      if id_matches_name?(data['id'], 'country')
+        value = data['properties']['short_code']
+      else
+        value = context_part('country', 'short_code')
+      end
+
       value.upcase unless value.nil?
     end
 
     def neighborhood
-      context_part('neighborhood')
+      data_part('neighborhood') || context_part('neighborhood')
     end
 
     def address
-      [place_name, street, city, state, postal_code, country].compact.join(', ')
+      data['place_name']
     end
 
     private
 
+    def id_matches_name?(id, name)
+      id =~ Regexp.new(name)
+    end
+
+    def data_part(name)
+      data['text'] if id_matches_name?(data['id'], name)
+    end
+
     def context_part(name, key = 'text')
-      (context.detect { |c| c['id'] =~ Regexp.new(name) } || {})[key]
+      (context.detect { |c| id_matches_name?(c['id'], name) } || {})[key]
     end
 
     def context

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.8.3"
+  VERSION = "1.8.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.4
 platform: ruby
 authors:
 - Alex Reisner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -82,6 +82,7 @@ files:
 - lib/geocoder/lookups/abstract_api.rb
 - lib/geocoder/lookups/amap.rb
 - lib/geocoder/lookups/amazon_location_service.rb
+- lib/geocoder/lookups/azure.rb
 - lib/geocoder/lookups/baidu.rb
 - lib/geocoder/lookups/baidu_ip.rb
 - lib/geocoder/lookups/ban_data_gouv_fr.rb
@@ -149,6 +150,7 @@ files:
 - lib/geocoder/results/abstract_api.rb
 - lib/geocoder/results/amap.rb
 - lib/geocoder/results/amazon_location_service.rb
+- lib/geocoder/results/azure.rb
 - lib/geocoder/results/baidu.rb
 - lib/geocoder/results/baidu_ip.rb
 - lib/geocoder/results/ban_data_gouv_fr.rb