gelatin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dcd7c5c1f3a4c208becadf439bfa5dd40e590ce
+  data.tar.gz: d3101d363020db7e05d35c4c3427851cc22e9eef
+SHA512:
+  metadata.gz: 69a8096919e9035cd8133ecc60a15c8f777b0bf16342a1017bcd99e755826e05baa99d99d6a8a421b639b84e70c185e93edf339def7f93c312f2374eb54a5408
+  data.tar.gz: 521b8c6645b5b78bdc581cd11b0e1948f4d9e6cc08e566975cfff998411da24d937df6e12acec3067d0c75b0d7ba598966ee76fcda70e6ee73818d6f66fd5ee6

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{sh,markdown}]
+indent_size = 4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gelatin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eduardo Mourão
+
+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.md

@@ -0,0 +1,80 @@
+# Gelatin: A Jump Consistent Hash Ruby Gem
+
+[![Build Status](https://travis-ci.org/eduardordm/gelatin.svg?branch=master)](https://travis-ci.org/eduardordm/gelatin)
+
+This gem exposes the Google's consistent hash algorithm to ruby. It uses the
+original, mostly unmodified, implementation as described by
+["A Fast, Minimal Memory, Consistent Hash Algorithm"](http://arxiv.org/abs/1406.2294).
+
+You can use this gem as a consistent hasher or to create a ring of servers like the ones used in
+Amazon DynamoDB, Cassandra, etc. You could use it as some sort of novel cluster implementation also.
+It will evenly distribute your clients among the servers and remap them when the number of nodes changes.
+
+It containst no collision detection if you plan to use this as the main hasher for object storage, you might
+need add aditional steps in your underlying storage implementation.
+
+The performance is good: In a ring of 1.8mi servers and 2mi clients it returned the desired server within < 0.01 ms
+on my 4 year old laptop. As long as Array#[] stays O(1) you should be fine.
+
+"Google has not applied for patent protection for this algorithm, and, as of this writing, has no
+plans to. Rather, it wishes to contribute this algorithm to the community."
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gelatin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gelatin
+
+## Usage
+
+If you need just a simple hasher:
+
+```ruby
+require 'jch'
+
+key = rand(2**32..2**64-1)
+
+# The hash method takes two BIGNUMs.
+# the first is the key to which you are trying to find a node to.
+# The second is the quantity of available nodes.
+my_node = hash(key, 1000000)
+```
+
+If you are using this as a Server Ring (main purpose of this gem):
+
+```ruby
+sh = Gelatin::Ring.new
+(1...254).each do |i|
+  sh.add Gelatin::Node.new("192.168.0.#{i}")
+end
+puts sh.get("localhost".unpack('q*').first) # returns the server for this key
+```
+
+You might use the same hasher to hash long strings like file paths, but you need to split the string into 64bit chunks.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gelatin.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new("jch") do |ext|
+  ext.ext_dir = "ext/jch"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb', 'test/**/*_bench.rb']
+end
+
+task default: %w(compile test)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gelatin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/jch/extconf.rb

@@ -0,0 +1,7 @@
+require "mkmf"
+
+have_library('stdc++');
+
+$CFLAGS << " -Wall"
+
+create_makefile "jch/jch"

data/ext/jch/jch.c

@@ -0,0 +1,30 @@
+#include <ruby.h>
+
+const double JUMP = (double)(1LL << 31);
+
+int32_t
+JumpConsistentHashImpl(uint64_t key, int32_t num_buckets)
+{
+  int64_t b = -1, j = 0;
+  while (j < num_buckets) {
+    b = j;
+    key = key * 2862933555777941757ULL + 1;
+    j = (b + 1) * (JUMP / (double)((key >> 33) + 1));
+  }
+  return b;
+}
+
+static
+VALUE
+JumpConsistentHash(VALUE t, VALUE v_key, VALUE v_num_buckets)
+{
+  return INT2NUM(JumpConsistentHashImpl(NUM2ULL(v_key),
+                  NUM2UINT(v_num_buckets)));
+}
+
+void
+Init_jch(void)
+{
+  VALUE m_jch = rb_define_module("Jch");
+  rb_define_method(m_jch, "hash", JumpConsistentHash, 2);
+}

data/gelatin.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gelatin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gelatin"
+  spec.version       = Gelatin::VERSION
+  spec.authors       = ["Eduardo Mourão"]
+  spec.email         = ["eduardo.a20@gmail.com"]
+
+  spec.summary       = %q{Gelatin: A Jump Consistent Hash Ruby Gem}
+  spec.description   = %q{Gelatin: A Jump Consistent Hash Ruby Gem}
+  spec.homepage      = "http://github.com/eduardordm/gelatin"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/jch/extconf.rb"]
+
+  spec.add_dependency "rake-compiler"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rubocop"
+end

data/lib/gelatin/hashable.rb

@@ -0,0 +1,7 @@
+module Gelatin
+  module Hashable
+    def key
+      self.to_s.unpack('q*').first
+    end
+  end
+end

data/lib/gelatin/node.rb

@@ -0,0 +1,14 @@
+module Gelatin
+  # Node is a PORO
+  class Node
+    attr_accessor :addr
+
+    def initialize(addr)
+      @addr = addr
+    end
+
+    def to_s
+      @addr
+    end
+  end
+end

data/lib/gelatin/ring.rb

@@ -0,0 +1,29 @@
+require 'jch'
+
+module Gelatin
+  # Defines the hasher class
+  # http://arxiv.org/pdf/1406.2294.pdf
+  class Ring
+    include Jch
+
+    def initialize
+      @nodes = []
+    end
+
+    def add(node)
+      @nodes << node
+    end
+
+    def delete(node)
+      @nodes.delete node
+    end
+
+    # Key should be some sort of information about the object.
+    # If it's a file, maybe you could use its relative path.
+    # If the object can fit in a uint64, you could use the object
+    # itself as the key.
+    def get(key)
+      @nodes[hash(key, @nodes.size)]
+    end
+  end
+end

data/lib/gelatin/version.rb

@@ -0,0 +1,3 @@
+module Gelatin
+  VERSION = "0.1.0"
+end

data/lib/gelatin.rb

@@ -0,0 +1,7 @@
+require "gelatin/version"
+require "gelatin/hashable"
+require "gelatin/node"
+require "gelatin/ring"
+
+module Gelatin
+end

data/test/gelatin_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class GelatinTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Gelatin::VERSION
+  end
+end

data/test/jch_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+require 'jch'
+
+class JchTest < Minitest::Test
+  include Jch
+
+  def test_hasher_consistency
+      key = rand(2**32..2**64-1)
+      nodes = rand(1000..100000)
+      node_a = hash(key, nodes)
+      node_b = hash(key, nodes)
+      assert_includes (0...nodes), node_a
+      assert_includes (0...nodes), node_b
+      assert_equal node_a, node_b
+  end
+
+  def test_rotation_on_removal
+    key = rand(2**32..2**64-1)
+    num_nodes = 10
+    last_node = 0
+    while(num_nodes > 1)
+      current_node = hash(key, num_nodes)
+      next_node = hash(key, num_nodes-=1)
+      if(current_node != next_node) # rotation should happen
+        assert next_node < current_node
+        last_node = next_node # we need to test if the last node is 0 at the end
+      end
+    end
+    assert_equal 0, last_node
+  end
+
+  def test_rotation_on_increase
+    key = rand(2**32..2**64-1)
+    num_nodes = 1
+    while(num_nodes < 10000)
+      current_node = hash(key, num_nodes)
+      next_node = hash(key, num_nodes+=1)
+      if(current_node != next_node) # better distribution should happen as space gets larger
+        assert next_node > current_node
+        last_node = next_node
+      end
+    end
+    refute_equal 0, last_node
+  end
+end

data/test/ring.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class RingTest < Minitest::Test
+  def test_that_it_finds_a_server
+    sh = Gelatin::Ring.new
+    (1...254).each do |i|
+      sh.add Gelatin::Node.new("192.168.0.#{i}")
+    end
+    refute_nil sh.get(Item.new.key)
+    assert valid_v4? sh.get(Item.new.key).addr
+  end
+end

data/test/ring_bench.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class BenchRing < Minitest::Benchmark
+  def bench_ring_google_numbers
+    ring = Gelatin::Ring.new
+
+    assert_performance_constant 0.1800000 do
+      ring.add(Gelatin::Node.new("192.168.0.1"))
+    end
+
+    assert_performance_constant 0.10000 do
+      (1..100000).each { ring.get(Item.new.key) }
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'gelatin'
+
+require 'minitest/autorun'
+require "minitest/benchmark"
+
+require 'securerandom'
+
+class Item
+  include Gelatin::Hashable
+  def to_s
+    ::SecureRandom.base64
+  end
+end
+
+def valid_v4?(addr)
+  if /\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\Z/ =~ addr
+    return $~.captures.all? {|i| i.to_i < 256}
+  end
+  return false
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: gelatin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eduardo Mourão
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Gelatin: A Jump Consistent Hash Ruby Gem'
+email:
+- eduardo.a20@gmail.com
+executables: []
+extensions:
+- ext/jch/extconf.rb
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/jch/extconf.rb
+- ext/jch/jch.c
+- gelatin.gemspec
+- lib/gelatin.rb
+- lib/gelatin/hashable.rb
+- lib/gelatin/node.rb
+- lib/gelatin/ring.rb
+- lib/gelatin/version.rb
+- lib/jch.bundle
+- test/gelatin_test.rb
+- test/jch_test.rb
+- test/ring.rb
+- test/ring_bench.rb
+- test/test_helper.rb
+homepage: http://github.com/eduardordm/gelatin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: 'Gelatin: A Jump Consistent Hash Ruby Gem'
+test_files: []