redis_wmrs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 979cef6e3bf745de0a66e2f5e581ec1d1b6a58b1
+  data.tar.gz: fccb0412a5a9ec93fd372d2eb7d1b52516c4e902
+SHA512:
+  metadata.gz: 4c884afba7b7c9925bbe5a683cd643aac4c0cba2255d64a592dc8ecb6c5246f7d7ca8c07d947a725c2d651861bf75d8d02b6313713d7b61d09f40f100347daa0
+  data.tar.gz: 7ce30770eec208e8bbe0a44807be25a3f2d358cf9cab8de51cc40ffd55dad50f4642c1ef7ee1cb51a38fab65ef0e89dd808939737433e56cbd490cd00fc8a052

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/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis_wmrs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 akima
+
+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,55 @@
+# RedisWmrs
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_wmrs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_wmrs
+
+## Usage
+
+```
+
+redis = RedisWmrs.new(
+  :master_name => "sentinel_master",
+  :sentinels => [
+    {:host => "redis01", :port => 26379},
+    {:host => "redis02", :port => 26379},
+    {:host => "redis03", :port => 26379}
+  ])
+
+i = -1
+while true
+  i += 1
+  i = 0 if i > 10
+  redis.set("foo", Time.now.to_s) if i == 0
+
+  header = "[#{Time.now.to_s}] sentinel:#{redis.client.current_sentinel.client.location} redis:#{redis.client.location}"
+  begin
+    puts "#{header} #{redis.get 'foo'}"
+  rescue => e
+    puts "#{header} [#{e.class.name}]: #{e.message}"
+  end
+  sleep 1
+end
+
+```
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/test.rb

@@ -0,0 +1,38 @@
+# -*- coding:utf-8 -*-
+
+require 'redis_wmrs'
+require 'logger'
+
+@redis = RedisWmrs.new({
+  :master_name => "sentinel_apisrv",
+  :sentinels => [
+    {:host => "redis01", :port => 26379},
+    {:host => "redis02", :port => 26379},
+    {:host => "redis03", :port => 26379}
+  ],
+  # :logger => Logger.new(STDOUT)
+})
+
+def logging
+  master = @redis.client.master.location
+  master_sentinel = @redis.client.master.current_sentinel.client.location rescue nil
+  slave = @redis.client.slave.location
+  slave_sentinel = @redis.client.slave.current_sentinel.client.location rescue nil
+
+  header = "[#{Time.now.to_s}] MASTER:#{master}~#{master_sentinel} SLAVE:#{slave}~#{slave_sentinel}"
+  begin
+    result = yield
+    puts "#{header} #{result}"
+  rescue => e
+    puts "#{header} [#{e.class.name}]: #{e.message}"
+  end
+end
+
+i = -1
+while true
+  i += 1
+  i = 0 if i > 10
+  logging{ @redis.set("foo", Time.now.to_s) } if i == 0
+  logging{ @redis.get('foo') }
+  sleep 1
+end

data/lib/redis_wmrs/dispatcher.rb

