geocoder 1.6.6 → 1.8.5

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/here.rb

@@ -7,76 +7,71 @@ module Geocoder::Result
     # A string in the given format.
     #
     def address(format = :full)
-      address_data['Label']
+      address_data["label"]
     end
 
     ##
     # A two-element array: [lat, lon].
     #
     def coordinates
-      fail unless d = @data['Location']['DisplayPosition']
-      [d['Latitude'].to_f, d['Longitude'].to_f]
+      fail unless d = @data["position"]
+      [d["lat"].to_f, d["lng"].to_f]
     end
     
     def route
-      address_data['Street']
+      address_data["street"]
     end
     
     def street_number
-      address_data['HouseNumber']
+      address_data["houseNumber"]
     end  
 
     def state
-      fail unless d = address_data['AdditionalData']
-      if v = d.find{|ad| ad['key']=='StateName'}
-        return v['value']
-      end
+      address_data["state"]
     end
 
     def province
-      address_data['County']
+      address_data["county"]
     end
 
     def postal_code
-      address_data['PostalCode']
+      address_data["postalCode"]
     end
 
     def city
-      address_data['City']
+      address_data["city"]
     end
 
     def state_code
-      address_data['State']
+      address_data["stateCode"]
     end
 
     def province_code
-      address_data['State']
+      address_data["state"]
     end
 
     def country
-      fail unless d = address_data['AdditionalData']
-      if v = d.find{|ad| ad['key']=='CountryName'}
-        return v['value']
-      end
+      address_data["countryName"]
     end
 
     def country_code
-      address_data['Country']
+      address_data["countryCode"]
     end
 
     def viewport
-      map_view = data['Location']['MapView'] || fail
-      south = map_view['BottomRight']['Latitude']
-      west = map_view['TopLeft']['Longitude']
-      north = map_view['TopLeft']['Latitude']
-      east = map_view['BottomRight']['Longitude']
+      return [] if data["resultType"] == "place"
+      map_view = data["mapView"]
+      south = map_view["south"]
+      west = map_view["west"]
+      north = map_view["north"]
+      east = map_view["east"]
       [south, west, north, east]
     end
 
     private # ----------------------------------------------------------------
 
     def address_data
-      @data['Location']['Address'] || fail
+      @data["address"] || fail
     end
   end
 end

data/lib/geocoder/results/ip2location_io.rb

@@ -0,0 +1,21 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ip2locationIo < Base
+
+    def address(format = :full)
+      "#{city_name} #{zip_code}, #{country_name}".sub(/^[ ,]*/, '')
+    end
+
+    def self.response_attributes
+      %w[ip country_code country_name region_name city_name latitude longitude
+        zip_code time_zone asn as is_proxy]
+    end
+
+    response_attributes.each do |attr|
+      define_method attr do
+        @data[attr] || ""
+      end
+    end
+  end
+end

data/lib/geocoder/results/ip2location_lite.rb

@@ -0,0 +1,47 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ip2locationLite < Base
+
+    def coordinates
+      [@data[:latitude], @data[:longitude]]
+    end
+
+    def city
+      @data[:city]
+    end
+
+    def state
+      @data[:region]
+    end
+
+    def state_code
+      "" # Not available in Maxmind's database
+    end
+
+    def country
+      @data[:country_long]
+    end
+
+    def country_code
+      @data[:country_short]
+    end
+
+    def postal_code
+      @data[:zipcode]
+    end
+
+    def self.response_attributes
+      %w[country_short country_long region latitude longitude isp
+        domain netspeed areacode iddcode timezone zipcode weatherstationname
+        weatherstationcode mcc mnc mobilebrand elevation usagetype addresstype
+        category district asn as]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a] || ""
+      end
+    end
+  end
+end

data/lib/geocoder/results/ipbase.rb

@@ -0,0 +1,40 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ipbase < Base
+    def ip
+      @data["data"]['ip']
+    end
+
+    def country_code
+      @data["data"]["location"]["country"]["alpha2"]
+    end
+
+    def country
+      @data["data"]["location"]["country"]["name"]
+    end
+
+    def state_code
+      @data["data"]["location"]["region"]["alpha2"]
+    end
+
+    def state
+      @data["data"]["location"]["region"]["name"]
+    end
+
+    def city
+      @data["data"]["location"]["city"]["name"]
+    end
+
+    def postal_code
+      @data["data"]["location"]["zip"]
+    end
+
+    def coordinates
+      [
+        @data["data"]["location"]["latitude"].to_f,
+        @data["data"]["location"]["longitude"].to_f
+      ]
+    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/mapbox.rb

@@ -16,37 +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
 
-    alias_method :state_code, :state
+    def state_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
 
-    alias_method :country_code, :country
+    def country_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 context_part(name)
-      context.map { |c| c['text'] if c['id'] =~ Regexp.new(name) }.compact.first
+    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| id_matches_name?(c['id'], 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/nominatim.rb

@@ -4,12 +4,12 @@ module Geocoder::Result
   class Nominatim < Base
 
     def poi
-      return @data['address'][place_type] if @data['address'].key?(place_type)
+      return address_data[place_type] if address_data.key?(place_type)
       return nil
     end
 
     def house_number
-      @data['address']['house_number']
+      address_data['house_number']
     end
 
     def address
@@ -18,69 +18,71 @@ module Geocoder::Result
 
     def street
       %w[road pedestrian highway].each do |key|
-        return @data['address'][key] if @data['address'].key?(key)
+        return address_data[key] if address_data.key?(key)
       end
       return nil
     end
 
     def city
       %w[city town village hamlet].each do |key|
-        return @data['address'][key] if @data['address'].key?(key)
+        return address_data[key] if address_data.key?(key)
       end
       return nil
     end
 
     def village
-      @data['address']['village']
+      address_data['village']
     end
 
     def town
-      @data['address']['town']
+      address_data['town']
     end
 
     def state
-      @data['address']['state']
+      address_data['state']
     end
 
     alias_method :state_code, :state
 
     def postal_code
-      @data['address']['postcode']
+      address_data['postcode']
     end
 
     def county
-      @data['address']['county']
+      address_data['county']
     end
 
     def country
-      @data['address']['country']
+      address_data['country']
     end
 
     def country_code
-      @data['address']['country_code']
+      address_data['country_code']
     end
 
     def suburb
-      @data['address']['suburb']
+      address_data['suburb']
     end
 
     def city_district
-      @data['address']['city_district']
+      address_data['city_district']
     end
 
     def state_district
-      @data['address']['state_district']
+      address_data['state_district']
     end
 
     def neighbourhood
-      @data['address']['neighbourhood']
+      address_data['neighbourhood']
     end
 
     def municipality
-      @data['address']['municipality']
+      address_data['municipality']
     end
 
     def coordinates
+      return [] unless @data['lat'] && @data['lon']
+
       [@data['lat'].to_f, @data['lon'].to_f]
     end
 
@@ -109,5 +111,11 @@ module Geocoder::Result
         end
       end
     end
+
+    private
+
+    def address_data
+      @data['address'] || {}
+    end
   end
 end