async-redis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f51bfc647fd3f6a3f8a066cdfddd4147d072efb240fccce0e911ca6d0968831
+  data.tar.gz: e35d2061ecf625ad6dfd818e07718bc78af8b2c4095e2bf9b42b1ea02a385b0d
+SHA512:
+  metadata.gz: 36d4b12adcaec403cf91f9ebfaa07d44f2e0381f72ca23c3420dd1359277d9ecc33de90c0413bb130ac8308aa88a6317bdcf0d722e7dcb34c1f8d5afbbee7cfe
+  data.tar.gz: b46435ea68404c5656631b362b130755a8b8a0837af03a29a950b988141ed61279eccc18d9711d3dd1fb03afc1b33fbe54d00d550158d719d6e1f38b24ee7132

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+cache: bundler
+
+services:
+  - redis-server
+
+before_script:
+  - gem update --system
+  - gem install bundler
+
+matrix:
+  include:
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--debug -X+O"
+    - rvm: ruby-head
+    - rvm: rbx-3
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in async-io.gemspec
+gemspec
+
+group :development do
+	gem 'pry'
+end
+
+group :test do
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -0,0 +1,61 @@
+# Async::Redis
+
+An asynchronous client for Redis including TLS. Support for streaming requests and responses. Built on top of [async] and [async-io].
+
+[![Build Status](https://secure.travis-ci.org/socketry/async-redis.svg)](https://travis-ci.org/socketry/async-redis)
+[![Code Climate](https://codeclimate.com/github/socketry/async-redis.svg)](https://codeclimate.com/github/socketry/async-redis)
+[![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
+
+## 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](https://www.codeotaku.com/samuel-williams) and
+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

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test

data/async-redis.gemspec

@@ -0,0 +1,27 @@
+
+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.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+	
+	spec.add_dependency("async", "~> 1.6")
+	spec.add_dependency("async-io", "~> 1.7")
+	
+	spec.add_development_dependency "async-rspec", "~> 1.1"
+	
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rspec", "~> 3.6"
+	spec.add_development_dependency "rake"
+end

data/lib/async/redis.rb

@@ -0,0 +1,21 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require "async/redis/version"

data/lib/async/redis/client.rb

@@ -0,0 +1,81 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require_relative 'protocol/resp'
+require_relative 'pool'
+
+require 'async/io/endpoint'
+
+module Async
+	module Redis
+		def self.local_endpoint
+			Async::IO::Endpoint.tcp('localhost', 6379)
+		end
+		
+		class Client
+			def initialize(endpoint = Redis.local_endpoint, protocol = Protocol::RESP, **options)
+				@endpoint = endpoint
+				@protocol = protocol
+				
+				@connections = connect(**options)
+			end
+			
+			attr :endpoint
+			attr :protocol
+			
+			def self.open(*args, &block)
+				client = self.new(*args)
+				
+				return client unless block_given?
+				
+				begin
+					yield client
+				ensure
+					client.close
+				end
+			end
+			
+			def close
+				@connections.close
+			end
+			
+			def call(*arguments)
+				@connections.acquire do |connection|
+					connection.write_request(arguments)
+					return connection.read_response
+				end
+			end
+			
+			protected
+			
+			def connect(connection_limit: nil)
+				Pool.new(connection_limit) do
+					peer = @endpoint.connect
+						
+					peer.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+					
+					stream = IO::Stream.new(peer)
+					
+					@protocol.client(stream)
+				end
+			end
+		end
+	end
+end

data/lib/async/redis/pool.rb

@@ -0,0 +1,95 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Async
+	module Redis
+		# It might make sense to add support for pipelining https://redis.io/topics/pipelining
+		# We should be able to wrap the protocol so that write_request and read_response happen in lockstep.
+		# The only problem would be blocking operations. It might also be confusing if order of operations affects commands.
+		class Pool
+			def initialize(limit = nil, &block)
+				@available = []
+				@waiting = []
+				
+				@limit = limit
+				
+				@constructor = block
+			end
+			
+			def acquire
+				resource = wait_for_next_available
+				
+				return resource unless block_given?
+				
+				begin
+					yield resource
+				ensure
+					release(resource)
+				end
+			end
+			
+			# Make the resource available and let waiting tasks know that there is something available.
+			def release(resource)
+				@available << resource
+					
+				if task = @waiting.pop
+					task.resume
+				end
+			end
+			
+			def close
+				@available.each(&:close)
+				@available.clear
+			end
+			
+			protected
+			
+			def wait_for_next_available
+				until resource = next_available
+					@waiting << Fiber.current
+					Task.yield
+				end
+				
+				return resource
+			end
+			
+			def create_resource
+				begin
+					# This might fail, which is okay :)
+					resource = @constructor.call
+				rescue StandardError
+					Async.logger.error "#{$!}: #{$!.backtrace}"
+					return nil
+				end
+				
+				return resource
+			end
+			
+			def next_available
+				if @available.any?
+					@available.pop
+				elsif !@limit or @available.count < @limit
+					Async.logger.debug(self) {"No available resources, allocating new one..."}
+					create_resource
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,117 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'async/io/protocol/line'
+
+module Async
+	module Redis
+		class ServerError < StandardError
+		end
+		
+		module Protocol
+			class RESP < Async::IO::Protocol::Line
+				CRLF = "\r\n".freeze
+				
+				class << self
+					alias client new
+				end
+				
+				def initialize(stream)
+					super(stream, CRLF)
+				end
+				
+				# The redis server doesn't want actual objects (e.g. integers) but only bulk strings. So, we inline it for performance.
+				def write_request(arguments)
+					write_lines("*#{arguments.count}")
+					
+					arguments.each do |argument|
+						string = argument.to_s
+						
+						write_lines("$#{string.bytesize}", string)
+					end
+					
+					@stream.flush
+				end
+				
+				def write_object(object)
+					case object
+					when String
+						write_lines("$#{object.bytesize}", object)
+					when Array
+						write_array(object)
+					when Integer
+						write_lines(":#{object}")
+					else
+						write_object(object.to_redis)
+					end
+				end
+				
+				# def write_lines(*args)
+				# 	puts "write_lines(#{args.inspect})"
+				# 	super
+				# end
+				# 
+				# def read_line
+				# 	result = super
+				# 	puts "read_line #{result}"
+				# 
+				# 	return result
+				# end
+				
+				def read_object
+					token = @stream.read(1)
+					# puts "token: #{token}"
+					
+					case token
+					when '$'
+						length = read_line.to_i
+						
+						if length == -1
+							return nil
+						else
+							buffer = @stream.read(length)
+							read_line # Eat trailing whitespace?
+						
+							return buffer
+						end
+					when '*'
+						count = read_line.to_i
+						array = Array.new(count) {read_object}
+						
+						return array
+					when ':'
+						return read_line.to_i
+					
+					when '-'
+						raise ServerError.new(read_line)
+					
+					when '+'
+						return read_line
+					
+					else
+						raise NotImplementedError, "Implementation for token #{token} missing"
+					end
+				end
+				
+				alias read_response read_object
+			end
+		end
+	end
+end

data/lib/async/redis/version.rb

@@ -0,0 +1,25 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Async
+	module Redis
+		VERSION = "0.1.0"
+	end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: async-redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+- Huba Nagy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: async-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: async-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+- 12huba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- async-redis.gemspec
+- lib/async/redis.rb
+- lib/async/redis/client.rb
+- lib/async/redis/pool.rb
+- lib/async/redis/protocol/resp.rb
+- lib/async/redis/version.rb
+homepage: https://github.com/socketry/async-redis
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A Redis client library.
+test_files: []