redis_feature_control 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.gemspec
+pkg
+nbproject

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Ben VandenBos
+
+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,63 @@
+redis_feature_control
+=====================
+
+Redis_feature_control is a module to mark features/services as enabled or disabled
+so jobs can take appropriate action.
+
+
+### Why?
+
+Sometimes you depend on services.  Sometimes these services go down.  Sometimes
+you want to explicitly turn off services and have your app know the service is
+turned off.  That way your app can display a pretty message to a user
+rather than trying a service and waiting for it to time out.  Maybe your backend
+job depends on a service.  When it notices it's disabled, it can sleep or delay
+that job to sometime in the future without having to test the service.
+
+
+
+### Usage
+
+First configure it:
+
+    require 'rubygems'
+    require 'redis/feature_control'
+    Redis::FeatureControl.connection_string = "redis_server:6379"
+
+Then add your features/services to it:
+
+    Redis::FeatureControl.features << :data_warehouse
+    Redis::FeatureControl.features << :cc_gateway
+    Redis::FeatureControl.features << :hulu
+
+Then see if they are enabled and toggle them:
+
+    # on by default
+    Redis::FeatureControl.enabled?(:cc_gateway) # => true
+
+    # disabling...
+    Redis::FeatureControl.disable!(:cc_gateway)
+    Redis::FeatureControl.enabled?(:cc_gateway) # => false
+    Redis::FeatureControl.status(:cc_gateway) # => "disabled"
+
+    # enabling...
+    Redis::FeatureControl.enable!(:cc_gateway)
+    Redis::FeatureControl.enabled?(:cc_gateway) # => true
+    Redis::FeatureControl.disabled?(:cc_gateway) # => false
+    Redis::FeatureControl.status(:cc_gateway) # => "enabled"
+
+### Mocking for Test/Development
+
+Since you don't always have redis available in development and test, sometimes
+it's nice to just keep the state of features in memory.  You can enable the mock
+behavior like so:
+
+    Redis::FeatureControl.mock!
+
+It will work exactly the same as when it's using redis, but it will only store
+the states of features in memory.
+
+To stop mocking:
+
+    Redis::FeatureControl.unmock!
+

data/Rakefile

@@ -0,0 +1,50 @@
+$LOAD_PATH.unshift 'lib'
+
+task :default => :test
+
+desc "Run tests"
+task :test do
+  Dir['test/*_test.rb'].each do |f|
+    require f
+  end
+end
+
+desc "Build a gem"
+task :gem => [ :test, :gemspec, :build ]
+
+begin
+  begin
+    require 'jeweler'
+  rescue LoadError
+    puts "Jeweler not available. Install it with: "
+    puts "gem install jeweler"
+  end
+
+  require 'redis/feature_control'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "redis_feature_control"
+    gemspec.summary = "Feature enable/disable library on top of Redis"
+    gemspec.description = gemspec.summary
+    gemspec.email = "bvandenbos@gmail.com"
+    gemspec.homepage = "http://github.com/bvandenbos/redis_feature_control"
+    gemspec.authors = ["Ben VandenBos"]
+    gemspec.version = Redis::FeatureControl::Version
+    
+    gemspec.add_dependency "redis", ">= 0.1.1"
+    gemspec.add_dependency "redis-namespace", ">= 0.2.0"
+    gemspec.add_development_dependency "jeweler"
+    gemspec.add_development_dependency "mocha"
+  end
+end
+
+
+desc "Push a new version to Gemcutter"
+task :publish => [ :test, :gemspec, :build ] do
+  require 'redis/feature_control'
+  system "git tag v#{Redis::FeatureControl::Version}"
+  system "git push origin v#{Redis::FeatureControl::Version}"
+  system "git push origin master"
+  system "gem push pkg/redis_feature_control-#{Redis::FeatureControl::Version}.gem"
+  system "git clean -fd"
+end

data/lib/redis/feature_control.rb

@@ -0,0 +1,141 @@
+require 'rubygems'
+require 'redis'
+require 'redis/namespace'
+
+#
+# Redis::FeatureControl
+#
+# The point of this is to have a very simple way to turn pieces of the site on
+# and off without having to load your entire Rails stack (models, etc).
+#
+# How it stores stuff in Redis:
+# Features default on, so if the value in redis is nil, it's considered
+# enabled.  The value is "1" when explicitly turned on and "0" when off.
+#
+class Redis
+
+  module FeatureControl
+
+    Version = '0.0.1'
+
+    class Redis::FeatureControl::UnknownFeatureError < RuntimeError; end;
+
+    class << self
+
+      attr_accessor :features
+
+      def features
+        @features ||= []
+      end
+
+      def host
+        @host ||= 'localhost'
+      end
+
+      def port
+        @port ||= 6379
+      end
+
+      # Redis::FeatureControl
+      def connection_string=(value)
+        @host, @port = value.split(":", 2)
+        redis_connect!
+      end
+
+      # Connects to redis on the current host/port and sets the redis object
+      def redis_connect!
+        redis = Redis.new(:host => host, :port => port, :thread_safe => true)
+        @redis = Redis::Namespace.new(:feature_control, :redis => redis)
+      end
+
+      def redis
+        if @redis.nil?
+          begin
+            redis_connect!
+          rescue Errno::ECONNREFUSED
+          end
+        end
+        @redis
+      end
+
+      def disabled?(feature)
+        check_feature!(feature)
+        !enabled?(feature)
+      end
+
+      def enabled?(feature)
+        check_feature!(feature)
+        if mock?
+          mock_feature_hash[feature.to_s].nil? || true == mock_feature_hash[feature.to_s]
+        else
+          (redis.get(feature.to_s) || 1).to_i == 1
+        end
+      rescue Errno::ECONNREFUSED
+        true # default to enabled if we can't connect to redis
+      end
+
+      def enable!(feature)
+        check_feature!(feature)
+        if mock?
+          mock_feature_hash[feature.to_s] = true
+        else
+          redis.set(feature.to_s, 1)
+        end
+      rescue Errno::ECONNREFUSED
+        # Ignore
+      end
+
+      def disable!(feature)
+        check_feature!(feature)
+        if mock?
+          mock_feature_hash[feature.to_s] = false
+        else
+          redis.set(feature.to_s, 0)
+        end
+      rescue Errno::ECONNREFUSED
+        # Ignore
+      end
+
+      # value >=1 enable the feature
+      # value <1 disable the feature
+      def set_status(feature, value)
+        value = value.to_i
+        if value >= 1
+          enable!(feature)
+        else
+          disable!(feature)
+        end
+      end
+
+      # Returns a string for the state of the feature
+      def state(feature)
+        enabled?(feature) ? 'enabled' : 'disabled'
+      end
+
+      def check_feature!(feature)
+        raise Redis::FeatureControl::UnknownFeatureError unless features.include?(feature.to_sym)
+      end
+
+      # This redfines enabled/disabled to only use class variables instead of connecting
+      # to redis.  This allows you to run tests w/out a connection to redis
+      def mock!
+        @mock = true
+      end
+
+      def unmock!
+        @mock = false
+      end
+
+      def mock?
+        @mock
+      end
+
+      def mock_feature_hash
+        @feature_hash ||= {}
+      end
+
+    end
+    
+  end
+
+end

data/test/feature_control_test.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Redis::FeatureControlTest < Test::Unit::TestCase
+
+  def setup
+    Redis::FeatureControl.connection_string = 'localhost:9736'
+    Redis::FeatureControl.unmock!
+    Redis::FeatureControl.features = [:enabled_feature]
+    Redis::FeatureControl.redis.flushall
+  end
+
+  def test_connection_string_works
+    Redis::FeatureControl.connection_string = "redis:1234"
+    assert_equal('redis', Redis::FeatureControl.host)
+    assert_equal('1234', Redis::FeatureControl.port)
+  end
+
+  def test_redis
+    assert(Redis::FeatureControl.redis.is_a?(Redis::Namespace))
+  end
+
+  def test_unknown_features_raise_errors
+    assert_raises(Redis::FeatureControl::UnknownFeatureError) do
+      Redis::FeatureControl.enabled?(:some_feature)
+    end
+  end
+
+  def test_enable_disable
+    Redis::FeatureControl.features << :cool_service # add a feature
+    assert(Redis::FeatureControl.enabled?(:cool_service)) # should be enabled by default
+    assert(!Redis::FeatureControl.disabled?(:cool_service)) # should be enabled by default
+
+    Redis::FeatureControl.enable!(:cool_service)
+    assert(Redis::FeatureControl.enabled?(:cool_service)) # should still be enabled
+
+    Redis::FeatureControl.disable!(:cool_service)
+    assert(!Redis::FeatureControl.enabled?(:cool_service)) # should still be enabled
+    assert(Redis::FeatureControl.disabled?(:cool_service)) # should still be enabled
+
+    Redis::FeatureControl.enable!(:cool_service)
+    assert(Redis::FeatureControl.enabled?(:cool_service)) # should still be enabled
+  end
+
+  def test_set_status
+
+    Redis::FeatureControl.features << :cool_service # add a feature
+
+    Redis::FeatureControl.set_status(:cool_service, 0.9) # <1
+    assert(Redis::FeatureControl.disabled?(:cool_service)) # should still be enabled
+
+    Redis::FeatureControl.set_status(:cool_service, 1.0)
+    assert(Redis::FeatureControl.enabled?(:cool_service)) # should still be enabled
+
+    Redis::FeatureControl.set_status(:cool_service, -1)
+    assert(Redis::FeatureControl.disabled?(:cool_service)) # should still be enabled
+
+    Redis::FeatureControl.set_status(:cool_service, -1.0)
+    assert(Redis::FeatureControl.disabled?(:cool_service)) # should still be enabled
+
+    Redis::FeatureControl.set_status(:cool_service, 42)
+    assert(Redis::FeatureControl.enabled?(:cool_service)) # should still be enabled
+
+    Redis::FeatureControl.set_status(:cool_service, -42)
+    assert(Redis::FeatureControl.disabled?(:cool_service)) # should still be enabled
+
+  end
+
+  def test_state_string
+    Redis::FeatureControl.features << :cool_service # add a feature
+
+    Redis::FeatureControl.enable!(:cool_service)
+    assert_equal('enabled', Redis::FeatureControl.state(:cool_service))
+
+    Redis::FeatureControl.disable!(:cool_service)
+    assert_equal('disabled', Redis::FeatureControl.state(:cool_service))
+  end
+
+  def test_check_feature
+    assert_raises(Redis::FeatureControl::UnknownFeatureError) do
+      Redis::FeatureControl.enabled?(:some_feature)
+    end
+
+    assert_nothing_raised do
+      Redis::FeatureControl.enabled?(:enabled_feature)
+    end
+  end
+
+  def test_mock
+
+    Redis::FeatureControl.mock!
+    assert(Redis::FeatureControl.mock?)
+
+    Redis::FeatureControl.unmock!
+    assert(!Redis::FeatureControl.mock?)
+  end
+
+  def test_mock_enable_disable
+    Redis::FeatureControl.mock!
+
+    Redis::FeatureControl.expects(:redis).never # It's mocked, so it shouldn't use redis
+
+    Redis::FeatureControl.features << :cool_service # add a feature
+    assert(Redis::FeatureControl.enabled?(:cool_service)) # should be enabled by default
+    assert(!Redis::FeatureControl.disabled?(:cool_service)) # should be enabled by default
+
+    Redis::FeatureControl.enable!(:cool_service)
+    assert(Redis::FeatureControl.enabled?(:cool_service)) # should still be enabled
+
+    Redis::FeatureControl.disable!(:cool_service)
+    assert(!Redis::FeatureControl.enabled?(:cool_service)) # should still be enabled
+    assert(Redis::FeatureControl.disabled?(:cool_service)) # should still be enabled
+
+    Redis::FeatureControl.enable!(:cool_service)
+    assert(Redis::FeatureControl.enabled?(:cool_service)) # should still be enabled
+  end
+
+end

data/test/redis-test.conf

@@ -0,0 +1,132 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./test/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./test/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+# slaveof <masterip> <masterport>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes
+
+# Use object sharing. Can save a lot of memory if you have many common
+# string in your dataset, but performs lookups against the shared objects
+# pool so it uses more CPU and can be a bit slower. Usually it's a good
+# idea.
+#
+# When object sharing is enabled (shareobjects yes) you can use
+# shareobjectspoolsize to control the size of the pool used in order to try
+# object sharing. A bigger pool size will lead to better sharing capabilities.
+# In general you want this value to be at least the double of the number of
+# very common strings you have in your dataset.
+#
+# WARNING: object sharing is experimental, don't enable this feature
+# in production before of Redis 1.0-stable. Still please try this feature in
+# your development environment so that we can test it better.
+shareobjects no
+shareobjectspoolsize 1024

data/test/test_helper.rb

@@ -0,0 +1,40 @@
+dir = File.dirname(File.expand_path(__FILE__))
+
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'redis'
+$LOAD_PATH.unshift File.dirname(File.expand_path(__FILE__)) + '/../lib'
+require 'redis/feature_control'
+
+#
+# make sure we can run redis
+#
+
+if !system("which redis-server")
+  puts '', "** can't find `redis-server` in your path"
+  puts "** try running `sudo rake install`"
+  abort ''
+end
+
+
+#
+# start our own redis when the tests start,
+# kill it when they end
+#
+
+at_exit do
+  next if $!
+
+  exit_code = Test::Unit::AutoRunner.run
+
+  pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
+  puts "Killing test redis server..."
+  `rm -f #{dir}/dump.rdb`
+  Process.kill("KILL", pid.to_i)
+  exit exit_code
+end
+
+puts "Starting redis for testing at localhost:9736..."
+`redis-server #{dir}/redis-test.conf`
+Redis::FeatureControl.connection_string = 'localhost:9736'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: redis_feature_control
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben VandenBos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redis-namespace
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Feature enable/disable library on top of Redis
+email: bvandenbos@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/redis/feature_control.rb
+- test/feature_control_test.rb
+- test/redis-test.conf
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bvandenbos/redis_feature_control
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Feature enable/disable library on top of Redis
+test_files: 
+- test/feature_control_test.rb
+- test/test_helper.rb