redis-slave-read 0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem "rspec"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Heald
+
+MIT License
+
+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,43 @@
+# Redis::SlaveRead
+
+Provides for distribution of slave reads in a Redis cluster.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis-slave-read'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-slave-read
+
+## Usage
+
+Rather than using a Redis instance, create a wrapper that wraps multiple Redis connections.
+
+    master = Redis.new "localhost:6379"
+    slave1 = Redis.new "localhost:6389"
+    slave2 = Redis.new "localhost:6399"
+    $redis = Redis::SlaveRead::Interface::HiRedis.new(master: master, slaves: [slave1, slave2])
+
+Make sure that your slaves are set to be slaved to the master, like `slaveof localhost 6379`
+
+Now, you can treat your SlaveRead interface as a normal Redis interfaces. Reads are distributed
+among the slaves, and writes are always sent to the master. Writes will be propagated to slaves
+by the master.
+
+    $redis.set "foo", "bar"
+    $redis.get "foo"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color --format documentation']
+end
+task :default => :spec

data/lib/activesupport/lib/active_support/cache/redis_slave_read_cache.rb

@@ -0,0 +1,185 @@
+module ActiveSupport
+  module Cache
+    class RedisStore < Store
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new
+      #     # => host: localhost,   port: 6379,  db: 0
+      #
+      #   RedisStore.new "example.com"
+      #     # => host: example.com, port: 6379,  db: 0
+      #
+      #   RedisStore.new "example.com:23682"
+      #     # => host: example.com, port: 23682, db: 0
+      #
+      #   RedisStore.new "example.com:23682/1"
+      #     # => host: example.com, port: 23682, db: 1
+      #
+      #   RedisStore.new "example.com:23682/1/theplaylist"
+      #     # => host: example.com, port: 23682, db: 1, namespace: theplaylist
+      #
+      #   RedisStore.new "localhost:6379/0", "localhost:6380/0"
+      #     # => instantiate a cluster
+      def initialize(*addresses)
+        @data = ::Redis::Factory.create(addresses)
+        super(addresses.extract_options!)
+      end
+
+      def write(name, value, options = nil)
+        options = merged_options(options)
+        instrument(:write, name, options) do |payload|
+          entry = options[:raw].present? ? value : Entry.new(value, options)
+          write_entry(namespaced_key(name, options), entry, options)
+        end
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.del_matched "rab*"
+      def delete_matched(matcher, options = nil)
+        options = merged_options(options)
+        instrument(:delete_matched, matcher.inspect) do
+          matcher = key_matcher(matcher, options)
+          begin
+            !(keys = @data.keys(matcher)).empty? && @data.del(*keys)
+          rescue Errno::ECONNREFUSED => e
+            false
+          end
+        end
+      end
+
+      # Reads multiple keys from the cache using a single call to the
+      # servers for all keys. Options can be passed in the last argument.
+      #
+      # Example:
+      #   cache.read_multi "rabbit", "white-rabbit"
+      #   cache.read_multi "rabbit", "white-rabbit", :raw => true
+      def read_multi(*names)
+        values = @data.mget(*names)
+
+        # Remove the options hash before mapping keys to values
+        names.extract_options!
+
+        result = Hash[names.zip(values)]
+        result.reject!{ |k,v| v.nil? }
+        result
+      end
+
+      # Increment a key in the store.
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.increment "counter"
+      #   cache.read "counter", :raw => true      # => "24"
+      #
+      #   cache.increment "counter", 6
+      #   cache.read "counter", :raw => true      # => "30"
+      #
+      #   cache.increment "a counter"
+      #   cache.read "a counter", :raw => true    # => "1"
+      #
+      #   cache.increment "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "1"
+      def increment(key, amount = 1)
+        instrument(:increment, key, :amount => amount) do
+          @data.incrby key, amount
+        end
+      end
+
+      # Decrement a key in the store
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.decrement "counter"
+      #   cache.read "counter", :raw => true      # => "22"
+      #
+      #   cache.decrement "counter", 2
+      #   cache.read "counter", :raw => true      # => "20"
+      #
+      #   cache.decrement "a counter"
+      #   cache.read "a counter", :raw => true    # => "-1"
+      #
+      #   cache.decrement "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "-1"
+      def decrement(key, amount = 1)
+        instrument(:decrement, key, :amount => amount) do
+          @data.decrby key, amount
+        end
+      end
+
+      # Clear all the data from the store.
+      def clear
+        instrument(:clear, nil, nil) do
+          @data.flushdb
+        end
+      end
+
+      def stats
+        @data.info
+      end
+
+      # Force client reconnection, useful Unicorn deployed apps.
+      def reconnect
+        @data.reconnect
+      end
+
+      protected
+        def write_entry(key, entry, options)
+          method = options && options[:unless_exist] ? :setnx : :set
+          @data.send method, key, entry, options
+        rescue Errno::ECONNREFUSED => e
+          false
+        end
+
+        def read_entry(key, options)
+          entry = @data.get key, options
+          if entry
+            entry.is_a?(ActiveSupport::Cache::Entry) ? entry : ActiveSupport::Cache::Entry.new(entry)
+          end
+        rescue Errno::ECONNREFUSED => e
+          nil
+        end
+
+        ##
+        # Implement the ActiveSupport::Cache#delete_entry
+        #
+        # It's really needed and use
+        #
+        def delete_entry(key, options)
+          @data.del key
+        rescue Errno::ECONNREFUSED => e
+          false
+        end
+
+
+        # Add the namespace defined in the options to a pattern designed to match keys.
+        #
+        # This implementation is __different__ than ActiveSupport:
+        # __it doesn't accept Regular expressions__, because the Redis matcher is designed
+        # only for strings with wildcards.
+        def key_matcher(pattern, options)
+          prefix = options[:namespace].is_a?(Proc) ? options[:namespace].call : options[:namespace]
+          if prefix
+            raise "Regexps aren't supported, please use string with wildcards." if pattern.is_a?(Regexp)
+            "#{prefix}:#{pattern}"
+          else
+            pattern
+          end
+        end
+    end
+  end
+end

data/lib/redis-slave-read.rb

@@ -0,0 +1,3 @@
+require "redis-slave-read/version"
+require 'redis-slave-read/interface/base'
+require 'redis-slave-read/interface/hiredis'

data/lib/redis-slave-read/interface/base.rb

@@ -0,0 +1,106 @@
+require 'redis'
+require 'thread'
+
+class Redis
+  module SlaveRead
+    module Interface
+      class Base
+        attr_accessor :master, :slaves, :nodes, :read_master, :all
+
+        class << self
+          def slave(commands)
+            commands.each do |method|
+              define_method(method) do |*args|
+                next_node.send(method, *args)
+              end
+            end
+          end
+
+          def master(commands)
+            commands.each do |method|
+              define_method(method) do |*args|
+                master.send(method, *args)
+              end
+            end
+          end
+
+          def all(commands)
+            commands.each do |method|
+              define_method(method) do |*args|
+                @all.each do |node|
+                  node.send(method, *args)
+                end
+              end
+            end
+          end
+        end
+
+        def initialize(options = {})
+          @block_exec_mutex = Mutex.new
+          @round_robin_mutex = Mutex.new
+          @master = options[:master] || raise("Must specify a master")
+          @slaves = options[:slaves] || []
+          @read_master = options[:read_master].nil? && true || options[:read_master]
+          @all = slaves + [@master]
+          @nodes = slaves.dup
+          @nodes.unshift @master if @read_master
+          @index = 0
+        end
+
+        def method_missing(method, *args)
+          if master.respond_to?(method)
+            define_method(method) do |*_args|
+              @master.send(method, *_args)
+            end
+            send(method, *args)
+          else
+            super
+          end
+        end
+
+        def pipelined(*args, &block)
+          @block_exec_mutex.synchronize do
+            @locked_node = @master
+            @master.send(:pipelined, *args, &block)
+          end
+        end
+
+        def exec(*args)
+          @block_exec_mutex.synchronize do
+            @locked_node = nil
+            @master.send(:exec, *args)
+          end
+        end
+
+        def discard(*args)
+          @block_exec_mutex.synchronize do
+            @locked_node = nil
+            @master.send(:discard, *args)
+            @locked_node = nil
+          end
+        end
+
+        def multi(*args, &block)
+          @block_exec_mutex.synchronize do
+            @locked_node = @master
+            @master.send(:multi, *args, &block)
+            @locked_node = nil
+          end
+        end
+
+        private
+
+        def next_node
+          @round_robin_mutex.synchronize do
+            if @locked_node
+              @locked_node
+            else
+              @index = (@index + 1) % @nodes.length
+              @nodes[@index]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redis-slave-read/interface/hiredis.rb

@@ -0,0 +1,30 @@
+class Redis
+  module SlaveRead
+    module Interface
+      class Hiredis < Base
+        slave %w(
+          bitcount dbsize debug dump echo exists get getbit getrange hexists hget hgetall hkeys hlen hmget hvals info keys lastsave lindex llen mget object ping pttl
+          randomkey scard sismember smembers srandmember strlen sunion time ttl type zcard zcount zrange zrangebyscore zrank zrevrank zrevrangebyscore zrevrank zscore
+        )
+
+        master %w(
+          append auth bgrewriteaof bgsave bitop blpop brpop brpoplpush client config debug debug decr decrby del eval evalsha expire expireat flushall
+          flushdb getset hdel hincrby hincrbyfloat hmset hset hsetnx incr incrby incrbyfloat linsert lpop lpush lpushx lrange lrem lset ltrim migrate monitor move mset
+          msetnx persist pexpire pexpireat psetex psubscribe publish punsubscribe quit rename renamenx restore rpop rpoplpush rpush rpushx sadd save script exists
+          script flush script kill script load sdiff sdiffstore select set setbit setex setnx setrange shutdown sinter sinterstore slaveof slowlog smove sort spop srem
+          subscribe sunionstore sync unsubscribe unwatch watch zadd zincrby zinterstore zrem zremrangebyrank zremrangebyscore zrevrange zunionstore
+        )
+
+        all %w(select)
+
+        %w(db= connect disconnect reconnect).each do |method|
+          define_method(method) do |*args|
+            all.each do |node|
+              node.client.send(method, *args)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redis-slave-read/version.rb

@@ -0,0 +1,5 @@
+class Redis
+  module SlaveRead
+    VERSION = "0.1"
+  end
+end

data/redis-slave-read.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis-slave-read/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redis-slave-read"
+  gem.version       = Redis::SlaveRead::VERSION
+  gem.authors       = ["Chris Heald"]
+  gem.email         = ["cheald@gmail.com"]
+  gem.description   = %q{Provides load balancing of reads in a cluster of Redis replicas}
+  gem.summary       = %q{Provides load balancing of reads in a cluster of Redis replicas}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "redis"
+  gem.add_development_dependency "redis"
+end

data/spec/interface/hiredis_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Redis::SlaveRead::Interface::Hiredis do
+  let(:master) { Redis.new }
+  let(:slaves) { [Redis.new, Redis.new] }
+
+  subject { described_class.new master: master, slaves: slaves }
+
+  it "should distribute reads between all available nodes" do
+    master.should_receive(:get).once
+    slaves[0].should_receive(:get).once
+    slaves[1].should_receive(:get).once
+
+    3.times { subject.get "foo" }
+  end
+
+  it "should always send non-reads to the master" do
+    master.should_receive(:set).exactly(3).times
+
+    3.times { subject.set "foo", "bar" }
+  end
+
+  context "when read_master is false" do
+    subject { described_class.new master: master, slaves: slaves, read_master: false }
+
+    it "should distribute reads between all available slaves" do
+      master.should_receive(:get).never
+      slaves[1].should_receive(:get).twice
+      slaves[0].should_receive(:get).once
+
+      3.times { subject.get "foo" }
+    end
+  end
+
+  context "when in a multi block" do
+    it "sends all commands to the master" do
+      master.should_receive(:get).twice
+
+      subject.multi do
+        2.times { subject.get "foo" }
+      end
+    end
+  end
+
+  context "when in a pipelined block" do
+    it "sends all commands to the master" do
+      master.should_receive(:get).twice
+
+      subject.pipelined do
+        2.times { subject.get "foo" }
+      end
+    end
+  end
+
+  context "commands that distribute to all nodes" do
+    it "should distribute to each node" do
+      master.should_receive(:select).once
+      slaves.each {|slave| slave.should_receive(:select).once }
+      subject.send(:select)
+    end
+
+    it "should set the DB on each node" do
+      subject.select 4
+      master.client.db.should == 4
+      slaves[0].client.db.should == 4
+      slaves[1].client.db.should == 4
+    end
+
+    it "should disconnect each client" do
+      subject.disconnect
+      !!master.client.connected?.should == false
+      !!slaves[0].client.connected?.should == false
+      !!slaves[1].client.connected?.should == false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'redis-slave-read'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: redis-slave-read
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: '0.1'
+platform: ruby
+authors:
+- Chris Heald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: redis
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: redis
+description: Provides load balancing of reads in a cluster of Redis replicas
+email:
+- cheald@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/activesupport/lib/active_support/cache/redis_slave_read_cache.rb
+- lib/redis-slave-read.rb
+- lib/redis-slave-read/interface/base.rb
+- lib/redis-slave-read/interface/hiredis.rb
+- lib/redis-slave-read/version.rb
+- redis-slave-read.gemspec
+- spec/interface/hiredis_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides load balancing of reads in a cluster of Redis replicas
+test_files:
+- spec/interface/hiredis_spec.rb
+- spec/spec_helper.rb
+has_rdoc: