kyototycoon 0.1.2 → 0.5.0

data/README.markdown

@@ -1,3 +1,12 @@
+KyotoTycoon client for Ruby.
+
+# Feature / Fixture
+
+* Always Keep-Alive connect (v0.5.0+)
+* You can choise key/value encoding from URI or Base64
+* You can use MessagePack tranparency
+* Benchmark scripts appended(they are connect to localhost:19999)
+
 # Install
 
     $ gem install kyototycoon
@@ -6,7 +15,7 @@
 
 ## Simple case
 
-    @kt = KyotoTycoon.new
+    @kt = KyotoTycoon.new('localhost', 1978)
 
     # traditional style
     @kt.set('foo', 123)
@@ -21,9 +30,18 @@
 
 
 ## Complex case
+    # KT#configure for instance setting store.
+
+    KyotoTycoon.configure(:generic) do |kt|
+      kt.db = '*' # on memory
+    end
 
-    @kt = KyotoTycoon.new('remotehost', 12345) # connect any host, any port
-    @kt.db = '*' # on memory, or DB file as KT known
+    # connect any host, any port
+    KyotoTycoon.configure(:favicon, 'remotehost', 12345) do |kt|
+      kt.db = 'favicons.kch' # DB file as KT known
+    end
+
+    @kt = KyotoTycoon.create(:generic) # got KT instance by KT#configure(:generic) rules
 
     # set/bulk_set/get/bulk_get uses msgpack. default as :default
     @kt.serializer = :msgpack
@@ -37,14 +55,14 @@
     # @kt.logger = STDOUT
     # @kt.logger = Logger.new(STDOUT)
 
-    # HTTP agent
-    @kt.agent = :skinny # low-level socket communicate. a bit of faster than :nethttp(default). try benchmark/agent.rb
-
     # standby server
     @kt.connect_timeout = 0.5 # => wait 0.5 sec for connection open
     @kt.servers << ['server2', 1978] # standby server that will use when primary server (a.k.a. KT#new(host, port)) is dead.
     @kt.servers << ['server3', 1978] # same as above
 
+    # key/value encoding from :U or :B(default). default as base64 because it seems better than URL encode for me.
+    @kt.colenc = :U
+
     # get/set
     @kt.set('foo', 42, 100) # => expire at 100 seconds after
     @kt['foo'] # => 42. it is interger by msgpack serializer works
@@ -61,7 +79,7 @@
     @kt.remove_bulk([:foo, :bar])
 
     # it can store when msgpack using.
-    @kt['baz'] = {'a' => 'a', 'b' => 'b}
+    @kt['baz'] = {'a' => 'a', 'b' => 'b'}
     @kt['baz'] # => {'a' => 'a', 'b' => 'b}
 
     # increment
@@ -70,6 +88,10 @@
     @kt.increment('bar', 10) # => 12
     @kt.increment('bar', -5) # => 7
 
+    # shorthand
+    @kt.incr('foo') # => 1
+    @kt.decr('foo') # => 0
+
     # delete keys
     @kt.delete(:foo, :bar, :baz)
 

data/benchmark/bulk.rb

@@ -1,11 +1,7 @@
 # -- coding: utf-8
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require "rubygems"
-require "benchmark"
-require 'kyototycoon.rb'
+require File.expand_path("#{File.dirname(__FILE__)}/helper.rb")
 
-kt = KyotoTycoon.new
 bulk={}
 50000.times.map{|n|
   bulk[n.to_s] = "#{n}-#{rand}"
@@ -15,23 +11,5 @@ job = lambda {|kt|
   kt.get_bulk(bulk.keys)
   kt.clear
 }
-Benchmark.bm do |x|
-  x.report('default') {
-    kt.serializer=:default
-    job.call(kt)
-  }
-  x.report('msgpack') {
-    kt.serializer=:msgpack
-    job.call(kt)
-  }
-  x.report('default(skinny)') {
-    kt.agent = :skinny
-    kt.serializer=:default
-    job.call(kt)
-  }
-  x.report('msgpack(skinny)') {
-    kt.agent = :skinny
-    kt.serializer=:msgpack
-    job.call(kt)
-  }
-end
+
+benchmark(job)

data/benchmark/bulk_bigdata.rb

@@ -1,11 +1,7 @@
 # -- coding: utf-8
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require "rubygems"
-require "benchmark"
-require 'kyototycoon.rb'
+require File.expand_path("#{File.dirname(__FILE__)}/helper.rb")
 
-kt = KyotoTycoon.new
 bulk={}
 str = "string ああ" * 10000
 100.times.map{|n|
@@ -16,13 +12,4 @@ job = lambda {|kt|
   kt.get_bulk(bulk.keys)
   kt.clear
 }
-Benchmark.bm do |x|
-  x.report('default') {
-    kt.serializer=:default
-    job.call(kt)
-  }
-  x.report('msgpack') {
-    kt.serializer=:msgpack
-    job.call(kt)
-  }
-end
+benchmark(job)

data/benchmark/getset.rb

@@ -1,11 +1,7 @@
 # -- coding: utf-8
 
-require "rubygems"
-require "benchmark"
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'kyoto_tycoon.rb'
+require File.expand_path("#{File.dirname(__FILE__)}/helper.rb")
 
-kt = KyotoTycoon.new
 job = lambda {|kt|
   1000.times{|n|
     kt.set(n.to_s, n)
@@ -13,25 +9,4 @@ job = lambda {|kt|
   }
   kt.clear
 }
-Benchmark.bm do |x|
-  x.report('default') {
-    kt.agent = :nethttp
-    kt.serializer=:default
-    job.call(kt)
-  }
-  x.report('msgpack') {
-    kt.agent = :nethttp
-    kt.serializer=:msgpack
-    job.call(kt)
-  }
-  x.report('default(skinny)') {
-    kt.agent = :skinny
-    kt.serializer=:default
-    job.call(kt)
-  }
-  x.report('msgpack(skinny)') {
-    kt.agent = :skinny
-    kt.serializer=:msgpack
-    job.call(kt)
-  }
-end
+benchmark(job)

data/benchmark/getset_while_1sec.rb

@@ -1,10 +1,6 @@
 # -- coding: utf-8
 
-require "rubygems"
-require "benchmark"
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require "msgpack"
-require 'kyototycoon.rb'
+require File.expand_path("#{File.dirname(__FILE__)}/helper.rb")
 
 job = lambda {|kt|
   cnt = 0
@@ -22,12 +18,4 @@ job = lambda {|kt|
   cnt
 }
 
-kt = KyotoTycoon.new
-
-%w"nethttp skinny".each{|agent|
-  %w!default msgpack!.each{|serializer|
-    kt.agent = agent.to_sym
-    kt.serializer = serializer.to_sym
-    puts "#{agent}/#{serializer}: #{job.call(kt)}"
-  }
-}
+benchmark(job)

data/benchmark/helper.rb

@@ -0,0 +1,22 @@
+# -- coding: utf-8
+
+require "benchmark"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'kyototycoon.rb'
+
+def benchmark(job)
+  kt = KyotoTycoon.new('0.0.0.0', 19999)
+  Benchmark.bm do |x|
+    %w!B U!.each{|colenc|
+      %w!default msgpack!.each{|serializer|
+        x.report("#{serializer}, colenc=#{colenc}") {
+          kt.serializer=serializer.to_sym
+          kt.colenc = colenc.to_sym
+          job.call(kt)
+        }
+      }
+    }
+  end
+end
+

data/kyototycoon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kyototycoon}
-  s.version = "0.1.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["uu59"]
-  s.date = %q{2010-12-09}
+  s.date = %q{2010-12-22}
   s.description = %q{KyotoTycoon client for Ruby}
   s.email = %q{a@tt25.org}
   s.extra_rdoc_files = [
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
     "README.markdown",
     "Rakefile",
     "VERSION",
-    "benchmark/agent.rb",
+    "benchmark/helper.rb",
     "benchmark/bulk.rb",
     "benchmark/bulk_bigdata.rb",
     "benchmark/getset.rb",
@@ -33,7 +33,6 @@ Gem::Specification.new do |s|
     "lib/kyototycoon/serializer/default.rb",
     "lib/kyototycoon/serializer/msgpack.rb",
     "lib/kyototycoon/tsvrpc.rb",
-    "lib/kyototycoon/tsvrpc/nethttp.rb",
     "lib/kyototycoon/tsvrpc/skinny.rb",
     "spec/helper.rb"
   ]

data/lib/kyototycoon.rb

@@ -10,9 +10,10 @@ require "kyototycoon/serializer/default.rb"
 require "kyototycoon/serializer/msgpack.rb"
 require "kyototycoon/tsvrpc.rb"
 require "kyototycoon/tsvrpc/skinny.rb"
-require "kyototycoon/tsvrpc/nethttp.rb"
 
 class KyotoTycoon
+  VERSION = '0.5.0'
+
   attr_accessor :colenc, :connect_timeout, :servers
   attr_reader :serializer, :logger, :db
 
@@ -42,8 +43,7 @@ class KyotoTycoon
     @servers = [[host, port]]
     @serializer = KyotoTycoon::Serializer::Default
     @logger = Logger.new(nil)
-    @agent = :nethttp
-    @colenc = :U
+    @colenc = :B
     @connect_timeout = 0.5
   end
 
@@ -63,10 +63,6 @@ class KyotoTycoon
     @logger = logger
   end
 
-  def agent=(agent)
-    @agent = agent
-  end
-
   def get(key)
     res = request('/rpc/get', {:key => key})
     @serializer.decode(Tsvrpc.parse(res[:body])['value'])
@@ -218,35 +214,39 @@ class KyotoTycoon
       params ||= {}
       params[:DB] = @db
     end
-    if @servers.length > 1
-      @servers.each{|s|
-        host,port = *s
-        if ping(host, port)
-          @servers = [[host, port]]
-          break
-        end
-      }
-    end
-    if @servers.length == 0
-      msg = "alived server not exists"
-      @logger.crit(msg)
-      raise msg
-    end
-    tsvrpc ||= begin
-      host, port = *@servers.first
-      Tsvrpc.new(host, port)
+
+    status,body = client.request(path, params, @colenc)
+    if ![200, 450].include?(status.to_i)
+      raise body
     end
-    res = tsvrpc.request(path, params, @agent, @colenc)
+    res = {:status => status, :body => body}
     @logger.info("#{path}: #{res[:status]} with query parameters #{params.inspect}")
     res
   end
 
+  def client
+    host, port = *choice_server
+    @client ||= begin
+      Tsvrpc::Skinny.new(host, port)
+    end
+  end
+
+  def start
+    client.start
+  end
+
+  def finish
+    client.finish
+  end
+
+  private
+
   def ping(host, port)
     begin
+      rpc = Tsvrpc::Skinny.new(host, port)
       timeout(@connect_timeout){
         @logger.debug("connect check #{host}:#{port}")
-        rpc = Tsvrpc.new(host, port)
-        res = rpc.request('/rpc/echo', {'0' => '0'}, :skinny, :U)
+        res = rpc.request('/rpc/echo', {'0' => '0'}, :U)
         @logger.debug(res)
       }
       true
@@ -254,9 +254,38 @@ class KyotoTycoon
       # Ruby 1.8.7 compatible
       @logger.warn("connect failed at #{host}:#{port}")
       false
+    rescue SystemCallError
+      @logger.warn("connect failed at #{host}:#{port}")
+      false
     rescue => ex
       @logger.warn("connect failed at #{host}:#{port}")
       false
+    ensure
+      rpc.finish
     end
   end
+
+  def choice_server
+    current = @servers.first
+    if @servers.length > 1
+      @servers.each{|s|
+        host,port = *s
+        if ping(host, port)
+          @servers = [[host, port]]
+          break
+        end
+      }
+    end
+    if @servers.length == 0
+      msg = "alived server not exists"
+      @logger.crit(msg)
+      raise msg
+    end
+    result = @servers.first
+    if current != result
+      @client = nil
+    end
+    result
+  end
+
 end

data/lib/kyototycoon/tsvrpc.rb

@@ -2,29 +2,7 @@
 
 
 class KyotoTycoon
-  class Tsvrpc
-    def initialize(host, port)
-      @host = host
-      @port = port
-    end
-
-    def http(agent)
-      case agent
-        when :skinny
-          Skinny.new(@host, @port)
-        else
-          Nethttp.new(@host, @port)
-      end
-    end
-
-    def request(path, params, agent, colenc)
-      status,body = *http(agent).request(path, params, colenc)
-      if ![200, 450].include?(status)
-        raise body
-      end
-      {:status => status, :body => body}
-    end
-
+  module Tsvrpc
     def self.parse(body)
       body.split("\n").inject({}){|r, line|
         k,v = *line.split("\t", 2).map{|v| CGI.unescape(v)}

data/lib/kyototycoon/tsvrpc/skinny.rb

@@ -1,28 +1,29 @@
 # -- coding: utf-8
 
 class KyotoTycoon
-  class Tsvrpc
+  module Tsvrpc
     class Skinny
       def initialize(host, port)
         @host = host
         @port = port
         @tpl = ""
-        @tpl << "POST %s HTTP/1.0\r\n"
+        @tpl << "POST %s HTTP/1.1\r\n"
         @tpl << "Content-Length: %d\r\n"
         @tpl << "Content-Type: text/tab-separated-values; colenc=%s\r\n"
         @tpl << "\r\n%s"
       end
 
       def request(path, params, colenc)
-        sock ||= ::TCPSocket.new(@host, @port)
+        start 
         query = KyotoTycoon::Tsvrpc.build_query(params, colenc)
         request = @tpl % [path, query.bytesize, colenc, query]
-        sock.write(request)
-        status = sock.gets[9, 3]
+        @sock.write(request)
+        first_line = @sock.gets
+        status = first_line[9, 3]
         bodylen = 0
         body = ""
         loop do
-          line = sock.gets
+          line = @sock.gets
           if line['Content-Length']
             bodylen = line.match(/[0-9]+/)[0].to_i
             next
@@ -31,10 +32,17 @@ class KyotoTycoon
             break
           end
         end
-        body = sock.read(bodylen)
-        sock.close
+        body = @sock.read(bodylen)
         [status.to_i, body]
       end
+
+      def start
+        @sock ||= ::TCPSocket.new(@host, @port)
+      end
+
+      def finish
+        @sock.close if @sock
+      end
     end
   end
 end

data/spec/helper.rb

@@ -23,6 +23,9 @@ describe do
   end
 
   before(:each) do
+  end
+
+  after(:each) do
     @kt.clear
   end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 2
-  version: 0.1.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - uu59
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-09 00:00:00 +09:00
+date: 2010-12-22 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,7 +103,7 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
-- benchmark/agent.rb
+- benchmark/helper.rb
 - benchmark/bulk.rb
 - benchmark/bulk_bigdata.rb
 - benchmark/getset.rb
@@ -114,7 +114,6 @@ files:
 - lib/kyototycoon/serializer/default.rb
 - lib/kyototycoon/serializer/msgpack.rb
 - lib/kyototycoon/tsvrpc.rb
-- lib/kyototycoon/tsvrpc/nethttp.rb
 - lib/kyototycoon/tsvrpc/skinny.rb
 - spec/helper.rb
 has_rdoc: true

data/benchmark/agent.rb

@@ -1,27 +0,0 @@
-# -- coding: utf-8
-
-require "rubygems"
-require "benchmark"
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'kyototycoon.rb'
-
-kt = KyotoTycoon.new
-job = lambda {|kt|
-  10000.times{|n|
-    kt.set(n.to_s, n)
-    kt.get(n)
-  }
-  kt.clear
-}
-Benchmark.bm do |x|
-  x.report('skinny') {
-    kt.agent = :skinny
-    kt.serializer=:default
-    job.call(kt)
-  }
-  x.report('nethttp') {
-    kt.agent = :nethttp
-    kt.serializer=:default
-    job.call(kt)
-  }
-end

data/lib/kyototycoon/tsvrpc/nethttp.rb

@@ -1,28 +0,0 @@
-# -- coding: utf-8
-
-require "rubygems"
-
-class KyotoTycoon
-  class Tsvrpc
-    class Nethttp
-      def initialize(host, port)
-        @host = host
-        @port = port
-        @http ||= ::Net::HTTP.new(@host, @port)
-      end
-
-      def request(path, params, colenc)
-        query = KyotoTycoon::Tsvrpc.build_query(params, colenc)
-        req = Net::HTTP::Post.new(path)
-        if query.length > 0
-          req.body = query
-          req['Content-Length'] = query.size
-        end
-        req['Content-Type'] = "text/tab-separated-values; colenc=#{colenc}"
-        req['Connection'] = "close"
-        res = @http.request(req)
-        [res.code.to_i, res.body]
-      end
-    end
-  end
-end