consistent_hashr 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Superfeedr
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,21 @@
+= ConsistentHashr
+
+A small module to do easy consistent hashing.
+
+== Usage
+
+hashr = ConsistentHashr.new()
+
+hashr.add_server("s1", "server1")
+hashr.add_server("s2", "server2")
+hashr.add_server("s3", "server3")
+hashr.add_server("s4", "server4")
+hashr.add_server("s5", "server5")
+
+hashr.get(key) # Should return the same key consistently when new servers are added.
+
+== Implementation
+
+Based on "Mike Perham's":http://www.mikeperham.com/ "code":http://www.mikeperham.com/2009/01/14/consistent-hashing-in-memcache-client/ and tests. I thought this layer didn't belong to any specific client, this is why I extracted it.
+
+Greatly inspired by "Tom White's consistent hashing explaination":http://weblogs.java.net/blog/tomwhite/archive/2007/11/consistent_hash.html.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "consistent_hashr"
+    gem.summary = %Q{A ruby gem to do consistent hashing}
+    gem.description = %Q{A simple gem to perform consistent hashing}
+    gem.email = "julien.genestoux@gmail.com"
+    gem.homepage = "http://github.com/superfeedr/consistent_hashr"
+    gem.authors = ["julien"]
+    gem.add_development_dependency "rspec", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "consistent_hashr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/consistent_hashr.rb

@@ -0,0 +1,47 @@
+require 'zlib'
+
+class ConsistentHashr
+  
+  ##
+  # Creates a new Hasher. Servers should be a hash.
+  def initialize(_servers = {}, _number_of_replicas = 50)
+    @circle = {}
+    @number_of_replicas = _number_of_replicas
+    _servers.each do |name, server|
+      add_server(name, server)
+    end
+  end
+  
+  ##
+  # Computes a key
+  def hash_key(key)
+    Zlib.crc32("#{key}")
+  end
+
+  ##
+  # Adds a server to the circle
+  def add_server(_name, _server)
+    @number_of_replicas.times do |t|
+      @circle[hash_key("#{_name}+#{t}")] = _server
+    end
+  end
+  
+  ##
+  # Returns the server for the provided key
+  def get(key)
+    return nil if @circle.empty?
+    return @circle.first.last if @circle.size == 1
+    
+    hash = hash_key(key)
+    
+    # If the key is there, let's return it.
+    return @circle[hash] if @circle[hash]
+    
+    # If not, we need to find the next closest from it!
+    hash = @circle.keys.select() { |k| k > hash }.sort.first
+    
+    return @circle.first.last if hash.nil?
+    return @circle[hash]
+  end
+  
+end

data/spec/consistent_hashr_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe ConsistentHashr do
+  before(:each) do
+    @servers = {:s1 => "s1", :s2 => "s2", :s3 => "s3", :s4 => "s4", :s5 => "s5", :s6 => "s6"}
+    @hashr = ConsistentHashr.new(@servers)
+  end
+
+  it "should not change more than 75% of keys" do
+    keys = []
+    1000.times do |idx|
+      keys << rand(100000).to_s
+    end
+    before = keys.map() { |k|  @hashr.get(k)}
+    
+    @hashr.add_server(:s7, "s7")
+    
+    after = keys.map() { |k|  @hashr.get(k)}
+    
+    diff = before.zip(after).find_all {|a| a[0] == a[1] }.size
+    diff.should > keys.size*0.7
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "rubygems"
+require File.dirname(__FILE__) + "/../lib/consistent_hashr"
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: consistent_hashr
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- julien
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-10 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A simple gem to perform consistent hashing
+email: julien.genestoux@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/consistent_hashr.rb
+- spec/consistent_hashr_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/superfeedr/consistent_hashr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A ruby gem to do consistent hashing
+test_files: 
+- spec/consistent_hashr_spec.rb
+- spec/spec_helper.rb