redis-sentinel 1.0.0

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'
+
+# Specify your gem's dependencies in redis-sentinel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Richard Huang
+
+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,37 @@
+# Redis::Sentinel
+
+monkey patch [redis-rb][0] to support redis sentinel.
+
+it subscribes message with channel "+switch-master", when message
+received, it will disconnect current connection and connect to new
+master server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis-sentinel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-sentinel
+
+## Usage
+
+Specify the sentinel servers and master name
+
+    Redis.new(master_name: "master1", sentinels: [{host: "localhost", port: 26379}, {host: "localhost", port: 26380}])
+
+## 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
+
+[0]: https://github.com/redis/redis-rb

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/redis-sentinel.rb

@@ -0,0 +1,2 @@
+require "redis-sentinel/version"
+require "redis-sentinel/client"

data/lib/redis-sentinel/client.rb

@@ -0,0 +1,84 @@
+require "redis"
+
+class Redis::Client
+  class_eval do
+    def initiliaze_with_sentinel(options={})
+      @master_name = options.delete(:master_name) || options.delete("master_name")
+      @sentinels = options.delete(:sentinels) || options.delete("sentinels")
+      @watcher = Thread.new { watch_sentinel } if sentinel?
+      initialize_without_sentinel(options)
+    end
+
+    alias initialize_without_sentinel initialize
+    alias initialize initiliaze_with_sentinel
+
+    def connect_with_sentinel
+      discover_master if sentinel?
+      connect_without_sentinel
+    end
+
+    alias connect_without_sentinel connect
+    alias connect connect_with_sentinel
+
+    def sentinel?
+      @master_name && @sentinels
+    end
+
+    def try_next_sentinel
+      @sentinels << @sentinels.shift
+      if @logger && @logger.debug?
+        @logger.debug? "Trying next sentinel: #{@sentinels[0][:host]}:#{@sentinels[0][:port]}"
+      end
+      return @sentinels[0]
+    end
+
+    def discover_master
+      masters = []
+
+      while true
+        sentinel = Redis.new(@sentinels[0])
+
+        begin
+          host, port = sentinel.sentinel("get-master-addr-by-name", @master_name)
+          if !host && !port
+            raise Redis::ConnectionError("No master named: #{@master_name}")
+          end
+          @options.merge!(host: host, port: port.to_i)
+
+          break
+        rescue Redis::CannotConnectError
+          try_next_sentinel
+        end
+      end
+    end
+
+    def watch_sentinel
+      while true
+        sentinel = Redis.new(@sentinels[0])
+
+        begin
+          sentinel.psubscribe("*") do |on|
+            on.pmessage do |pattern, channel, message|
+              next if channel != "+switch-master"
+
+              master_name, old_host, old_port, new_host, new_port = message.split(" ")
+
+              next if master_name != @master_name
+
+              @options.merge!(host: new_host, port: new_port.to_i)
+
+              if @logger && @logger.debug?
+                @logger.debug "Failover: #{old_host}:#{old_port} => #{new_host}:#{new_port}"
+              end
+
+              disconnect
+            end
+          end
+        rescue Redis::CannotConnectError
+          try_next_sentinel
+          sleep 1
+        end
+      end
+    end
+  end
+end

data/lib/redis-sentinel/version.rb

@@ -0,0 +1,5 @@
+class Redis
+  module Sentinel
+    VERSION = "1.0.0"
+  end
+end

data/redis-sentinel.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-sentinel/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redis-sentinel"
+  gem.version       = Redis::Sentinel::VERSION
+  gem.authors       = ["Richard Huang"]
+  gem.email         = ["flyerhzm@gmail.com"]
+  gem.description   = %q{monkey patch redis-rb to support redis sentinel}
+  gem.summary       = %q{monkey patch redis-rb to support redis sentinel}
+  gem.homepage      = "https://github.com/flyerhzm/redis-sentinel"
+
+  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 "rspec"
+end

data/spec/redis-sentinel/client_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Redis::Client do
+  context "#sentinel?" do
+    it "should be true if passing sentiels and master_name options" do
+      expect(Redis::Client.new(master_name: "master", sentinels: [{host: "localhost", port: 26379}, {host: "localhost", port: 26380}])).to be_sentinel
+    end
+
+    it "should not be true if not passing sentinels and maser_name options" do
+      expect(Redis::Client.new).not_to be_sentinel
+    end
+
+    it "should not be true if passing sentinels option but not master_name option" do
+      expect(Redis::Client.new(sentinels: [{host: "localhost", port: 26379}, {host: "localhost", port: 26380}])).not_to be_sentinel
+    end
+
+    it "should not be true if passing master_name option but not sentinels option" do
+      expect(Redis::Client.new(master_name: "master")).not_to be_sentinel
+    end
+  end
+
+  context "#try_next_sentinel" do
+    let(:client) { Redis::Client.new(master_name: "master", sentinels: [{host: "localhost", port: 26379}, {host: "localhost", port: 26380}]) }
+
+    it "should return next sentinel server" do
+      expect(client.try_next_sentinel).to eq({host: "localhost", port: 26380})
+    end
+  end
+
+  context "#discover_master" do
+    let(:client) { Redis::Client.new(master_name: "master", sentinels: [{host: "localhost", port: 26379}, {host: "localhost", port: 26380}]) }
+    before { Redis.any_instance.should_receive(:sentinel).with("get-master-addr-by-name", "master").and_return(["remote.server", 8888]) }
+
+    it "should update options" do
+      client.discover_master
+      expect(client.host).to eq "remote.server"
+      expect(client.port).to eq 8888
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "rspec"
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require "redis"
+require "redis-sentinel"
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: redis-sentinel
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: monkey patch redis-rb to support redis sentinel
+email:
+- flyerhzm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis-sentinel.rb
+- lib/redis-sentinel/client.rb
+- lib/redis-sentinel/version.rb
+- redis-sentinel.gemspec
+- spec/redis-sentinel/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/flyerhzm/redis-sentinel
+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: monkey patch redis-rb to support redis sentinel
+test_files:
+- spec/redis-sentinel/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: