redis 4.0.1 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e0d0ba2328aca583c0f487729779c2b10b12c7b
-  data.tar.gz: 4a411cfa3512bafe7c2c12ac8a02c02bc87065aa
+  metadata.gz: 1ec178932a6874e8ac7a4f6cfa4390c8223367ec
+  data.tar.gz: 986e6c5d1729b9ec8f7d66900e5d9ad9437e29f9
 SHA512:
-  metadata.gz: 3af7dc63dc7bdc243da306817583db9b6989c21a0714c6652b4a443bfd9c46b2afba0707b028d708a74148bbeedd09d4ec207a0459b3559cb19b95f2f030bb07
-  data.tar.gz: 98d5aed456ebcd3ccdc50980879a3c14be4c8a1874c6febae95579d2fb3828bda2e82b05e62dc6a4966e178993d4a2a20dc3dedd9f8583cd731851eab2f8e164
+  metadata.gz: 14db8cb42f08014ebd942c39b5f119a68a8ec50fec046572bb3afc7708634589311b9bea0d4153bfd1d7cb1c46a94a00d77613872b2cb8c10c33f132755cd62d
+  data.tar.gz: efe0db683450fcb30b6d23b8c9448d6925b5c5d95b847f9563405a61cc7e667bbf8aea22642dcc9d8a1b716dc9c8cb55c562c86a08223e020991f69eff7df7f7

data/.gitignore

@@ -5,6 +5,7 @@ Gemfile.lock
 /tmp/
 /.idea
 /.yardoc
