async-redis 0.10.1 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da847e343c291506a20337eec6170867a0e0bf295b713ece60fd7f48928d873f
-  data.tar.gz: 2ea6e2720f556084f57415501a1964c0bb2a93a411a9cb52138dbb8ed141c45b
+  metadata.gz: 1a6afd9e0917905a3ac88663aab6185431af4f90230a160439131b137611a072
+  data.tar.gz: 503e41aea7adc5f2f103d442db5be4c37f9299c9fb9bbba33b040f8200237511
 SHA512:
-  metadata.gz: 9ac74325525a0dc00b06aaee1fa505566bce74f4806c07f26a8581ac7b20db79f11cbb052d6d598d02b7eec94aae6a142d88da00eb01e4b0a8d72e134ef5a798
-  data.tar.gz: 2b873fd8ee1cfffda74d301265ec9477a34dfe571d30d4c36d195cf39b089c22635bc74c07ade143ca46a5e169d0db226470a6149ce912be3b3da0db96e26b49
+  metadata.gz: 459502e1c7c5cfbb6250a4460f1dfa4b5e0cd2386e056f77696883521274d3ad0b6c25cd5a1e6ee3db393d18703782c643c1fe6b39e4cf22292cd26417b6af9b
+  data.tar.gz: 3119cf4d3b60ed724b68ed9fa2fc9dee2729a27657ebf1460453d236426d8e1c19f3f1717c5d0266fb85a9c7f821ca1e74f3e1e2321750b71805ecbefe084387

data/lib/async/redis/client.rb

@@ -7,16 +7,16 @@
 # Copyright, 2019, by David Ortiz.
 # Copyright, 2020, by Salim Semaoune.
 
-require_relative 'context/pipeline'
-require_relative 'context/transaction'
-require_relative 'context/subscribe'
-require_relative 'endpoint'
+require_relative "context/pipeline"
+require_relative "context/transaction"
+require_relative "context/subscribe"
+require_relative "endpoint"
 
-require 'io/endpoint/host_endpoint'
-require 'async/pool/controller'
-require 'protocol/redis/methods'
+require "io/endpoint/host_endpoint"
+require "async/pool/controller"
+require "protocol/redis/methods"
 
-require 'io/stream'
+require "io/stream"
 
 module Async
 	module Redis
@@ -89,7 +89,7 @@ module Async
 				@endpoint = endpoint
 				@protocol = protocol
 				
-				@pool = connect(**options)
+				@pool = make_pool(**options)
 			end
 			
 			attr :endpoint
@@ -113,7 +113,14 @@ module Async
 			
 			protected
 			
-			def connect(**options)
+			def assign_default_tags(tags)
+				tags[:endpoint] = @endpoint.to_s
+				tags[:protocol] = @protocol.to_s
+			end
+			
+			def make_pool(**options)
+				self.assign_default_tags(options[:tags] ||= {})
+				
 				Async::Pool::Controller.wrap(**options) do
 					peer = @endpoint.connect
 					

data/lib/async/redis/cluster_client.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020, by David Ortiz.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
+# Copyright, 2025, by Travis Bell.
 
-require_relative 'client'
-require 'io/stream'
+require_relative "client"
+require "io/stream"
 
 module Async
 	module Redis
@@ -57,6 +57,7 @@ module Async
 			# @property endpoints [Array(Endpoint)] The list of cluster endpoints.
 			def initialize(endpoints, **options)
 				@endpoints = endpoints
+				@options = options
 				@shards = nil
 			end
 			
@@ -94,7 +95,7 @@ module Async
 				end
 				
 				if node = nodes.sample
-					return (node.client ||= Client.new(node.endpoint))
+					return (node.client ||= Client.new(node.endpoint, **@options))
 				end
 			end
 			
@@ -102,25 +103,25 @@ module Async
 			
 			def reload_cluster!(endpoints = @endpoints)
 				@endpoints.each do |endpoint|
-					client = Client.new(endpoint)
+					client = Client.new(endpoint, **@options)
 					
 					shards = RangeMap.new
 					endpoints = []
 					
-					client.call('CLUSTER', 'SHARDS').each do |shard|
+					client.call("CLUSTER", "SHARDS").each do |shard|
 						shard = shard.each_slice(2).to_h
 						
-						slots = shard['slots']
+						slots = shard["slots"]
 						range = Range.new(*slots)
 						
-						nodes = shard['nodes'].map do |node|
+						nodes = shard["nodes"].map do |node|
 							node = node.each_slice(2).to_h
-							endpoint = Endpoint.remote(node['ip'], node['port'])
+							endpoint = Endpoint.remote(node["ip"], node["port"])
 							
 							# Collect all endpoints:
 							endpoints << endpoint
 							
-							Node.new(node['id'], endpoint, node['role'].to_sym, node['health'].to_sym)
+							Node.new(node["id"], endpoint, node["role"].to_sym, node["health"].to_sym)
 						end
 						
 						shards.add(range, nodes)
@@ -193,8 +194,8 @@ module Async
 			def slot_for(key)
 				key = key.to_s
 				
-				if s = key.index('{')
-					if e = key.index('}', s + 1) and e != s + 1
+				if s = key.index("{")
+					if e = key.index("}", s + 1) and e != s + 1
 						key = key[s + 1..e - 1]
 					end
 				end

data/lib/async/redis/context/generic.rb

@@ -2,9 +2,9 @@
 
 # Released under the MIT License.
 # Copyright, 2019, by Mikael Henriksson.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
-require 'protocol/redis/methods'
+require "protocol/redis/methods"
 
 module Async
 	module Redis

data/lib/async/redis/context/pipeline.rb

@@ -5,7 +5,7 @@
 # Copyright, 2019-2024, by Samuel Williams.
 # Copyright, 2022, by Tim Willard.
 
-require_relative 'generic'
+require_relative "generic"
 
 module Async
 	module Redis

data/lib/async/redis/context/subscribe.rb

@@ -2,15 +2,15 @@
 
 # Released under the MIT License.
 # Copyright, 2018, by Huba Nagy.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
-require_relative 'generic'
+require_relative "generic"
 
 module Async
 	module Redis
 		module Context
 			class Subscribe < Generic
-				MESSAGE = 'message'
+				MESSAGE = "message"
 				
 				def initialize(pool, channels)
 					super(pool)
@@ -31,13 +31,21 @@ module Async
 					end
 				end
 				
+				def each
+					return to_enum unless block_given?
+					
+					while response = self.listen
+						yield response
+					end
+				end
+				
 				def subscribe(channels)
-					@connection.write_request ['SUBSCRIBE', *channels]
+					@connection.write_request ["SUBSCRIBE", *channels]
 					@connection.flush
 				end
 				
 				def unsubscribe(channels)
-					@connection.write_request ['UNSUBSCRIBE', *channels]
+					@connection.write_request ["UNSUBSCRIBE", *channels]
 					@connection.flush
 				end
 			end

data/lib/async/redis/context/transaction.rb

@@ -2,9 +2,9 @@
 
 # Released under the MIT License.
 # Copyright, 2018, by Huba Nagy.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
-require_relative 'pipeline'
+require_relative "pipeline"
 
 module Async
 	module Redis
@@ -15,20 +15,20 @@ module Async
 				end
 				
 				def multi
-					call('MULTI')
+					call("MULTI")
 				end
 				
 				def watch(*keys)
-					sync.call('WATCH', *keys)
+					sync.call("WATCH", *keys)
 				end
 				
 				# Execute all queued commands, provided that no watched keys have been modified. It's important to note that even when a command fails, all the other commands in the queue are processed – Redis will not stop the processing of commands.
 				def execute
-					sync.call('EXEC')
+					sync.call("EXEC")
 				end
 				
 				def discard
-					sync.call('DISCARD')
+					sync.call("DISCARD")
 				end
 			end
 		end

data/lib/async/redis/endpoint.rb

@@ -3,13 +3,13 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'io/endpoint'
-require 'io/endpoint/host_endpoint'
-require 'io/endpoint/ssl_endpoint'
+require "io/endpoint"
+require "io/endpoint/host_endpoint"
+require "io/endpoint/ssl_endpoint"
 
-require_relative 'protocol/resp2'
-require_relative 'protocol/authenticated'
-require_relative 'protocol/selected'
+require_relative "protocol/resp2"
+require_relative "protocol/authenticated"
+require_relative "protocol/selected"
 
 module Async
 	module Redis
@@ -30,8 +30,8 @@ module Async
 			end
 			
 			SCHEMES = {
-				'redis' => URI::Generic,
-				'rediss' => URI::Generic,
+				"redis" => URI::Generic,
+				"rediss" => URI::Generic,
 			}
 			
 			def self.parse(string, endpoint = nil, **options)
@@ -117,7 +117,7 @@ module Async
 			end
 			
 			def secure?
-				['rediss'].include?(self.scheme)
+				["rediss"].include?(self.scheme)
 			end
 			
 			def protocol

data/lib/async/redis/protocol/authenticated.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'protocol/redis'
+require "protocol/redis"
 
 module Async
 	module Redis

data/lib/async/redis/protocol/resp2.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2018-2024, by Samuel Williams.
 
-require 'protocol/redis'
+require "protocol/redis"
 
 module Async
 	module Redis

data/lib/async/redis/protocol/selected.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'protocol/redis'
+require "protocol/redis"
 
 module Async
 	module Redis

data/lib/async/redis/sentinel_client.rb

@@ -3,14 +3,15 @@
 # Released under the MIT License.
 # Copyright, 2020, by David Ortiz.
 # Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2024, by Joan Lledó.
 
-require_relative 'client'
-require 'io/stream'
+require_relative "client"
+require "io/stream"
 
 module Async
 	module Redis
 		class SentinelClient
-			DEFAULT_MASTER_NAME = 'mymaster'
+			DEFAULT_MASTER_NAME = "mymaster"
 			
 			include ::Protocol::Redis::Methods
 			include Client::Methods
@@ -30,7 +31,7 @@ module Async
 				# A cache of sentinel connections.
 				@sentinels = {}
 				
-				@pool = connect(**options)
+				@pool = make_pool(**options)
 			end
 			
 			# @attribute [String] The name of the master instance.
@@ -64,26 +65,26 @@ module Async
 			
 			def failover(name = @master_name)
 				sentinels do |client|
-					return client.call('SENTINEL', 'FAILOVER', name)
+					return client.call("SENTINEL", "FAILOVER", name)
 				end
 			end
 			
 			def masters
 				sentinels do |client|
-					return client.call('SENTINEL', 'MASTERS').map{|fields| fields.each_slice(2).to_h}
+					return client.call("SENTINEL", "MASTERS").map{|fields| fields.each_slice(2).to_h}
 				end
 			end
 			
 			def master(name = @master_name)
 				sentinels do |client|
-					return client.call('SENTINEL', 'MASTER', name).each_slice(2).to_h
+					return client.call("SENTINEL", "MASTER", name).each_slice(2).to_h
 				end
 			end
 			
 			def resolve_master
 				sentinels do |client|
 					begin
-						address = client.call('SENTINEL', 'GET-MASTER-ADDR-BY-NAME', @master_name)
+						address = client.call("SENTINEL", "GET-MASTER-ADDR-BY-NAME", @master_name)
 					rescue Errno::ECONNREFUSED
 						next
 					end
@@ -97,7 +98,7 @@ module Async
 			def resolve_slave
 				sentinels do |client|
 					begin
-						reply = client.call('SENTINEL', 'SLAVES', @master_name)
+						reply = client.call("SENTINEL", "SLAVES", @master_name)
 					rescue Errno::ECONNREFUSED
 						next
 					end
@@ -106,7 +107,7 @@ module Async
 					next if slaves.empty?
 					
 					slave = select_slave(slaves)
-					return Endpoint.remote(slave['ip'], slave['port'])
+					return Endpoint.remote(slave["ip"], slave["port"])
 				end
 				
 				return nil
@@ -114,8 +115,14 @@ module Async
 			
 			protected
 			
+			def assign_default_tags(tags)
+				tags[:protocol] = @protocol.to_s
+			end
+			
 			# Override the parent method. The only difference is that this one needs to resolve the master/slave address.
-			def connect(**options)
+			def make_pool(**options)
+				self.assign_default_tags(options[:tags] ||= {})
+				
 				Async::Pool::Controller.wrap(**options) do
 					endpoint = resolve_address
 					peer = endpoint.connect
@@ -141,7 +148,7 @@ module Async
 				slaves = reply.map{|fields| fields.each_slice(2).to_h}
 				
 				slaves.reject do |slave|
-					slave['flags'].split(',').include?('s_down')
+					slave["flags"].split(",").include?("s_down")
 				end
 			end
 			

data/lib/async/redis/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Redis
-		VERSION = "0.10.1"
+		VERSION = "0.11.1"
 	end
 end

data/lib/async/redis.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 # Copyright, 2020, by David Ortiz.
 
-require_relative 'redis/version'
-require_relative 'redis/client'
+require_relative "redis/version"
+require_relative "redis/client"
 
-require_relative 'redis/cluster_client'
-require_relative 'redis/sentinel_client'
+require_relative "redis/cluster_client"
+require_relative "redis/sentinel_client"

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2018-2024, by Samuel Williams.  
+Copyright, 2018-2025, by Samuel Williams.  
 Copyright, 2018, by Huba Nagy.  
 Copyright, 2019-2020, by David Ortiz.  
 Copyright, 2019, by Pierre Montelle.  
@@ -12,6 +12,8 @@ Copyright, 2021, by Olle Jonsson.
 Copyright, 2021, by Troex Nevelin.  
 Copyright, 2022, by Tim Willard.  
 Copyright, 2022, by Gleb Sinyavskiy.  
+Copyright, 2024, by Joan Lledó.  
+Copyright, 2025, by Travis Bell.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -4,12 +4,30 @@ An asynchronous client for Redis including TLS. Support for streaming requests a
 
 [![Development Status](https://github.com/socketry/async-redis/workflows/Test/badge.svg)](https://github.com/socketry/async-redis/actions?workflow=Test)
 
+## Support
+
+This gem supports both Valkey and Redis. It is designed to be compatible with the latest versions of both libraries. We also test Redis sentinel and cluster configurations.
+
 ## Usage
 
 Please see the [project documentation](https://socketry.github.io/async-redis/) for more details.
 
   - [Getting Started](https://socketry.github.io/async-redis/guides/getting-started/index) - This guide explains how to use the `async-redis` gem to connect to a Redis server and perform basic operations.
 
+## Releases
+
+Please see the [project releases](https://socketry.github.io/async-redis/releases/index) for all releases.
+
+### v0.11.1
+
+  - Correctly pass `@options` to `Async::Redis::Client` instances created by `Async::Redis::ClusterClient`.
+
+### v0.10.0
+
+  - [Add support for Redis Clusters](https://socketry.github.io/async-redis/releases/index#add-support-for-redis-clusters)
+  - [Add support for Redis Sentinels](https://socketry.github.io/async-redis/releases/index#add-support-for-redis-sentinels)
+  - [Improved Integration Tests](https://socketry.github.io/async-redis/releases/index#improved-integration-tests)
+
 ## Contributing
 
 We welcome contributions to this project.

data/{changes.md → releases.md}

@@ -1,10 +1,16 @@
-# v0.10.0
+# Releases
 
-## Cluster Client
+## v0.11.1
+
+  - Correctly pass `@options` to `Async::Redis::Client` instances created by `Async::Redis::ClusterClient`.
+
+## v0.10.0
+
+### Add support for Redis Clusters
 
 `Async::Redis::ClusterClient` is a new class that provides a high-level interface to a Redis Cluster. Due to the way clustering works, it does not provide the same interface as the `Async::Redis::Client` class. Instead, you must request an appropriate client for the key you are working with.
 
-```ruby
+``` ruby
 endpoints = [
 	Async::Redis::Endpoint.parse("redis://redis-a"),
 	Async::Redis::Endpoint.parse("redis://redis-b"),
@@ -18,11 +24,11 @@ cluster_client.clients_for("key") do |client|
 end
 ```
 
-## Sentinel Client
+### Add support for Redis Sentinels
 
 The previous implementation `Async::Redis::SentinelsClient` has been replaced with `Async::Redis::SentinelClient`. This new class uses `Async::Redis::Endpoint` objects to represent the sentinels and the master.
 
-```ruby
+``` ruby
 sentinels = [
 	Async::Redis::Endpoint.parse("redis://redis-sentinel-a"),
 	Async::Redis::Endpoint.parse("redis://redis-sentinel-b"),
@@ -41,6 +47,6 @@ slave_client.session do |session|
 end
 ```
 
-## Integration Tests
+### Improved Integration Tests
 
 Integration tests for Redis Cluster and Sentinel have been added, using `docker-compose` to start the required services and run the tests. These tests are not part of the default test suite and must be run separately. See the documentation in the `sentinel/` and `cluster/` directories for more information.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-redis
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -12,11 +12,12 @@ authors:
 - Troex Nevelin
 - Alex Matchneer
 - Jeremy Jung
+- Joan Lledó
 - Olle Jonsson
 - Pierre Montelle
 - Salim Semaoune
 - Tim Willard
-autorequire:
+- Travis Bell
 bindir: bin
 cert_chain:
 - |
@@ -48,7 +49,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -120,13 +121,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- changes.md
 - lib/async/redis.rb
 - lib/async/redis/client.rb
 - lib/async/redis/cluster_client.rb
@@ -143,13 +141,13 @@ files:
 - lib/async/redis/version.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/async-redis
 licenses:
 - MIT
 metadata:
   documentation_uri: https://socketry.github.io/async-redis/
   source_code_uri: https://github.com/socketry/async-redis.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,8 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Redis client library.
 test_files: []