Merge pull request #730 from TheSmartnik/add_geocommands

Add geo commands

Author: badboy

lib/redis.rb

@@ -2710,6 +2710,86 @@ def pfmerge(dest_key, *source_key)
     end
   end
 
+  # Adds the specified geospatial items (latitude, longitude, name) to the specified key
+  #
+  # @param [String] key
+  # @param [Array] member arguemnts for member or members: longitude, latitude, name
+  # @return [Intger] number of elements added to the sorted set
+  def geoadd(key, *member)
+    synchronize do |client|
+      client.call([:geoadd, key, member])
+    end
+  end
+
+  # Returns geohash string representing position for specified members of the specified key.
+  #
+  # @param [String] key
+  # @param [String, Array<String>] member one member or array of members
+  # @return [Array<String, nil>] returns array containg geohash string if member is present, nil otherwise
+  def geohash(key, member)
+    synchronize do |client|
+      client.call([:geohash, key, member])
+    end
+  end
+
+
+  # Query a sorted set representing a geospatial index to fetch members matching a
+  # given maximum distance from a point
+  #
+  # @param [Array] args key, longitude, latitude, radius, unit(m|km|ft|mi)
+  # @param ['asc', 'desc'] sort sort returned items from the nearest to the farthest or the farthest to the nearest relative to the center
+  # @param [Integer] count limit the results to the first N matching items
+  # @param ['WITHDIST', 'WITHCOORD', 'WITHHASH'] options to return additional information
+  # @return [Array<String>] may be changed with `options`
+
+  def georadius(*args, **geoptions)
+    geoarguments = _geoarguments(*args, **geoptions)
+
+    synchronize do |client|
+      client.call([:georadius, *geoarguments])
+    end
+  end
+
+  # Query a sorted set representing a geospatial index to fetch members matching a
+  # given maximum distance from an already existing member
+  #
+  # @param [Array] args key, member, radius, unit(m|km|ft|mi)
+  # @param ['asc', 'desc'] sort sort returned items from the nearest to the farthest or the farthest to the nearest relative to the center
+  # @param [Integer] count limit the results to the first N matching items
+  # @param ['WITHDIST', 'WITHCOORD', 'WITHHASH'] options to return additional information
+  # @return [Array<String>] may be changed with `options`
+
+  def georadiusbymember(*args, **geoptions)
+    geoarguments = _geoarguments(*args, **geoptions)
+
+    synchronize do |client|
+      client.call([:georadiusbymember, *geoarguments])
+    end
+  end
+
+  # Returns longitude and latitude of members of a geospatial index
+  #
+  # @param [String] key
+  # @param [String, Array<String>] member one member or array of members
+  # @return [Array<Array<String>, nil>] returns array of elements, where each element is either array of longitude and latitude or nil
+  def geopos(key, member)
+    synchronize do |client|
+      client.call([:geopos, key, member])
+    end
+  end
+
+  # Returns the distance between two members of a geospatial index
+  #
+  # @param [String ]key
+  # @param [Array<String>] members
+  # @param ['m', 'km', 'mi', 'ft'] unit
+  # @return [String, nil] returns distance in spefied unit if both members present, nil otherwise.
+  def geodist(key, member1, member2, unit = 'm')
+    synchronize do |client|
+      client.call([:geodist, key, member1, member2, unit])
+    end
+  end
+
   # Interact with the sentinel command (masters, master, slaves, failover)
   #
   # @param [String] subcommand e.g. `masters`, `master`, `slaves`
@@ -2813,6 +2893,14 @@ def method_missing(command, *args)
       end
     }
 
+  def _geoarguments(*args, options: nil, sort: nil, count: nil)
+    args.push sort if sort
+    args.push 'count', count if count
+    args.push options if options
+
+    args.uniq
+  end
+
   def _subscription(method, timeout, channels, block)
     return @client.call([method] + channels) if subscribed?
 

test/commands_on_geo_test.rb

@@ -0,0 +1,90 @@
+require_relative "helper"
+
+class TestCommandsGeo < Test::Unit::TestCase
+  include Helper::Client
+
+  def setup
+    super
+
+    added_items_count = r.geoadd("Sicily", 13.361389, 38.115556, "Palermo", 15.087269, 37.502669, "Catania")
+    assert_equal 2, added_items_count
+  end
+
+  def test_georadius_with_sort
+    nearest_cities = r.georadius("Sicily", 15, 37, 200, 'km', sort: 'asc')
+    assert_equal %w(Catania Palermo), nearest_cities
+
+    farthest_cities = r.georadius("Sicily", 15, 37, 200, 'km', sort: 'desc')
+    assert_equal %w(Palermo Catania), farthest_cities
+  end
+
+  def test_georadius_with_count
+    city = r.georadius("Sicily", 15, 37, 200, 'km', count: 1)
+    assert_equal %w(Catania), city
+  end
+
+  def test_georadius_with_options_count_sort
+    city = r.georadius("Sicily", 15, 37, 200, 'km', sort: :desc, options: :WITHDIST, count: 1)
+    assert_equal [["Palermo", "190.4424"]], city
+  end
+
+  def test_georadiusbymember_with_sort
+    nearest_cities = r.georadiusbymember("Sicily", "Catania", 200, 'km', sort: 'asc')
+    assert_equal %w(Catania Palermo), nearest_cities
+
+    farthest_cities = r.georadiusbymember("Sicily", "Catania", 200, 'km', sort: 'desc')
+    assert_equal %w(Palermo Catania), farthest_cities
+  end
+
+  def test_georadiusbymember_with_count
+    city = r.georadiusbymember("Sicily", "Catania", 200, 'km', count: 1)
+    assert_equal %w(Catania), city
+  end
+
+  def test_georadiusbymember_with_options_count_sort
+    city = r.georadiusbymember("Sicily", "Catania", 200, 'km', sort: :desc, options: :WITHDIST, count: 1)
+    assert_equal [["Palermo", "166.2742"]], city
+  end
+
+  def test_geopos
+    location = r.geopos("Sicily", "Catania")
+    assert_equal [["15.08726745843887329", "37.50266842333162032"]], location
+
+    locations = r.geopos("Sicily", ["Palermo", "Catania"])
+    assert_equal [["13.36138933897018433", "38.11555639549629859"], ["15.08726745843887329", "37.50266842333162032"]], locations
+  end
+
+  def test_geopos_nonexistant_location
+    location = r.geopos("Sicily", "Rome")
+    assert_equal [nil], location
+
+    locations = r.geopos("Sicily", ["Rome", "Catania"])
+    assert_equal [nil, ["15.08726745843887329", "37.50266842333162032"]], locations
+  end
+
+  def test_geodist
+    distination_in_meters = r.geodist("Sicily", "Palermo", "Catania")
+    assert_equal "166274.1516", distination_in_meters
+
+    distination_in_feet = r.geodist("Sicily", "Palermo", "Catania", 'ft')
+    assert_equal "545518.8700", distination_in_feet
+  end
+
+  def test_geodist_with_nonexistant_location
+    distination = r.geodist("Sicily", "Palermo", "Rome")
+    assert_equal nil, distination
+  end
+
+  def test_geohash
+    geohash = r.geohash("Sicily", "Palermo")
+    assert_equal ["sqc8b49rny0"], geohash
+
+    geohashes = r.geohash("Sicily", ["Palermo", "Catania"])
+    assert_equal %w(sqc8b49rny0 sqdtr74hyu0), geohashes
+  end
+
+  def test_geohash_with_nonexistant_location
+    geohashes = r.geohash("Sicily", ["Palermo", "Rome"])
+    assert_equal ["sqc8b49rny0", nil], geohashes
+  end
+end