redis-cluster-activesupport 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41a552daa168903056def19dfee44dbb70ced2b1
+  data.tar.gz: f62493d655a4e333afd44a6b83558a416bc83eb3
+SHA512:
+  metadata.gz: 7a93ea6b63fd8193ec17d85870b8bed1d3fa90dc6b32b2ba237d86b47e5de477900c467b769a5bd496898406c6f2c53a8daea9d649b4ff891e0929db016394ac
+  data.tar.gz: a15320ac7087fbecd4f3390e6cec06925d8dc582e3269a174f5b9dd58a4b9b3581d1c4c93c5cec5ec267952b3ea156665f63d500943e9be7f8254d539bebca63

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+ - 2.4
+ - 2.3
+sudo: false
+cache: bundler
+notifications:
+  email:
+    on_success: never
+    on_failure: always

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Garrett Thornburg
+
+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,71 @@
+# Redis cluster stores for ActiveSupport [![Build Status](https://travis-ci.org/film42/redis-cluster-activesupport.svg?branch=master)](https://travis-ci.org/film42/redis-cluster-activesupport)
+
+This gem is an extension to [redis-activesupport](https://github.com/redis-store/redis-activesupport) that adds support
+for a few features required to use `redis-store` with redis cluster. Right now there isn't an official redis cluster
+client in ruby, so it's become common to use a redis cluster proxy like [corvus](https://github.com/eleme/corvus). When
+switching there are a few things you can't do with redis cluster that you can do with a single redis server. Most of
+them revolve around issuing commands with multiple keys. In redis cluster, your keys are partitioned and live on
+different physical servers, operations like `KEYS` are not possible. Corvus will break apart `MSET` and `MGET` into
+individual `GET` and `SET` commands automatically, but in general, it's not a good idea to use them.
+
+## Usage
+
+This gem is a small extension to `redis-activesupport`, so refer to their documentation for most configuration. Instead
+of specifying `:redis_store` you must now specify `:redis_cluster_store` to load this extension.
+
+```ruby
+module MyProject
+  class Application < Rails::Application
+    config.cache_store = :redis_cluster_store, options
+  end
+end
+```
+
+Additionally, there's a new configuration option: `:ignored_command_errors`. This is useful if you're using a redis
+cluster proxy like corvus who will raise a `Redis::CommandError` with a message indicating the cluster is offline or
+experiencing a partial outage. This extension allows you to whitelist certain `ignored_command_errors` that would
+normally be raised by `redis-activesupport`. By default this gem whitelists the following errors:
+
+```ruby
+DEFAULT_IGNORED_COMMAND_ERRORS = ["ERR Proxy error"]
+```
+
+If you need additional errors added to the whitelist, you can do this through your own configuration or open a pull
+request to add it to the default whitelist. NOTE: this list is turned into a `Set` to keep lookups fast, so feel free to
+make this list as big as you need. Example:
+
+```ruby
+module MyProject
+  class Application < Rails::Application
+    config.cache_store = :redis_cluster_store, {:ignored_command_errors => ["Uh oh", "Please, stop", "Fire emoji"]}
+  end
+end
+```
+
+With this change, your cache store will now silently fail once again so a redis cluster won't knock your rails apps
+offline.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "redis-cluster-activesupport"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-cluster-activesupport
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/film42/redis-cluster-activesupport.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis/activesupport/cluster"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_support/cache/redis_cluster_store.rb

@@ -0,0 +1,49 @@
+require "redis-activesupport"
+require "set"
+
+module ActiveSupport
+  module Cache
+    class RedisClusterStore < RedisStore
+      attr_reader :ignored_command_errors
+
+      DEFAULT_IGNORED_COMMAND_ERRORS = ["ERR Proxy error"].freeze
+
+      def initialize(*)
+        super
+        @ignored_command_errors = ::Set.new(@options.fetch(:ignored_command_errors, DEFAULT_IGNORED_COMMAND_ERRORS))
+      end
+
+      def delete_entry(key, options)
+        super
+      rescue Redis::CommandError => error
+        raise unless ignored_command_errors.include?(error.message)
+        raise if raise_errors?
+        false
+      end
+
+      def delete_matched(matcher, options = nil)
+        fail ::NotImplementedError, "Deleting keys with a matcher is not supported with redis cluster"
+      end
+
+      def fetch_multi(*names)
+        fail ::NotImplementedError, "The default implementation uses MULTI which isn't supported. This can be changed to use MSET and work."
+      end
+
+      def read_entry(key, options)
+        super
+      rescue Redis::CommandError => error
+        raise unless ignored_command_errors.include?(error.message)
+        raise if raise_errors?
+        nil
+      end
+
+      def write_entry(key, entry, options)
+        super
+      rescue Redis::CommandError => error
+        raise unless ignored_command_errors.include?(error.message)
+        raise if raise_errors?
+        false
+      end
+    end
+  end
+end

data/lib/redis/cluster/activesupport.rb

@@ -0,0 +1 @@
+require "active_support/cache/redis_cluster_store"

data/redis-cluster-activesupport.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-cluster-activesupport"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Garrett Thornburg"]
+  spec.email         = ["film42@gmail.com"]
+
+  spec.summary       = "Extension to redis-activesupport for working with redis cluster"
+  spec.description   = "Extension to redis-activesupport for working with redis cluster"
+  spec.homepage      = "https://github.com/film42/redis-cluster-activesupport"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis-activesupport"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: redis-cluster-activesupport
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garrett Thornburg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Extension to redis-activesupport for working with redis cluster
+email:
+- film42@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/active_support/cache/redis_cluster_store.rb
+- lib/redis/cluster/activesupport.rb
+- redis-cluster-activesupport.gemspec
+homepage: https://github.com/film42/redis-cluster-activesupport
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Extension to redis-activesupport for working with redis cluster
+test_files: []