async-redis 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6d0663e06a759b527cd94e0098f963e74c6c5c24dfc0f36f77a03bc5c719776
-  data.tar.gz: 88530a16ce78f5a55399010f287be6008350adabc7f911e39560e45f3d11a595
+  metadata.gz: d30c4c6db1611c8d2d65ea9ba1c807b2aecc1522ac9e936ff969db8c1aa3196d
+  data.tar.gz: a1acc4eabeff0c0f5f0f1a6b90353605d1c6452e43bf4da15b7c108e5de21a81
 SHA512:
-  metadata.gz: f8bc38e694669b220071a3b50f555e6e485d4eb66656be2ab8d8680615d01f46501ae92a00081b75e8206913b013d1985c61716de0a40af105da882cc3b54500
-  data.tar.gz: 509b6e77d40be0858035cf2a1e53667830f4c106d0f7235aee8a1c7a2493d6e87622a06fb0c6f420088366e196ef0d85bb758aa66b56b79003aac3895f06c120
+  metadata.gz: 3741bb0209230896d293dd109c86315dd154a23c488ef278ad611b8a26f6ac5e055cecbd7930d274a878507ac4c7cd722080baefb3d83425cc655beabc34ba51
+  data.tar.gz: 609fb8b39c3a7bf430a1aac0de4d9234f44d6f63fea22b2ecd61d57763371b8be3374a975100658b1f8bdb891fd37f3c7c0a5390769d15733648d4fa3797b596

data/lib/async/redis.rb

@@ -22,3 +22,4 @@
 
 require_relative 'redis/version'
 require_relative 'redis/client'
+require_relative 'redis/sentinels'

data/lib/async/redis/client.rb

@@ -37,8 +37,8 @@ module Async
 		# Legacy.
 		ServerError = ::Protocol::Redis::ServerError
 		
-		def self.local_endpoint
-			Async::IO::Endpoint.tcp('localhost', 6379)
+		def self.local_endpoint(port: 6379)
+			Async::IO::Endpoint.tcp('localhost', port)
 		end
 		
 		class Client
@@ -101,13 +101,14 @@ module Async
 					context.close
 				end
 			end
+			
 			alias multi transaction
-
+			
 			def pipeline(&block)
 				context = Context::Pipeline.new(@pool)
-
+				
 				return context unless block_given?
-
+				
 				begin
 					yield context
 				ensure

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

@@ -35,6 +35,13 @@ module Async
 					subscribe(channels)
 				end
 				
+				def close
+					# There is no way to reset subscription state. On Redis v6+ you can use RESET, but this is not supported in <= v6.
+					@connection&.close
+					
+					super
+				end
+				
 				def listen
 					return @connection.read_response
 				end
@@ -67,7 +74,7 @@ module Async
 						return response
 					else
 						@channels.subtract(channels)
-						return call 'UNSUBSCRIBE', *channels
+						return call('UNSUBSCRIBE', *channels)
 					end
 				end
 			end

data/lib/async/redis/sentinels.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Async
+	module Redis
+		class SentinelsClient < Client
+			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])
+				end
+				@role = role
+
+				@protocol = protocol
+				@pool = connect(**options)
+			end
+
+			private
+
+			# Override the parent method. The only difference is that this one needs
+			# to resolve the master/slave address.
+			def connect(**options)
+				Async::Pool::Controller.wrap(**options) do
+					endpoint = resolve_address
+					peer = endpoint.connect
+					stream = IO::Stream.new(peer)
+
+					@protocol.client(stream)
+				end
+			end
+
+			def resolve_address
+				address = case @role
+									when :master then resolve_master
+									when :slave then resolve_slave
+									else raise ArgumentError, "Unknown instance role #{@role}"
+									end
+
+				address or raise RuntimeError, "Unable to fetch #{@role} via Sentinel."
+			end
+
+			def resolve_master
+				@sentinel_endpoints.each do |sentinel_endpoint|
+					client = Client.new(sentinel_endpoint)
+
+					begin
+						address = client.call('sentinel', 'get-master-addr-by-name', @master_name)
+					rescue Errno::ECONNREFUSED
+						next
+					end
+
+					return Async::IO::Endpoint.tcp(address[0], address[1]) if address
+				end
+
+				nil
+			end
+
+			def resolve_slave
+				@sentinel_endpoints.each do |sentinel_endpoint|
+					client = Client.new(sentinel_endpoint)
+
+					begin
+						reply = client.call('sentinel', 'slaves', @master_name)
+					rescue Errno::ECONNREFUSED
+						next
+					end
+
+					slaves = available_slaves(reply)
+					next if slaves.empty?
+
+					slave = select_slave(slaves)
+					return Async::IO::Endpoint.tcp(slave['ip'], slave['port'])
+				end
+
+				nil
+			end
+
+			def available_slaves(slaves_cmd_reply)
+				# The reply is an array with the format: [field1, value1, field2,
+				# value2, etc.].
+				# When a slave is marked as down by the sentinel, the "flags" field
+				# (comma-separated array) contains the "s_down" value.
+				slaves_cmd_reply.map { |s| s.each_slice(2).to_h }
+						            .reject { |s| s.fetch('flags').split(',').include?('s_down') }
+			end
+
+			def select_slave(available_slaves)
+				available_slaves.sample
+			end
+		end
+	end
+end

data/lib/async/redis/version.rb

@@ -22,6 +22,6 @@
 
 module Async
 	module Redis
-		VERSION = "0.5.0"
+		VERSION = "0.5.1"
 	end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: async-redis
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Samuel Williams
 - Huba Nagy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-22 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: hiredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,21 +138,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,35 +166,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hiredis
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '3.6'
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
-- 12huba@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/workflows/development.yml"
-- ".gitignore"
-- ".rspec"
-- Gemfile
-- README.md
-- Rakefile
-- async-redis.gemspec
 - lib/async/redis.rb
 - lib/async/redis/client.rb
 - lib/async/redis/context/generic.rb
@@ -203,11 +193,13 @@ files:
 - lib/async/redis/context/transaction.rb
 - lib/async/redis/key.rb
 - lib/async/redis/protocol/resp2.rb
+- lib/async/redis/sentinels.rb
 - lib/async/redis/version.rb
 homepage: https://github.com/socketry/async-redis
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -223,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Redis client library.
 test_files: []

data/.editorconfig

@@ -1,6 +0,0 @@
-root = true
-
-[*]
-indent_style = tab
-indent_size = 2
-

data/.github/workflows/development.yml

@@ -1,36 +0,0 @@
-name: Development
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    strategy:
-      matrix:
-        os:
-          - ubuntu
-          - macos
-        
-        ruby:
-          - 2.4
-          - 2.5
-          - 2.6
-          - 2.7
-        
-        include:
-          - os: 'ubuntu'
-            ruby: '2.6'
-            env: COVERAGE=PartialSummary,Coveralls
-    
-    runs-on: ${{matrix.os}}-latest
-    
-    steps:
-    - uses: actions/checkout@v1
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{matrix.ruby}}
-    - name: Install dependencies
-      run: bundle install
-    - name: Setup redis
-      uses: shogo82148/actions-setup-redis@v1
-    - name: Run tests
-      run: ${{matrix.env}} bundle exec rspec

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.covered.db

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---warnings
---require spec_helper

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in async-io.gemspec
-gemspec
-
-# gem "protocol-redis", path: "../protocol-redis"
-
-group :development do
-	gem 'pry'
-end

data/README.md

@@ -1,124 +0,0 @@
-# Async::Redis
-
-An asynchronous client for Redis including TLS. Support for streaming requests and responses. Built on top of [async] and [async-io].
-
-[![Actions Status](https://github.com/socketry/async-redis/workflows/Development/badge.svg)](https://github.com/socketry/async-redis/actions?workflow=Development)
-[![Coverage Status](https://coveralls.io/repos/socketry/async-redis/badge.svg)](https://coveralls.io/r/socketry/async-redis)
-
-[async]: https://github.com/socketry/async
-[async-io]: https://github.com/socketry/async-io
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'async-redis'
-```
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install 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
-```
-
-### 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
-```
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-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
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2018, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).  
-Copyright, 2018, by Huba Z. Nagy.  
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/Rakefile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:test)
-
-task :default => :test
-
-task :client do
-	require 'irb'
-	require 'async/redis/client'
-	
-	endpoint = Async::Redis.local_endpoint
-	client = Async::Redis::Client.new(endpoint)
-	
-	Async do
-		binding.irb
-	end
-end

data/async-redis.gemspec

@@ -1,38 +0,0 @@
-
-require_relative 'lib/async/redis/version'
-
-Gem::Specification.new do |spec|
-	spec.name = "async-redis"
-	spec.version = Async::Redis::VERSION
-	spec.authors = ["Samuel Williams", "Huba Nagy"]
-	spec.email = ["samuel.williams@oriontransfer.co.nz", "12huba@gmail.com"]
-	
-	spec.summary = "A Redis client library."
-	spec.homepage = "https://github.com/socketry/async-redis"
-	
-	spec.files = `git ls-files -z`.split("\x0").reject do |f|
-		f.match(%r{^(test|spec|features)/})
-	end
-	
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency("async", "~> 1.8")
-	spec.add_dependency("async-io", "~> 1.10")
-	spec.add_dependency("async-pool", "~> 0.2")
-	
-	spec.add_dependency("protocol-redis", "~> 0.5.0")
-	
-	spec.add_development_dependency "async-rspec", "~> 1.1"
-	spec.add_development_dependency "redis"
-	spec.add_development_dependency "benchmark-ips"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rspec", "~> 3.6"
-	spec.add_development_dependency "rake"
-	
-	# Dependencies with C extensions
-	if defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby"
-		spec.add_development_dependency "hiredis"
-	end
-end