oxblood 0.1.0.dev5 → 0.1.0.dev6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b3e70584c6264f36457da12558ba76dcabc4b19
-  data.tar.gz: 06a8d8e83f0e9d9a68790126fb1324023cd86c08
+  metadata.gz: 5d4ee25bdc593d1e5add8d8a72fe3a5672c761be
+  data.tar.gz: 83eb492c6fa4754533db829df5a8ae73502393cb
 SHA512:
-  metadata.gz: 36e9a9993f99b8fc11ebb7ee0208964c7eaedf08ce300f3b0061844dfe3d080e25d0d7b66353564b9a73c9c3af624b9e3f18773cbfb2c2ff0fac067b93e7a4fb
-  data.tar.gz: b8612141ca6b893edc340ce5247cf7f2a2b3429baf1b0ccd4688deb1fe2c77fd586910dba1fcb5658a6450c18472b7ba5f4efb2f50e4d8278846c8f22f66e6f7
+  metadata.gz: e92b901aa353d3db7398918a44721fa85d84f9b835c0478841402b0bc82afccd0435228800d19dcf7745e1f3f5ce03fcafe26881c2a6d72ef5f1be0652122ddf
+  data.tar.gz: 63d6b37b92ed32d333223afafaa776ae31fa07f49ed777ccb75fb3c8191665221360de1604fa24488c074ab182bedf4a43696254a0dbaae189d8113c1e479119

data/README.md

@@ -1,12 +1,18 @@
 # Oxblood
 
 [![Gem Version](https://badge.fury.io/rb/oxblood.svg)](https://badge.fury.io/rb/oxblood)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/etehtsea/oxblood/master/frames)
 [![Code Climate](https://codeclimate.com/github/etehtsea/oxblood/badges/gpa.svg)](https://codeclimate.com/github/etehtsea/oxblood)
 [![Test Coverage](https://codeclimate.com/github/etehtsea/oxblood/badges/coverage.svg)](https://codeclimate.com/github/etehtsea/oxblood/coverage)
 [![Issue Count](https://codeclimate.com/github/etehtsea/oxblood/badges/issue_count.svg)](https://codeclimate.com/github/etehtsea/oxblood)
 
 An experimental Redis Ruby client.
 
+## Compatibility
+
+- Ruby 2.2.2+
+- JRuby 9k+
+
 ## Usage
 
 ### Standalone

data/lib/oxblood/session.rb

@@ -72,6 +72,9 @@ module Oxblood
     # @param [Integer] increment by value
     #
     # @return [String] the value of field after the increment
+    # @return [RError] field contains a value of the wrong type (not a string).
+    #   Or the current field content or the specified increment are not parsable
+    #   as a double precision floating point number.
     def hincrbyfloat(key, field, increment)
       run(:HINCRBYFLOAT, key, field, increment)
     end
@@ -171,13 +174,6 @@ module Oxblood
       run(:HVALS, key)
     end
 
-    # Incrementally iterate hash fields and associated values
-    # @see http://redis.io/commands/hscan
-    #
-    # @todo Implement this command
-    def hscan(key, cursor)
-    end
-
     # ------------------ Strings ---------------------
 
     # ------------------ Connection ---------------------
@@ -188,6 +184,8 @@ module Oxblood
     # @param [String] password
     #
     # @return [String] 'OK'
+    # @return [RError] if wrong password was passed or server does not require
+    #   password
     def auth(password)
       run(:AUTH, password)
     end
@@ -231,6 +229,7 @@ module Oxblood
     # @param [Integer] index database to switch
     #
     # @return [String] 'OK'
+    # @return [RError] if wrong index was passed
     def select(index)
       run(:SELECT, index)
     end
@@ -242,9 +241,10 @@ module Oxblood
     # @see http://redis.io/commands/info
     #
     # @param [String] section used to select a specific section of information
+    #
+    # @return [String] raw redis server response as a collection of text lines.
     def info(section = nil)
       section ? run(:INFO, section) : run(:INFO)
-      # FIXME: Parse response
     end
 
     # ------------------ Keys ------------------------
@@ -259,12 +259,26 @@ module Oxblood
       run(*keys.unshift(:DEL))
     end
 
-    # Find all keys matching the given pattern
-    # @see http://redis.io/commands/keys
+    # Return a serialized version of the value stored at specified key.
+    # @see http://redis.io/commands/dump
     #
-    # @param [String] pattern used to match keys
-    def keys(pattern)
-      run(:KEYS, pattern)
+    # @param [String] key
+    #
+    # @return [String] serialized value
+    def dump(key)
+      run(:DUMP, key)
+    end
+
+    # Determine if a key exists
+    # @see http://redis.io/commands/exists
+    #
+    # @param [String, Array<String>] keys to check
+    #
+    # @return [Integer] the number of keys existing among the ones specified as
+    #   arguments. Keys mentioned multiple times and existing are counted
+    #   multiple times.
+    def exists(*keys)
+      run(*keys.unshift(:EXISTS))
     end
 
     # Set a key's time to live in seconds
@@ -279,6 +293,170 @@ module Oxblood
       run(:EXPIRE, key, seconds)
     end
 
+    # Set the expiration for a key as a UNIX timestamp
+    # @see http://redis.io/commands/expireat
+    #
+    # @param [String] key
+    # @param [Integer] timestamp in UNIX format
+    #
+    # @return [Integer] 1 if the timeout was set. 0 if key does not exist or
+    #   the timeout could not be set.
+    def expireat(key, timestamp)
+      run(:EXPIREAT, key, timestamp)
+    end
+
+    # Find all keys matching the given pattern
+    # @see http://redis.io/commands/keys
+    #
+    # @param [String] pattern used to match keys
+    def keys(pattern)
+      run(:KEYS, pattern)
+    end
+
+    # Move a key to another database
+    # @see http://redis.io/commands/move
+    #
+    # @param [String] key
+    # @param [Integer] db index
+    #
+    # @return [Integer] 1 if key was moved and 0 otherwise.
+    def move(key, db)
+      run(:MOVE, key, db)
+    end
+
+    # Inspect the internals of Redis objects
+    # @see http://redis.io/commands/object
+    #
+    # @param [String] subcommand `REFCOUNT`, `ENCODING`, `IDLETIME`
+    # @param [String] key
+    #
+    # @return [Integer] in case of `REFCOUNT` and `IDLETIME` subcommands
+    # @return [String] in case of `ENCODING` subcommand
+    # @return [nil] if object you try to inspect is missing
+    def object(subcommand, key)
+      run(:OBJECT, subcommand, key)
+    end
+
+    # Remove expiration from a key
+    # @see http://redis.io/commands/persist
+    # @param [String] key
+    #
+    # @return [Integer] 1 if the timeout was removed and 0 otherwise
+    def persist(key)
+      run(:PERSIST, key)
+    end
+
+    # Set a key's time to live in milliseconds
+    # @see http://redis.io/commands/pexpire
+    #
+    # @param [String] key
+    # @param [Integer] milliseconds
+    #
+    # @return [Integer] 1 if the timeout was set and 0 otherwise
+    def pexpire(key, milliseconds)
+      run(:PEXPIRE, key, milliseconds)
+    end
+
+    # Set the expiration for a key as a UNIX timestamp specified in milliseconds
+    # @see http://redis.io/commands/pexpireat
+    #
+    # @param [String] key
+    # @param [Integer] timestamp in milliseconds
+    #
+    # @return [Integer] 1 if the timeout was set and 0 otherwise
+    def pexpireat(key, timestamp)
+      run(:PEXPIREAT, key, timestamp)
+    end
+
+    # Get the time to live for a key in milliseconds
+    # @see http://redis.io/commands/pttl
+    #
+    # @param [String] key
+    #
+    # @return [Integer] TTL in milliseconds, or a negative value in order to
+    #   signal an error
+    def pttl(key)
+      run(:PTTL, key)
+    end
+
+    # Return a random key from the keyspace
+    # @see http://redis.io/commands/randomkey
+    #
+    # @return [String] the random key
+    # @return [nil] if database is empty
+    def randomkey
+      run(:RANDOMKEY)
+    end
+
+    # Rename a key
+    # @see http://redis.io/commands/rename
+    #
+    # @param [String] key to rename
+    # @param [String] newkey
+    #
+    # @return [String] OK in case of success
+    # @return [RError] if key does not exist. Before Redis 3.2.0, an error is
+    #   returned if source and destination names are the same.
+    def rename(key, newkey)
+      run(:RENAME, key, newkey)
+    end
+
+    # Rename a key, only if the new key does not exist
+    # @see http://redis.io/commands/renamenx
+    #
+    # @param [String] key to rename
+    # @param [String] newkey
+    #
+    # @return [Integer] 1 if key was renamed to newkey. 0 if newkey already
+    #   exists.
+    # @return [RError] if key does not exist. Before Redis 3.2.0, an error is
+    #   returned if source and destination names are the same.
+    def renamenx(key, newkey)
+      run(:RENAMENX, key, newkey)
+    end
+
+    # Create a key using the provided serialized value, previously obtained
+    # using DUMP
+    # @see http://redis.io/commands/restore
+    #
+    # @param [String] key
+    # @param [Integer] ttl expire time in milliseconds
+    # @param [String] serialized_value obtained using DUMP command
+    # @param [Hash] opts
+    #
+    # @option opts [Boolean] :replace (false) Override key if it already exists
+    #
+    # @return [String] OK on success
+    # @return [RError] if replace is false and key already exists or RDB version
+    #   and data checksum don't match.
+    def restore(key, ttl, serialized_value, opts = {})
+      args = [:RESTORE, key, ttl, serialized_value]
+      args << :REPLACE if opts[:replace]
+
+      run(*args)
+    end
+
+    # Get the time to live for a key
+    # @see http://redis.io/commands/ttl
+    #
+    # @param [String] key
+    #
+    # @return [Integer] TTL in seconds, or a negative value in order to signal
+    #   an error
+    def ttl(key)
+      run(:TTL, key)
+    end
+
+    # Determine the type stored at key
+    # @see http://redis.io/commands/type
+    #
+    # @param [String] key
+    #
+    # @return [String] type of key, or none when key does not exist.
+    def type(key)
+      run(:TYPE, key)
+    end
+
     # ------------------ Sets ------------------------
 
     # Add one or more members to a set
@@ -326,10 +504,24 @@ module Oxblood
     # @param [String] key under which set is stored
     # @param [String] min value
     # @param [String] max value
+    #
+    # @return [Array] list of elements in the specified score range
     def zrangebyscore(key, min, max)
       run(:ZRANGEBYSCORE, key, min, max)
     end
 
+    # Remove one or more members from a sorted set
+    # @see http://redis.io/commands/zrem
+    #
+    # @param [String] key
+    # @param [Array<String>] members to delete
+    #
+    # @return [Integer] number of deleted members
+    # @return [RError] when key exists and does not hold a sorted set.
+    def zrem(key, *members)
+      run(*members.unshift(:ZREM, key))
+    end
+
     protected
 
     def serialize(*command)

data/lib/oxblood/version.rb

@@ -1,3 +1,3 @@
 module Oxblood
-  VERSION = '0.1.0.dev5'
+  VERSION = '0.1.0.dev6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxblood
 version: !ruby/object:Gem::Version
-  version: 0.1.0.dev5
+  version: 0.1.0.dev6
 platform: ruby
 authors:
 - Konstantin Shabanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A Ruby Redis client