memcache-client 1.3.0 → 1.4.0

data/History.txt

@@ -1,3 +1,13 @@
+= 1.4.0
+
+* Fix bug #10371, #set does not check response for server errors.
+  Submitted by Ben VandenBos.
+* Fix bug #12450, set TCP_NODELAY socket option.  Patch by Chris
+  McGrath.
+* Fix bug #10704, missing #add method.  Patch by Jamie Macey.
+* Fix bug #10371, handle socket EOF in cache_get.  Submitted by Ben
+  VandenBos.
+
 = 1.3.0
 
 * Apply patch #6507, add stats command.  Submitted by Tyler Kovacs.

data/README.txt

@@ -2,12 +2,16 @@
 
 Rubyforge Project:
 
-http://rubyforge.org/projects/rctools/
+http://rubyforge.org/projects/seattlerb
 
 File bugs:
 
 http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
 
+Documentation:
+
+http://seattlerb.org/memcache-client
+
 == About
 
 memcache-client is a client for Danga Interactive's memcached.

data/Rakefile

@@ -2,26 +2,18 @@
 
 require 'hoe'
 
-require './lib/memcache'
-
-DEV_DOC_PATH = "Libraries/memcache-client"
+$:.unshift 'lib'
+require 'memcache'
 
 hoe = Hoe.new 'memcache-client', MemCache::VERSION do |p|
   p.summary = 'A Ruby memcached client'
-  p.description = 'memcache-client is a pure-ruby client to Danga\'s memcached.'
+  p.description = p.paragraphs_of('README.txt', 8).first
   p.author = ['Eric Hodel', 'Robert Cottrell']
-  p.email = 'eric@robotcoop.com'
-  p.url = "http://dev.robotcoop.com/#{DEV_DOC_PATH}"
+  p.email = 'drbrain@segment7.net'
+  p.url = p.paragraphs_of('README.txt', 6).first
   p.changes = File.read('History.txt').scan(/\A(=.*?)^=/m).first.first
 
   p.rubyforge_name = 'seattlerb'
   p.extra_deps << ['ZenTest', '>= 3.4.2']
 end
 
-SPEC = hoe.spec
-
-begin
-  require '../tasks'
-rescue LoadError
-end
-

data/lib/memcache.rb

@@ -1,4 +1,4 @@
-$TESTING = defined? $TESTING && $TESTING
+$TESTING = defined?($TESTING) && $TESTING
 
 require 'socket'
 require 'thread'
@@ -42,7 +42,7 @@ class MemCache
   ##
   # The version of MemCache you are using.
 
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 
   ##
   # Default options for the cache object.
@@ -80,6 +80,11 @@ class MemCache
 
   attr_reader :multithread
 
+  ##
+  # The servers this client talks to.  Play at your own peril.
+
+  attr_reader :servers
+
   ##
   # Accepts a list of +servers+ and a list of +opts+.  +servers+ may be
   # omitted.  See +servers=+ for acceptable server list arguments.
@@ -283,6 +288,9 @@ class MemCache
   ##
   # Add +key+ to the cache with value +value+ that expires in +expiry+
   # seconds.  If +raw+ is true, +value+ will not be Marshalled.
+  #
+  # Warning: Readers should not call this method in the event of a cache miss;
+  # see MemCache#add.
 
   def set(key, value, expiry = 0, raw = false)
     raise MemCacheError, "Update of readonly cache" if @readonly
@@ -292,6 +300,35 @@ class MemCache
     value = Marshal.dump value unless raw
     command = "set #{cache_key} 0 #{expiry} #{value.size}\r\n#{value}\r\n"
 
