protocol-redis 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eab7d3758fbb84ad4e85cbeae48dc4a370c5dcab35c6db79cf4ac7d0b4f23e03
-  data.tar.gz: d052a525167a7f439308f143780d6b4bfe4884b4593fc56b7e4bea6f1caf8598
+  metadata.gz: eaec89c45931d2380b65c26b642dc53cc65b0c2b93251c57fa9831fa8aa654a6
+  data.tar.gz: 87be2b36ea8deeb9eef4ed56f2e833120a8641fa4256feb0decb4f8ee73b4f64
 SHA512:
-  metadata.gz: 5ba96c540da05dc4a029dbaba7599bcc267b4cb94e311f8b5064116fc77a1cb581bcec7bc98bb70c8e624ac277d39b8e9cfedb3b3084ec0b9e5ce677123f2d88
-  data.tar.gz: af8434897aa46a45c949029dc180c478aeeae818524100da114e09e8fb8b2268914b184c23de9709ea85b1afd1de6bc8e0527c67bdbadf73838510f6738c70bf
+  metadata.gz: 9c4bf2da40ab8a0090e08428a26f2bdf1b02c1c210a805945d8ff001c5836d6bc3710e1889cd192f0f862bd17dfeb1a6c83dec2cae55ee407b216a96edfd9666
+  data.tar.gz: 4a737e454c0fcdd0c2469f9770caa1e6c4bbe309c2a80a15b5a4937462c5628d175ab59390c075b4d2edd07497ff6bd6947396d0239b11859a89c95fb3962f03

data/README.md

@@ -1,6 +1,6 @@
 # Protocol::Redis
 
-Implements the RESP2 and future redis protocols.
+Implements the RESP2 and [RESP3](https://github.com/antirez/RESP3) Redis protocols.
 
 [![Build Status](https://travis-ci.com/socketry/protocol-redis.svg?branch=master)](https://travis-ci.com/socketry/protocol-redis)
 
@@ -22,7 +22,16 @@ Or install it yourself as:
 
 ## Usage
 
-...
+```ruby
+sockets = Socket.pair(Socket::PF_UNIX, Socket::SOCK_STREAM)
+
+client = Protocol::Redis::Connection.new(sockets.first)
+server = Protocol::Redis::Connection.new(sockets.last)
+
+client.write_object("Hello World!")
+puts server.read_object
+# => "Hello World!"
+```
 
 ## Contributing
 

data/lib/protocol/redis.rb

@@ -19,4 +19,4 @@
 # THE SOFTWARE.
 
 require_relative 'redis/version'
-require_relative 'redis/client'
+require_relative 'redis/connection'

data/lib/protocol/redis/connection.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'async/io/protocol/line'
+require_relative 'error'
 
 module Protocol
 	module Redis
@@ -49,7 +49,7 @@ module Protocol
 			
 			# 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}")
+				write_lines("*#{arguments.size}")
 				
 				arguments.each do |argument|
 					string = argument.to_s
@@ -81,7 +81,8 @@ module Protocol
 			end
 			
 			def read_object
-				line = read_line
+				line = read_line or raise EOFError
+				
 				token = line.slice!(0, 1)
 				
 				case token

data/lib/protocol/redis/methods.rb

@@ -0,0 +1,39 @@
+# Copyright, 2019, by Mikael Henriksson. <http://www.mhenrixon.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 'methods/hashes'
+require_relative 'methods/keys'
+require_relative 'methods/lists'
+require_relative 'methods/server'
+require_relative 'methods/strings'
+
+module Protocol
+	module Redis
+		module Methods
+			def self.included(klass)
+				klass.include Methods::Hashes
+				klass.include Methods::Keys
+				klass.include Methods::Lists
+				klass.include Methods::Server
+				klass.include Methods::Strings
+			end
+		end
+	end
+end

data/lib/protocol/redis/methods/hashes.rb

@@ -0,0 +1,79 @@
+# Copyright, 2019, by Mikael Henriksson. <http://www.mhenrixon.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 Protocol
+	module Redis
+		module Methods
+			module Hashes
+				def hlen(key)
+					return call('HLEN', key)
+				end
+				
+				def hset(key, field, value)
+					return call('HSET', key, field, value)
+				end
+				
+				def hsetnx(key, field, value)
+					return call('HSETNX', key, field, value)
+				end
+				
+				def hmset(key, *attrs)
+					return call('HMSET', key, *attrs)
+				end
+				
+				def hget(key, field)
+					return call('HGET', key, field)
+				end
+				
+				def hmget(key, *fields, &blk)
+					return call('HMGET', key, *fields, &blk)
+				end
+				
+				def hdel(key, *fields)
+					return call('HDEL', key, *fields)
+				end
+				
+				def hexists(key, field)
+					return call('HEXISTS', key, field)
+				end
+				
+				def hincrby(key, field, increment)
+					return call('HINCRBY', key, field, increment)
+				end
+				
+				def hincrbyfloat(key, field, increment)
+					return call('HINCRBYFLOAT', key, field, increment)
+				end
+				
+				def hkeys(key)
+					return call('HKEYS', key)
+				end
+				
+				def hvals(key)
+					return call('HVALS', key)
+				end
+				
+				def hgetall(key)
+					return call('HGETALL', key)
+				end
+			end
+		end
+	end
+end

data/lib/protocol/redis/methods/keys.rb

@@ -0,0 +1,140 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2018, by Huba 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.
+
+require 'date'
+
+module Protocol
+	module Redis
+		module Methods
+			module Keys
+				def del(key, *keys)
+					return call('DEL', key, *keys)
+				end
+				
+				def dump(key)
+					return call('DUMP', key)
+				end
+				
+				def exists(key, *keys)
+					return call('EXISTS', key, *keys)
+				end
+				
+				def expire(key, seconds)
+					return call('EXPIRE', key, seconds)
+				end
+				
+				def expireat(key, time)
+					case time
+					when DateTime, Time, Date 
+						timestamp =  time.strftime('%s').to_i
+					else
+						timestamp = time
+					end
+					
+					return call('EXPIREAT', key, timestamp)
+				end
+				
+				def keys(pattern)
+					return call('KEYS', pattern)
+				end
+				
+				def migrate
+					
+				end
+				
+				def move(key, db)
+					return call('MOVE', key, db)
+				end
+				
+				def object
+					
+				end
+				
+				def persist(key)
+					return call('PERSIST', key)
+				end
+				
+				def pexpire(key, milliseconds)
+					return call('PEXPIRE', milliseconds)
+				end
+				
+				def pexpireat(key, time)
+					case time.class
+					when DateTime, Time, Date 
+						timestamp =  time.strftime('%Q').to_i
+					else
+						timestamp = time
+					end
+					
+					return call('PEXPIREAT', key, timestamp)
+				end
+				
+				def pttl(key)
+					return call('PTTL', key)
+				end
+				
+				def randomkey
+					return call('RANDOMKEY')
+				end
+				
+				def rename(key, new_key)
+					return call('RENAME', key, new_key)
+				end
+				
+				def renamenx(key, new_key)
+					return call('RENAMENX', key, new_key)
+				end
+				
+				def restore(key, serialized_value, ttl=0)
+					return call('RESTORE', key, ttl, serialized_value)
+				end
+				
+				def sort
+					
+				end
+				
+				def touch(key, *keys)
+					return call('TOUCH', key, *keys)
+				end
+				
+				def ttl(key)
+					return call('TTL', key)
+				end
+				
+				def type(key)
+					return call('TYPE', key)
+				end
+				
+				def unlink(key)
+					return call('UNLINK', key)
+				end
+					
+				def wait(newreplicas, timeout)
+					
+				end
+				
+				def scan
+					
+				end
+			end
+		end
+	end
+end

data/lib/protocol/redis/methods/lists.rb

@@ -0,0 +1,118 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2018, by Huba 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.
+
+module Protocol
+	module Redis
+		module Methods
+			module Lists
+				def blpop(*keys, timeout: 0)
+					return call('BLPOP', *keys, timeout)
+				end
+				
+				def brpop(*keys, timeout: 0)
+					return call('BRPOP', *keys, timeout)
+				end
+				
+				def brpoplpush(source, destination, timeout)
+					return call('BRPOPLPUSH', source, destination, timeout)
+				end
+				
+				def lindex(key, index)
+					return call('LINDEX', key, index)
+				end
+				
+				def linsert(key, position=:before, index, value)
+					if position == :before
+						offset = 'BEFORE'
+					else
+						offset = 'AFTER'
+					end
+					
+					return call('LINSERT', key, offset, index, value)
+				end
+				
+				def llen(key)
+					return call('LLEN', key)
+				end
+				
+				def lpop(key)
+					return call('LPOP', key)
+				end
+				
+				def lpush(key, value, *values)
+					case value
+					when Array
+						values = value
+					else
+						values = [value] + values
+					end
+					
+					return call('LPUSH', key, *values)
+				end
+				
+				def lpushx(key, value)
+					return call('LPUSHX', key, value)
+				end
+				
+				def lrange(key, start, stop)
+					return call('LRANGE', key, start, stop)
+				end
+				
+				def lrem(key, count, value)
+					return call('LREM', key, count)
+				end
+				
+				def lset(key, index, values)
+					return call('LSET', key, index, values)
+				end
+				
+				def ltrim(key, start, stop)
+					return call('LTRIM', key, start, stop)
+				end
+				
+				def rpop(key)
+					return call('RPOP', key)
+				end
+				
+				def rpoplpush(source, destination=nil)
+					destination = source if destination.nil?
+					
+					return call('RPOPLPUSH', source, destination)
+				end
+				
+				def rpush(key, value, *values)
+					case value
+					when Array
+						values = value
+					else
+						values = [value] + values
+					end
+					
+					return call('RPUSH', key, *values)
+				end
+				
+				def rpushx(key, value)
+					return call('RPUSHX', key, value)
+				end
+			end
+		end
+	end
+end

data/lib/protocol/redis/methods/server.rb

@@ -0,0 +1,48 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2018, by Huba 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.
+
+module Protocol
+	module Redis
+		module Methods
+			module Server
+				# Get info from server.
+				# @return [Hash] the server metadata.
+				def info
+					metadata = {}
+					
+					call('INFO').each_line(Protocol::CRLF) do |line|
+						key, value = line.split(':')
+						
+						if value
+							metadata[key.to_sym] = value.chomp!
+						end
+					end
+					
+					return metadata
+				end
+				
+				def flushdb!
+					call 'FLUSHDB'
+				end
+			end
+		end
+	end
+end

data/lib/protocol/redis/methods/strings.rb

@@ -0,0 +1,132 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2018, by Huba 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.
+
+module Protocol
+	module Redis
+		module Methods
+			module Strings
+				def append(key, value)
+					return call('APPEND', key, value)
+				end
+
+				def bitcount(key, *range)
+					return call('BITCOUNT', key, *range)
+				end
+
+				def decr(key)
+					return call('DECR', key)
+				end
+
+				def decrby(key, decrement)
+					return call('DECRBY', key, decrement)
+				end
+
+				def get(key)
+					return call('GET', key)
+				end
+
+				def getbit(key, offset)
+					return call('GETBIT', key, offset)
+				end
+
+				def getrange(key, start_index, end_index)
+					return call('GETRANGE', key, start_index, end_index)
+				end
+
+				def getset(key, value)
+					return call('GETSET', key, value)
+				end
+
+				def incr(key)
+					return call('INCR', key)
+				end
+
+				def incrby(key, increment)
+					return call('INCRBY', key, increment)
+				end
+
+				def incrbyfloat(key, increment)
+					return call('INCRBYFLOAT', key, increment)
+				end
+
+				def mget(key, *keys)
+					return call('MGET', key, *keys)
+				end
+
+				def mset(pairs)
+					flattened_pairs = pairs.keys.zip(pairs.values).flatten
+					return call('MSET', *flattened_pairs)
+				end
+
+				def msetnx(pairs)
+					flattened_pairs = pairs.keys.zip(pairs.values).flatten
+					return call('MSETNX', *flattened_pairs)
+				end
+
+				def psetex(key, milliseconds, value)
+					return set key, value, milliseconds: milliseconds
+				end
+
+				def set(key, value, **options)
+					arguments = []
+
+					if options.has_key? :seconds
+						arguments << 'EX'
+						arguments << options[:seconds]
+					end
+
+					if options.has_key? :milliseconds
+						arguments << 'PX'
+						arguments << options[:milliseconds]
+					end
+
+					if options[:condition] == :nx
+						arguments << 'NX'
+					elsif options[:condition] == :xx
+						arguments << 'XX'
+					end
+
+					return call('SET', key, value, *arguments)
+				end
+
+				def setbit(key, offset, value)
+					return call('SETBIT', key, offset, value)
+				end
+
+				def setex(key, seconds, value)
+					return set key, value, seconds: seconds
+				end
+
+				def setnx(key, value)
+					return set key, value, condition: :nx
+				end
+
+				def setrange(key, offset, value)
+					return call('SETRANGE', key, offset, value)
+				end
+
+				def strlen(key)
+					return call('STRLEN', key)
+				end
+			end
+		end
+	end
+end

data/lib/protocol/redis/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module Redis
-		VERSION = "0.1.0"
+		VERSION = "0.2.0"
 	end
 end

data/protocol-redis.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 	
-	spec.add_development_dependency "async-rspec", "~> 1.1"
 	spec.add_development_dependency "benchmark-ips"
 
 	spec.add_development_dependency "covered"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-redis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-10 00:00:00.000000000 Z
+date: 2019-08-16 00:00:00.000000000 Z
 dependencies:
-- !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: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +99,12 @@ files:
 - lib/protocol/redis.rb
 - lib/protocol/redis/connection.rb
 - lib/protocol/redis/error.rb
+- lib/protocol/redis/methods.rb
+- lib/protocol/redis/methods/hashes.rb
+- lib/protocol/redis/methods/keys.rb
+- lib/protocol/redis/methods/lists.rb
+- lib/protocol/redis/methods/server.rb
+- lib/protocol/redis/methods/strings.rb
 - lib/protocol/redis/version.rb
 - protocol-redis.gemspec
 homepage: https://github.com/socketry/protocol-redis