memcached 0.18.0 → 0.19.pre

data/lib/memcached.rb

@@ -27,5 +27,6 @@ end
 require 'memcached/integer'
 require 'memcached/exceptions'
 require 'memcached/behaviors'
+require 'memcached/auth'
 require 'memcached/memcached'
 require 'memcached/rails'

data/lib/memcached/auth.rb

@@ -0,0 +1,16 @@
+class Memcached
+  def destroy_credentials
+    if options[:credentials] != nil
+      check_return_code(Lib.memcached_destroy_sasl_auth_data(@struct))
+    end
+  end
+
+  def set_credentials
+    # If credentials aren't provided, try to get them from the environment
+    if options[:credentials] != nil
+      username, password = options[:credentials]
+      check_return_code(Lib.memcached_set_sasl_auth_data(@struct, username, password))
+    end
+  end
+end
+

data/lib/memcached/memcached.rb

@@ -3,7 +3,6 @@
 The Memcached client class.
 =end
 class Memcached
-
   FLAGS = 0x0
 
   DEFAULTS = {
@@ -20,8 +19,9 @@ class Memcached
     :timeout => 0.25,
     :rcv_timeout => nil,
     :poll_timeout => nil,
-    :connect_timeout => 2,
-    :prefix_key => nil,
+    :connect_timeout => 4,
+    :prefix_key => '',
+    :prefix_delimiter => '',
     :hash_with_prefix_key => true,
     :default_ttl => 604800,
     :default_weight => 8,
@@ -30,7 +30,8 @@ class Memcached
     :server_failure_limit => 2,
     :verify_key => true,
     :use_udp => false,
-    :binary_protocol => false
+    :binary_protocol => false,
+    :credentials => nil
   }
 
 #:stopdoc:
@@ -52,7 +53,8 @@ Weights only affect Ketama hashing.  If you use Ketama hashing and don't specify
 
 Valid option parameters are:
 
-<tt>:prefix_key</tt>:: A string to prepend to every key, for namespacing. Max length is 127.
+<tt>:prefix_key</tt>:: A string to prepend to every key, for namespacing. Max length is 127. Defaults to the empty string.
+<tt>:prefix_delimiter</tt>:: A character to postpend to the prefix key. Defaults to the empty string.
 <tt>:hash</tt>:: The name of a hash function to use. Possible values are: <tt>:crc</tt>, <tt>:default</tt>, <tt>:fnv1_32</tt>, <tt>:fnv1_64</tt>, <tt>:fnv1a_32</tt>, <tt>:fnv1a_64</tt>, <tt>:hsieh</tt>, <tt>:md5</tt>, and <tt>:murmur</tt>. <tt>:fnv1_32</tt> is fast and well known, and is the default. Use <tt>:md5</tt> for compatibility with other ketama clients.
 <tt>:distribution</tt>:: Either <tt>:modula</tt>, <tt>:consistent_ketama</tt>, <tt>:consistent_wheel</tt>, or <tt>:ketama</tt>. Defaults to <tt>:ketama</tt>.
 <tt>:server_failure_limit</tt>:: How many consecutive failures to allow before marking a host as dead. Has no effect unless <tt>:retry_timeout</tt> is also set.
@@ -78,15 +80,28 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
 
 =end
 
-  def initialize(servers = "localhost:11211", opts = {})
-    @struct = Lib::MemcachedSt.new
-    Lib.memcached_create(@struct)
+  def initialize(servers = nil, opts = {})
+    @struct = Lib.memcached_create(nil)
 
     # Merge option defaults and discard meaningless keys
     @options = DEFAULTS.merge(opts)
     @options.delete_if { |k,v| not DEFAULTS.keys.include? k }
     @default_ttl = options[:default_ttl]
 
+    if servers == nil
+      if ENV.key?("MEMCACHE_SERVERS")
+        servers = ENV["MEMCACHE_SERVERS"].split(",").map do | s | s.strip end
+      else
+        servers = "127.0.0.1:11211"
+      end
+    end
+
+    if options[:credentials] == nil && ENV.key?("MEMCACHE_USERNAME") && ENV.key?("MEMCACHE_PASSWORD")
+      options[:credentials] = [ENV["MEMCACHE_USERNAME"], ENV["MEMCACHE_PASSWORD"]]
+    end
+
+    options[:binary_protocol] = true if options[:credentials] != nil
+
     # Force :buffer_requests to use :no_block
     # XXX Deleting the :no_block key should also work, but libmemcached doesn't seem to set it
     # consistently
@@ -95,9 +110,6 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
     # Disallow weights without ketama
     options.delete(:ketama_weighted) if options[:distribution] != :consistent_ketama
 
-    # Legacy accessor
-    options[:prefix_key] = options.delete(:namespace) if options[:namespace]
-
     # Disallow :sort_hosts with consistent hashing
     if options[:sort_hosts] and options[:distribution] == :consistent
       raise ArgumentError, ":sort_hosts defeats :consistent hashing"
@@ -107,9 +119,12 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
     options[:rcv_timeout] ||= options[:timeout] || 0
     options[:poll_timeout] ||= options[:timeout] || 0
 
-    # Set the behaviors on the struct
+    # Set the prefix key. Support the legacy name.
+    set_prefix_key(options.delete(:prefix_key) || options.delete(:namespace))
+
+    # Set the behaviors and credentials on the struct
     set_behaviors
-    set_callbacks
+    set_credentials
 
     # Freeze the hash
     options.freeze
@@ -120,9 +135,9 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
     # Not found exceptions
     unless options[:show_backtraces]
       @not_found = NotFound.new
-      @not_found.no_backtrace = true      
+      @not_found.no_backtrace = true
       @not_stored = NotStored.new
-      @not_stored.no_backtrace = true      
+      @not_stored.no_backtrace = true
     end
   end
 
@@ -131,21 +146,23 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
   def set_servers(servers)
     Array(servers).each_with_index do |server, index|
       # Socket
-      if server.is_a?(String) and File.socket?(server)
-        args = [@struct, server, options[:default_weight].to_i]
-        check_return_code(Lib.memcached_server_add_unix_socket_with_weight(*args))
-      # Network
-      elsif server.is_a?(String) and server =~ /^[\w\d\.-]+(:\d{1,5}){0,2}$/
-        host, port, weight = server.split(":")
-        args = [@struct, host, port.to_i, (weight || options[:default_weight]).to_i]                
-        if options[:use_udp] #
-          check_return_code(Lib.memcached_server_add_udp_with_weight(*args))
+      check_return_code(
+        if server.is_a?(String) and File.socket?(server)
+          args = [@struct, server, options[:default_weight].to_i]
+          Lib.memcached_server_add_unix_socket_with_weight(*args)
+        # Network
+        elsif server.is_a?(String) and server =~ /^[\w\d\.-]+(:\d{1,5}){0,2}$/
+          host, port, weight = server.split(":")
+          args = [@struct, host, port.to_i, (weight || options[:default_weight]).to_i]
+          if options[:use_udp]
+            Lib.memcached_server_add_udp_with_weight(*args)
+          else
+            Lib.memcached_server_add_with_weight(*args)
+          end
         else
-          check_return_code(Lib.memcached_server_add_with_weight(*args))
+          raise ArgumentError, "Servers must be either in the format 'host:port[:weight]' (e.g., 'localhost:11211' or  'localhost:11211:10') for a network server, or a valid path to a Unix domain socket (e.g., /var/run/memcached)."
         end
-      else
-        raise ArgumentError, "Servers must be either in the format 'host:port[:weight]' (e.g., 'localhost:11211' or  'localhost:11211:10') for a network server, or a valid path to a Unix domain socket (e.g., /var/run/memcached)."
-      end
+      )
     end
     # For inspect
     @servers = send(:servers)
@@ -158,6 +175,27 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
     end
   end
 
