async-redis 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c7b31b58959e0fe6165b3c2b506d9948d095477a5c9efd656dbcb590bfbfe1
-  data.tar.gz: 5d1b6ba10c70e35796b3ee7d02d2be2678dbb99c5fec21be5c2a37eb38aeea41
+  metadata.gz: c61c1f4d04e59d7a09f58429a04438e674d7839bc6d6411b3fc33668d4068c4b
+  data.tar.gz: f13579f444972e6b5a7d1388f37d20d74978e867130b5cdad303e829905a6ca6
 SHA512:
-  metadata.gz: 7c117ee7b68fc57780806754c976686bfff540e22e2077b518892fcd863fe9b86b98dbbf69a37dd7b647f7bf6ad7a4fed1e82071db72c8549fb09bf39e79814a
-  data.tar.gz: 95870e075f3528b95a3503fc3d597a8e9fefe9e038d2f9f62448a8cb1b6df9fb2ae67dc24e5dbadd4798b3619f09089f6dbe2f1058d53895f2b2636df952152f
+  metadata.gz: 99b7e9bb4091f09a6b51a1216a44b69ebd63918df6755d447f327b69bdf148cbf91e7a1b1a5adbe75ccff93f36be93cdf0d5034bed624743fcac23524d285df7
+  data.tar.gz: f9afbc599da80472df731cb370c77422184c3a41a4ab0efd0df638fad31f9a68fa7cde775d7451826cf781c1d29e9c86d3d27c0a94a6b1605b121dd33dddd13f

data/lib/async/redis/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 # Copyright, 2018, by Huba Nagy.
 # Copyright, 2019, by Mikael Henriksson.
 # Copyright, 2019, by David Ortiz.
@@ -10,22 +10,21 @@
 require_relative 'context/pipeline'
 require_relative 'context/transaction'
 require_relative 'context/subscribe'
-
 require_relative 'protocol/resp2'
 
-require 'async/io'
-require 'async/io/stream'
+require 'io/endpoint/host_endpoint'
 require 'async/pool/controller'
-
 require 'protocol/redis/methods'
 
+require 'io/stream'
+
 module Async
 	module Redis
 		# Legacy.
 		ServerError = ::Protocol::Redis::ServerError
 		
 		def self.local_endpoint(port: 6379)
-			Async::IO::Endpoint.tcp('localhost', port)
+			::IO::Endpoint.tcp('localhost', port)
 		end
 		
 		class Client
@@ -121,7 +120,7 @@ module Async
 					# We will manage flushing ourselves:
 					peer.sync = true
 					
-					stream = IO::Stream.new(peer)
+					stream = ::IO::Stream(peer)
 					
 					@protocol.client(stream)
 				end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
 require 'protocol/redis'
 
@@ -15,7 +15,7 @@ module Async
 					end
 					
 					def viable?
-						@stream.connected?
+						@stream.readable?
 					end
 					
 					def reusable?

data/lib/async/redis/sentinels.rb

@@ -2,7 +2,9 @@
 
 # Released under the MIT License.
 # Copyright, 2020, by David Ortiz.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
+
+require 'io/stream'
 
 module Async
 	module Redis
@@ -10,7 +12,7 @@ module Async
 			def initialize(master_name, sentinels, role = :master, protocol = Protocol::RESP2, **options)
 				@master_name = master_name
 				@sentinel_endpoints = sentinels.map do |sentinel|
-					Async::IO::Endpoint.tcp(sentinel[:host], sentinel[:port])
+					::IO::Endpoint.tcp(sentinel[:host], sentinel[:port])
 				end
 				@role = role
 
@@ -26,7 +28,7 @@ module Async
 				Async::Pool::Controller.wrap(**options) do
 					endpoint = resolve_address
 					peer = endpoint.connect
-					stream = IO::Stream.new(peer)
+					stream = ::IO::Stream(peer)
 
 					@protocol.client(stream)
 				end
@@ -52,7 +54,7 @@ module Async
 						next
 					end
 
-					return Async::IO::Endpoint.tcp(address[0], address[1]) if address
+					return ::IO::Endpoint.tcp(address[0], address[1]) if address
 				end
 
 				nil
@@ -72,7 +74,7 @@ module Async
 					next if slaves.empty?
 
 					slave = select_slave(slaves)
-					return Async::IO::Endpoint.tcp(slave['ip'], slave['port'])
+					return ::IO::Endpoint.tcp(slave['ip'], slave['port'])
 				end
 
 				nil

data/lib/async/redis/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Redis
-		VERSION = "0.8.0"
+		VERSION = "0.8.1"
 	end
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2018-2023, by Samuel Williams.  
+Copyright, 2018-2024, by Samuel Williams.  
 Copyright, 2018, by Huba Nagy.  
 Copyright, 2019-2020, by David Ortiz.  
 Copyright, 2019, by Pierre Montelle.  

data/readme.md

@@ -1,111 +1,14 @@
 # Async::Redis
 
-An asynchronous client for Redis including TLS. Support for streaming requests and responses. Built on top of [async](https://github.com/socketry/async) and [async-io](https://github.com/socketry/async-io).
+An asynchronous client for Redis including TLS. Support for streaming requests and responses. Built on top of [async](https://github.com/socketry/async).
 
 [![Development Status](https://github.com/socketry/async-redis/workflows/Test/badge.svg)](https://github.com/socketry/async-redis/actions?workflow=Test)
 
-## Installation
-
-``` shell
-$ bundle add async-redis
-```
-
 ## Usage
 
-### Basic Local Connection
-
-``` ruby
-require 'async/redis'
-
-endpoint = Async::Redis.local_endpoint
-client = Async::Redis::Client.new(endpoint)
-
-Async do
-	pp client.info
-ensure
-	client.close
-end
-```
-
-### Connecting to Redis SSL Endpoint
-
-This example demonstrates parsing an environment variable with a `redis://` or SSL `rediss://` scheme, and demonstrates how you can specify SSL parameters on the SSLContext object.
-
-``` ruby
-require 'async/redis'
-
-def make_redis_endpoint(uri)
-	tcp_endpoint = Async::IO::Endpoint.tcp(uri.hostname, uri.port)
-	case uri.scheme
-	when 'redis'
-		tcp_endpoint
-	when 'rediss'
-		ssl_context = OpenSSL::SSL::SSLContext.new
-		ssl_context.set_params(
-			ca_file: "/path/to/ca.crt",
-			cert: OpenSSL::X509::Certificate.new(File.read("client.crt")),
-			key: OpenSSL::PKey::RSA.new(File.read("client.key")),
-		)
-		Async::IO::SSLEndpoint.new(tcp_endpoint, ssl_context: ssl_context)
-	else
-		raise ArgumentError
-	end
-end
-
-endpoint = make_redis_endpoint(URI(ENV['REDIS_URL']))
-client = Async::Redis::Client.new(endpoint)
-
-# ...
-```
+Please see the [project documentation](https://github.com/socketry/async-redis) for more details.
 
-### Variables
-
-``` ruby
-require 'async'
-require 'async/redis'
-
-endpoint = Async::Redis.local_endpoint
-client = Async::Redis::Client.new(endpoint)
-
-Async do
-	client.set('X', 10)
-	pp client.get('X')
-ensure
-	client.close
-end
-```
-
-### Subscriptions
-
-``` ruby
-require 'async'
-require 'async/redis'
-
-endpoint = Async::Redis.local_endpoint
-client = Async::Redis::Client.new(endpoint)
-
-Async do |task|
-	condition = Async::Condition.new
-	
-	publisher = task.async do
-		condition.wait
-		
-		client.publish 'status.frontend', 'good'
-	end
-	
-	subscriber = task.async do
-		client.subscribe 'status.frontend' do |context|
-			condition.signal # We are waiting for messages.
-			
-			type, name, message = context.listen
-			
-			pp type, name, message
-		end
-	end
-ensure
-	client.close
-end
-```
+  - [Getting Started](https://github.com/socketry/async-redisguides/getting-started/index) - This guide explains how to use the `async-redis` gem to connect to a Redis server and perform basic operations.
 
 ## Contributing
 
@@ -116,3 +19,11 @@ We welcome contributions to this project.
 3.  Commit your changes (`git commit -am 'Add some feature'`).
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-redis
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -48,7 +48,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-06-13 00:00:00.000000000 Z
+date: 2024-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -71,33 +71,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: async-io
+  name: async-pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: async-pool
+  name: io-endpoint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: io-stream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: protocol-redis
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +147,8 @@ files:
 homepage: https://github.com/socketry/async-redis
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/socketry/async-redis.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -142,14 +157,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A Redis client library.