geocoder 1.2.6 → 1.8.2

data/lib/geocoder/results/nominatim.rb

@@ -4,14 +4,12 @@ module Geocoder::Result
   class Nominatim < Base
 
     def poi
-      %w[stadium bus_stop tram_stop].each do |key|
-        return @data['address'][key] if @data['address'].key?(key)
-      end
+      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
@@ -20,53 +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
+      address_data['city_district']
+    end
+
+    def state_district
+      address_data['state_district']
+    end
+
+    def neighbourhood
+      address_data['neighbourhood']
+    end
+
+    def municipality
+      address_data['municipality']
     end
 
     def coordinates
+      return [] unless @data['lat'] && @data['lon']
+
       [@data['lat'].to_f, @data['lon'].to_f]
     end
 
@@ -78,6 +94,11 @@ module Geocoder::Result
       @data['type']
     end
 
+    def viewport
+      south, north, west, east = @data['boundingbox'].map(&:to_f)
+      [south, west, north, east]
+    end
+
     def self.response_attributes
       %w[place_id osm_type osm_id boundingbox license
          polygonpoints display_name class type stadium]
@@ -90,5 +111,11 @@ module Geocoder::Result
         end
       end
     end
+
+    private
+
+    def address_data
+      @data['address'] || {}
+    end
   end
 end

data/lib/geocoder/results/opencagedata.rb

@@ -36,12 +36,13 @@ module Geocoder::Result
       @data['components']['village']
     end
 
-
     def state
       @data['components']['state']
     end
 
-    alias_method :state_code, :state
+    def state_code
+      @data['components']['state_code']
+    end
 
     def postal_code
       @data['components']['postcode'].to_s
@@ -66,6 +67,23 @@ module Geocoder::Result
     def coordinates
       [@data['geometry']['lat'].to_f, @data['geometry']['lng'].to_f]
     end
+
+    def viewport
+      bounds = @data['bounds'] || fail
+      south, west = %w(lat lng).map { |i| bounds['southwest'][i] }
+      north, east = %w(lat lng).map { |i| bounds['northeast'][i] }
+      [south, west, north, east]
+    end
+
+    def time_zone
+      # The OpenCage API documentation states that `annotations` is available
+      # "when possible" https://geocoder.opencagedata.com/api#annotations
+      @data
+        .fetch('annotations', {})
+        .fetch('timezone', {})
+        .fetch('name', nil)
+    end
+
     def self.response_attributes
       %w[boundingbox license 
         formatted stadium]

data/lib/geocoder/results/osmnames.rb

@@ -0,0 +1,56 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Osmnames < Base
+    def address
+      @data['display_name']
+    end
+
+    def coordinates
+      [@data['lat'].to_f, @data['lon'].to_f]
+    end
+
+    def viewport
+      west, south, east, north = @data['boundingbox'].map(&:to_f)
+      [south, west, north, east]
+    end
+
+    def state
+      @data['state']
+    end
+    alias_method :state_code, :state
+
+    def place_class
+      @data['class']
+    end
+
+    def place_type
+      @data['type']
+    end
+
+    def postal_code
+      ''
+    end
+
+    def country_code
+      @data['country_code']
+    end
+
+    def country
+      @data['country']
+    end
+
+    def self.response_attributes
+      %w[house_number street city name osm_id osm_type boundingbox place_rank
+      importance county rank name_suffix]
+    end
+
+    response_attributes.each do |a|
+      unless method_defined?(a)
+        define_method a do
+          @data[a]
+        end
+      end
+    end
+  end
+end

data/lib/geocoder/results/pc_miler.rb

@@ -0,0 +1,98 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class PcMiler < Base
+    # sample response:
+    # https://singlesearch.alk.com/na/api/search?authToken=<TOKEN>&include=Meta&query=Feasterville
+    #
+    #   {
+    #     "Err": 0,
+    #     "ErrString": "OK",
+    #     "QueryConfidence": 1,
+    #     "TimeInMilliseconds": 93,
+    #     "GridDataVersion": "GRD_ALK.NA.2023.01.18.29.1.1",
+    #     "CommitID": "pcmws-22.08.11.0-1778-g586da49bd1b: 05/30/2023 20:14",
+    #     "Locations": [
+    #       {
+    #         "Address": {
+    #           "StreetAddress": "",
+    #           "LocalArea": "",
+    #           "City": "Feasterville",
+    #           "State": "PA",
+    #           "StateName": "Pennsylvania",
+    #           "Zip": "19053",
+    #           "County": "Bucks",
+    #           "Country": "US",
+    #           "CountryFullName": "United States",
+    #           "SPLC": null
+    #         },
+    #         "Coords": {
+    #           "Lat": "40.150025",
+    #           "Lon": "-75.002511"
+    #         },
+    #         "StreetCoords": {
+    #           "Lat": "40.150098",
+    #           "Lon": "-75.002827"
+    #         },
+    #         "Region": 4,
+    #         "POITypeID": 0,
+    #         "PersistentPOIID": -1,
+    #         "SiteID": -1,
+    #         "ResultType": 4,
+    #         "ShortString": "Feasterville",
+    #         "GridID": 37172748,
+    #         "LinkID": 188,
+    #         "Percent": 6291,
+    #         "TimeZone": "GMT-4:00 EDT"
+    #       }
+    #     ]
+    #   }
+
+    def address(format=:unused)
+      [street, city, state, postal_code, country]
+      .map { |i| i == '' ? nil : i }
+      .compact
+      .join(', ')
+    end
+
+    def coordinates
+      coords = data["Coords"] || {}
+      [coords["Lat"].to_f, coords["Lon"].to_f]
+    end
+
+    def street
+      address_data["StreetAddress"]
+    end
+
+    def city
+      address_data["City"]
+    end
+
+    def state
+      address_data["StateName"]
+    end
+
+    def state_code
+      address_data["State"]
+    end
+
+    def postal_code
+      address_data["Zip"]
+    end
+
+    def country
+      address_data["CountryFullName"]
+    end
+
+    def country_code
+      address_data["Country"]
+    end
+
+    private
+
+    def address_data
+      data["Address"] || {}
+    end
+  end
+end
+

data/lib/geocoder/results/pelias.rb

@@ -0,0 +1,58 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Pelias < Base
+    def address(format = :full)
+      properties['label']
+    end
+
+    def city
+      locality
+    end
+
+    def coordinates
+      geometry['coordinates'].reverse
+    end
+
+    def country_code
+      properties['country_a']
+    end
+
+    def postal_code
+      properties['postalcode'].to_s
+    end
+
+    def province
+      state
+    end
+
+    def state
+      properties['region']
+    end
+
+    def state_code
+      properties['region_a']
+    end
+
+    def self.response_attributes
+      %w[county confidence country gid id layer localadmin locality neighborhood]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        properties[a]
+      end
+    end
+
+    private
+
+    def geometry
+      @data.fetch('geometry', {})
+    end
+
+    def properties
+      @data.fetch('properties', {})
+    end
+  end
+end
+

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/results/pickpoint.rb

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

data/lib/geocoder/results/pointpin.rb

@@ -23,10 +23,6 @@ module Geocoder::Result
       @data['country_name']
     end
 
-    def country_code
-      @data['country_code']
-    end
-
     def postal_code
       @data['postcode']
     end

data/lib/geocoder/results/postcodes_io.rb

@@ -0,0 +1,40 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class PostcodesIo < Base
+
+    def coordinates
+      [@data['latitude'].to_f, @data['longitude'].to_f]
+    end
+
+    def quality
+      @data['quality']
+    end
+
+    def postal_code
+      @data['postcode']
+    end
+    alias address postal_code
+
+    def city
+      @data['admin_ward']
+    end
+
+    def county
+      @data['admin_county']
+    end
+    alias state county
+
+    def state_code
+      @data['codes']['admin_county']
+    end
+
+    def country
+      'United Kingdom'
+    end
+
+    def country_code
+      'UK'
+    end
+  end
+end

data/lib/geocoder/results/smarty_streets.rb

@@ -3,57 +3,89 @@ require 'geocoder/lookups/base'
 module Geocoder::Result
   class SmartyStreets < Base
     def coordinates
-      %w(latitude longitude).map do |i|
+      result = %w(latitude longitude).map do |i|
         zipcode_endpoint? ? zipcodes.first[i] : metadata[i]
       end
+
+      if result.compact.empty?
+        nil
+      else
+        result
+      end
     end
 
     def address
-      [
-        delivery_line_1,
-        delivery_line_2,
-        last_line
-      ].select{ |i| i.to_s != "" }.join(" ")
+      parts =
+        if international_endpoint?
+          (1..12).map { |i| @data["address#{i}"] }
+        else
+          [
+            delivery_line_1,
+            delivery_line_2,
+            last_line
+          ]
+        end
+      parts.select{ |i| i.to_s != "" }.join(" ")
     end
 
     def state
-      zipcode_endpoint? ?
-        city_states.first['state'] :
+      if international_endpoint?
+        components['administrative_area']
+      elsif zipcode_endpoint?
+        city_states.first['state']
+      else
         components['state_abbreviation']
+      end
     end
 
     def state_code
-      zipcode_endpoint? ?
-        city_states.first['state_abbreviation'] :
+      if international_endpoint?
+        components['administrative_area']
+      elsif zipcode_endpoint?
+        city_states.first['state_abbreviation']
+      else
         components['state_abbreviation']
+      end
     end
 
     def country
-      # SmartyStreets returns results for USA only
-      "United States"
+      international_endpoint? ?
+        components['country_iso_3'] :
+        "United States"
     end
 
     def country_code
-      # SmartyStreets returns results for USA only
-      "US"
+      international_endpoint? ?
+        components['country_iso_3'] :
+        "US"
     end
 
     ## Extra methods not in base.rb ------------------------
 
     def street
-      components['street_name']
+      international_endpoint? ?
+        components['thoroughfare_name'] :
+        components['street_name']
     end
 
     def city
-      zipcode_endpoint? ?
-        city_states.first['city'] :
+      if international_endpoint?
+        components['locality']
+      elsif zipcode_endpoint?
+        city_states.first['city']
+      else
         components['city_name']
+      end
     end
 
     def zipcode
-      zipcode_endpoint? ?
-        zipcodes.first['zipcode'] :
+      if international_endpoint?
+        components['postal_code']
+      elsif zipcode_endpoint?
+        zipcodes.first['zipcode']
+      else
         components['zipcode']
+      end
     end
     alias_method :postal_code, :zipcode
 
@@ -72,6 +104,10 @@ module Geocoder::Result
       zipcodes.any?
     end
 
+    def international_endpoint?
+      !@data['address1'].nil?
+    end
+
     [
       :delivery_line_1,
       :delivery_line_2,

data/lib/geocoder/results/telize.rb

@@ -3,11 +3,6 @@ require 'geocoder/results/base'
 module Geocoder::Result
   class Telize < Base
 
-    def address(format = :full)
-      s = state_code.to_s == "" ? "" : ", #{state_code}"
-      "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
-    end
-
     def city
       @data['city']
     end