geocoder 1.6.4 → 1.7.0

data/lib/geocoder/results/amazon_location_service.rb

@@ -0,0 +1,57 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class AmazonLocationService < Base
+    def initialize(result)
+      @place = result
+    end
+
+    def coordinates
+      [@place.geometry.point[1], @place.geometry.point[0]]
+    end
+
+    def address
+      @place.label
+    end
+
+    def neighborhood
+      @place.neighborhood
+    end
+
+    def route
+      @place.street
+    end
+
+    def city
+      @place.municipality || @place.sub_region
+    end
+
+    def state
+      @place.region
+    end
+
+    def state_code
+      @place.region
+    end
+
+    def province
+      @place.region
+    end
+
+    def province_code
+      @place.region
+    end
+
+    def postal_code
+      @place.postal_code
+    end
+
+    def country
+      @place.country
+    end
+
+    def country_code
+      @place.country
+    end
+  end
+end

data/lib/geocoder/results/ban_data_gouv_fr.rb

@@ -4,6 +4,27 @@ require 'geocoder/results/base'
 module Geocoder::Result
   class BanDataGouvFr < Base
 
+    STATE_CODE_MAPPINGS = {
+      "Guadeloupe" => "01",
+      "Martinique" => "02",
+      "Guyane" => "03",
+      "La Réunion" => "04",
+      "Mayotte" => "06",
+      "Île-de-France" => "11",
+      "Centre-Val de Loire" => "24",
+      "Bourgogne-Franche-Comté" => "27",
+      "Normandie" => "28",
+      "Hauts-de-France" => "32",
+      "Grand Est" => "44",
+      "Pays de la Loire" => "52",
+      "Bretagne" => "53",
+      "Nouvelle-Aquitaine" => "75",
+      "Occitanie" => "76",
+      "Auvergne-Rhône-Alpes" => "84",
+      "Provence-Alpes-Côte d'Azur" => "93",
+      "Corse" => "94"
+    }.freeze
+
     #### BASE METHODS ####
 
     def self.response_attributes
@@ -209,6 +230,10 @@ module Geocoder::Result
       end
     end
 
+    def region_code
+      STATE_CODE_MAPPINGS[region_name]
+    end
+
     def country
       "France"
     end
@@ -235,7 +260,7 @@ module Geocoder::Result
     alias_method :street, :street_name
     alias_method :city, :city_name
     alias_method :state, :region_name
-    alias_method :state_code, :state
+    alias_method :state_code, :region_code
 
     #### CITIES' METHODS ####
 

data/lib/geocoder/results/esri.rb

@@ -16,11 +16,14 @@ module Geocoder::Result
       end
     end
 
-    def state_code
+    def state
       attributes['Region']
     end
 
-    alias_method :state, :state_code
+    def state_code
+      abbr = attributes['RegionAbbr']
+      abbr.to_s == "" ? state : abbr
+    end
 
     def country
       country_key = reverse_geocode? ? "CountryCode" : "Country"

