xfiredb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bd830b09b250371533632ecf4aa70b9f9d40a7d
-  data.tar.gz: 63c8d424676a7b44b615a7be898c66e5248ffed7
+  metadata.gz: d11e78d17ca8c37ae5988f4f51d116bc6c8d5b95
+  data.tar.gz: ccb4c25286946a02a5b22b99afc9334510093a9e
 SHA512:
-  metadata.gz: 3ac853af16c4d8341f9d7e8076adc4e9f3c836ac8cfd1b7270c65ebea89ea08706e1f183bfb12673da199a1080d4d69fd942c02afd2bbb08a28d904a01032897
-  data.tar.gz: baef7b08a54e305e05040b95f14f9ce118ab85c958086e05b7a3af8063d9fcf44027aca048ee5a98537e6401c35dfb408e3676c5a8476d4b6b6b787017345cfa
+  metadata.gz: 9a196ec5d624c61c21ebd4074ddf00cf040e7b8709c0683a37a8918c7657714c6db3f2a61166931a3ef29eeff1708d0df2a99414e524a5bbfe06a9ed773107c1
+  data.tar.gz: ec4329bb304621dcd0299da0c901086ddbfa4307ce9f8e91e1d2955dd335b164c62be5feb00d9645b635f41042f9c4df57b41c5da7b3fc955aae7c96af477d30

data/lib/xfiredb.rb

@@ -18,6 +18,7 @@
 
 require 'socket'
 require 'openssl'
+require 'set'
 
 require 'xfiredb/socket'
 require 'xfiredb/version'

data/lib/xfiredb/client.rb

@@ -69,12 +69,9 @@ module XFireDB
       reply.chomp! if reply
       num = reply.scan(/\ /).count + 1
 
-      puts num
-
       num.times do
         data = @socket.gets
         data.chomp! if data
-        puts data
         res = XFireDB::Result.new data
         res.process
         yield res
@@ -102,6 +99,262 @@ module XFireDB
     def ssl?
       @ssl
     end
+
+    # -- String commands --- #
+
+    # Lookup a string key.
+    # @param [String] key Key to lookup.
+    # @return [String] The value of key. nil is returned if the key doesn't exist.
+    def get(key)
+      str = nil
+      self.query("GET #{key}") {|result|
+        str = result.data unless result.null?
+      }
+
+      str
+    end
+
+    # Set a key to a string value.
+    # @param [String] key Key to set.
+    # @param [String] data Data to set the key to.
+    # @return [Boolean] True on success, false otherwise.
+    def set(key, data)
+      success = false
+      self.query("SET #{key} \"#{data}\"") { |result|
+        success = result.success?
+      }
+      success
+    end
+
+    # Delete a key.
+    # @param [String] key Key to delete.
+    # @return [Boolean] True on success, false otherwise.
+    def delete(key)
+      success = false
+      self.query("DELETE #{key}") {|result|
+        success = result.success?
+      }
+      success
+    end
+
+    # Add a hashmap node to a hashmap.
+    # @param [String] key Hashmap to add a key to.
+    # @param [String] hkey Hashmap key to add.
+    # @param [String] data Data to store under hkey.
+    # @return [Boolean] True on success, false otherwise.
+    def map_add(key, hkey, data)
+      success = false
+      self.query("MADD #{key} #{hkey} \"#{data}\"") {|result|
+        success = result.success?
+      }
+      success
+    end
+
+    # Reference a hashmap.
+    # @param [String] key Hashmap to lookup.
+    # @param [String] args List of hashmap keys to lookup.
+    # @return [Hash] Hashmap of the lookup keys.
+    #
+    # @example map_ref
+    #   map_ref('test-map', 'key1', 'key2', 'key3')
+    # 
+    # @example returned data
+    #   key1 => Key1 data
+    #   key2 => nil # This key didn't exist in 'test-map'
+    #   key3 => Key3 data
+    def map_ref(key, *args)
+      map = Hash.new
+      hkeys = args.join(' ')
+      i = 0
+      self.query("MREF #{key} #{hkeys}") {|result|
+        if result.success?
+          map[args[i]] = result.data
+        else
+          map[args[i]] = nil
+        end
+        i += 1
+      }
+
+      map
+    end
+
+    # Clear a hashmap.
+    # @param [String] key Hashmap to clear.
+    # @return [Boolean] True on success, false otherwise.
+    def map_clear(key)
+      self.delete(key)
+    end
+
+    # Get the size of a hashmap.
+    # @param [String] key Hashmap to get the size of.
+    # @return [Fixnum] Number of hashmap entry's in the hashmap.
+    def map_size(key)
+      size = 0
+      self.query("MSIZE #{key}") {|result|
+        size = result.data if result.success?
+      }
+      size
+    end
+
+    # Delete a number of keys from a hashmap.
+    # @param [String] key Hashmap to delete from.
+    # @param [String] args List of keys to delete.
+    # @return [Fixnum] Number of keys deleted.
+    #
+    # map_delete('test-map', 'key1', 'key2', 'key3') will
+    # attempt to delete the keys key1, key2 and key3 from the
+    # hashmap stored at 'test-map'.
+    def map_delete(key, *args)
+      num = 0
+      hkeys = args.join ' '
+      self.query("MDEL #{key} #{hkeys}") {|result|
+        num = result.data if result.success?
+      }
+      num
+    end
+
+    # Check if a key is included in a set.
+    # @param [String] key Set to look into.
+    # @param [String] set_key The set will be checked for this key.
+    # @return [Boolean] True if set_key exists, false otherwise.
+    def set_include?(key, set_key)
+      included = false
+      self.query("SINCLUDE #{key} \"#{set_key}\"") {|result|
+        included = result.data if result.success?
+      }
+      included
+    end
+
+    # Add one or more keys to a set.
+    # @param [String] key Set to add the keys to.
+    # @param [String] args Keys which have to be added.
+    # @return [Fixnum] Number of keys added.
+    # @example set_add
+    #   set_add('test-set', 'set key 1', 'set key 2', 'set key 3')
+    def set_add(key, *args)
+      args = array_add_quotes(args)
+      keys = args.join ' '
+      num = 0
+      self.query("SADD #{key} #{keys}") {|result|
+        num = result.data if result.success?
+      }
+      num
+    end
+
+    # Delete one or more keys from a set.
+    # @param [String] key Set to delete from.
+    # @param [String] args Keys to delete from the set.
+    # @return [Fixnum] Number of keys deleted.
+    def set_delete(key, *args)
+      args = array_add_quotes(args)
+      keys = args.join ' '
+      num = 0
+      self.query("SDEL #{key} #{keys}") {|result|
+        num = result.data if result.success?
+      }
+      num
+    end
+
+    # Clear out an entire set.
+    # @param [String] key Set to delete.
+    # @return [Boolean] True on success, false otherwise.
+    def set_clear(key)
+      self.delete(key)
+    end
+
+    # Add data to a list.
+    # @param [String] key List to push into.
+    # @param [String] data Data to push into the list.
+    # @return [Boolean] True on success, false otherwise.
+    def list_push(key, data)
+      success = false
+      self.query("LPUSH #{key} \"#{data}\"") {|result|
+        success = result.success?
+      }
+      success
+    end
+
+    # Reference a list by index or range.
+    # @param [String] key List to reference.
+    # @param [String] idx Index or range.
+    # @return [Array] Array of the results.
+    #
+    # @example by index
+    #   list_ref('test-list', 1)
+    # @example by range
+    #   list_ref('test-list', '0..-1')
+    def list_ref(key, idx)
+      ary = Array.new
+      self.query("LREF #{key} #{idx}") {|result|
+        if result.success?
+          ary.push result.data
+        else
+          ary.push nil
+        end
+      }
+      ary
+    end
+
+    # Pop elements from a list by index or range.
+    # @param [String] key List to reference.
+    # @param [String] idx Index or range.
+    # @return [Array] Array of the results.
+    #
+    # @example by index
+    #   list_pop('test-list', 1)
+    # @example by range
+    #   list_pop('test-list', '0..-1')
+    def list_pop(key, idx)
+      ary = Array.new
+      self.query("LPOP #{key} #{idx}") {|result|
+        if result.success?
+          ary.push result.data
+        else
+          ary.push nil
+        end
+      }
+      ary
+    end
+
+    # Set the data in a list at a specific index.
+    # @param [String] key List to reference.
+    # @param [Fixnum] idx Index to edit.
+    # @param [String] data Data to set.
+    # @note The index has to exist before you are able to use list_set on it.
+    def list_set(key, idx, data)
+      success = false
+      self.query("LSET #{key} #{idx} \"#{data}\"") {|result|
+        success = result.success?
+      }
+      success
+    end
+
+    # Get the size of a list (number of elements).
+    # @param [String] key List to get the size of.
+    # @return [Fixnum] Number of elements in the list.
+    def list_size(key)
+      num = 0
+      self.query("LSIZE #{key}") {|result|
+        num = result.data if result.success?
+      }
+      num
+    end
+
+    # Clear out an entire list.
+    # @param [String] key List to delete.
+    # @return [Boolean] True on success, false otherwise.
+    def list_clear(key)
+      self.delete(key)
+    end
+
+    private
+    def array_add_quotes(ary)
+      return unless ary.kind_of? Array
+      ary.collect! {|element|
+        "\"#{element}\""
+      }
+      ary
+    end
   end
 end
 

data/lib/xfiredb/result.rb

@@ -81,6 +81,7 @@ module XFireDB
         @status = ACK
       elsif @data == "nil"
         @status = NULL
+        @data = nil
       else
         @status = MSG
       end

data/lib/xfiredb/version.rb

@@ -1,4 +1,4 @@
 module XFireDB
   # XFireDB ruby client version number.
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xfiredb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Michel Megens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler