geocoder 1.5.1 → 1.7.3

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

@@ -27,7 +27,10 @@ module Geocoder::Result
     end  
 
     def state
-      address_data['County']
+      fail unless d = address_data['AdditionalData']
+      if v = d.find{|ad| ad['key']=='StateName'}
+        return v['value']
+      end
     end
 
     def province

data/lib/geocoder/results/ipgeolocation.rb

@@ -0,0 +1,59 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ipgeolocation < Base
+
+    def coordinates
+      [@data['latitude'].to_f, @data['longitude'].to_f]
+    end
+
+    def address(format = :full)
+      "#{city}, #{state} #{postal_code}, #{country_name}".sub(/^[ ,]*/, "")
+    end
+
+    def state
+      @data['state_prov']
+    end
+
+    def state_code
+      @data['state_prov']
+    end
+
+    def country
+      @data['country_name']
+    end
+
+    def country_code
+      @data['country_code2']
+    end
+
+    def postal_code
+      @data['zipcode']
+    end
+
+    def self.response_attributes
+      [
+          ['ip', ''],
+          ['hostname', ''],
+          ['continent_code', ''],
+          ['continent_name', ''],
+          ['country_code2', ''],
+          ['country_code3', ''],
+          ['country_name', ''],
+          ['country_capital',''],
+          ['district',''],
+          ['state_prov',''],
+          ['city', ''],
+          ['zipcode', ''],
+          ['time_zone', {}],
+          ['currency', {}]
+      ]
+    end
+
+    response_attributes.each do |attr, default|
+      define_method attr do
+        @data[attr] || default
+      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

@@ -0,0 +1,304 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ipregistry < Base
+
+    def initialize(data)
+      super
+
+      @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
+          flatten_hash(v).map do |h_k, h_v|
+            h["#{k}_#{h_k}".to_s] = h_v
+          end
+        else
+          h[k] = v
+        end
+      end
+    end
+
+    private :flatten_hash
+
+    def city
+      @data['location_city']
+    end
+
+    def country
+      @data['location_country_name']
+    end
+
+    def country_code
+      @data['location_country_code']
+    end
+
+    def postal_code
+      @data['location_postal']
+    end
+
+    def state
+      @data['location_region_name']
+    end
+
+    def state_code
+      @data['location_region_code']
+    end
+
+    # methods for fields specific to Ipregistry
+
+    def ip
+      @data["ip"]
+    end
+
+    def type
+      @data["type"]
+    end
+
+    def hostname
+      @data["hostname"]
+    end
+
+    def carrier_name
+      @data["carrier_name"]
+    end
+
+    def carrier_mcc
+      @data["carrier_mcc"]
+    end
+
+    def carrier_mnc
+      @data["carrier_mnc"]
+    end
+
+    def connection_asn
+      @data["connection_asn"]
+    end
+
+    def connection_domain
+      @data["connection_domain"]
+    end
+
+    def connection_organization
+      @data["connection_organization"]
+    end
+
+    def connection_type
+      @data["connection_type"]
+    end
+
+    def currency_code
+      @data["currency_code"]
+    end
+
+    def currency_name
+      @data["currency_name"]
+    end
+
+    def currency_plural
+      @data["currency_plural"]
+    end
+
+    def currency_symbol
+      @data["currency_symbol"]
+    end
+
+    def currency_symbol_native
+      @data["currency_symbol_native"]
+    end
+
+    def currency_format_negative_prefix
+      @data["currency_format_negative_prefix"]
+    end
+
+    def currency_format_negative_suffix
+      @data["currency_format_negative_suffix"]
+    end
+
+    def currency_format_positive_prefix
+      @data["currency_format_positive_prefix"]
+    end
+
+    def currency_format_positive_suffix
+      @data["currency_format_positive_suffix"]
+    end
+
+    def location_continent_code
+      @data["location_continent_code"]
+    end
+
+    def location_continent_name
+      @data["location_continent_name"]
+    end
+
+    def location_country_area
+      @data["location_country_area"]
+    end
+
+    def location_country_borders
+      @data["location_country_borders"]
+    end
+
+    def location_country_calling_code
+      @data["location_country_calling_code"]
+    end
+
+    def location_country_capital
+      @data["location_country_capital"]
+    end
+
+    def location_country_code
+      @data["location_country_code"]
+    end
+
+    def location_country_name
+      @data["location_country_name"]
+    end
+
+    def location_country_population
+      @data["location_country_population"]
+    end
+
+    def location_country_population_density
+      @data["location_country_population_density"]
+    end
+
+    def location_country_flag_emoji
+      @data["location_country_flag_emoji"]
+    end
+
+    def location_country_flag_emoji_unicode
+      @data["location_country_flag_emoji_unicode"]
+    end
+
+    def location_country_flag_emojitwo
+      @data["location_country_flag_emojitwo"]
+    end
+
+    def location_country_flag_noto
+      @data["location_country_flag_noto"]
+    end
+
+    def location_country_flag_twemoji
+      @data["location_country_flag_twemoji"]
+    end
+
+    def location_country_flag_wikimedia
+      @data["location_country_flag_wikimedia"]
+    end
+
+    def location_country_languages
+      @data["location_country_languages"]
+    end
+
+    def location_country_tld
+      @data["location_country_tld"]
+    end
+
+    def location_region_code
+      @data["location_region_code"]
+    end
+
+    def location_region_name
+      @data["location_region_name"]
+    end
+
+    def location_city
+      @data["location_city"]
+    end
+
+    def location_postal
+      @data["location_postal"]
+    end
+
+    def location_latitude
+      @data["location_latitude"]
+    end
+
+    def location_longitude
+      @data["location_longitude"]
+    end
+
+    def location_language_code
+      @data["location_language_code"]
+    end
+
+    def location_language_name
+      @data["location_language_name"]
+    end
+
+    def location_language_native
+      @data["location_language_native"]
+    end
+
+    def location_in_eu
+      @data["location_in_eu"]
+    end
+
+    def security_is_bogon
+      @data["security_is_bogon"]
+    end
+
+    def security_is_cloud_provider
+      @data["security_is_cloud_provider"]
+    end
+
+    def security_is_tor
+      @data["security_is_tor"]
+    end
+
+    def security_is_tor_exit
+      @data["security_is_tor_exit"]
+    end
+
+    def security_is_proxy
+      @data["security_is_proxy"]
+    end
+
+    def security_is_anonymous
+      @data["security_is_anonymous"]
+    end
+
+    def security_is_abuser
+      @data["security_is_abuser"]
+    end
+
+    def security_is_attacker
+      @data["security_is_attacker"]
+    end
+
+    def security_is_threat
+      @data["security_is_threat"]
+    end
+
+    def time_zone_id
+      @data["time_zone_id"]
+    end
+
+    def time_zone_abbreviation
+      @data["time_zone_abbreviation"]
+    end
+
+    def time_zone_current_time
+      @data["time_zone_current_time"]
+    end
+
+    def time_zone_name
+      @data["time_zone_name"]
+    end
+
+    def time_zone_offset
+      @data["time_zone_offset"]
+    end
+
+    def time_zone_in_daylight_saving
+      @data["time_zone_in_daylight_saving"]
+    end
+  end
+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