+  # Set the prefix key.
+  def set_prefix_key(key)
+    check_return_code(
+      if key
+        key += options[:prefix_delimiter]
+        raise ArgumentError, "Max prefix key + prefix delimiter size is #{Lib::MEMCACHED_PREFIX_KEY_MAX_SIZE - 1}" unless
+          key.size < Lib::MEMCACHED_PREFIX_KEY_MAX_SIZE
+        Lib.memcached_callback_set(@struct, Lib::MEMCACHED_CALLBACK_PREFIX_KEY, key)
+      else
+        Lib.memcached_callback_set(@struct, Lib::MEMCACHED_CALLBACK_PREFIX_KEY, "")
+      end
+    )
+  end
+  alias :set_namespace :set_prefix_key
+
+  # Return the current prefix key.
+  def prefix_key
+    @struct.prefix_key[0..-1 - options[:prefix_delimiter].size] if @struct.prefix_key.size > 0
+  end
+  alias :namespace :prefix_key
+
   # Safely copy this instance. Returns a Memcached instance.
   #
   # <tt>clone</tt> is useful for threading, since each thread must have its own unshared Memcached
@@ -169,16 +207,21 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
     # struct = Lib.memcached_clone(nil, @struct)
     # memcached.instance_variable_set('@struct', struct)
     # memcached
-    self.class.new(servers, options)
+    self.class.new(servers, options.merge(:prefix_key => prefix_key))
   end
 
   # Reset the state of the libmemcached struct. This is useful for changing the server list at runtime.
-  def reset(current_servers = nil)
+  def reset(current_servers = nil, with_prefix_key = true)
+    # Store state and teardown
     current_servers ||= servers
-    @struct = Lib::MemcachedSt.new
-    Lib.memcached_create(@struct)
+    prev_prefix_key = prefix_key
+
+    # Create
+    # FIXME Duplicates logic with initialize()
+    @struct = Lib.memcached_create(nil)
+    set_prefix_key(prev_prefix_key) if with_prefix_key
     set_behaviors
-    set_callbacks
+    set_credentials
     set_servers(current_servers)
   end
 
@@ -192,6 +235,24 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
   alias :dup :clone #:nodoc:
   #:startdoc:
 
+  # change the prefix_key after we're in motion
+  def prefix_key=(key)
+    unless key.size < Lib::MEMCACHED_PREFIX_KEY_MAX_SIZE
+      raise ArgumentError, "Max prefix_key size is #{Lib::MEMCACHED_PREFIX_KEY_MAX_SIZE - 1}"
+    end
+    check_return_code(
+      Lib.memcached_callback_set(@struct, Lib::MEMCACHED_CALLBACK_PREFIX_KEY, "#{key}#{options[:prefix_delimiter]}")
+    )
+  end
+  alias namespace= prefix_key=
+
+  # report the prefix_key
+  def prefix_key
+    @struct.prefix_key[0..-1 - options[:prefix_delimiter].size]
+  end
+  alias namespace prefix_key
+
+
 ### Configuration helpers
 
   private
@@ -226,7 +287,7 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
       key
     )
   rescue ClientError
-    # FIXME Memcached 1.2.8 occasionally rejects valid sets 
+    # FIXME Memcached 1.2.8 occasionally rejects valid sets
     tried = 1 and retry unless defined?(tried)
     raise
   end
@@ -309,7 +370,10 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
     value = yield value
     value = Marshal.dump(value) if marshal
 
-    check_return_code(Lib.memcached_cas(@struct, key, value, ttl, flags, cas), key)
+    check_return_code(
+      Lib.memcached_cas(@struct, key, value, ttl, flags, cas),
+      key
+    )
   end
 
   alias :compare_and_swap :cas
@@ -372,17 +436,18 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
   def server_by_key(key)
     ret = Lib.memcached_server_by_key(@struct, key)
     if ret.is_a?(Array)
-      string = inspect_server(ret.first) 
-      Rlibmemcached.memcached_server_free(ret.first)
-      string
+      check_return_code(ret.last)
+      inspect_server(ret.first)
+    else
+      check_return_code(ret)
     end
   end
 
   # Return a Hash of statistics responses from the set of servers. Each value is an array with one entry for each server, in the same order the servers were defined.
-  def stats
+  def stats(subcommand = nil)
     stats = Hash.new([])
 
-    stat_struct, ret = Lib.memcached_stat(@struct, "")
+    stat_struct, ret = Lib.memcached_stat(@struct, subcommand)
     check_return_code(ret)
 
     keys, ret = Lib.memcached_stat_get_keys(@struct, stat_struct)
@@ -469,14 +534,12 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
     set_behavior(:hash, options[:hash])
   end
 
-  # Set the callbacks on the struct from the current options.
-  def set_callbacks
-    # Only support prefix_key for now
-    if options[:prefix_key]
-      unless options[:prefix_key].size < Lib::MEMCACHED_PREFIX_KEY_MAX_SIZE
-        raise ArgumentError, "Max prefix_key size is #{Lib::MEMCACHED_PREFIX_KEY_MAX_SIZE - 1}"
-      end
-      Lib.memcached_callback_set(@struct, Lib::MEMCACHED_CALLBACK_PREFIX_KEY, options[:prefix_key])
+  # Set the SASL credentials from the current options. If credentials aren't provided, try to get them from the environment.
+  def set_credentials
+    if options[:credentials]
+      check_return_code(
+        Lib.memcached_set_sasl_auth_data(@struct, *options[:credentials])
+      )
     end
   end
 
@@ -488,7 +551,7 @@ Please note that when pipelining is enabled, setter and deleter methods do not r
   def inspect_server(server)
     strings = [server.hostname]
     if !is_unix_socket?(server)
-      strings << ":#{server.port}"      
+      strings << ":#{server.port}"
       strings << ":#{server.weight}" if options[:ketama_weighted]
     end
     strings.join

data/lib/memcached/rails.rb

@@ -76,8 +76,8 @@ class Memcached
     end
 
     # Wraps Memcached#delete so that it doesn't raise.
-    def delete(key)
-      super
+    def delete(key, expiry=0)
+      super(key)
     rescue NotFound
     end
 
@@ -105,11 +105,6 @@ class Memcached
     rescue NotStored
     end
 
-    # Namespace accessor.
-    def namespace
-      options[:prefix_key]
-    end
-
     alias :flush_all :flush
 
     alias :"[]" :get

data/memcached.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{memcached}
-  s.version = "0.18.0"
+  s.version = "0.19.pre"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver"]
   s.cert_chain = ["/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-public_cert.pem"]
-  s.date = %q{2010-02-04}
+  s.date = %q{2010-03-07}
   s.description = %q{An interface to the libmemcached C client.}
   s.email = %q{}
   s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = ["BENCHMARKS", "CHANGELOG", "LICENSE", "README", "TODO", "lib/memcached.rb", "lib/memcached/behaviors.rb", "lib/memcached/exceptions.rb", "lib/memcached/memcached.rb", "lib/memcached/rails.rb"]
