protocol-redis 0.4.0 → 0.6.0

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# 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 Protocol
+	module Redis
+		module Methods
+			module Streams
+				# Get information on streams and consumer groups. O(N) with N being the number of returned items for the subcommands CONSUMERS and GROUPS. The STREAM subcommand is O(log N) with N being the number of items in the stream.
+				# @see https://redis.io/commands/xinfo
+				# @param help [Enum]
+				def xinfo(*arguments)
+					call("XINFO", *arguments)
+				end
+				
+				# Appends a new entry to a stream. O(1).
+				# @see https://redis.io/commands/xadd
+				# @param key [Key]
+				# @param ID [String]
+				def xadd(*arguments)
+					call("XADD", *arguments)
+				end
+				
+				# Trims the stream to (approximately if '~' is passed) a certain size. O(N), with N being the number of evicted entries. Constant times are very small however, since entries are organized in macro nodes containing multiple entries that can be released with a single deallocation.
+				# @see https://redis.io/commands/xtrim
+				# @param key [Key]
+				# @param strategy [Enum]
+				# @param approx [Enum]
+				# @param count [Integer]
+				def xtrim(*arguments)
+					call("XTRIM", *arguments)
+				end
+				
+				# Removes the specified entries from the stream. Returns the number of items actually deleted, that may be different from the number of IDs passed in case certain IDs do not exist. O(1) for each single item to delete in the stream, regardless of the stream size.
+				# @see https://redis.io/commands/xdel
+				# @param key [Key]
+				# @param ID [String]
+				def xdel(*arguments)
+					call("XDEL", *arguments)
+				end
+				
+				# Return a range of elements in a stream, with IDs matching the specified IDs interval. O(N) with N being the number of elements being returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1).
+				# @see https://redis.io/commands/xrange
+				# @param key [Key]
+				# @param start [String]
+				# @param end [String]
+				def xrange(*arguments)
+					call("XRANGE", *arguments)
+				end
+				
+				# Return a range of elements in a stream, with IDs matching the specified IDs interval, in reverse order (from greater to smaller IDs) compared to XRANGE. O(N) with N being the number of elements returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1).
+				# @see https://redis.io/commands/xrevrange
+				# @param key [Key]
+				# @param end [String]
+				# @param start [String]
+				def xrevrange(*arguments)
+					call("XREVRANGE", *arguments)
+				end
+				
+				# Return the number of entires in a stream. O(1).
+				# @see https://redis.io/commands/xlen
+				# @param key [Key]
+				def xlen(*arguments)
+					call("XLEN", *arguments)
+				end
+				
+				# Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block. For each stream mentioned: O(N) with N being the number of elements being returned, it means that XREAD-ing with a fixed COUNT is O(1). Note that when the BLOCK option is used, XADD will pay O(M) time in order to serve the M clients blocked on the stream getting new data.
+				# @see https://redis.io/commands/xread
+				# @param streams [Enum]
+				# @param key [Key]
+				# @param id [String]
+				def xread(*arguments)
+					call("XREAD", *arguments)
+				end
+				
+				# Create, destroy, and manage consumer groups. O(1) for all the subcommands, with the exception of the DESTROY subcommand which takes an additional O(M) time in order to delete the M entries inside the consumer group pending entries list (PEL).
+				# @see https://redis.io/commands/xgroup
+				def xgroup(*arguments)
+					call("XGROUP", *arguments)
+				end
+				
+				# Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block. For each stream mentioned: O(M) with M being the number of elements returned. If M is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay the O(N) time in order to serve the N clients blocked on the stream getting new data.
+				# @see https://redis.io/commands/xreadgroup
+				# @param noack [Enum]
+				# @param streams [Enum]
+				# @param key [Key]
+				# @param ID [String]
+				def xreadgroup(*arguments)
+					call("XREADGROUP", *arguments)
+				end
+				
+				# Marks a pending message as correctly processed, effectively removing it from the pending entries list of the consumer group. Return value of the command is the number of messages successfully acknowledged, that is, the IDs we were actually able to resolve in the PEL. O(1) for each message ID processed.
+				# @see https://redis.io/commands/xack
+				# @param key [Key]
+				# @param group [String]
+				# @param ID [String]
+				def xack(*arguments)
+					call("XACK", *arguments)
+				end
+				
+				# Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer. O(log N) with N being the number of messages in the PEL of the consumer group.
+				# @see https://redis.io/commands/xclaim
+				# @param key [Key]
+				# @param group [String]
+				# @param consumer [String]
+				# @param min-idle-time [String]
+				# @param ID [String]
+				def xclaim(*arguments)
+					call("XCLAIM", *arguments)
+				end
+				
+				# Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged. O(N) with N being the number of elements returned, so asking for a small fixed number of entries per call is O(1). When the command returns just the summary it runs in O(1) time assuming the list of consumers is small, otherwise there is additional O(N) time needed to iterate every consumer.
+				# @see https://redis.io/commands/xpending
+				# @param key [Key]
+				# @param group [String]
+				# @param consumer [String]
+				def xpending(*arguments)
+					call("XPENDING", *arguments)
+				end
+			end
+		end
+	end
+end

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

@@ -30,21 +30,21 @@ module Protocol
 				# @param key [Key]
 				# @param value [String]
 				def append(key, value)
-					return call('APPEND', key, value)
+					call('APPEND', key, value)
 				end
 
 				# Count set bits in a string. O(N).
 				# @see https://redis.io/commands/bitcount
 				# @param key [Key]
 				def bitcount(key, *range)
-					return call('BITCOUNT', key, *range)
+					call('BITCOUNT', key, *range)
 				end
 
 				# Decrement the integer value of a key by one. O(1).
 				# @see https://redis.io/commands/decr
 				# @param key [Key]
 				def decr(key)
-					return call('DECR', key)
+					call('DECR', key)
 				end
 
 				# Decrement the integer value of a key by the given number. O(1).
@@ -52,14 +52,14 @@ module Protocol
 				# @param key [Key]
 				# @param decrement [Integer]
 				def decrby(key, decrement)
-					return call('DECRBY', key, decrement)
+					call('DECRBY', key, decrement)
 				end
 
 				# Get the value of a key. O(1).
 				# @see https://redis.io/commands/get
 				# @param key [Key]
 				def get(key)
-					return call('GET', key)
+					call('GET', key)
 				end
 
 				# Returns the bit value at offset in the string value stored at key. O(1).
@@ -67,7 +67,7 @@ module Protocol
 				# @param key [Key]
 				# @param offset [Integer]
 				def getbit(key, offset)
-					return call('GETBIT', key, offset)
+					call('GETBIT', key, offset)
 				end
 
 				# Get a substring of the string stored at a key. O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
@@ -76,7 +76,7 @@ module Protocol
 				# @param start [Integer]
 				# @param end [Integer]
 				def getrange(key, start_index, end_index)
-					return call('GETRANGE', key, start_index, end_index)
+					call('GETRANGE', key, start_index, end_index)
 				end
 
 				# Set the string value of a key and return its old value. O(1).
@@ -84,14 +84,14 @@ module Protocol
 				# @param key [Key]
 				# @param value [String]
 				def getset(key, value)
-					return call('GETSET', key, value)
+					call('GETSET', key, value)
 				end
 
 				# Increment the integer value of a key by one. O(1).
 				# @see https://redis.io/commands/incr
 				# @param key [Key]
 				def incr(key)
-					return call('INCR', key)
+					call('INCR', key)
 				end
 
 				# Increment the integer value of a key by the given amount. O(1).
@@ -99,7 +99,7 @@ module Protocol
 				# @param key [Key]
 				# @param increment [Integer]
 				def incrby(key, increment)
-					return call('INCRBY', key, increment)
+					call('INCRBY', key, increment)
 				end
 
 				# Increment the float value of a key by the given amount. O(1).
@@ -107,28 +107,30 @@ module Protocol
 				# @param key [Key]
 				# @param increment [Double]
 				def incrbyfloat(key, increment)
-					return call('INCRBYFLOAT', key, increment)
+					call('INCRBYFLOAT', key, increment)
 				end
 
 				# Get the values of all the given keys. O(N) where N is the number of keys to retrieve.
 				# @see https://redis.io/commands/mget
 				# @param key [Key]
 				def mget(key, *keys)
-					return call('MGET', key, *keys)
+					call('MGET', key, *keys)
 				end
 
 				# Set multiple keys to multiple values. O(N) where N is the number of keys to set.
 				# @see https://redis.io/commands/mset
 				def mset(pairs)
 					flattened_pairs = pairs.keys.zip(pairs.values).flatten
-					return call('MSET', *flattened_pairs)
+					
+					call('MSET', *flattened_pairs)
 				end
 
 				# Set multiple keys to multiple values, only if none of the keys exist. O(N) where N is the number of keys to set.
 				# @see https://redis.io/commands/msetnx
 				def msetnx(pairs)
 					flattened_pairs = pairs.keys.zip(pairs.values).flatten
-					return call('MSETNX', *flattened_pairs)
+					
+					call('MSETNX', *flattened_pairs)
 				end
 
 				# Set the value and expiration in milliseconds of a key. O(1).
@@ -137,7 +139,7 @@ module Protocol
 				# @param milliseconds [Integer]
 				# @param value [String]
 				def psetex(key, milliseconds, value)
-					return set key, value, milliseconds: milliseconds
+					call('PSETEX', key, milliseconds, value)
 				end
 
 				# Set the string value of a key. O(1).
@@ -163,7 +165,7 @@ module Protocol
 						arguments << "NX"
 					end
 
-					return call('SET', key, value, *arguments)
+					call('SET', key, value, *arguments)
 				end
 
 				# Sets or clears the bit at offset in the string value stored at key. O(1).
@@ -172,7 +174,7 @@ module Protocol
 				# @param offset [Integer]
 				# @param value [Integer]
 				def setbit(key, offset, value)
-					return call('SETBIT', key, offset, value)
+					call('SETBIT', key, offset, value)
 				end
 
 				# Set the value and expiration of a key. O(1).
@@ -181,15 +183,16 @@ module Protocol
 				# @param seconds [Integer]
 				# @param value [String]
 				def setex(key, seconds, value)
-					return set key, value, seconds: seconds
+					call('SETEX', key, seconds, value)
 				end
 
 				# Set the value of a key, only if the key does not exist. O(1).
+				# @return [Boolean] if the key was set.
 				# @see https://redis.io/commands/setnx
 				# @param key [Key]
 				# @param value [String]
 				def setnx(key, value)
-					return set key, value, condition: :nx
+					call('SETNX', key, value) == 1
 				end
 
 				# Overwrite part of a string at key starting at the specified offset. O(1), not counting the time taken to copy the new string in place. Usually, this string is very small so the amortized complexity is O(1). Otherwise, complexity is O(M) with M being the length of the value argument.
@@ -198,14 +201,14 @@ module Protocol
 				# @param offset [Integer]
 				# @param value [String]
 				def setrange(key, offset, value)
-					return call('SETRANGE', key, offset, value)
+					call('SETRANGE', key, offset, value)
 				end
 
 				# Get the length of the value stored in a key. O(1).
 				# @see https://redis.io/commands/strlen
 				# @param key [Key]
 				def strlen(key)
-					return call('STRLEN', key)
+					call('STRLEN', key)
 				end
 			end
 		end

data/lib/protocol/redis/version.rb

@@ -22,6 +22,6 @@
 
 module Protocol
 	module Redis
-		VERSION = "0.4.0"
+		VERSION = "0.6.0"
 	end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: protocol-redis
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
 - Huba Nagy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -26,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: trenni
+  name: bake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: bake-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +54,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: bake-modernize
+  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'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: covered
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -96,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: trenni
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,22 +137,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
-- 12huba@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- benchmark/call.rb
 - lib/protocol/redis.rb
 - lib/protocol/redis/connection.rb
 - lib/protocol/redis/error.rb
@@ -135,17 +153,20 @@ files:
 - lib/protocol/redis/methods/geospatial.rb
 - lib/protocol/redis/methods/hashes.rb
 - lib/protocol/redis/methods/lists.rb
+- lib/protocol/redis/methods/pubsub.rb
+- lib/protocol/redis/methods/scripting.rb
 - lib/protocol/redis/methods/server.rb
+- lib/protocol/redis/methods/sets.rb
 - lib/protocol/redis/methods/sorted_sets.rb
+- lib/protocol/redis/methods/streams.rb
 - lib/protocol/redis/methods/strings.rb
 - lib/protocol/redis/version.rb
-- protocol-redis.gemspec
-- tasks/generate.rake
-- tasks/methods.trenni
 homepage: https://github.com/socketry/protocol-redis
-licenses: []
-metadata: {}
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -153,15 +174,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: A RESP protocol client/server parser.
+summary: A transport agnostic RESP protocol client/server.
 test_files: []