@@ -0,0 +1,103 @@
+# -*- coding: utf-8 -*-
+require 'redis_wmrs'
+
+require 'forwardable'
+
+class RedisWmrs::Dispatcher
+  extend Forwardable
+
+  MASTER_SLAVE_COMMANDS = [
+    :select, :quit,
+  ].freeze
+
+  DEFAULT_SLAVE_COMMANDS = [
+    :info, # :sync,
+    :dbsize, :lastsave, :time, :ttl, :pttl, :exists, :keys, :randomkey, :type,
+    :get, :mget, :getrange, :getbit, :bitcount, :getset, :strlen, :llen,
+    :lindex, :srandmember, :sismember, :smembers, :sdiff, :sinter, :sunion,
+    :zcard, :zscore, :zrange, :zrevrange, :zrank, :zrevrank, :zrangebyscore,
+    :zrevrangebyscore, :zremrangebyscore, :zcount,
+    :hlen, :hget, :hmget, :hexists, :hkeys, :hvals, :hgetall,
+    # :watch, :unwatch,
+    :echo, :ping
+  ].freeze
+
+  attr_reader :master, :slave
+  attr_reader :options
+
+  def initialize(master, slave, options)
+    @master, @slave = master, slave
+    @both_cmds = options[:both] || MASTER_SLAVE_COMMANDS
+    @slave_cmds = options[:slave] || DEFAULT_SLAVE_COMMANDS
+  end
+
+  def ids
+    __map__ &:id
+  end
+
+  def locations
+    __map__ &:location
+  end
+
+  def db=(db)
+    __both__{|c| c.db = db}; return db
+  end
+
+  def logger=(v)
+    __both__{|c| c.logger = v}; return v
+  end
+
+  def connect   ; __both__{|c| c.connect   }; return self; end
+  def disconnect; __both__{|c| c.disconnect}; return self; end
+  def reconnect ; __both__{|c| c.reconnect }; return self; end
+
+  def call(command, &block)
+    __dispatch__(*command){|c|c.call(command, &block)}
+  end
+
+  def call_loop(command, &block)
+    __dispatch__(*command){|c|c.call_loop(command, &block)}
+  end
+
+  def call_with_timeout(command, timeout, &blk)
+    __dispatch__(*command){|c|c.call_with_timeout(command, timeout, &blk)}
+  end
+
+  def call_without_timeout(command, &blk)
+    __dispatch__(*command){|c|c.call_with_timeout(command, &blk)}
+  end
+
+  # すべてのpublicメソッドの定義後で実行する必要があります
+  master_deleted_methods = (Redis::Client.public_instance_methods(false).
+    delete_if{|s| s =~ /\A_|\Ainitialize|\=$/}) - self.public_instance_methods(false)
+
+  def_delegators :@master, *master_deleted_methods
+
+  private
+
+  def __both__
+    yield(@master)
+    yield(@slave)
+  end
+  def __master__; yield(@master); end
+  def __slave__ ; yield(@slave ); end
+
+  def __map__
+    if block_given?
+      [yield(@master), yield(@slave)]
+    else
+      [@master, @slave]
+    end
+  end
+
+  def __dispatch__(command, *, &blk)
+    m =
+      case
+      when @slave_cmds.include?(command) then :__slave__
+      when @both_cmds.include?(command)  then :__both__
+      else :__master__
+      end
+    send(m, &blk)
+  end
+
+end

data/lib/redis_wmrs/impl.rb

@@ -0,0 +1,14 @@
+require 'redis_wmrs'
+
+module RedisWmrs
+  class Impl < ::Redis
+
+    def initialize(options = {})
+      dispatch_options = options.delete(:dispatch) || options.delete("dispatch") || {}
+      super(options.dup) # Redis#initialize
+      m = @client # master client
+      s = SlaveClient.new(options)
+      @original_client = @client = RedisWmrs::Dispatcher.new(m, s, dispatch_options)
+    end
+  end
+end

