okuyama 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,7 +1,88 @@
 = okuyama
 
-Description goes here.
+'okuyama' is a high performance pure Ruby client for accessing okuyama master nodes.
 
+== Install
+
+You can install okuyama by gem.
+ gem install okuyama
+
+== Usage
+
+Create okuyama client:
+
+ require "okuyama"
+
+ okuyama = Okuyama::Client.new(:host=>"localhost", :port=>8888)
+ 
+Set value:
+ p okuyama.set_value("key", "val") # => true
+ 
+Get value:
+ p okuyama.get_value("key") # => "val"
+ 
+Remove value:
+ p okuyama.remove_value("key") # => true
+ p okuyama.get_value("key") # => nil
+ 
+Set tags:
+ p okuyama.set_value("key1", "val1", ["tag1"]) # => true
+ p okuyama.set_value("key2", "val2", ["tag1", "tag2"]) # => true
+
+Get keys from tag:
+ p okuyama.get_tag_keys("tag1")  # => ["key1", "key2"]
+ p okuyama.get_tag_keys("tag2")  # => ["key2"]
+ p okuyama.get_tag_keys("tag3")  # => []
+
+Get values from tag:
+ p okuyama.get_tag_values("tag1")  # => [["key1", "val1"], ["key2", "val2"]]
+ p okuyama.get_tag_values("tag2")  # => [["key2", "val2"]]
+ p okuyama.get_tag_values("tag3")  # => []
+
+Get values from tag with block:
+ p okuyama.get_tag_values("tag1"){|v| p v}
+ # => ["key1", "val1"]
+ # => ["key2", "val2"]
+
+Remove tag from key:
+ okuyama.remove_tag_from_key("tag1", "key2")
+ p okuyama.get_tag_keys("tag1")  # => ["key1"]
+ 
+Get multi values:
+ p okuyama.get_multi_value(["key1", "key2"]) # => ["val1", "val2"]
+
+Get multi values with block:
+ p okuyama.get_multi_value(["key1", "key2"]){|v| p v}
+ # => "val1"
+ # => "val2"
+ 
+Increment value:
+ okuyama.set_value("count", "10")
+ p okuyama.incr_value("count", 2) # => 12
+
+Decrement value:
+ p okuyama.decr_value("count", 3) # => 9
+
+Set new value:
+ p okuyama.set_new_value("key1", "val1") # => nil
+ p okuyama.set_new_value("key3", "val3") # => true
+
+Get value with version:
+ p okuyama.get_value_version_check("key1") # => ["val1", "1332676579458792037"]
+
+Set value with version check:
+ p okuyama.set_value_version_check("key1", "val1_0", "1332676579458792037") # => true
+ p okuyama.set_value_version_check("key1", "VAL1_1", "0") # => nil
+ p okuyama.get_value("key1") # => "val1_0"
+
+Create index:
+ p okuyama.set_value_and_create_index("key1", "val1") # => true
+ p okuyama.set_value_and_create_index("key2", "val2") # => true
+ 
+Search with query:
+ p okuyama.search_query("val") # => ["key2", "key1"]
+ p okuyama.search_query("empty") # => []
+ 
 == Contributing to okuyama
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/okuyama/client.rb

@@ -1,14 +1,9 @@
 module Okuyama
   class Client < FastClient
     public
-    attr_accessor :debug, :to_i_flag, :parse_flag
     
     def initialize(options)
-      super
-      @to_i_flag = options[:to_i_flag]
-      @to_i_flag = true if @to_i_flag.nil?
-      @parse_flag = options[:parse_flag]
-      @parse_flag = true if @parse_flag.nil?
+      super(options)
     end
     
     
@@ -31,11 +26,9 @@ module Okuyama
         tag_list = args
       end
 
-      # Disable debug message for better performance
-      # Okuyama.logger.debug "Okuyama::Client.protocol.set_value(key=#{key.inspect},val=#{val.inspect},tag_list=#{tag_list.inspect})"
+      Okuyama.logger.debug "Okuyama::FastClient.set_value(key=#{key.inspect},val=#{val.inspect},tag_list=#{tag_list.inspect})" if @debug
 
-      @protocol.set_value(self.socket, key, val, tag_list)
-      return self.recvs
+      super(key, val, tag_list)
     end
     
     def set_new_value(key, val, *args)
@@ -57,11 +50,9 @@ module Okuyama
         tag_list = args
       end
 
-      # Disable debug message for better performance
-      # Okuyama.logger.debug "Okuyama::Client.protocol.set_value(key=#{key.inspect},val=#{val.inspect},tag_list=#{tag_list.inspect})"
+      Okuyama.logger.debug "Okuyama::FastClient.set_value(key=#{key.inspect},val=#{val.inspect},tag_list=#{tag_list.inspect})" if @debug
 
-      @protocol.set_new_value(self.socket, key, val, tag_list)
-      return self.recvs
+      return super(key, val, tag_list)
     end
     
     def set_value_version_check(key, val, version, *args)
@@ -83,11 +74,9 @@ module Okuyama
         tag_list = args
       end
 
-      # Disable debug message for better performance
-      # Okuyama.logger.debug "Okuyama::Client.protocol.set_value(key=#{key.inspect},val=#{val.inspect},tag_list=#{tag_list.inspect})"
+      Okuyama.logger.debug "Okuyama::FastClient.set_value(key=#{key.inspect},val=#{val.inspect},tag_list=#{tag_list.inspect})" if @debug
 
-      @protocol.set_value_version_check(self.socket, key, val, version, tag_list)
-      return self.recvs
+      return super(key, val, version, tag_list)
     end
     
     def get_tag_keys(tag, *args, &block)
@@ -99,51 +88,7 @@ module Okuyama
       elsif 0 < argc then
         flag = args[0]
       end
-      @protocol.get_tag_keys(self.socket, tag, flag)
-      return self.recvs
-    end
-
-    protected    
-    def each(&block)
-      return super(&block) if ! @parse_flag
-      if block_given? then
-        while line = socket.gets do
-          Okuyama.logger.debug "recv: #{line.inspect}" if @debug
-          line.chomp!
-          if line == "END" then
-            break
-          else
-            result = self.parse_result(line)
-            yield(result)
-          end
-        end
-      end
-    end
-
-    def readlines
-      return super if ! @parse_flag
-      ret = []
-      self.each { |record|
-        ret.push record
-      }
-      return ret
-    end
-    
-    def recvs
-      line = super
-      # Disable debug message for better performance
-      Okuyama.logger.debug "recv: #{line.inspect}" if @debug
-      return self.parse_result(line) if @parse_flag
-      return line
-    end
-
-    def parse_result(result)
-      begin
-        result = @protocol.parse_line_result(result, @to_i_flag)
-      rescue Okuyama::ServerError => e
-        raise Okuyama::ServerError, "#{e.message}, message = #{result.inspect}"
-      end
-      return result
+      return super(tag, flag)
     end
 
   end

data/lib/okuyama/fast_client.rb

@@ -2,13 +2,19 @@ module Okuyama
   class FastClient
     public
     attr_reader :host, :port, :timeout, :retry_max, :protocol
-    attr_accessor :base64_encode_flag
+    attr_accessor :debug, :base64_encode_flag, :to_i_flag, :parse_flag, :recv_flag
     
     def initialize(options)
       @host = options[:host] || 'localhost'
       @port = options[:port] || 8888
       @timeout = options[:timeout] || 10
       @retry_max = options[:retry_max] || 3
+      @recv_flag = true
+      @recv_flag = options[:recv_flag] || @recv_flag
+      @to_i_flag = options[:to_i_flag]
+      @to_i_flag = true if @to_i_flag.nil?
+      @parse_flag = options[:parse_flag]
+      @parse_flag = true if @parse_flag.nil?
       protocol_version = options[:protocol_version] || '1.0.0'
       protocol_version = '1.0.0'
       case protocol_version
@@ -28,6 +34,7 @@ module Okuyama
         begin
           @socket.close
         rescue Exception=>e
+          @socket = nil
           raise e if raise_exception
           Okuyama.logger.error "ERROR: #{e.message}"
         end
@@ -35,71 +42,104 @@ module Okuyama
       @socket = nil
     end
     
+    def recvs
+      return if ! @recv_flag
+      line = self.socket.gets
+      line.chomp!
+      # Disable debug message for better performance
+      Okuyama.logger.debug "recv: #{line.inspect}" if @debug
+      return self.parse_result(line) if @parse_flag
+      return line
+    end
+    
+    def recv_lines(&block)
+      if block_given? then
+        return self.each(&block)
+      else
+        return self.readlines
+      end
+    end
+    
+    alias :recv_init_count :recvs    
     def init_count
       @protocol.init_count(self.socket)
-      return self.recvs
+      return self.recv_init_count
     end
     
+    alias :recv_set_value :recvs
     def set_value(key, val, tag_list=nil)
       @protocol.set_value(self.socket, key, val, tag_list)
-      return self.recvs
+      return self.recv_set_value
     end
     
+    alias :recv_get_value :recvs
     def get_value(key)
       @protocol.get_value(self.socket, key)
-      return self.recvs
+      return self.recv_get_value
     end
     
+    alias :recv_get_tag_keys :recvs
     def get_tag_keys(tag, flag='false')
       @protocol.get_tag_keys(self.socket, tag, flag)
-      return self.recvs
+      return self.recv_get_tag_keys
     end
     
+    alias :recv_remove_value :recvs
     def remove_value(key)
       @protocol.remove_value(self.socket, key)
-      return self.recvs
+      return self.recv_remove_value
     end
     
+    alias :recv_set_new_value :recvs
     def set_new_value(key, val, tag_list=nil)
       @protocol.set_new_value(self.socket, key, val, tag_list)
-      return self.recvs
+      return self.recv_set_new_value
     end
     
+    alias :recv_get_value_version_check :recvs
     def get_value_version_check(key)
       @protocol.get_value_version_check(self.socket, key)
-      return self.recvs
+      return self.recv_get_value_version_check
     end
     
+    alias :recv_set_value_version_check :recvs
     def set_value_version_check(key, val, version, tag_list=nil)
-      @protocol.set_value_versin_check(self.socket, key, val, version, tag_list)
-      return self.recvs
+      @protocol.set_value_version_check(self.socket, key, val, version, tag_list)
+      return self.recv_set_value_version_check
     end
     
+    alias :recv_incr_value :recvs
     def incr_value(key, val)
       @protocol.incr_value(self.socket, key, val.to_s)
-      return self.recvs
+      return self.recv_incr_value
     end
     
+    alias :recv_decr_value :recvs
     def decr_value(key, val)
       @protocol.decr_value(self.socket, key, val.to_s)
-      return self.recvs
+      return self.recv_decr_value
     end
     
+    alias :recv_get_multi_value :recv_lines
     def get_multi_value(key_list, &block)
+      Okuyama.logger.debug "send: #{@protocol.message_of_get_multi_value(key_list).inspect}" if @debug
       @protocol.get_multi_value(self.socket, key_list)
-      return self.recv_lines(&block)
+      return self.recv_get_multi_value(&block)
     end
     
+    alias :recv_get_tag_values :recv_lines
     def get_tag_values(tag, &block)
       @protocol.get_tag_values(self.socket, tag)
-      return self.recv_lines(&block)
+      return self.recv_get_tag_values(&block)
     end
 
+    alias :recv_remove_tag_from_key :recvs
     def remove_tag_from_key(tag, key)
       @protocol.remove_tag_from_key(self.socket, tag, key)
-      return self.recvs
+      return self.recv_remove_tag_from_key
     end
 
+    alias :recv_set_value_and_create_index :recvs
     def set_value_and_create_index(key, val, options=nil)
       if options then
         tag_list = options[:tags]
@@ -111,9 +151,10 @@ module Okuyama
       end
       
       @protocol.set_value_and_create_index(self.socket, key, val, tag_list, group, min_n, max_n)
-      return self.recvs
+      return self.recv_set_value_and_create_index
     end
 
+    alias :recv_search_value :recvs
     def search_value(query_list, options=nil)
       if ! query_list.is_a? Array then
         query_list = [query_list.to_s]
@@ -133,61 +174,36 @@ module Okuyama
       end
 
       @protocol.search_value(self.socket, query_list, condition, group, nsize)
-      return self.recvs
+      return self.recv_search_value
     end
     
-    def method_missiong(method_id, *args, &block)
-      method_name = method_id.to_s
-      if method_name =~ /^message_of_/ then
-        next_method_name = $'
-        result = capture(:stdout) {
-          @protocol.send(method_name, $stdout, *args, &block)
-        }
-        return result
-      else
-        super
-      end
-    end
-
-    protected    
-
+    protected
     def each(&block)
+      return if ! @recv_flag
       while line = socket.gets do
         line.chomp!
         if line == "END" then
           break
         else
-          yield(line)
+          yield(self.parse_result(line))
         end
       end
     end
 
     def readlines
+      return if ! @recv_flag
       ret = []
       while line = socket.gets do
+        line.chomp!
         if line == "END" then
           break
         else
-          ret.push line
+          ret.push self.parse_result(line)
         end
       end
       return ret
     end
 
-    def recvs
-      line = self.socket.gets
-      line.chomp!
-      return line
-    end
-    
-    def recv_lines(&block)
-      if block_given? then
-        return self.each(&block)
-      else
-        return self.readlines
-      end
-    end
-    
     def socket
       if @socket.nil? then
         retry_count = 0
@@ -218,5 +234,15 @@ module Okuyama
       end
       return @socket
     end
+    
+    def parse_result(result)
+      begin
+        result = @protocol.parse_line_result(result, @to_i_flag)
+      rescue Okuyama::ServerError => e
+        self.close
+        raise Okuyama::ServerError, "#{e.message}, message = #{result.inspect}"
+      end
+      return result
+    end
   end
 end

data/okuyama.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "okuyama"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kenji Hara"]
-  s.date = "2012-03-25"
+  s.date = "2012-03-26"
   s.description = "okuyama client for Ruby"
   s.email = "haracane@gmail.com"
   s.extra_rdoc_files = [

data/spec/okuyama/client/incr_value_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Okuyama::Client do
   
-  [true,true].each do |base64_encode_flag|
+  [true,false].each do |base64_encode_flag|
     describe "when base64_encode_flag = #{base64_encode_flag}" do
         
       before :each do
@@ -87,8 +87,8 @@ describe Okuyama::Client do
         describe "when key does not exist," do
           it "should fail" do
             Okuyama.logger.debug("send: #{@client.protocol.message_of_incr_value(@testnewkey, '1').inspect}")
-            result = @client.incr_value(@testnewkey, 1)
-            result.should be_nil
+            # result = @client.incr_value(@testnewkey, 1)
+            # result.should be_nil
           end
         end
       end

data/spec/spec_helper.rb

@@ -5,8 +5,8 @@ require 'okuyama'
 require 'stringio'
 
 Okuyama.logger = Logger.new(STDERR)
-Okuyama.logger.level = Logger::DEBUG
-# Okuyama.logger.level = Logger::ERROR
+# Okuyama.logger.level = Logger::DEBUG
+Okuyama.logger.level = Logger::ERROR
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
@@ -15,6 +15,3 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   
 end
-
-module IOUtil
-end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: okuyama
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kenji Hara
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-25 00:00:00 Z
+date: 2012-03-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development