-  s.files = ["BENCHMARKS", "CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "TODO", "ext/extconf.rb", "ext/libmemcached-0.32.tar.gz", "ext/libmemcached.patch", "ext/rlibmemcached.i", "ext/rlibmemcached_wrap.c", "lib/memcached.rb", "lib/memcached/behaviors.rb", "lib/memcached/exceptions.rb", "lib/memcached/integer.rb", "lib/memcached/memcached.rb", "lib/memcached/rails.rb", "test/profile/benchmark.rb", "test/profile/profile.rb", "test/profile/valgrind.rb", "test/setup.rb", "test/teardown.rb", "test/test_helper.rb", "test/unit/binding_test.rb", "test/unit/memcached_test.rb", "test/unit/rails_test.rb", "memcached.gemspec"]
+  s.files = ["BENCHMARKS", "CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "TODO", "ext/extconf.rb", "ext/libmemcached-0.32.tar.gz", "ext/libmemcached.patch", "ext/rlibmemcached.i", "ext/rlibmemcached_wrap.c", "ext/sasl.patch", "lib/memcached.rb", "lib/memcached/auth.rb", "lib/memcached/behaviors.rb", "lib/memcached/exceptions.rb", "lib/memcached/integer.rb", "lib/memcached/memcached.rb", "lib/memcached/rails.rb", "test/profile/benchmark.rb", "test/profile/profile.rb", "test/profile/valgrind.rb", "test/setup.rb", "test/teardown.rb", "test/test_helper.rb", "test/unit/binding_test.rb", "test/unit/memcached_test.rb", "test/unit/rails_test.rb", "memcached.gemspec"]
   s.homepage = %q{http://blog.evanweaver.com/files/doc/fauna/memcached/}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Memcached", "--main", "README"]
   s.require_paths = ["lib", "ext"]
   s.rubyforge_project = %q{fauna}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.signing_key = %q{/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-private_key.pem}
   s.summary = %q{An interface to the libmemcached C client.}
   s.test_files = ["test/test_helper.rb", "test/unit/binding_test.rb", "test/unit/memcached_test.rb", "test/unit/rails_test.rb"]

data/test/unit/binding_test.rb

@@ -1,5 +1,5 @@
 
-require "#{File.dirname(__FILE__)}/../test_helper"
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
 
 class BindingTest < Test::Unit::TestCase
   def test_libmemcached_loaded

data/test/unit/memcached_test.rb

@@ -1,5 +1,5 @@
 
-require "#{File.dirname(__FILE__)}/../test_helper"
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
 require 'socket'
 require 'mocha'
 require 'benchmark'
@@ -48,7 +48,7 @@ class MemcachedTest < Test::Unit::TestCase
 
   def test_initialize
     cache = Memcached.new @servers, :prefix_key => 'test'
-    assert_equal 'test', cache.options[:prefix_key]
+    assert_equal 'test', cache.prefix_key
     assert_equal 3, cache.send(:server_structs).size
     assert_equal 'localhost', cache.send(:server_structs).first.hostname
     assert_equal 43042, cache.send(:server_structs).first.port
@@ -91,7 +91,7 @@ class MemcachedTest < Test::Unit::TestCase
   def test_options_are_set
     Memcached::DEFAULTS.merge(@noblock_options).each do |key, expected|
       value = @noblock_cache.options[key]
-      unless key == :rcv_timeout or key == :poll_timeout
+      unless key == :rcv_timeout or key == :poll_timeout or key == :prefix_key
         assert(expected == value, "#{key} should be #{expected} but was #{value}")
       end
     end
@@ -133,6 +133,25 @@ class MemcachedTest < Test::Unit::TestCase
     assert_equal 3, cache.send(:server_structs).size
   end
 
+  def test_set_prefix_key
+    cache = Memcached.new @servers, :prefix_key => "foo"
+    cache.prefix_key = "bar"
+    assert_equal "bar", cache.prefix_key
+  end
+
+  def test_set_prefix_key_to_empty_string
+    cache = Memcached.new @servers, :prefix_key => "foo"
+    cache.prefix_key = "" 
+    assert_equal "", cache.prefix_key
+  end
+
+  def test_memcached_callback_set_with_empty_string_should_not_raise_exception
+    cache = Memcached.new @servers, :prefix_key => "foo"
+    assert_nothing_raised do
+      cache.prefix_key = ""
+    end
+  end
+
   def test_initialize_negative_behavior
     cache = Memcached.new @servers,
       :buffer_requests => false

data/test/unit/rails_test.rb

@@ -1,5 +1,5 @@
 
-require "#{File.dirname(__FILE__)}/../test_helper"
+require File.expand_path("#{File.dirname(__FILE__)}/../test_helper")
 
 class RailsTest < Test::Unit::TestCase
 
@@ -41,6 +41,13 @@ class RailsTest < Test::Unit::TestCase
     end
   end
 
+  def test_delete_with_two_arguments
+    assert_nothing_raised do
+      @cache.delete(key, 5)
+      assert_nil(@cache.get(key))
+    end
+  end
+
   def test_bracket_accessors
     @cache[key] = @value
     result = @cache[key]

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: memcached
 version: !ruby/object:Gem::Version 
-  version: 0.18.0
+  prerelease: true
+  segments: 
+  - 0
+  - 19
+  - pre
+  version: 0.19.pre
 platform: ruby
 authors: 
 - Evan Weaver
@@ -30,7 +35,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2010-02-04 00:00:00 -08:00
+date: 2010-03-07 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -64,7 +69,9 @@ files:
 - ext/libmemcached.patch
 - ext/rlibmemcached.i
 - ext/rlibmemcached_wrap.c
+- ext/sasl.patch
 - lib/memcached.rb
+- lib/memcached/auth.rb
 - lib/memcached/behaviors.rb
 - lib/memcached/exceptions.rb
 - lib/memcached/integer.rb
@@ -99,18 +106,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: fauna
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: An interface to the libmemcached C client.