data/lib/geocoder/results/geoapify.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'geocoder/results/base'
+
+module Geocoder
+  module Result
+    # https://apidocs.geoapify.com/docs/geocoding/api
+    class Geoapify < Base
+      def address(_format = :full)
+        properties['formatted']
+      end
+
+      def address_line1
+        properties['address_line1']
+      end
+
+      def address_line2
+        properties['address_line2']
+      end
+
+      def house_number
+        properties['housenumber']
+      end
+
+      def street
+        properties['street']
+      end
+
+      def postal_code
+        properties['postcode']
+      end
+
+      def district
+        properties['district']
+      end
+
+      def suburb
+        properties['suburb']
+      end
+
+      def city
+        properties['city']
+      end
+
+      def county
+        properties['county']
+      end
+
+      def state
+        properties['state']
+      end
+
+      # Not currently available in the API
+      def state_code
+        ''
+      end
+
+      def country
+        properties['country']
+      end
+
+      def country_code
+        return unless properties['country_code']
+
+        properties['country_code'].upcase
+      end
+
+      def coordinates
+        return unless properties['lat']
+        return unless properties['lon']
+
+        [properties['lat'], properties['lon']]
+      end
+
+      # See: https://tools.ietf.org/html/rfc7946#section-3.1
+      #
+      # Each feature has a "Point" type in the Geoapify API.
+      def geometry
+        return unless data['geometry']
+
+        symbol_hash data['geometry']
+      end
+
+      # See: https://tools.ietf.org/html/rfc7946#section-5
+      def bounds
+        data['bbox']
+      end
+
+      # Type of the result, one of:
+      #
+      #   * :unknown
+      #   * :amenity
+      #   * :building
+      #   * :street
+      #   * :suburb
+      #   * :district
+      #   * :postcode
+      #   * :city
+      #   * :county
+      #   * :state
+      #   * :country
+      #
+      def type
+        return :unknown unless properties['result_type']
+
+        properties['result_type'].to_sym
+      end
+
+      # Distance in meters to given bias:proximity or to given coordinates for
+      # reverse geocoding
+      def distance
+        properties['distance']
+      end
+
+      # Calculated rank for the result, containing the following keys:
+      #
+      #   * `popularity` - The popularity score of the result
+      #   * `confidence` - The confidence value of the result (0-1)
+      #   * `match_type` - The result's match type, one of following:
+      #      * full_match
+      #      * inner_part
+      #      * match_by_building
+      #      * match_by_street
+      #      * match_by_postcode
+      #      * match_by_city_or_disrict
+      #      * match_by_country_or_state
+      #
+      # Example:
+      #   {
+      #     popularity: 8.615793062435909,
+      #     confidence: 0.88,
+      #     match_type: :full_match
+      #   }
+      def rank
+        return unless properties['rank']
+
+        r = symbol_hash(properties['rank'])
+        r[:match_type] = r[:match_type].to_sym if r[:match_type]
+        r
+      end
+
+      # Examples:
+      #
+      # Open
+      #   {
+      #     sourcename: 'openstreetmap',
+      #     wheelchair: 'limited',
+      #     wikidata: 'Q186125',
+      #     wikipedia: 'en:Madison Square Garden',
+      #     website: 'http://www.thegarden.com/',
+      #     phone: '12124656741',
+      #     osm_type: 'W',
+      #     osm_id: 138141251,
+      #     continent: 'North America',
+      #   }
+      def datasource
+        return unless properties['datasource']
+
+        symbol_hash properties['datasource']
+      end
+
+      private
+
+      def properties
+        @properties ||= data['properties'] || {}
+      end
+
+      def symbol_hash(orig_hash)
+        {}.tap do |result|
+          orig_hash.each_key do |key|
+            next unless orig_hash[key]
+
+            result[key.to_sym] = orig_hash[key]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/geocoder/results/ipqualityscore.rb

@@ -0,0 +1,54 @@
+require 'geocoder/results/base'
+
+module Geocoder
+  module Result
+    class Ipqualityscore < Base
+
+      def self.key_method_mappings
+        {
+          'request_id' => :request_id,
+          'success' => :success?,
+          'message' => :message,
+          'city' => :city,
+          'region' => :state,
+          'country_code' => :country_code,
+          'mobile' => :mobile?,
+          'fraud_score' => :fraud_score,
+          'ISP' => :isp,
+          'ASN' => :asn,
+          'organization' => :organization,
+          'is_crawler' => :crawler?,
+          'host' => :host,
+          'proxy' => :proxy?,
+          'vpn' => :vpn?,
+          'tor' => :tor?,
+          'active_vpn' => :active_vpn?,
+          'active_tor' => :active_tor?,
+          'recent_abuse' => :recent_abuse?,
+          'bot_status' => :bot?,
+          'connection_type' => :connection_type,
+          'abuse_velocity' => :abuse_velocity,
+          'timezone' => :timezone,
+        }
+      end
+
+      key_method_mappings.each_pair do |key, meth|
+        define_method meth do
+          @data[key]
+        end
+      end
+
+      alias_method :state_code, :state
+      alias_method :country, :country_code
+
+      def postal_code
+        '' # No suitable fallback
+      end
+
+      def address
+        [city, state, country_code].compact.reject(&:empty?).join(', ')
+      end
+
+    end
+  end
+end

data/lib/geocoder/results/ipregistry.rb

@@ -9,6 +9,10 @@ module Geocoder::Result
       @data = flatten_hash(data)
     end
 
+    def coordinates
+      [@data['location_latitude'], @data['location_longitude']]
+    end
+
     def flatten_hash(hash)
       hash.each_with_object({}) do |(k, v), h|
         if v.is_a? Hash
@@ -35,14 +39,6 @@ module Geocoder::Result
       @data['location_country_code']
     end
 
-    def latitude
-      @data['location_latitude']
-    end
-
-    def longitude
-      @data['location_longitude']
-    end
-
     def postal_code
       @data['location_postal']
     end

data/lib/geocoder/results/mapbox.rb

@@ -23,7 +23,10 @@ module Geocoder::Result
       context_part('region')
     end
 
-    alias_method :state_code, :state
+    def state_code
+      value = context_part('region', 'short_code')
+      value.split('-').last unless value.nil?
+    end
 
     def postal_code
       context_part('postcode')
@@ -33,7 +36,10 @@ module Geocoder::Result
       context_part('country')
     end
 
-    alias_method :country_code, :country
+    def country_code
+      value = context_part('country', 'short_code')
+      value.upcase unless value.nil?
+    end
 
     def neighborhood
       context_part('neighborhood')
@@ -45,8 +51,8 @@ module Geocoder::Result
 
     private
 
-    def context_part(name)
-      context.map { |c| c['text'] if c['id'] =~ Regexp.new(name) }.compact.first
+    def context_part(name, key = 'text')
+      (context.detect { |c| c['id'] =~ Regexp.new(name) } || {})[key]
     end
 
     def context

data/lib/geocoder/results/melissa_street.rb

@@ -0,0 +1,46 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class MelissaStreet < Base
+    def address(format = :full)
+      @data['FormattedAddress']
+    end
+
+    def street_address
+      @data['AddressLine1']
+    end
+
+    def suffix
+      @data['ThoroughfareTrailingType']
+    end
+
+    def number
+      @data['PremisesNumber']
+    end
+
+    def city
+      @data['Locality']
+    end
+
+    def state_code
+      @data['AdministrativeArea']
+    end
+    alias_method :state, :state_code
+
+    def country
+      @data['CountryName']
+    end
+
+    def country_code
+      @data['CountryISO3166_1_Alpha2']
+    end
+
+    def postal_code
+      @data['PostalCode']
+    end
+
+    def coordinates
+      [@data['Latitude'].to_f, @data['Longitude'].to_f]
+    end
+  end
+end

data/lib/geocoder/results/nationaal_georegister_nl.rb

@@ -8,7 +8,7 @@ module Geocoder::Result
     end
 
     def coordinates
-      @data['centroide_ll'][6..-2].split(' ').map(&:to_f)
+      @data['centroide_ll'][6..-2].split(' ').map(&:to_f).reverse
     end
 
     def formatted_address

data/lib/geocoder/results/photon.rb

@@ -0,0 +1,119 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Photon < Base
+    def name
+      properties['name']
+    end
+
+    def address(_format = :full)
+      parts = []
+      parts << name if name
+      parts << street_address if street_address
+      parts << city
+      parts << state if state
+      parts << postal_code
+      parts << country
+
+      parts.join(', ')
+    end
+
+    def street_address
+      return unless street
+      return street unless house_number
+
+      "#{house_number} #{street}"
+    end
+
+    def house_number
+      properties['housenumber']
+    end
+
+    def street
+      properties['street']
+    end
+
+    def postal_code
+      properties['postcode']
+    end
+
+    def city
+      properties['city']
+    end
+
+    def state
+      properties['state']
+    end
+
+    def state_code
+      ''
+    end
+
+    def country
+      properties['country']
+    end
+
+    def country_code
+      ''
+    end
+
+    def coordinates
+      return unless geometry
+      return unless geometry[:coordinates]
+
+      geometry[:coordinates].reverse
+    end
+
+    def geometry
+      return unless data['geometry']
+
+      symbol_hash data['geometry']
+    end
+
+    def bounds
+      properties['extent']
+    end
+
+    # Type of the result (OSM object type), one of:
+    #
+    #   :node
+    #   :way
+    #   :relation
+    #
+    def type
+      {
+        'N' => :node,
+        'W' => :way,
+        'R' => :relation
+      }[properties['osm_type']]
+    end
+
+    def osm_id
+      properties['osm_id']
+    end
+
+    # See: https://wiki.openstreetmap.org/wiki/Tags
+    def osm_tag
+      return unless properties['osm_key']
+      return properties['osm_key'] unless properties['osm_value']
+
+      "#{properties['osm_key']}=#{properties['osm_value']}"
+    end
+
+    private
+
+    def properties
+      @properties ||= data['properties'] || {}
+    end
+
+    def symbol_hash(orig_hash)
+      {}.tap do |result|
+        orig_hash.each_key do |key|
+          next unless orig_hash[key]
+
+          result[key.to_sym] = orig_hash[key]
+        end
+      end
+    end
+  end
+end

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.6.4"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.0
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies: []
 description: Object geocoding (by street or IP address), reverse geocoding (coordinates
   to street address), distance queries for ActiveRecord and Mongoid, result caching,
