async-redis 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8adb00be17d1c72515a20f6c73dbba0e4f995780b6bec7e4fefef0aca53853
-  data.tar.gz: 39c7bef188aafb043d7efb1fe437bf18fc215bc1ebff5834e118a28fd37a3cfb
+  metadata.gz: f8921f2c6c6856463367ae38fcfa5e82a80616e5eda3430cc6eb40255c47f3ae
+  data.tar.gz: 53c01952126f0403bb75d3b82e522048e9b74ceb841a8c15d54a7fec980149b1
 SHA512:
-  metadata.gz: 872b269771f7bda3fd312cc70d334687062aefbc27b70e2cc155b06614a26290ee6db0aa3901ea2390b5e2a245617e12c8641eff88608ef8c72a17d83cf4cadc
-  data.tar.gz: 7cf5d03872e8d7197a00b2493af8838cd8591faa4f6843a02f4ece26d80ae31a58054b96e8b14c03c042fa879ff0a8781954f7c9091515c85cf60ef48f909e62
+  metadata.gz: 1bc75e38ba9b902f7f0f89c9a55fc8338c618492c3d30495b76e4da2976ae3509678ef0a51151b6668f6409c46e61fb6cccfda458dd039b5a8ce27d3b979e81a
+  data.tar.gz: 849ac7c70c39a57e25def98669e2843639a818f980b081805966d39589b9708cd23b1db13e06261e1c055e9c2c58c9f7bf3fadbfc0ab7d74786268c13dd6ebdc

data/.travis.yml

@@ -10,11 +10,13 @@ matrix:
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
+    - rvm: truffleruby
     - rvm: jruby-head
       env: JRUBY_OPTS="--debug -X+O"
     - rvm: ruby-head
     - rvm: rbx-3
   allow_failures:
+    - rvm: truffleruby
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: rbx-3

data/README.md

@@ -27,6 +27,63 @@ Or install it yourself as:
 
 ## Usage
 
+### Basic Local Connection
+
+```ruby
+require 'async/redis'
+
+endpoint = Async::Redis.local_endpoint
+client = Async::Redis::Client.new(endpoint)
+
+Async.run do
+	pp client.info
+ensure
+	client.close
+end
+```
+
+### Variables
+
+```ruby
+require 'async/redis'
+
+endpoint = Async::Redis.local_endpoint
+client = Async::Redis::Client.new(endpoint)
+
+Async.run do
+	client.set('X', 10)
+	pp client.get('X')
+ensure
+	client.close
+end
+```
+
+### Subscriptions
+
+```ruby
+require 'async/redis'
+require 'json'
+
+endpoint = Async::Redis.local_endpoint
+client = Async::Redis::Client.new(endpoint)
+
+Async.run do |task|
+	subscriber = task.async do
+		client.subscribe 'status.frontend' do |context|
+			type, name, message = context.listen
+			
+			pp type, name, message
+		end
+	end
+	
+	publisher = task.async do
+		client.publish 'status.frontend', 'good'
+	end
+ensure
+	client.close
+end
+```
+
 ## Contributing
 
 1. Fork it

data/async-redis.gemspec

@@ -13,15 +13,16 @@ Gem::Specification.new do |spec|
 	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.8")
-	spec.add_dependency("async-io", "~> 1.10.0")
+	spec.add_dependency("async-io", "~> 1.10")
 	
 	spec.add_development_dependency "async-rspec", "~> 1.1"
 	
-	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "bundler"
 	spec.add_development_dependency "rspec", "~> 3.6"
 	spec.add_development_dependency "rake"
 end

data/lib/async/redis.rb

@@ -18,4 +18,5 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require "async/redis/version"
+require_relative 'redis/version'
+require_relative 'redis/client'

data/lib/async/redis/client.rb

@@ -23,6 +23,11 @@ require_relative 'pool'
 require_relative 'context/multi'
 require_relative 'context/subscribe'
 
+require_relative 'methods/strings'
+require_relative 'methods/keys'
+require_relative 'methods/lists'
+require_relative 'methods/server'
+
 require 'async/io'
 
 module Async
@@ -32,6 +37,11 @@ module Async
 		end
 		
 		class Client
+			include Methods::Strings
+			include Methods::Keys
+			include Methods::Lists
+			include Methods::Server
+			
 			def initialize(endpoint = Redis.local_endpoint, protocol = Protocol::RESP, **options)
 				@endpoint = endpoint
 				@protocol = protocol

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

@@ -1,5 +1,5 @@
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# and Huba Nagy
+# 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
@@ -21,10 +21,18 @@
 
 require_relative 'nested'
 
+require_relative '../methods/strings'
+require_relative '../methods/keys'
+require_relative '../methods/lists'
+
 module Async
 	module Redis
 		module Context
 			class Multi < Nested
+				include Methods::Strings
+				include Methods::Keys
+				include Methods::Lists
+
 				def initialize(pool, *args)
 					super(pool)
 					
@@ -32,20 +40,12 @@ module Async
 					@connection.read_response
 				end
 				
-				def set(key, value)
-					return send_command('SET', key, value)
-				end
-				
-				def get(key)
-					return send_command 'GET', key
-				end
-				
 				def execute
-					return send_command 'EXEC'
+					return call 'EXEC'
 				end
 				
 				def discard
-					return send_command 'DISCARD'
+					return call 'DISCARD'
 				end
 			end
 		end

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

@@ -1,5 +1,5 @@
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# and Huba Nagy
+# 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
@@ -35,7 +35,7 @@ module Async
 					end
 				end
 				
-				def send_command(command, *args)
+				def call(command, *args)
 					@connection.write_request([command, *args])
 					return @connection.read_response
 				end

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

@@ -1,5 +1,5 @@
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# and Huba Nagy
+# 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
@@ -66,7 +66,7 @@ module Async
 						return response
 					else
 						@channels.subtract(channels)
-						return send_command 'UNSUBSCRIBE', *channels
+						return call 'UNSUBSCRIBE', *channels
 					end
 				end
 			end

data/lib/async/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 Async
+	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/async/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 Async
+	module Redis
+		module Methods
+			module Lists
+				def blpop(ttl=0, *keys)
+					return call('BLPOP', *keys, ttl)
+				end
+
+				def brpop(ttl=0, *keys)
+					return call('BRPOP', *keys, ttl)
+				end
+
+				def brpoplpush(sorce, 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/async/redis/methods/server.rb

@@ -0,0 +1,44 @@
+# 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 Async
+	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
+			end
+		end
+	end
+end

data/lib/async/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 Async
+	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/async/redis/protocol/resp.rb

@@ -26,9 +26,9 @@ module Async
 		end
 		
 		module Protocol
+			CRLF = "\r\n".freeze
+			
 			class RESP < Async::IO::Protocol::Line
-				CRLF = "\r\n".freeze
-				
 				class << self
 					alias client new
 				end

data/lib/async/redis/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module Redis
-		VERSION = "0.2.0"
+		VERSION = "0.3.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-redis
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -57,16 +57,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,10 @@ files:
 - lib/async/redis/context/multi.rb
 - lib/async/redis/context/nested.rb
 - lib/async/redis/context/subscribe.rb
+- lib/async/redis/methods/keys.rb
+- lib/async/redis/methods/lists.rb
+- lib/async/redis/methods/server.rb
+- lib/async/redis/methods/strings.rb
 - lib/async/redis/pool.rb
 - lib/async/redis/protocol/resp.rb
 - lib/async/redis/version.rb