data/lib/redis_wmrs/slave_client.rb

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+require 'redis_wmrs'
+
+module RedisWmrs
+  class SlaveClient < ::Redis::Client
+
+    # override Redis::Client#connect overwritten by redis-sentinel
+    # https://github.com/flyerhzm/redis-sentinel/blob/master/lib/redis-sentinel/client.rb#L24
+    def connect
+      if sentinel?
+        auto_retry_with_timeout do
+          discover_slave
+          begin
+            connect_without_sentinel
+          rescue => e
+            @failed ||= []
+            f = "#{@options[:host]}:#{@options[:port]}"
+            @failed.delete(f)
+            @failed.push(f) # 必ず末尾に追加する
+            puts "@failed: #{@failed.inspect}"
+            raise e
+          else
+            @failed.delete("#{@options[:host]}:#{@options[:port]}") if @failed
+          end
+        end
+      else
+        connect_without_sentinel
+      end
+    end
+
+    def discover_slave
+      while true
+        try_next_sentinel
+        host_attrs = fetch_slaves
+        host_attrs.each do |attrs|
+          begin
+            host, port = attrs["ip"], attrs["port"]
+            if host && port
+              # An ip:port pair
+              @options.merge!(:host => host, :port => port.to_i, :password => @master_password)
+              refresh_sentinels_list
+              return
+            else
+              # A null reply
+            end
+          rescue Redis::CommandError => e
+            raise unless e.message.include?("IDONTKNOW")
+          rescue Redis::CannotConnectError
+            # faile to connect to current sentinel server
+          end
+        end
+      end
+    end
+
+    MASTER_PRIORITY = 0
+
+    def fetch_slaves
+      preferred_indexes = []
+      slave_attrs_array = current_sentinel.sentinel("slaves", @master_name).map{|pairs| Hash[*pairs]}
+      # masterと同じサーバで動作しているクライアントの場合、slaveではなく
+      # masterに繋ぐべきなのでマスタも接続先に追加します。
+      master_attrs_array = slave_attrs_array.map{|h|
+        {"ip" => h["master-host"], "port" => h["master-port"], "slave-priority" => MASTER_PRIORITY}
+      }.uniq
+      attrs_array = slave_attrs_array + master_attrs_array
+      [*self.class.ip_and_hostnames, "127.0.0.1", "localhost"].compact.each do |ip_hostname|
+        if idx = attrs_array.index{|attrs| attrs["ip"] ==  ip_hostname}
+          preferred_indexes << idx
+        end
+      end
+      # slave-priorityの値が小さいほどmasterに昇格しやすいので、
+      # preferredではないslaves群についてはslave-priorityの降順で接続の優先順位を振ります。
+      not_preferred = ((0...attrs_array.length).to_a - preferred_indexes).
+        sort_by{|i| attrs_array[i]["slave-priority"].to_i}.reverse
+      result = (preferred_indexes + not_preferred).map{|i| attrs_array[i]}
+      # 接続に失敗した接続先は優先度を下げます
+      puts "@failed: #{@failed.inspect}"
+      (@failed || []).each do |failed|
+        if idx = result.index{|r| failed == "#{r['ip']}:#{r['port']}" }
+          result.push(result.delete_at(idx))
+        end
+      end
+      return result
+    rescue Exception => e
+      puts "[#{e.class}] #{e.message}\n  " << e.backtrace.join("\n  ")
+      raise e
+    end
+    private :fetch_slaves
+
+    def self.ip_and_hostnames
+      unless @my_hostname
+        @my_hostname = Socket::gethostname rescue nil
+        @my_ip = IPSocket::getaddress(@my_hostname) rescue nil
+      end
+      return @my_hostname, @my_ip
+    end
+
+  end
+end

data/lib/redis_wmrs/version.rb

@@ -0,0 +1,3 @@
+module RedisWmrs
+  VERSION = "0.0.1"
+end

data/lib/redis_wmrs.rb

@@ -0,0 +1,16 @@
+require "redis_wmrs/version"
+
+require "redis"
+require 'redis-sentinel'
+
+module RedisWmrs
+
+  autoload :Impl       , 'redis_wmrs/impl'
+  autoload :Dispatcher , 'redis_wmrs/dispatcher'
+  autoload :SlaveClient, 'redis_wmrs/slave_client'
+
+  def self.new(options = {})
+    RedisWmrs::Impl.new(options)
+  end
+
+end

data/redis_wmrs.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_wmrs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_wmrs"
+  spec.version       = RedisWmrs::VERSION
+  spec.authors       = ["akima"]
+  spec.email         = ["akima@groovenauts.jp"]
+  spec.description   = %q{redis client to write to master node and read from slave node}
+  spec.summary       = %q{redis client to write to master node and read from slave node}
+  spec.homepage      = "https://github.com/groovenauts/redis_wmrs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "redis"         , "~> 3.0.0"
+  spec.add_runtime_dependency "redis-sentinel", "~> 1.4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/redis_wmrs_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RedisWmrs do
+  it 'should have a version number' do
+    RedisWmrs::VERSION.should_not be_nil
+  end
+
+  it 'should do something useful' do
+    false.should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'redis_wmrs'

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: redis_wmrs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- akima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: redis-sentinel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: redis client to write to master node and read from slave node
+email:
+- akima@groovenauts.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/test.rb
+- lib/redis_wmrs.rb
+- lib/redis_wmrs/dispatcher.rb
+- lib/redis_wmrs/impl.rb
+- lib/redis_wmrs/slave_client.rb
+- lib/redis_wmrs/version.rb
+- redis_wmrs.gemspec
+- spec/redis_wmrs_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/groovenauts/redis_wmrs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: redis client to write to master node and read from slave node
+test_files:
+- spec/redis_wmrs_spec.rb
+- spec/spec_helper.rb
+has_rdoc: