rollout-zk 1.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Eric Lindvall
+
+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,31 @@
+# Zookeeper storage adapter for rollout
+
+I've implemented a zookeeper-based storage adapter for [rollout][] that does 
+not require any network roundtrips to check if a feature is active for a user.
+
+It uses zookeeper watches to store the entire dataset in memory (which will 
+generally be very small) and updates the local cache as soon as anything 
+changes.
+
+If you haven't migrated to rollout v2, you can just use this `:legacy_storage` 
+option and things will migrate to redis. If you have alerady migrated, it 
+would take some manual work (that I think could be fairly easy to automate).
+
+
+## Usage
+
+``` ruby
+    $rollout = Rollout.new(
+      Rollout::Zookeeper::Storage.new($zookeeper, "/rollout/users"),
+      :legacy_storage => $redis, :migrate => true)
+```
+
+## Items of note
+
+* it uses the [zk][] gem
+* all settings are stored is a single znode
+* this will automatically migrate everything properly if you haven't migrated to rollout v2 yet
+
+[rollout]: https://github.com/jamesgolick/rollout
+[zk]: https://github.com/slyphon/zk
+[pull request]: https://github.com/jamesgolick/rollout/pull/31

data/Rakefile

@@ -0,0 +1,151 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  prefix = name[/^([^-]*)/, 1]
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}", "lib/#{prefix}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/lib/rollout-zk.rb

@@ -0,0 +1,5 @@
+require 'rollout/zookeeper/storage'
+
+module RolloutZk
+  VERSION = "1.0.0"
+end

data/lib/rollout/zookeeper/distributed_hashtable.rb

@@ -0,0 +1,197 @@
+require 'zk'
+require 'yajl'
+
+module Rollout::Zookeeper
+  class DistributedHashtable
+    def initialize(zk, path, options = {})
+      @zk        = zk
+      @path      = path
+      @mutex     = Mutex.new
+      @callbacks = []
+      @on_error  = options[:on_error] || proc { |ex| }
+
+      configure_watches
+    end
+
+    def on_change(&block)
+      @mutex.synchronize do
+        @callbacks << block
+      end
+
+      block.call
+    end
+
+    def fire
+      callbacks = @mutex.synchronize do
+        @callbacks.dup
+      end
+
+      callbacks.each do |cb|
+        begin
+          cb.call
+        rescue => e
+          @on_error.call(e)
+        end
+      end
+    end
+
+    def [](key)
+      @mutex.synchronize do
+        if @hashtable
+          return @hashtable[key]
+        end
+      end
+    end
+    
+    def []=(key, value)
+      result = @mutex.synchronize do
+        update do |hashtable|
+          hashtable[key] = value
+        end
+      end
+
+      fire
+
+      return result
+    end
+    
+    def has_key?(key)
+      @mutex.synchronize do
+        if @hashtable
+          @hashtable.has_key?(key)
+        end
+      end
+    end
+    
+    def delete(key)
+      result = @mutex.synchronize do
+        update do |hashtable|
+          hashtable.delete(key)
+        end
+      end
+
+      fire
+
+      return result
+    end
+
+    def merge(other)
+      result = @mutex.synchronize do
+        update do |hashtable|
+          hashtable.merge(other)
+        end
+      end
+
+      fire
+
+      return result
+    end
+
+    def to_h
+      @mutex.synchronize do
+        if @hashtable
+          @hashtable.dup
+        else
+          {}
+        end
+      end
+    end
+
+    def each(&block)
+      to_h.each(&block)
+    end
+
+    def length
+      @mutex.synchronize do
+        if @hashtable
+          @hashtable.length
+        else
+          0
+        end
+      end
+    end
+
+    def empty?
+      length == 0
+    end
+    alias_method :blank?, :empty?
+
+    def read
+      @mutex.synchronize do
+        begin
+          current, _ = @zk.get(@path, :watch => true)
+          @hashtable = Yajl::Parser.parse(current)
+        rescue ::ZK::Exceptions::NoNode
+          if @zk.exists?(@path, :watch => true)
+            retry
+          else
+            @hashtable = Hash.new
+          end
+        end
+      end
+
+      fire
+    end
+
+    def update(&block)
+      return update_exists(&block)
+    rescue ::ZK::Exceptions::NoNode
+      begin
+        return update_initial(&block)
+      rescue ::ZK::Exceptions::NodeExists
+        return update_exists(&block)
+      end
+    end
+
+    def update_exists(&block)
+      begin
+        current, stat = @zk.get(@path, :watch => true)
+        hashtable = Yajl::Parser.parse(current)
+
+        result = block.call(hashtable)
+
+        @zk.set(@path, Yajl::Encoder.encode(hashtable), :version => stat.version)
+        @hashtable = hashtable
+
+        return result
+      rescue ::ZK::Exceptions::BadVersion
+        sleep 0.1 + rand
+        retry
+      end
+    end
+
+    def update_initial(&block)
+      begin
+        hashtable = Hash.new
+
+        result = block.call(hashtable)
+
+        @zk.create(@path, Yajl::Encoder.encode(hashtable))
+        @hashtable = hashtable
+
+        return result
+      rescue ::ZK::Exceptions::NoNode
+        @zk.mkdir_p(File.dirname(@path))
+        retry
+      end
+    end
+
+    def configure_watches
+      @register ||= @zk.register(@path) do
+        read
+      end
+
+      @on_connected ||= @zk.on_connected do
+        read
+      end
+
+      begin
+        read
+      rescue ::ZK::Exceptions::OperationTimeOut, ::Zookeeper::Exceptions::ContinuationTimeoutError, ::Zookeeper::Exceptions::NotConnected => e
+        # Ignore these, we'll get them next time
+
+        @on_error.call(e)
+      end
+    end
+  end
+end

data/lib/rollout/zookeeper/storage.rb

@@ -0,0 +1,17 @@
+require 'rollout/zookeeper/distributed_hashtable'
+
+module Rollout::Zookeeper
+  class Storage
+    def initialize(zk, path, options = {})
+      @cache = ::Rollout::Zookeeper::DistributedHashtable.new(zk, path, options)
+    end
+  
+    def get(key)
+      @cache[key]
+    end
+  
+    def set(key, value)
+      @cache[key] = value.to_s
+    end
+  end
+end

data/rollout-zk.gemspec

@@ -0,0 +1,71 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'rollout-zk'
+  s.version           = '1.0.0'
+  s.date              = '2013-09-10'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "A ZooKeeper storage adapter for rollout."
+  s.description = "A ZooKeeper storage adapter for rollout."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Eric Lindvall"]
+  s.email    = 'eric@papertrailapp.com'
+  s.homepage = 'https://github.com/papertrail/rollout-zk'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('rollout', [">= 2.0"])
+  s.add_dependency('zk')
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  # s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    lib/rollout-zk.rb
+    lib/rollout/zookeeper/distributed_hashtable.rb
+    lib/rollout/zookeeper/storage.rb
+    rollout-zk.gemspec
+    test/storage_test.rb
+    test/test_helper.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: rollout-zk
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Eric Lindvall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-09-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rollout
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: zk
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A ZooKeeper storage adapter for rollout.
+email: eric@papertrailapp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rollout-zk.rb
+- lib/rollout/zookeeper/distributed_hashtable.rb
+- lib/rollout/zookeeper/storage.rb
+- rollout-zk.gemspec
+- test/storage_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/papertrail/rollout-zk
+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: 2
+summary: A ZooKeeper storage adapter for rollout.
+test_files: 
+- test/test_helper.rb