rollout 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Golick
+
+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,84 @@
+= rollout
+
+Conditionally rollout features to certain users with redis.
+
+== How it works
+
+Initialize a rollout object. I assign it to a global var.
+
+  $redis   = Redis.new
+  $rollout = Rollout.new(redis)
+
+Check whether a feature is active for a particular user:
+  
+  $rollout.active?(:chat, User.first) # => true/false
+
+You can activate features using a number of different mechanisms.
+
+== Groups
+
+Rollout ships with one group by default: "all", which does exactly what it sounds like. 
+
+You can activate the all group for the chat feature like this:
+
+  $rollout.activate_group(:chat, :all)
+
+You might also want to define your own groups. We have one for our caretakers:
+
+  $rollout.define_group(:chat) do |user|
+    user.caretaker?
+  end
+
+You can activate multiple groups per feature.
+
+Deactivate groups like this:
+
+  $rollout.deactivate_group(:chat, :all)
+
+== Specific Users
+
+You might want to let a specific user into a beta test or something. If that user isn't part of an existing group, you can let them in specifically:
+  
+  $rollout.activate_user(:chat, @user)
+
+Deactivate them like this:
+
+  $rollout.deactivate_user(:chat, @user)
+
+== User Percentages
+
+If you're rolling out a new feature, you might want to test the waters by slowly letting in a percentage of your users.
+
+  $rollout.activate_percentage(:chat, 20)
+
+The algorithm for determining which users get let in is this:
+
+  user.id % (100 / percentage) == 0
+
+So, for 20%, it's every 5th user.
+
+Deactivate all percentages like this:
+
+  $rollout.deactivate_percentage(:chat)
+
+== Feature is broken
+
+Deactivate everybody at once:
+
+  $rollout.deactivate_all
+
+For some of our less stable features, we are actually measuring the error rate using redis, and deactivating them automatically when it raises above a certain threshold. It's pretty cool.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 James Golick, Protose, Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rollout"
+    gem.summary = %Q{Conditionally roll out features with redis.}
+    gem.description = %Q{Conditionally roll out features with redis.}
+    gem.email = "james@giraffesoft.ca"
+    gem.homepage = "http://github.com/giraffesoft/rollout"
+    gem.authors = ["James Golick"]
+    gem.add_development_dependency "rspec", "1.2.9"
+    gem.add_development_dependency "bourne", "1.0.0"
+    gem.add_development_dependency "redis", "0.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rollout #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rollout.rb

@@ -0,0 +1,78 @@
+class Rollout
+  def initialize(redis)
+    @redis  = redis
+    @groups = {"all" => lambda { |user| true }}
+  end
+
+  def activate_group(feature, group)
+    @redis.sadd(group_key(feature), group)
+  end
+
+  def deactivate_group(feature, group)
+    @redis.srem(group_key(feature), group)
+  end
+
+  def deactivate_all(feature)
+    @redis.del(group_key(feature))
+    @redis.del(user_key(feature))
+    @redis.del(percentage_key(feature))
+  end
+
+  def activate_user(feature, user)
+    @redis.sadd(user_key(feature), user.id)
+  end
+
+  def deactivate_user(feature, user)
+    @redis.srem(user_key(feature), user.id)
+  end
+
+  def define_group(group, &block)
+    @groups[group.to_s] = block
+  end
+
+  def active?(feature, user)
+    user_in_active_group?(feature, user) ||
+      user_active?(feature, user) ||
+        user_within_active_percentage?(feature, user)
+  end
+
+  def activate_percentage(feature, percentage)
+    @redis.set(percentage_key(feature), percentage)
+  end
+
+  def deactivate_percentage(feature)
+    @redis.del(percentage_key(feature))
+  end
+
+  private
+    def key(name)
+      "feature:#{name}"
+    end
+
+    def group_key(name)
+      "#{key(name)}:groups"
+    end
+
+    def user_key(name)
+      "#{key(name)}:users"
+    end
+
+    def percentage_key(name)
+      "#{key(name)}:percentage"
+    end
+
+    def user_in_active_group?(feature, user)
+      @redis.smembers(group_key(feature)).any? { |group| @groups[group].call(user) }
+    end
+
+    def user_active?(feature, user)
+      @redis.sismember(user_key(feature), user.id)
+    end
+
+    def user_within_active_percentage?(feature, user)
+      percentage = @redis.get(percentage_key(feature))
+      return false if percentage.nil?
+
+      user.id % (100 / percentage.to_i) == 0
+    end
+end

data/spec/rollout_spec.rb

@@ -0,0 +1,124 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Rollout" do
+  before do
+    @redis   = Redis.new
+    @rollout = Rollout.new(@redis)
+  end
+
+  describe "when a group is activated" do
+    before do
+      @rollout.define_group(:fivesonly) { |user| user.id == 5 }
+      @rollout.activate_group(:chat, :fivesonly)
+    end
+
+    it "the feature is active for users for which the block evaluates to true" do
+      @rollout.should be_active(:chat, stub(:id => 5))
+    end
+
+    it "is not active for users for which the block evaluates to false" do
+      @rollout.should_not be_active(:chat, stub(:id => 1))
+    end
+  end
+
+  describe "the default all group" do
+    before do
+      @rollout.activate_group(:chat, :all)
+    end
+
+    it "evaluates to true no matter what" do
+      @rollout.should be_active(:chat, stub(:id => 0))
+    end
+  end
+
+  describe "deactivating a group" do
+    before do
+      @rollout.define_group(:fivesonly) { |user| user.id == 5 }
+      @rollout.activate_group(:chat, :all)
+      @rollout.activate_group(:chat, :fivesonly)
+      @rollout.deactivate_group(:chat, :all)
+    end
+
+    it "deactivates the rules for that group" do
+      @rollout.should_not be_active(:chat, stub(:id => 10))
+    end
+
+    it "leaves the other groups active" do
+      @rollout.should be_active(:chat, stub(:id => 5))
+    end
+  end
+
+  describe "deactivating a feature completely" do
+    before do
+      @rollout.define_group(:fivesonly) { |user| user.id == 5 }
+      @rollout.activate_group(:chat, :all)
+      @rollout.activate_group(:chat, :fivesonly)
+      @rollout.activate_user(:chat, stub(:id => 51))
+      @rollout.activate_percentage(:chat, 100)
+      @rollout.deactivate_all(:chat)
+    end
+
+    it "removes all of the groups" do
+      @rollout.should_not be_active(:chat, stub(:id => 0))
+    end
+
+    it "removes all of the users" do
+      @rollout.should_not be_active(:chat, stub(:id => 51))
+    end
+
+    it "removes the percentage" do
+      @rollout.should_not be_active(:chat, stub(:id => 24))
+    end
+  end
+
+  describe "activating a specific user" do
+    before do
+      @rollout.activate_user(:chat, stub(:id => 42))
+    end
+
+    it "is active for that user" do
+      @rollout.should be_active(:chat, stub(:id => 42))
+    end
+
+    it "remains inactive for other users" do
+      @rollout.should_not be_active(:chat, stub(:id => 24))
+    end
+  end
+
+  describe "deactivating a specific user" do
+    before do
+      @rollout.activate_user(:chat, stub(:id => 42))
+      @rollout.activate_user(:chat, stub(:id => 24))
+      @rollout.deactivate_user(:chat, stub(:id => 42))
+    end
+
+    it "that user should no longer be active" do
+      @rollout.should_not be_active(:chat, stub(:id => 42))
+    end
+
+    it "remains active for other active users" do
+      @rollout.should be_active(:chat, stub(:id => 24))
+    end
+  end
+
+  describe "activating a feature for a percentage of users" do
+    before do
+      @rollout.activate_percentage(:chat, 20)
+    end
+
+    it "activates the feature for that percentage of the users" do
+      (1..120).select { |id| @rollout.active?(:chat, stub(:id => id)) }.length.should == 24
+    end
+  end
+
+  describe "deactivating the percentage of users" do
+    before do
+      @rollout.activate_percentage(:chat, 100)
+      @rollout.deactivate_percentage(:chat)
+    end
+
+    it "becomes inactivate for all users" do
+      @rollout.should_not be_active(:chat, stub(:id => 24))
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rollout'
+require 'spec'
+require 'spec/autorun'
+require 'bourne'
+require 'redis'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+  config.before { Redis.new.flushdb }
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: rollout
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Golick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bourne
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :development
+  version_requirements: *id003
+description: Conditionally roll out features with redis.
+email: james@giraffesoft.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rollout.rb
+- spec/rollout_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/giraffesoft/rollout
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Conditionally roll out features with redis.
+test_files: 
+- spec/rollout_spec.rb
+- spec/spec_helper.rb