+    begin
+      @mutex.lock if @multithread
+      socket.write command
+      result = socket.gets
+      raise MemCacheError, $1.strip if result =~ /^SERVER_ERROR (.*)/
+    rescue SocketError, SystemCallError, IOError => err
+      server.close
+      raise MemCacheError, err.message
+    ensure
+      @mutex.unlock if @multithread
+    end
+  end
+
+  ##
+  # Add +key+ to the cache with value +value+ that expires in +expiry+
+  # seconds, but only if +key+ does not already exist in the cache.
+  # If +raw+ is true, +value+ will not be Marshalled.
+  #
+  # Readers should call this method in the event of a cache miss, not
+  # MemCache#set or MemCache#[]=.
+
+  def add(key, value, expiry = 0, raw = false)
+    raise MemCacheError, "Update of readonly cache" if @readonly
+    server, cache_key = request_setup key
+    socket = server.socket
+
+    value = Marshal.dump value unless raw
+    command = "add #{cache_key} 0 #{expiry} #{value.size}\r\n#{value}\r\n"
+
     begin
       @mutex.lock if @multithread
       socket.write command
@@ -472,6 +509,12 @@ class MemCache
     socket = server.socket
     socket.write "get #{cache_key}\r\n"
     keyline = socket.gets # "VALUE <key> <flags> <bytes>\r\n"
+
+    if keyline.nil? then
+      server.close
+      raise MemCacheError, "lost connection to #{server.host}:#{server.port}"
+    end
+
     return nil if keyline == "END\r\n"
 
     unless keyline =~ /(\d+)\r/ then
@@ -492,18 +535,21 @@ class MemCache
     socket = server.socket
     socket.write "get #{cache_keys}\r\n"
 
-    while keyline = socket.gets
-      break if keyline == "END\r\n"
+    while keyline = socket.gets do
+      return values if keyline == "END\r\n"
+
       unless keyline =~ /^VALUE (.+) (.+) (.+)/ then
         server.close
         raise MemCacheError, "unexpected response #{keyline.inspect}"
       end
+
       key, data_length = $1, $3
       values[$1] = socket.read data_length.to_i
       socket.read(2) # "\r\n"
     end
 
-    return values
+    server.close
+    raise MemCacheError, "lost connection to #{server.host}:#{server.port}"
   end
 
   ##
@@ -554,9 +600,9 @@ class MemCache
     @mutex.unlock
   end
 
-  def threadsafe_cache_get_multi(socket, cache_key) # :nodoc:
+  def threadsafe_cache_get_multi(socket, cache_keys) # :nodoc:
     @mutex.lock
-    cache_get_multi socket, cache_key
+    cache_get_multi socket, cache_keys
   ensure
     @mutex.unlock
   end
@@ -667,6 +713,9 @@ class MemCache
         @sock = timeout CONNECT_TIMEOUT do
           TCPSocket.new @host, @port
         end
+        if Socket.constants.include? 'TCP_NODELAY' then
+          @sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
+        end
         @retry  = nil
         @status = 'CONNECTED'
       rescue SocketError, SystemCallError, IOError, Timeout::Error => err

data/lib/memcache_util.rb

@@ -10,7 +10,8 @@ module Cache
   # access the cache.
   #
   # If there is a cache miss and a block is given the result of the block will
-  # be stored in the cache with optional +expiry+.
+  # be stored in the cache with optional +expiry+, using the +add+ method rather
+  # than +set+.
 
   def self.get(key, expiry = 0)
     start_time = Time.now
@@ -19,7 +20,7 @@ module Cache
     ActiveRecord::Base.logger.debug('MemCache Get (%0.6f)  %s' % [elapsed, key])
     if value.nil? and block_given? then
       value = yield
-      put key, value, expiry
+      add key, value, expiry
     end
     value
   rescue MemCache::MemCacheError => err
@@ -46,6 +47,21 @@ module Cache
     nil
   end
 
+  ##
+  # Sets +value+ in the cache at +key+, with an optional +expiry+ time in
+  # seconds.  If +key+ already exists in cache, returns nil.
+
+  def self.add(key, value, expiry = 0)
+    start_time = Time.now
+    response = CACHE.add key, value, expiry
+    elapsed = Time.now - start_time
+    ActiveRecord::Base.logger.debug('MemCache Add (%0.6f)  %s' % [elapsed, key])
+    (response == "STORED\r\n") ? value : nil
+  rescue MemCache::MemCacheError => err
+    ActiveRecord::Base.logger.debug "MemCache Error: #{err.message}"
+    nil
+  end
+
   ##
   # Deletes +key+ from the cache in +delay+ seconds.
 

data/test/test_mem_cache.rb

@@ -9,7 +9,6 @@ require 'memcache'
 
 class MemCache
 
-  attr_reader :servers
   attr_writer :namespace
 
 end
@@ -39,11 +38,13 @@ end
 
 class FakeServer
 
-  attr_reader :socket
+  attr_reader :host, :port, :socket
 
   def initialize(socket = nil)
-    @socket = socket || FakeSocket.new
     @closed = false
+    @host = 'example.com'
+    @port = 11211
+    @socket = socket || FakeSocket.new
   end
 
   def close
@@ -72,6 +73,17 @@ class TestMemCache < Test::Unit::TestCase
                  server.socket.written.string
   end
 
+  def test_cache_get_EOF
+    server = util_setup_fake_server
+    server.socket.data.string = ''
+
+    e = assert_raise MemCache::MemCacheError do
+      @cache.cache_get server, 'my_namespace:key'
+    end
+
+    assert_equal "lost connection to example.com:11211", e.message
+  end
+
   def test_cache_get_bad_state
     server = FakeServer.new
     server.socket.data.write "bogus response\r\n"
@@ -104,6 +116,33 @@ class TestMemCache < Test::Unit::TestCase
                  socket.written.string
   end
 
+  def test_cache_get_multi
+    server = util_setup_fake_server
+    server.socket.data.write "VALUE foo 0 7\r\n"
+    server.socket.data.write "\004\b\"\bfoo\r\n"
+    server.socket.data.write "VALUE bar 0 7\r\n"
+    server.socket.data.write "\004\b\"\bbar\r\n"
+    server.socket.data.write "END\r\n"
+    server.socket.data.rewind
+
+    result = @cache.cache_get_multi server, 'foo bar baz'
+
+    assert_equal 2, result.length
+    assert_equal "\004\b\"\bfoo", result['foo']
+    assert_equal "\004\b\"\bbar", result['bar']
+  end
+
+  def test_cache_get_multi_EOF
+    server = util_setup_fake_server
+    server.socket.data.string = ''
+
+    e = assert_raise MemCache::MemCacheError do
+      @cache.cache_get_multi server, 'my_namespace:key'
+    end
+
+    assert_equal "lost connection to example.com:11211", e.message
+  end
+
   def test_cache_get_multi_bad_state
     server = FakeServer.new
     server.socket.data.write "bogus response\r\n"
@@ -113,7 +152,7 @@ class TestMemCache < Test::Unit::TestCase
     @cache.servers << server
 
     e = assert_raise MemCache::MemCacheError do
-      @cache.cache_get_multi(server, ['my_namespace:key'])
+      @cache.cache_get_multi server, 'my_namespace:key'
     end
 
     assert_equal "unexpected response \"bogus response\\r\\n\"", e.message
@@ -440,6 +479,13 @@ class TestMemCache < Test::Unit::TestCase
     assert_equal 'key', @cache.make_cache_key('key')
   end
 
+  def test_servers
+    server = FakeServer.new
+    @cache.servers = []
+    @cache.servers << server
+    assert_equal [server], @cache.servers
+  end
+
   def test_servers_equals_type_error
     e = assert_raise TypeError do
       @cache.servers = [Object.new]
@@ -461,6 +507,19 @@ class TestMemCache < Test::Unit::TestCase
     assert_equal expected, server.socket.written.string
   end
 
