redis-client 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35ff65a4af6127cb60acff6a3d3b2d2e5e65ddeffc0e8e808b7dec90792697a6
-  data.tar.gz: 854f82d7548c5462b53ae29a637dc208cdc70b3399b28d0c61f38e02f073e37e
+  metadata.gz: c8038f4b1f7316e16bd3561f43311334a9e69896e54a75b1a9666cb2718ba3b0
+  data.tar.gz: e37514256b44be8b0d5832c3d944c8d3be2a8228bff1fa05ac3a28347c6445ae
 SHA512:
-  metadata.gz: 2c9e8e564662e86f4e1a24ca9528a5d909a096218eaf62bd7b58838402db390e7bec65d79a43aa89a2b98d22f9645ca7e412ae2db4010dc4131cbf2133d2666f
-  data.tar.gz: c6400693a10e28e377bf52792ee54f41afb2b2c97ea49578a90eba767b6e3b6a7f37eaeaccf41a38a8222827f461f44aa0b1f75881084dc30a521e407508e277
+  metadata.gz: f02d99ca8c468cf38a4527817257169104d7f64cea5110c170d434d82b7f30cfea8338e0e746504d2d8c29866f81ef6cf4e81d014400ff364d5138d7653dfdc3
+  data.tar.gz: 2a66a02666e43b17c5007f2ae99c08f331cc46eb4645330b0f3df31fec39080ab779860bebcaa40add2beacc057d7a4ce586a7bc4453c50ddb0c4a10b677281f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+# 0.17.0
+
+- Adds `sentinel_username` and `sentinel_password` options for `RedisClient#sentinel`
+
 # 0.16.0
 
 - Add `RedisClient#disable_reconnection`.
@@ -71,7 +75,7 @@
 
 - Make the client resilient to `Timeout.timeout` or `Thread#kill` use (it still is very much discouraged to use either).
   Use of async interrupts could cause responses to be interleaved.
-- hiredis: handle commands returning a top-level `false` (no command does this today, but some extensions might). 
+- hiredis: handle commands returning a top-level `false` (no command does this today, but some extensions might).
 - Workaround a bug in Ruby 2.6 causing a crash if the `debug` gem is enabled when `redis-client` is being required. Fix: #48
 
 # 0.8.0
@@ -90,7 +94,7 @@
 
 - Raise a distinct `RedisClient::OutOfMemoryError`, for Redis `OOM` errors.
 - Fix the instrumentation API to be called even for authentication commands.
-- Fix `url:` configuration to accept a trailing slash. 
+- Fix `url:` configuration to accept a trailing slash.
 
 # 0.7.1
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-client (0.16.0)
+    redis-client (0.17.0)
       connection_pool
 
 GEM

data/README.md

@@ -128,6 +128,41 @@ but a few so that if one is down the client will try the next one. The client
 is able to remember the last Sentinel that was able to reply correctly and will
 use it for the next requests.
 
+To [authenticate](https://redis.io/docs/management/sentinel/#configuring-sentinel-instances-with-authentication) Sentinel itself, you can specify the `sentinel_username` and `sentinel_password` options per instance. Exclude the `sentinel_username` option if you're using password-only authentication.
+
+```ruby
+SENTINELS = [{ host: '127.0.0.1', port: 26380},
+             { host: '127.0.0.1', port: 26381}]
+
+redis_config = RedisClient.sentinel(name: 'mymaster', sentinel_username: 'appuser', sentinel_password: 'mysecret', sentinels: SENTINELS, role: :master)
+```
+
+If you specify a username and/or password at the top level for your main Redis instance, Sentinel *will not* using thouse credentials
+
+```ruby
+# Use 'mysecret' to authenticate against the mymaster instance, but skip authentication for the sentinels:
+SENTINELS = [{ host: '127.0.0.1', port: 26380 },
+             { host: '127.0.0.1', port: 26381 }]
+
+redis_config = RedisClient.sentinel(name: 'mymaster', sentinels: SENTINELS, role: :master, password: 'mysecret')
+```
+
+So you have to provide Sentinel credential and Redis explictly even they are the same
+
+```ruby
+# Use 'mysecret' to authenticate against the mymaster instance and sentinel
+SENTINELS = [{ host: '127.0.0.1', port: 26380 },
+             { host: '127.0.0.1', port: 26381 }]
+
+redis_config = RedisClient.sentinel(name: 'mymaster', sentinels: SENTINELS, role: :master, password: 'mysecret', sentinel_password: 'mysecret')
+```
+
+Also the `name`, `password`, `username` and `db` for Redis instance can be passed as an url:
+
+```ruby
+redis_config = RedisClient.sentinel(url: "redis://appuser:mysecret@mymaster/10", sentinels: SENTINELS, role: :master)
+```
+
 ### Type support
 
 Only a select few Ruby types are supported as arguments beside strings.

data/lib/redis_client/config.rb

@@ -159,21 +159,23 @@ class RedisClient
       host: nil,
       port: nil,
       path: nil,
+      username: nil,
+      password: nil,
       **kwargs
     )
       if url
         url_config = URLConfig.new(url)
         kwargs = {
           ssl: url_config.ssl?,
-          username: url_config.username,
-          password: url_config.password,
           db: url_config.db,
         }.compact.merge(kwargs)
         host ||= url_config.host
         port ||= url_config.port
+        username ||= url_config.username
+        password ||= url_config.password
       end
 
-      super(**kwargs)
+      super(username: username, password: password, **kwargs)
 
       @host = host || DEFAULT_HOST
       @port = Integer(port || DEFAULT_PORT)

data/lib/redis_client/sentinel_config.rb

@@ -9,7 +9,15 @@ class RedisClient
 
     attr_reader :name
 
-    def initialize(sentinels:, role: :master, name: nil, url: nil, **client_config)
+    def initialize(
+      sentinels:,
+      sentinel_password: nil,
+      sentinel_username: nil,
+      role: :master,
+      name: nil,
+      url: nil,
+      **client_config
+    )
       unless %i(master replica slave).include?(role.to_sym)
         raise ArgumentError, "Expected role to be either :master or :replica, got: #{role.inspect}"
       end
@@ -30,7 +38,11 @@ class RedisClient
       end
 
       @to_list_of_hash = @to_hash = nil
-      @extra_config = {}
+      @extra_config = {
+        username: sentinel_username,
+        password: sentinel_password,
+        db: nil,
+      }
       if client_config[:protocol] == 2
         @extra_config[:protocol] = client_config[:protocol]
         @to_list_of_hash = lambda do |may_be_a_list|
@@ -106,9 +118,9 @@ class RedisClient
       sentinels.map do |sentinel|
         case sentinel
         when String
-          Config.new(**@client_config, **@extra_config, url: sentinel, db: nil)
+          Config.new(**@client_config, **@extra_config, url: sentinel)
         else
-          Config.new(**@client_config, **@extra_config, **sentinel, db: nil)
+          Config.new(**@client_config, **@extra_config, **sentinel)
         end
       end
     end

data/lib/redis_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedisClient
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

data/lib/redis_client.rb

@@ -175,6 +175,10 @@ class RedisClient
     "#<#{self.class.name} #{config.server_url}#{id_string}>"
   end
 
+  def server_url
+    config.server_url
+  end
+
   def size
     1
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-client
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool