okuyama 0.0.1 → 0.1.0

data/lib/okuyama/protocol/version1.rb

@@ -0,0 +1,306 @@
+module Okuyama
+  module Protocol
+    class Version1 < AbstractProtocol
+      def initialize(options=nil)
+        if options then
+          @base64_encode_flag = options[:base64_encode_flag]
+        end
+        @base64_encode_flag = true if @base64_encode_flag.nil?
+      end
+            
+      def version
+        return '1.0.0'
+      end
+      
+      def encode(text)
+        return text if ! @base64_encode_flag
+        return Base64.encode64(text).chomp
+      end
+      
+      def decode(text)
+        return text if ! @base64_encode_flag
+        return Base64.decode64(text)
+      end
+      
+      def init_count(socket)
+        socket.puts '0'
+      end
+      
+      def set_value(socket, key, val, tag_list=nil)
+        return self.send_key_tags_value_message(socket, '1', key, tag_list, val)
+      end
+      
+      def get_value(socket, key)
+        return self.send_key_message(socket, '2', key)
+      end
+
+      def get_tag_keys(socket, tag, flag)
+        return self.send_tag_flag_message(socket, '3', tag, flag)
+      end
+  
+      def remove_value(socket, key)
+        return self.send_key_dlock_message(socket, '5', key, '0')
+      end
+  
+      def set_new_value(socket, key, val, tag_list=nil)
+        return self.send_key_tags_value_message(socket, '6', key, tag_list, val)
+      end
+      
+      def get_value_version_check(socket, key)
+        return self.send_key_message(socket, '15', key)
+      end
+      
+      def set_value_version_check(socket, key, val, version, tag_list=nil)
+        return self.send_key_tags_value_message(socket, '16', key, tag_list, val, version)
+      end
+  
+      def incr_value(socket, key, val)
+        return self.send_key_value_message(socket, '13', key, val)
+      end
+      
+      def decr_value(socket, key, val)
+        return self.send_key_value_message(socket, '14', key, val)
+      end
+      
+      def get_multi_value(socket, key_list)
+        return self.send_keys_message(socket, '22', key_list)
+      end
+      
+      def get_tag_values(socket, tag)
+        return self.send_tag_message(socket, '23', tag)
+      end
+      
+      def remove_tag_from_key(socket, tag, key)
+        return self.send_tag_key_message(socket, '40', tag, key)
+      end
+
+      def set_value_and_create_index(socket, key, val, tag_list=nil, group=nil, min_index_n='1', max_index_n='3')
+        return self.send_key_tags_value_group_index_message(socket, '42', key, tag_list, val, group, min_index_n, max_index_n)
+      end
+      
+      def search_value(socket, query_list, condition='1', group=nil, nsize='3')
+        return self.send_query_condition_group_index_message(socket, '43', query_list, condition, group, nsize)
+      end
+
+      def parse_line_result(result, to_i_flag=nil)
+        record = result.split(/,/)
+        
+        opcode = record.shift
+        exit_code = record.shift
+        
+        case exit_code
+        when 'false'
+          case opcode
+          when '4'
+            return []
+          when '43'
+            return []
+          else
+            return nil
+          end
+        when 'error'
+          raise Okuyama::ServerError, record[0]
+        end
+        
+        case opcode
+        when '0'   # init_count
+          result = record[0]
+          result = result.to_i if to_i_flag
+          return result
+        when '2'   # get_value
+          ret = record[0]
+          ret = self.decode(record[0])
+          return ret
+        when '4'   # get_tag_keys
+          return record[0].split(/:/).map{|b|self.decode(b)}
+        when '13'  # incr_value
+          if to_i_flag then
+            result = Base64.decode64(record[0]).chomp
+            result = result.to_i
+          else
+            result = self.decode(record[0])
+          end
+          return result
+        when '14'  # decr_value
+          if to_i_flag then
+            result = Base64.decode64(record[0]).chomp
+            result = result.to_i
+          else
+            result = self.decode(record[0])
+          end
+          return result
+        when '15'  # get_value_version_check
+          record[0] = self.decode(record[0])
+          return record
+        when '22'  # get_multi_value
+          return self.decode(record[0])
+        when '23'  # get_tag_values
+          record[0] = self.decode(record[0])
+          record[1] = self.decode(record[1])
+          return record
+        when '43'   # search_value
+          return record[0].split(/:/).map{|b|self.decode(b)}
+        else
+          return true
+        end
+        return record
+      end
+
+      protected
+      def send_key_message(socket, opcode, key)
+        key_base64 = self.encode(key)
+        socket.print opcode
+        socket.print ","
+        socket.print  key_base64
+        socket.puts
+      end
+
+      def send_key_dlock_message(socket, opcode, key, dlock)
+        key_base64 = self.encode(key)
+        socket.print opcode
+        socket.print ","
+        socket.print  key_base64
+        socket.print ","
+        socket.print  dlock
+        socket.puts
+      end
+
+      def send_keys_message(socket, opcode, key_list)
+        keys_base64 = key_list.map{|key|self.encode(key)}.join(',')
+        socket.print opcode
+        socket.print ","
+        socket.print  keys_base64
+        socket.puts
+     end
+
+      def send_key_value_message(socket, opcode, key, val)
+        key_base64 = self.encode(key)
+        val_base64 = self.encode(val)
+        dlock = '0'
+        socket.print opcode
+        socket.print ","
+        socket.print  key_base64
+        socket.print ","
+        socket.print  dlock
+        socket.print ","
+        socket.print  val_base64
+        socket.puts
+      end
+      
+      def send_key_tags_value_message(socket, opcode, key, tag_list, val, version=nil)
+        key_base64 = self.encode(key)
+        val_base64 = self.encode(val)
+        tags = nil
+        if tag_list then
+          tags = tag_list.map{|t|self.encode(t)}.join(':')
+        end
+        tags ||= "(B)"
+        dlock = '0'
+        socket.print opcode
+        socket.print ","
+        socket.print  key_base64
+        socket.print ","
+        socket.print  tags
+        socket.print ","
+        socket.print  dlock
+        socket.print ","
+        socket.print  val_base64
+
+        if version then
+          socket.print ","
+          socket.print  version
+        end
+        socket.puts
+      end
+      
+      def send_key_tags_value_group_index_message(socket, opcode, key, tag_list, val, group, min_index_n, max_index_n)
+        key_base64 = self.encode(key)
+        val_base64 = self.encode(val)
+
+        tags = nil
+        if tag_list then
+          tags = tag_list.map{|t|self.encode(t)}.join(':')
+        end
+        tags ||= "(B)"
+
+        dlock = '0'
+
+        group_base64 = nil
+        if group then
+          group_base64 = self.encode(group)
+        end
+        group_base64 ||= "(B)"
+
+        socket.print opcode
+        socket.print ","
+        socket.print  key_base64
+        socket.print ","
+        socket.print  tags
+        socket.print ","
+        socket.print  dlock
+        socket.print ","
+        socket.print  val_base64
+        socket.print ","
+        socket.print  group_base64
+        socket.print ","
+        socket.print  min_index_n
+        socket.print ","
+        socket.print  max_index_n
+        socket.puts
+      end
+
+      def send_tag_message(socket, opcode, tag)
+        tag_base64 = self.encode(tag)
+        socket.print opcode
+        socket.print ","
+        socket.print  tag_base64
+        socket.puts
+      end
+
+      def send_tag_flag_message(socket, opcode, tag, flag)
+        tag_base64 = self.encode(tag)
+        socket.print opcode
+        socket.print ","
+        socket.print  tag_base64
+        socket.print ","
+        socket.print  flag
+        socket.puts
+      end
+
+      def send_tag_key_message(socket, opcode, tag, key)
+        tag_base64 = self.encode(tag)
+        key_base64 = self.encode(key)
+        dlock = '0'
+        socket.print opcode
+        socket.print ","
+        socket.print  tag_base64
+        socket.print ","
+        socket.print  key_base64
+        socket.print ","
+        socket.print  dlock
+        socket.puts
+      end
+
+      def send_query_condition_group_index_message(socket, opcode, query_list, condition, group, nsize)
+        queries = query_list.map{|q|self.encode(q)}.join(':')
+        
+        group_base64 = nil
+        if group then
+          group_base64 = self.encode(group)
+        end
+        group_base64 ||= "(B)"
+        socket.print opcode
+        socket.print ","
+        socket.print  queries
+        socket.print ","
+        socket.print  condition
+        socket.print ","
+        socket.print  group_base64
+        socket.print ","
+        socket.print  nsize
+        socket.puts
+      end
+
+    end
+  end
+end

data/lib/okuyama.rb

@@ -5,9 +5,18 @@ autoload :Logger, 'logger'
 
 module Okuyama
   autoload :Client, 'okuyama/client'
-  autoload :Protocol, 'okuyama/protocol'
+  autoload :FastClient, 'okuyama/fast_client'
+  module Protocol
+    autoload :AbstractProtocol, 'okuyama/protocol/abstract_protocol'
+    autoload :Version1, 'okuyama/protocol/version1'
+  end
 
+  # generic error
   class OkuyamaError < RuntimeError; end
+  # socket/server communication error
+  class NetworkError < OkuyamaError; end
+  # server error
+  class ServerError < OkuyamaError; end
 
   def self.logger
     @logger ||= (rails_logger || default_logger)

data/okuyama.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "okuyama"
+  s.version = "0.1.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.description = "okuyama client for Ruby"
+  s.email = "haracane@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/okuyama.rb",
+    "lib/okuyama/client.rb",
+    "lib/okuyama/fast_client.rb",
+    "lib/okuyama/protocol/abstract_protocol.rb",
+    "lib/okuyama/protocol/version1.rb",
+    "okuyama.gemspec",
+    "spec/okuyama/client/decr_value_spec.rb",
+    "spec/okuyama/client/incr_value_spec.rb",
+    "spec/okuyama/client/search_spec.rb",
+    "spec/okuyama/client_spec.rb",
+    "spec/okuyama/protocol/version1_spec.rb",
+    "spec/okuyama_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/haracane/okuyama"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.21"
+  s.summary = "okuyama client for Ruby"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/okuyama/client/decr_value_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Okuyama::Client do
+  
+  [true, false].each do |base64_encode_flag|
+    describe "when base64_encode_flag = #{base64_encode_flag}" do
+        
+      before :each do
+        @testnumval_int = 10
+
+        @testnumkey = 'testnumkey'
+        @testnumval = @testnumval_int.to_s
+        @testkey1 = 'testkey1'
+        @testval1 = 'testval1'
+        @testkey2 = 'testkey2'
+        @testval2 = 'testval2'
+        @testnewkey = 'testnewkey'
+        @testnewval = 'testnewval'
+        @testnewval1 = 'testnewval1'
+        @testtag = 'testtag'
+        @testnewtag = 'testnewtag'
+        @testgroup = 'testgroup'
+        @testnewgroup = 'testnewgroup'
+        @testquery1 = 'testval'
+        @testquery2 = 'val1'
+        @testnewquery = 'testnewval'
+        
+        if base64_encode_flag == false then 
+          @testnumkey = Base64.encode64(@testnumkey).chomp
+          @testnumval = Base64.encode64(@testnumval).chomp
+          @testkey1 = Base64.encode64(@testkey1).chomp
+          @testval1 = Base64.encode64(@testval1).chomp
+          @testkey2 = Base64.encode64(@testkey2).chomp
+          @testval2 = Base64.encode64(@testval2).chomp
+          @testnewkey = Base64.encode64(@testnewkey).chomp
+          @testnewval = Base64.encode64(@testnewval).chomp
+          @testnewval1 = Base64.encode64(@testnewval1).chomp
+          @testtag = Base64.encode64(@testtag).chomp
+          @testnewtag = Base64.encode64(@testnewtag).chomp
+          @testgroup = Base64.encode64(@testgroup).chomp
+          @testnewgroup = Base64.encode64(@testnewgroup).chomp
+          @testquery1 = Base64.encode64(@testquery1).chomp
+          @testquery2 = Base64.encode64(@testquery2).chomp
+          @testnewquery = Base64.encode64(@testnewquery).chomp
+        end
+        
+        
+        @client = Okuyama::Client.new(:host=>'localhost', :port=>8888, :base64_encode_flag=>base64_encode_flag)
+        @client.debug = true
+        @client.remove_value(@testnumkey)
+        @client.remove_value(@testkey1)
+        @client.remove_value(@testkey2)
+        @client.remove_value(@testnewkey)
+        @client.remove_tag_from_key(@testnewtag, @testkey1)
+        @client.set_value(@testnumkey, @testnumval)
+        @client.set_value_and_create_index(@testkey1, @testval1, :tags=>[@testtag], :group=>@testgroup, :min_n=>1, :max_n=>3)
+        @client.set_value(@testkey2, @testval2, @testtag)
+
+      end
+    
+      after :each do 
+        @client.close
+      end
+    
+      describe "decr_value(key)" do
+        describe "when key exists," do
+          describe "when value is a number" do
+            it "should return decremented value(integer)" do
+              result = @client.decr_value(@testnumkey, 1)
+              result.should == (@testnumval_int - 1)
+            end
+            it "should return decremented value(text)" do
+              @client.to_i_flag = false
+              val = @client.get_value(@testnumkey)
+              result = @client.decr_value(@testnumkey, 1)
+              expected = (@testnumval_int - 1).to_s
+              expected = Base64.encode64(expected).chomp if base64_encode_flag == false
+              result.should == expected
+            end
+          end
+          describe "when value is not a number" do
+            it "should return 1(integer)" do
+              result = @client.decr_value(@testkey1, 1)
+              result.should == 0
+            end
+          end
+        end
+        describe "when key does not exist," do
+          it "should fail" do
+            # result = @client.decr_value(@testnewkey, 1)
+            # result.should be_nil
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/spec/okuyama/client/incr_value_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Okuyama::Client do
+  
+  [true,true].each do |base64_encode_flag|
+    describe "when base64_encode_flag = #{base64_encode_flag}" do
+        
+      before :each do
+        @testnumval_int = 10
+
+        @testnumkey = 'testnumkey'
+        @testnumval = @testnumval_int.to_s
+        @testkey1 = 'testkey1'
+        @testval1 = 'testval1'
+        @testkey2 = 'testkey2'
+        @testval2 = 'testval2'
+        @testnewkey = 'testnewkey'
+        @testnewval = 'testnewval'
+        @testnewval1 = 'testnewval1'
+        @testtag = 'testtag'
+        @testnewtag = 'testnewtag'
+        @testgroup = 'testgroup'
+        @testnewgroup = 'testnewgroup'
+        @testquery1 = 'testval'
+        @testquery2 = 'val1'
+        @testnewquery = 'testnewval'
+        
+        if base64_encode_flag == false then 
+          @testnumkey = Base64.encode64(@testnumkey).chomp
+          @testnumval = Base64.encode64(@testnumval).chomp
+          @testkey1 = Base64.encode64(@testkey1).chomp
+          @testval1 = Base64.encode64(@testval1).chomp
+          @testkey2 = Base64.encode64(@testkey2).chomp
+          @testval2 = Base64.encode64(@testval2).chomp
+          @testnewkey = Base64.encode64(@testnewkey).chomp
+          @testnewval = Base64.encode64(@testnewval).chomp
+          @testnewval1 = Base64.encode64(@testnewval1).chomp
+          @testtag = Base64.encode64(@testtag).chomp
+          @testnewtag = Base64.encode64(@testnewtag).chomp
+          @testgroup = Base64.encode64(@testgroup).chomp
+          @testnewgroup = Base64.encode64(@testnewgroup).chomp
+          @testquery1 = Base64.encode64(@testquery1).chomp
+          @testquery2 = Base64.encode64(@testquery2).chomp
+          @testnewquery = Base64.encode64(@testnewquery).chomp
+        end
+        
+        @client = Okuyama::Client.new(:host=>'localhost', :port=>8888, :base64_encode_flag=>base64_encode_flag)
+        @client.debug = true
+        @client.remove_value(@testnumkey)
+        @client.remove_value(@testkey1)
+        @client.remove_value(@testkey2)
+        @client.remove_value(@testnewkey)
+        @client.remove_tag_from_key(@testnewtag, @testkey1)
+        @client.set_value(@testnumkey, @testnumval)
+        @client.set_value_and_create_index(@testkey1, @testval1, :tags=>[@testtag], :group=>@testgroup, :min_n=>1, :max_n=>3)
+        @client.set_value(@testkey2, @testval2, @testtag)
+
+      end
+    
+      after :each do 
+        @client.close
+      end
+    
+      describe "incr_value(key, val)" do
+        describe "when key exists," do
+          describe "when value is a number" do
+            it "should return incremented value(integer)" do
+              Okuyama.logger.debug("send: #{@client.protocol.message_of_incr_value(@testnumkey, '1').inspect}")
+              result = @client.incr_value(@testnumkey, 1)
+              result.should == (@testnumval_int + 1)
+            end
+            it "should return incremented value(text)" do
+              @client.to_i_flag = false
+              result = @client.incr_value(@testnumkey, 1)
+              expected = (@testnumval_int + 1).to_s
+              expected = Base64.encode64(expected).chomp if base64_encode_flag == false
+              result.should == expected
+            end
+          end
+          describe "when value is not a number" do
+            it "should return 1(integer)" do
+              result = @client.incr_value(@testkey1, 1)
+              result.should == 1
+            end
+          end
+        end
+        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
+          end
+        end
+      end
+    
+    end
+  end
+end
+