geocoder 1.1.9 → 1.8.0

data/lib/geocoder/results/ipdata_co.rb

@@ -0,0 +1,40 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class IpdataCo < Base
+
+    def city
+      @data['city']
+    end
+
+    def state
+      @data['region']
+    end
+
+    def state_code
+      @data['region_code']
+    end
+
+    def country
+      @data['country_name']
+    end
+
+    def country_code
+      @data['country_code']
+    end
+
+    def postal_code
+      @data['postal']
+    end
+
+    def self.response_attributes
+      %w[ip asn organisation currency currency_symbol calling_code flag time_zone is_eu]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class IpinfoIo < Base
+
+    def address(format = :full)
+      "#{city} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
+    end
+
+    def coordinates
+      @data['loc'].to_s.split(",").map(&:to_f)
+    end
+
+    def city
+      @data['city']
+    end
+
+    def state
+      @data['region']
+    end
+
+    def country
+      @data['country']
+    end
+
+    def postal_code
+      @data['postal']
+    end
+
+    def country_code
+      @data.fetch('country', '')
+    end
+
+    def state_code
+      @data.fetch('region_code', '')
+    end
+
+    def self.response_attributes
+      %w(ip region postal)
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      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/ipstack.rb

@@ -0,0 +1,60 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ipstack < Base
+
+    def address(format = :full)
+      s = region_code.empty? ? "" : ", #{region_code}"
+      "#{city}#{s} #{zip}, #{country_name}".sub(/^[ ,]*/, "")
+    end
+
+    def state
+      @data['region_name']
+    end
+
+    def state_code
+      @data['region_code']
+    end
+
+    def country
+      @data['country_name']
+    end
+
+    def postal_code
+      @data['zip'] || @data['zipcode'] || @data['zip_code']
+    end
+
+    def self.response_attributes
+      [
+        ['ip', ''],
+        ['hostname', ''],
+        ['continent_code', ''],
+        ['continent_name', ''],
+        ['country_code', ''],
+        ['country_name', ''],
+        ['region_code', ''],
+        ['region_name', ''],
+        ['city', ''],
+        ['zip', ''],
+        ['latitude', 0],
+        ['longitude', 0],
+        ['location', {}],
+        ['time_zone', {}],
+        ['currency', {}],
+        ['connection', {}],
+        ['security', {}],
+      ]
+    end
+
+    response_attributes.each do |attr, default|
+      define_method attr do
+        @data[attr] || default
+      end
+    end
+
+    def metro_code
+      Geocoder.log(:warn, "Ipstack does not implement `metro_code` in api results.  Please discontinue use.")
+      0 # no longer implemented by ipstack
+    end
+  end
+end

data/lib/geocoder/results/latlon.rb

@@ -0,0 +1,71 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Latlon < Base
+
+    def city
+      address_components["city"]
+    end
+
+    def coordinates
+      [@data['lat'].to_f, @data['lon'].to_f]
+    end
+
+    def country
+      "United States" # LatLon.io only supports the US
+    end
+
+    def country_code
+      "US" # LatLon.io only supports the US
+    end
+
+    def formatted_address(format = :full)
+      address_components["address"]
+    end
+    alias_method :address, :formatted_address
+
+    def number
+      address_components["number"]
+    end
+
+    def prefix
+      address_components["prefix"]
+    end
+
+    def state
+      address_components["state"]
+    end
+    alias_method :state_code, :state
+
+    def street
+      [street_name, street_type].compact.join(' ')
+    end
+
+    def street_name
+      address_components["street_name"]
+    end
+
+    def street_type
+      address_components["street_type"]
+    end
+
+    def suffix
+      address_components["suffix"]
+    end
+
+    def unit
+      address_components["unit"]
+    end
+
+    def zip
+      address_components["zip"]
+    end
+    alias_method :postal_code, :zip
+
+    private
+
+    def address_components
+      @data["address"] || {}
+    end
+  end
+end

data/lib/geocoder/results/location_iq.rb

@@ -0,0 +1,6 @@
+require 'geocoder/results/nominatim'
+
+module Geocoder::Result
+  class LocationIq < Nominatim
+  end
+end

data/lib/geocoder/results/mapbox.rb

@@ -0,0 +1,63 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Mapbox < Base
+
+    def coordinates
+      data['geometry']['coordinates'].reverse.map(&:to_f)
+    end
+
+    def place_name
+      data['text']
+    end
+
+    def street
+      data['properties']['address']
+    end
+
+    def city
+      context_part('place')
+    end
+
+    def state
+      context_part('region')
+    end
+
+    def state_code
+      value = context_part('region', 'short_code')
+      value.split('-').last unless value.nil?
+    end
+
+    def postal_code
+      context_part('postcode')
+    end
+
+    def country
+      context_part('country')
+    end
+
+    def country_code
+      value = context_part('country', 'short_code')
+      value.upcase unless value.nil?
+    end
+
+    def neighborhood
+      context_part('neighborhood')
+    end
+
+    def address
+      [place_name, street, city, state, postal_code, country].compact.join(', ')
+    end
+
+    private
+
+    def context_part(name, key = 'text')
+      (context.detect { |c| c['id'] =~ Regexp.new(name) } || {})[key]
+    end
+
+    def context
+      Array(data['context'])
+    end
+  end
+end
+