@@ -49,7 +49,9 @@ files:
 - lib/geocoder/kernel_logger.rb
 - lib/geocoder/logger.rb
 - lib/geocoder/lookup.rb
+- lib/geocoder/lookups/abstract_api.rb
 - lib/geocoder/lookups/amap.rb
+- lib/geocoder/lookups/amazon_location_service.rb
 - lib/geocoder/lookups/baidu.rb
 - lib/geocoder/lookups/baidu_ip.rb
 - lib/geocoder/lookups/ban_data_gouv_fr.rb
@@ -59,6 +61,7 @@ files:
 - lib/geocoder/lookups/dstk.rb
 - lib/geocoder/lookups/esri.rb
 - lib/geocoder/lookups/freegeoip.rb
+- lib/geocoder/lookups/geoapify.rb
 - lib/geocoder/lookups/geocoder_ca.rb
 - lib/geocoder/lookups/geocodio.rb
 - lib/geocoder/lookups/geoip2.rb
@@ -73,6 +76,7 @@ files:
 - lib/geocoder/lookups/ipdata_co.rb
 - lib/geocoder/lookups/ipgeolocation.rb
 - lib/geocoder/lookups/ipinfo_io.rb
+- lib/geocoder/lookups/ipqualityscore.rb
 - lib/geocoder/lookups/ipregistry.rb
 - lib/geocoder/lookups/ipstack.rb
 - lib/geocoder/lookups/latlon.rb
@@ -82,11 +86,13 @@ files:
 - lib/geocoder/lookups/maxmind.rb
 - lib/geocoder/lookups/maxmind_geoip2.rb
 - lib/geocoder/lookups/maxmind_local.rb
+- lib/geocoder/lookups/melissa_street.rb
 - lib/geocoder/lookups/nationaal_georegister_nl.rb
 - lib/geocoder/lookups/nominatim.rb
 - lib/geocoder/lookups/opencagedata.rb
 - lib/geocoder/lookups/osmnames.rb
 - lib/geocoder/lookups/pelias.rb
+- lib/geocoder/lookups/photon.rb
 - lib/geocoder/lookups/pickpoint.rb
 - lib/geocoder/lookups/pointpin.rb
 - lib/geocoder/lookups/postcode_anywhere_uk.rb
@@ -105,7 +111,9 @@ files:
 - lib/geocoder/query.rb
 - lib/geocoder/railtie.rb
 - lib/geocoder/request.rb
+- lib/geocoder/results/abstract_api.rb
 - lib/geocoder/results/amap.rb
+- lib/geocoder/results/amazon_location_service.rb
 - lib/geocoder/results/baidu.rb
 - lib/geocoder/results/baidu_ip.rb
 - lib/geocoder/results/ban_data_gouv_fr.rb
@@ -115,6 +123,7 @@ files:
 - lib/geocoder/results/dstk.rb
 - lib/geocoder/results/esri.rb
 - lib/geocoder/results/freegeoip.rb
+- lib/geocoder/results/geoapify.rb
 - lib/geocoder/results/geocoder_ca.rb
 - lib/geocoder/results/geocodio.rb
 - lib/geocoder/results/geoip2.rb
@@ -129,6 +138,7 @@ files:
 - lib/geocoder/results/ipdata_co.rb
 - lib/geocoder/results/ipgeolocation.rb
 - lib/geocoder/results/ipinfo_io.rb
+- lib/geocoder/results/ipqualityscore.rb
 - lib/geocoder/results/ipregistry.rb
 - lib/geocoder/results/ipstack.rb
 - lib/geocoder/results/latlon.rb
@@ -138,11 +148,13 @@ files:
 - lib/geocoder/results/maxmind.rb
 - lib/geocoder/results/maxmind_geoip2.rb
 - lib/geocoder/results/maxmind_local.rb
+- lib/geocoder/results/melissa_street.rb
 - lib/geocoder/results/nationaal_georegister_nl.rb
 - lib/geocoder/results/nominatim.rb
 - lib/geocoder/results/opencagedata.rb
 - lib/geocoder/results/osmnames.rb
 - lib/geocoder/results/pelias.rb
+- lib/geocoder/results/photon.rb
 - lib/geocoder/results/pickpoint.rb
 - lib/geocoder/results/pointpin.rb
 - lib/geocoder/results/postcode_anywhere_uk.rb