+  def test_set
+    server = FakeServer.new
+    server.socket.data.write "STORED\r\n"
+    server.socket.data.rewind
+    @cache.servers = []
+    @cache.servers << server
+
+    @cache.set 'key', 'value'
+
+    expected = "set my_namespace:key 0 0 9\r\n\004\b\"\nvalue\r\n"
+    assert_equal expected, server.socket.written.string
+  end
+
   def test_set_expiry
     server = FakeServer.new
     server.socket.data.write "STORED\r\n"
@@ -497,6 +556,82 @@ class TestMemCache < Test::Unit::TestCase
     assert_equal 'Update of readonly cache', e.message
   end
 
+  def test_set_too_big
+    server = FakeServer.new
+    server.socket.data.write "SERVER_ERROR object too large for cache\r\n"
+    server.socket.data.rewind
+    @cache.servers = []
+    @cache.servers << server
+
+    e = assert_raise MemCache::MemCacheError do
+      @cache.set 'key', 'v'
+    end
+
+    assert_equal 'object too large for cache', e.message
+  end
+
+  def test_add
+    server = FakeServer.new
+    server.socket.data.write "STORED\r\n"
+    server.socket.data.rewind
+    @cache.servers = []
+    @cache.servers << server
+
+    @cache.add 'key', 'value'
+
+    expected = "add my_namespace:key 0 0 9\r\n\004\b\"\nvalue\r\n"
+    assert_equal expected, server.socket.written.string
+  end
+
+  def test_add_exists
+    server = FakeServer.new
+    server.socket.data.write "NOT_STORED\r\n"
+    server.socket.data.rewind
+    @cache.servers = []
+    @cache.servers << server
+
+    @cache.add 'key', 'value'
+
+    expected = "add my_namespace:key 0 0 9\r\n\004\b\"\nvalue\r\n"
+    assert_equal expected, server.socket.written.string
+  end
+
+  def test_add_expiry
+    server = FakeServer.new
+    server.socket.data.write "STORED\r\n"
+    server.socket.data.rewind
+    @cache.servers = []
+    @cache.servers << server
+
+    @cache.add 'key', 'value', 5
+
+    expected = "add my_namespace:key 0 5 9\r\n\004\b\"\nvalue\r\n"
+    assert_equal expected, server.socket.written.string
+  end
+
+  def test_add_raw
+    server = FakeServer.new
+    server.socket.data.write "STORED\r\n"
+    server.socket.data.rewind
+    @cache.servers = []
+    @cache.servers << server
+
+    @cache.add 'key', 'value', 0, true
+
+    expected = "add my_namespace:key 0 0 5\r\nvalue\r\n"
+    assert_equal expected, server.socket.written.string
+  end
+
+  def test_add_readonly
+    cache = MemCache.new :readonly => true
+
+    e = assert_raise MemCache::MemCacheError do
+      cache.add 'key', 'value'
+    end
+
+    assert_equal 'Update of readonly cache', e.message
+  end
+
   def test_stats
     socket = FakeSocket.new
     socket.data.write "STAT pid 20188\r\nSTAT total_items 32\r\rEND\r\n"

metadata

@@ -1,22 +1,28 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4.3
 specification_version: 1
 name: memcache-client
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
-date: 2007-03-06 00:00:00 -08:00
+  version: 1.4.0
+date: 2007-07-30 00:00:00 -07:00
 summary: A Ruby memcached client
 require_paths: 
 - lib
-email: eric@robotcoop.com
-homepage: http://dev.robotcoop.com/Libraries/memcache-client
+email: drbrain@segment7.net
+homepage: http://seattlerb.org/memcache-client
 rubyforge_project: seattlerb
-description: memcache-client is a pure-ruby client to Danga's memcached.
+description: memcache-client is a client for Danga Interactive's memcached.
 autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">"
     - !ruby/object:Gem::Version 
@@ -40,10 +46,14 @@ files:
 - test/test_mem_cache.rb
 test_files: 
 - test/test_mem_cache.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
 executables: []
 
 extensions: []
@@ -54,7 +64,7 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   name: ZenTest
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -63,9 +73,9 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   name: hoe
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.0
+        version: 1.2.2
     version: