geocoder 1.7.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86304e3364377f7c93cc2a91dba1235316b63469ee1c09261b0763db052bcded
-  data.tar.gz: ab4d2167f60e9149bb052e98bf11df40f7b68a0f75873d7c95e638e7c84acda2
+  metadata.gz: 29b831bd2fcb54be9ffadc479be5c2010fb11191b1f240e0868d8ff6bdd379af
+  data.tar.gz: 0d9ca932a2cdcd36b0014e271a96afbc867f6b0f151b1e119c533d64b260048e
 SHA512:
-  metadata.gz: 3d8a017acef8c3c15e48c641311b38363f28d7900047fc5bf371d669dcd083401736b30de9ccc859290234a1d44308694de338bddca4cd2706df35fe2c060dbe
-  data.tar.gz: 372826b2a2ac13ed235eb7a78c9fdb4b214d54e28672a9ff24ae88f16ef9f4d07c867d6d09f0e90cd6e7e0e9adea975a9932356a2238a9a0eb15f987ee5d4c69
+  metadata.gz: aa027cbdf72f35e4c19e9413f483c245a7a8b1286ac5ad9cc9c527fd8d05e9ab4dd6a43065a60dac089ec94e2798228f823a2d517d8b0b36ef0c978a9bc59cd6
+  data.tar.gz: 20e927de754e571eb2587734a2027e5aeb57bb8a38a487b6a8d04504bb6b22678b4ab2c9485e0a79d0006969468254a8c094e543192a0f305b62346adb129c43

data/CHANGELOG.md

@@ -3,6 +3,10 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.7.1 (2022 Jan  1)
+-------------------
+* Various bugfixes and refactorings.
+
 1.7.0 (2021 Oct 11)
 -------------------
 * Add support for Geoapify and Photo lookups (thanks github.com/ahukkanen).

data/README.md

@@ -246,9 +246,12 @@ Geocoder.configure(
   units: :km,
 
   # caching (see Caching section below for details):
+  # warning: `cache_prefix` is deprecated, use `cache_options` instead
   cache: Redis.new,
-  cache_prefix: "..."
-
+  cache_options: {
+    expiration: 2.days, # Redis ttl
+    prefix: "..."
+  }
 )
 ```
 

data/lib/generators/geocoder/config/templates/initializer.rb

@@ -9,7 +9,7 @@ Geocoder.configure(
   # https_proxy: nil,           # HTTPS proxy server (user:pass@host:port)
   # api_key: nil,               # API key for geocoding service
   # cache: nil,                 # cache object (must respond to #[], #[]=, and #del)
-  # cache_prefix: 'geocoder:',  # prefix (string) to use for all cache keys
+  # cache_prefix: 'geocoder:',  # DEPRECATED, please use cache_options[:prefix] instead
 
   # Exceptions that should not be rescued by default
   # (if you want to implement custom error handling);
@@ -19,4 +19,10 @@ Geocoder.configure(
   # Calculation options
   # units: :mi,                 # :km for kilometers or :mi for miles
   # distances: :linear          # :spherical or :linear
+
+  # Cache configuration
+  # cache_options: {
+  #   expiration: 2.days,
+  #   prefix: 'geocoder:'
+  # }
 )

data/lib/geocoder/cache.rb

@@ -1,23 +1,18 @@
+Dir["#{__dir__}/cache_stores/*.rb"].each {|file| require file }
+
 module Geocoder
   class Cache
 
-    def initialize(store, prefix)
-      @store = store
-      @prefix = prefix
+    def initialize(store, config)
+      @class = (Object.const_get("Geocoder::CacheStore::#{store.class}") rescue Geocoder::CacheStore::Generic)
+      @store_service = @class.new(store, config)
     end
 
     ##
     # Read from the Cache.
     #
     def [](url)
-      interpret case
-        when store.respond_to?(:[])
-          store[key_for(url)]
-        when store.respond_to?(:get)
-          store.get key_for(url)
-        when store.respond_to?(:read)
-          store.read key_for(url)
-      end
+      interpret store_service.read(url)
     rescue => e
       warn "Geocoder cache read error: #{e}"
     end
@@ -26,14 +21,7 @@ module Geocoder
     # Write to the Cache.
     #
     def []=(url, value)
-      case
-        when store.respond_to?(:[]=)
-          store[key_for(url)] = value
-        when store.respond_to?(:set)
-          store.set key_for(url), value
-        when store.respond_to?(:write)
-          store.write key_for(url), value
-      end
+      store_service.write(url, value)
     rescue => e
       warn "Geocoder cache write error: #{e}"
     end
@@ -44,7 +32,7 @@ module Geocoder
     #
     def expire(url)
       if url == :all
-        if store.respond_to?(:keys)
+        if store_service.respond_to?(:keys)
           urls.each{ |u| expire(u) }
         else
           raise(NoMethodError, "The Geocoder cache store must implement `#keys` for `expire(:all)` to work")
@@ -57,33 +45,21 @@ module Geocoder
 
     private # ----------------------------------------------------------------
 
-    def prefix; @prefix; end
-    def store; @store; end
-
-    ##
-    # Cache key for a given URL.
-    #
-    def key_for(url)
-      if url.match(/^#{prefix}/)
-        url
-      else
-        [prefix, url].join
-      end
-    end
+    def store_service; @store_service; end
 
     ##
     # Array of keys with the currently configured prefix
     # that have non-nil values.
     #
     def keys
-      store.keys.select{ |k| k.match(/^#{prefix}/) and self[k] }
+      store_service.keys
     end
 
     ##
     # Array of cached URLs.
     #
     def urls
-      keys.map{ |k| k[/^#{prefix}(.*)/, 1] }
+      store_service.urls
     end
 
     ##
@@ -95,8 +71,7 @@ module Geocoder
     end
 
     def expire_single_url(url)
-      key = key_for(url)
-      store.respond_to?(:del) ? store.del(key) : store.delete(key)
+      store_service.remove(url)
     end
   end
 end

data/lib/geocoder/cache_stores/base.rb

@@ -0,0 +1,40 @@
+module Geocoder::CacheStore
+  class Base
+    def initialize(store, options)
+      @store = store
+      @config = options
+      @prefix = config[:prefix]
+    end
+
+    ##
+    # Array of keys with the currently configured prefix
+    # that have non-nil values.
+    def keys
+      store.keys.select { |k| k.match(/^#{prefix}/) and self[k] }
+    end
+
+    ##
+    # Array of cached URLs.
+    #
+    def urls
+      keys
+    end
+
+    protected # ----------------------------------------------------------------
+
+    def prefix; @prefix; end
+    def store; @store; end
+    def config; @config; end
+
+    ##
+    # Cache key for a given URL.
+    #
+    def key_for(url)
+      if url.match(/^#{prefix}/)
+        url
+      else
+        [prefix, url].join
+      end
+    end
+  end
+end

data/lib/geocoder/cache_stores/generic.rb

@@ -0,0 +1,33 @@
+module Geocoder::CacheStore
+  class Generic < Base
+    def write(url, value)
+      case
+      when store.respond_to?(:[]=)
+        store[key_for(url)] = value
+      when store.respond_to?(:set)
+        store.set key_for(url), value
+      when store.respond_to?(:write)
+        store.write key_for(url), value
+      end
+    end
+
+    def read(url)
+      case
+      when store.respond_to?(:[])
+        store[key_for(url)]
+      when store.respond_to?(:get)
+        store.get key_for(url)
+      when store.respond_to?(:read)
+        store.read key_for(url)
+      end
+    end
+
+    def keys
+      store.keys
+    end
+
+    def remove(key)
+      store.delete(key)
+    end
+  end
+end

data/lib/geocoder/cache_stores/redis.rb

@@ -0,0 +1,32 @@
+module Geocoder::CacheStore
+  class Redis < Base
+    def initialize(store, options)
+      super
+      @expiration = options[:expiration]
+    end
+
+    def write(url, value, expire = @expiration)
+      if expire.present?
+        store.set key_for(url), value, ex: expire
+      else
+        store.set key_for(url), value
+      end
+    end
+
+    def read(url)
+      store.get key_for(url)
+    end
+
+    def keys
+      store.keys("#{prefix}*")
+    end
+
+    def remove(key)
+      store.del(key)
+    end
+
+    private # ----------------------------------------------------------------
+
+    def expire; @expiration; end
+  end
+end

data/lib/geocoder/configuration.rb

@@ -68,7 +68,8 @@ module Geocoder
       :distances,
       :basic_auth,
       :logger,
-      :kernel_logger_level
+      :kernel_logger_level,
+      :cache_options
     ]
 
     attr_accessor :data
@@ -108,7 +109,7 @@ module Geocoder
       @data[:https_proxy]  = nil         # HTTPS proxy server (user:pass@host:port)
       @data[:api_key]      = nil         # API key for geocoding service
       @data[:cache]        = nil         # cache object (must respond to #[], #[]=, and #keys)
-      @data[:cache_prefix] = "geocoder:" # prefix (string) to use for all cache keys
+      @data[:cache_prefix] = "geocoder:" # - DEPRECATED - prefix (string) to use for all cache keys
       @data[:basic_auth]   = {}          # user and password for basic auth ({:user => "user", :password => "password"})
       @data[:logger]       = :kernel     # :kernel or Logger instance
       @data[:kernel_logger_level] = ::Logger::WARN # log level, if kernel logger is used
@@ -121,6 +122,9 @@ module Geocoder
       # calculation options
       @data[:units]     = :mi      # :mi or :km
       @data[:distances] = :linear  # :linear or :spherical
+
+      # explicit cache service options
+      @data[:cache_options] = {}
     end
 
     instance_eval(OPTIONS.map do |option|

data/lib/geocoder/lookups/amazon_location_service.rb

@@ -4,12 +4,21 @@ require 'geocoder/results/amazon_location_service'
 module Geocoder::Lookup
   class AmazonLocationService < Base
     def results(query)
-      params = { **global_index_name, **query.options }
-      if query.reverse_geocode?
-        resp = client.search_place_index_for_position(**{ **params, position: query.coordinates.reverse })
+      params = query.options.dup
+
+      # index_name is required
+      # Aws::ParamValidator raises ArgumentError on missing required keys
+      params.merge!(index_name: configuration[:index_name])
+
+      # Aws::ParamValidator raises ArgumentError on unexpected keys
+      params.delete(:lookup) 
+      
+      resp = if query.reverse_geocode?
+        client.search_place_index_for_position(params.merge(position: query.coordinates.reverse))
       else
-        resp = client.search_place_index_for_text(**{ **params, text: query.text })
+        client.search_place_index_for_text(params.merge(text: query.text))
       end
+      
       resp.results.map(&:place)
     end
 
@@ -41,13 +50,5 @@ module Geocoder::Lookup
           )
       end
     end
-
-    def global_index_name
-      if configuration[:index_name]
-        { index_name: configuration[:index_name] }
-      else
-        {}
-      end
-    end
   end
 end

data/lib/geocoder/lookups/base.rb

@@ -83,8 +83,14 @@ module Geocoder
       # The working Cache object.
       #
       def cache
-        if @cache.nil? and store = configuration.cache
-          @cache = Cache.new(store, configuration.cache_prefix)
+        if @cache.nil? && (store = configuration.cache)
+          cache_options = configuration.cache_options
+          cache_prefix = (configuration.cache_prefix rescue false)
+          if cache_prefix
+            cache_options[:prefix] ||= configuration.cache_prefix
+            warn '[Geocoder] cache_prefix is deprecated, please change to cache_options.prefix instead'
+          end
+          @cache = Cache.new(store, cache_options)
         end
         @cache
       end

data/lib/geocoder/lookups/ipdata_co.rb

@@ -47,7 +47,7 @@ module Geocoder::Lookup
     end
 
     def host
-      "api.ipdata.co"
+      configuration[:host] || "api.ipdata.co"
     end
 
     def check_response_for_errors!(response)

data/lib/geocoder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2022-01-01 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,
@@ -39,6 +39,9 @@ files:
 - lib/generators/geocoder/migration_version.rb
 - lib/geocoder.rb
 - lib/geocoder/cache.rb
+- lib/geocoder/cache_stores/base.rb
+- lib/geocoder/cache_stores/generic.rb
+- lib/geocoder/cache_stores/redis.rb
 - lib/geocoder/calculations.rb
 - lib/geocoder/cli.rb
 - lib/geocoder/configuration.rb