+/.bundle
 /coverage/*
 /doc/
 /examples/sentinel/sentinel.conf
@@ -14,3 +15,5 @@ Gemfile.lock
 /redis/*
 /test/db
 /test/test.conf
+appendonly.aof
+temp-rewriteaof-*.aof

data/.travis.yml

@@ -1,13 +1,19 @@
 language: ruby
+cache:
+    directories:
+      - tmp/cache
+before_install:
+  - gem update --system 2.6.14
+  - gem --version
 
-script: make test
+script: make
 
 rvm:
   - 2.2.2
   - 2.3.3
   - 2.4.1
-  - jruby-9
-  - rbx-3
+  - 2.5.0
+  - jruby-9.1.17.0
 
 gemfile: ".travis/Gemfile"
 
@@ -19,7 +25,7 @@ before_script:
 env:
   global:
     - VERBOSE=true
-    - TIMEOUT=1
+    - TIMEOUT=9
   matrix:
     - DRIVER=ruby      REDIS_BRANCH=3.0
     - DRIVER=ruby      REDIS_BRANCH=3.2
@@ -27,7 +33,7 @@ env:
     - DRIVER=hiredis   REDIS_BRANCH=3.2
     - DRIVER=synchrony REDIS_BRANCH=3.0
     - DRIVER=synchrony REDIS_BRANCH=3.2
-    - DRIVER=ruby      REDIS_BRANCH=unstable
+    - DRIVER=ruby      REDIS_BRANCH=4.0
 
 branches:
   only:
@@ -38,34 +44,16 @@ branches:
 matrix:
   exclude:
     # hiredis
-    - rvm: jruby-9
-      gemfile: .travis/Gemfile
-      env: DRIVER=hiredis REDIS_BRANCH=3.0
-    - rvm: jruby-9
-      gemfile: .travis/Gemfile
-      env: DRIVER=hiredis REDIS_BRANCH=3.2
-    - rvm: jruby-9
-      gemfile: .travis/Gemfile
-      env: DRIVER=hiredis REDIS_BRANCH=3.0
-    - rvm: jruby-9
-      gemfile: .travis/Gemfile
-      env: DRIVER=hiredis REDIS_BRANCH=3.2
+    - rvm: jruby-9.1.17.0
+      env: DRIVER=hiredis   REDIS_BRANCH=3.0
+    - rvm: jruby-9.1.17.0
+      env: DRIVER=hiredis   REDIS_BRANCH=3.2
 
     # synchrony
-    - rvm: jruby-9
-      gemfile: .travis/Gemfile
+    - rvm: jruby-9.1.17.0
       env: DRIVER=synchrony REDIS_BRANCH=3.0
-    - rvm: jruby-9
-      gemfile: .travis/Gemfile
+    - rvm: jruby-9.1.17.0
       env: DRIVER=synchrony REDIS_BRANCH=3.2
-    - rvm: jruby-9
-      gemfile: .travis/Gemfile
-      env: DRIVER=synchrony REDIS_BRANCH=3.0
-    - rvm: jruby-9
-      gemfile: .travis/Gemfile
-      env: DRIVER=synchrony REDIS_BRANCH=3.2
-  allow_failures:
-    - rvm: rbx-3
 
 notifications:
   irc:

data/.travis/Gemfile

@@ -2,6 +2,11 @@ source "https://rubygems.org"
 
 gemspec :path => "../"
 
+# Using jruby-openssl 0.10.0, we get NPEs in jruby tests: https://github.com/redis/redis-rb/issues/756
+platform :jruby do
+  gem 'jruby-openssl', '<0.10.0'
+end
+
 case ENV["DRIVER"]
 when "hiredis"
   gem "hiredis"

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 4.0.3
+
+* Fix raising command error for first command in pipeline. See #788.
+* Fix the gemspec to stop exposing a `build` executable. See #785.
+* Add `:reconnect_delay` and `:reconnect_delay_max` options. See #778.
+
+# 4.0.2
+
+* Added `Redis#unlink`. See #766.
+
+* `Redis.new` now accept a custom connector via `:connector`. See #591.
+
+* `Redis#multi` no longer perform empty transactions. See #747.
+
+* `Redis#hdel` now accepts hash keys as multiple arguments like `#del`. See #755.
+
+* Allow to skip SSL verification. See #745.
+
+* Add Geo commands: `geoadd`, `geohash`, `georadius`, `georadiusbymember`, `geopos`, `geodist`. See #730.
+
 # 4.0.1
 
 * `Redis::Distributed` now supports `mget` and `mapped_mget`. See #687.
@@ -21,6 +41,15 @@
 
 * Dropped official support for Ruby < 2.2.2.
 
+# 3.3.5
+
+* Fixed Ruby 1.8 compatibility after backporting `Redis#connection`. See #719.
+
+# 3.3.4 (yanked)
+
+* `Redis#connection` returns a hash with connection information.
+  You shouldn't need to call `Redis#_client`, ever.
+
 # 3.3.3
 
 * Improved timeout handling after dropping Timeout module.

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
 gemspec
+
+# Using jruby-openssl 0.10.0, we get NPEs in jruby tests: https://github.com/redis/redis-rb/issues/756
+platform :jruby do
+  gem 'jruby-openssl', '<0.10.0'
+end

data/README.md

@@ -176,7 +176,7 @@ it can't connect to the server a `Redis::CannotConnectError` error will be raise
 ```ruby
 begin
   redis.ping
-rescue Exception => e
+rescue StandardError => e
   e.inspect
 # => #<Redis::CannotConnectError: Timed out connecting to Redis on 10.0.1.1:6380>
 

data/bin/build

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+TARBALL = ARGV[0]
+
+require 'digest/sha1'
+require 'fileutils'
+
+class Builder
+  def initialize(redis_branch, tmp_dir)
+    @redis_branch = redis_branch
+    @tmp_dir = tmp_dir
+    @build_dir = File.join(@tmp_dir, "cache", "redis-#{redis_branch}")
+  end
+
+  def run
+    download_tarball
+    if old_checkum != checksum
+      build
+      update_checksum
+    end
+    0
+  end
+
+  def download_tarball
+    command!('wget', tarball_url, '-O', tarball_path)
+  end
+
+  def tarball_path
+    File.join(@tmp_dir, "redis-#{@redis_branch}.tar.gz")
+  end
+
+  def tarball_url
+    "https://github.com/antirez/redis/archive/#{@redis_branch}.tar.gz"
+  end
+
+  def build
+    FileUtils.rm_rf(@build_dir)
+    FileUtils.mkdir_p(@build_dir)
+    command!('tar', 'xf', tarball_path, '-C', File.expand_path('../', @build_dir))
+    Dir.chdir(@build_dir) do
+      command!('make')
+    end
+  end
+
+  def update_checksum
+    File.write(checksum_path, checksum)
+  end
+
+  def old_checkum
+    File.read(checksum_path)
+  rescue Errno::ENOENT
+    nil
+  end
+
+  def checksum_path
+    File.join(@build_dir, 'build.checksum')
+  end
+
+  def checksum
+    @checksum ||= Digest::SHA1.file(tarball_path).hexdigest
+  end
+
+  def command!(*args)
+    puts "$ #{args.join(' ')}"
+    unless system(*args)
+      raise "Command failed with status #{$?.exitstatus}"
+    end
+  end
+end
+
+exit Builder.new(ARGV[0], ARGV[1]).run

data/lib/redis.rb

@@ -31,11 +31,16 @@ class Redis
   # @option options [Boolean] :inherit_socket (false) Whether to use socket in forked process or not
   # @option options [Array] :sentinels List of sentinels to contact
   # @option options [Symbol] :role (:master) Role to fetch via Sentinel, either `:master` or `:slave`
+  # @option options [Array<String, Hash{Symbol => String, Integer}>] :cluster List of cluster nodes to contact
+  # @option options [Boolean] :replica Whether to use readonly replica nodes in Redis Cluster or not
+  # @option options [Class] :connector Class of custom connector
   #
   # @return [Redis] a new client instance
   def initialize(options = {})
     @options = options.dup
-    @original_client = @client = Client.new(options)
+    @cluster_mode = options.key?(:cluster)
+    client = @cluster_mode ? Cluster : Client
+    @original_client = @client = client.new(options)
     @queue = Hash.new { |h, k| h[k] = [] }
 
     super() # Monitor#initialize
@@ -273,9 +278,7 @@ class Redis
     synchronize do |client|
       client.call([:info, cmd].compact) do |reply|
         if reply.kind_of?(String)
-          reply = Hash[reply.split("\r\n").map do |line|
-            line.split(":", 2) unless line =~ /^(#|$)/
-          end.compact]
+          reply = HashifyInfo.call(reply)
 
           if cmd && cmd.to_s == "commandstats"
             # Extract nested hashes for INFO COMMANDSTATS
@@ -524,6 +527,16 @@ class Redis
     end
   end
 
+  # Unlink one or more keys.
+  #
+  # @param [String, Array<String>] keys
+  # @return [Fixnum] number of keys that were unlinked
+  def unlink(*keys)
+    synchronize do |client|
+      client.call([:unlink] + keys)
+    end
+  end
+
   # Determine if a key exists.
   #
   # @param [String] key
@@ -2102,9 +2115,9 @@ class Redis
   # @param [String] key
   # @param [String, Array<String>] field
   # @return [Fixnum] the number of fields that were removed from the hash
-  def hdel(key, field)
+  def hdel(key, *fields)
     synchronize do |client|
-      client.call([:hdel, key, field])
+      client.call([:hdel, key, *fields])
     end
   end
 
@@ -2710,6 +2723,86 @@ class Redis
     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`
@@ -2737,6 +2830,41 @@ class Redis
     end
   end
 
+  # Sends `CLUSTER *` command to random node and returns its reply.
+  #
+  # @see https://redis.io/commands#cluster Reference of cluster command
+  #
+  # @param subcommand [String, Symbol] the subcommand of cluster command
+  #   e.g. `:slots`, `:nodes`, `:slaves`, `:info`
+  #
+  # @return [Object] depends on the subcommand
+  def cluster(subcommand, *args)
+    subcommand = subcommand.to_s.downcase
+    block = case subcommand
+            when 'slots'  then HashifyClusterSlots
+            when 'nodes'  then HashifyClusterNodes
+            when 'slaves' then HashifyClusterSlaves
+            when 'info'   then HashifyInfo
+            else Noop
+            end
+
+    # @see https://github.com/antirez/redis/blob/unstable/src/redis-trib.rb#L127 raw reply expected
+    block = Noop unless @cluster_mode
+
+    synchronize do |client|
+      client.call([:cluster, subcommand] + args, &block)
+    end
+  end
+
+  # Sends `ASKING` command to random node and returns its reply.
+  #
+  # @see https://redis.io/topics/cluster-spec#ask-redirection ASK redirection
+  #
+  # @return [String] `'OK'`
+  def asking
+    synchronize { |client| client.call(%i[asking]) }
+  end
+
   def id
     @original_client.id
   end
@@ -2750,6 +2878,8 @@ class Redis
   end
 
   def connection
+    return @original_client.connection_info if @cluster_mode
+
     {
       host:     @original_client.host,
       port:     @original_client.port,
@@ -2805,14 +2935,70 @@ private
     }
 
   FloatifyPairs =
-    lambda { |array|
-      if array
-        array.each_slice(2).map do |member, score|
-          [member, Floatify.call(score)]
-        end
+    lambda { |result|
+      result.each_slice(2).map do |member, score|
+        [member, Floatify.call(score)]
+      end
+    }
+
+  HashifyInfo =
+    lambda { |reply|
+      Hash[reply.split("\r\n").map do |line|
+        line.split(':', 2) unless line =~ /^(#|$)/
+      end.compact]
+    }
+
+  HashifyClusterNodeInfo =
+    lambda { |str|
+      arr = str.split(' ')
+      {
+        'node_id'        => arr[0],
+        'ip_port'        => arr[1],
+        'flags'          => arr[2].split(','),
+        'master_node_id' => arr[3],
+        'ping_sent'      => arr[4],
+        'pong_recv'      => arr[5],
+        'config_epoch'   => arr[6],
+        'link_state'     => arr[7],
+        'slots'          => arr[8].nil? ? nil : Range.new(*arr[8].split('-'))
+      }
+    }
+
+  HashifyClusterSlots =
+    lambda { |reply|
+      reply.map do |arr|
+        first_slot, last_slot = arr[0..1]
+        master = { 'ip' => arr[2][0], 'port' => arr[2][1], 'node_id' => arr[2][2] }
+        replicas = arr[3..-1].map { |r| { 'ip' => r[0], 'port' => r[1], 'node_id' => r[2] } }
+        {
+          'start_slot' => first_slot,
+          'end_slot'   => last_slot,
+          'master'     => master,
+          'replicas'   => replicas
+        }
       end
     }
 
+  HashifyClusterNodes =
+    lambda { |reply|
+      reply.split(/[\r\n]+/).map { |str| HashifyClusterNodeInfo.call(str) }
+    }
+
+  HashifyClusterSlaves =
+    lambda { |reply|
+      reply.map { |str| HashifyClusterNodeInfo.call(str) }
+    }
+
+  Noop = ->(reply) { reply }
+
+  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?
 
@@ -2827,11 +3013,11 @@ private
       @client = original
     end
   end
-
 end
 
 require_relative "redis/version"
 require_relative "redis/connection"
 require_relative "redis/client"
+require_relative "redis/cluster"
 require_relative "redis/pipeline"
 require_relative "redis/subscribe"