Merge pull request #364 from grzuy/dont_require_redis_for_memory_store

[Fixes #355] Don't require redis if not necessary

.travis.yml

@@ -27,6 +27,11 @@ gemfile:
   - gemfiles/rails_5_1.gemfile
   - gemfiles/rails_4_2.gemfile
   - gemfiles/dalli2.gemfile
+  - gemfiles/connection_pool_dalli.gemfile
+  - gemfiles/active_support_redis_cache_store.gemfile
+  - gemfiles/active_support_redis_cache_store_pooled.gemfile
+  - gemfiles/redis_store.gemfile
+  - gemfiles/active_support_redis_store.gemfile
 
 matrix:
   allow_failures:

Appraisals

@@ -32,3 +32,27 @@ end
 appraise 'dalli2' do
   gem 'dalli', '~> 2.0'
 end
+
+appraise "connection_pool_dalli" do
+  gem "connection_pool", "~> 2.2"
+  gem "dalli", "~> 2.7"
+end
+
+appraise "active_support_redis_cache_store" do
+  gem "activesupport", "~> 5.2.0"
+  gem "redis", "~> 4.0"
+end
+
+appraise "active_support_redis_cache_store_pooled" do
+  gem "activesupport", "~> 5.2.0"
+  gem "connection_pool", "~> 2.2"
+  gem "redis", "~> 4.0"
+end
+
+appraise "redis_store" do
+  gem "redis-store", "~> 1.5"
+end
+
+appraise "active_support_redis_store" do
+  gem "redis-activesupport", "~> 5.0"
+end

gemfiles/active_support_redis_cache_store.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.2.0"
+gem "redis", "~> 4.0"
+
+gemspec path: "../"

gemfiles/active_support_redis_cache_store_pooled.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.2.0"
+gem "connection_pool", "~> 2.2"
+gem "redis", "~> 4.0"
+
+gemspec path: "../"

gemfiles/active_support_redis_store.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "redis-activesupport", "~> 5.0"
+
+gemspec path: "../"

gemfiles/connection_pool_dalli.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "connection_pool", "~> 2.2"
+gem "dalli", "~> 2.7"
+
+gemspec path: "../"

gemfiles/redis_store.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "redis-store", "~> 1.5"
+
+gemspec path: "../"

lib/rack/attack/store_proxy/redis_cache_store_proxy.rb

@@ -5,7 +5,7 @@ module Rack
     module StoreProxy
       class RedisCacheStoreProxy < SimpleDelegator
         def self.handle?(store)
-          defined?(::ActiveSupport::Cache::RedisCacheStore) && store.is_a?(::ActiveSupport::Cache::RedisCacheStore)
+          defined?(::Redis) && defined?(::ActiveSupport::Cache::RedisCacheStore) && store.is_a?(::ActiveSupport::Cache::RedisCacheStore)
         end
 
         def increment(name, amount = 1, options = {})

rack-attack.gemspec

@@ -48,7 +48,4 @@ Gem::Specification.new do |s|
   # which rack-attack uses only for testing compatibility in test suite.
   s.add_development_dependency 'actionpack', '>= 3.0.0'
   s.add_development_dependency 'activesupport', '>= 3.0.0'
-  s.add_development_dependency 'connection_pool'
-  s.add_development_dependency 'dalli'
-  s.add_development_dependency 'redis-activesupport'
 end

spec/acceptance/stores/active_support_dalli_store_spec.rb

@@ -1,39 +1,41 @@
 require_relative "../../spec_helper"
-require_relative "../../support/cache_store_helper"
 
-require "active_support/cache/dalli_store"
-require "timecop"
+if defined?(::Dalli)
+  require_relative "../../support/cache_store_helper"
+  require "active_support/cache/dalli_store"
+  require "timecop"
 
-describe "ActiveSupport::Cache::DalliStore as a cache backend" do
-  before do
-    Rack::Attack.cache.store = ActiveSupport::Cache::DalliStore.new
-  end
-
-  after do
-    Rack::Attack.cache.store.clear
-  end
-
-  it_works_for_cache_backed_features
-
-  it "doesn't leak keys" do
-    Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
-      request.ip
+  describe "ActiveSupport::Cache::DalliStore as a cache backend" do
+    before do
+      Rack::Attack.cache.store = ActiveSupport::Cache::DalliStore.new
     end
 
-    key = nil
-
-    # Freeze time during these statement to be sure that the key used by rack attack is the same
-    # we pre-calculate in local variable `key`
-    Timecop.freeze do
-      key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
-
-      get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+    after do
+      Rack::Attack.cache.store.clear
     end
 
-    assert Rack::Attack.cache.store.fetch(key)
+    it_works_for_cache_backed_features
 
-    sleep 2.1
+    it "doesn't leak keys" do
+      Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
+        request.ip
+      end
 
-    assert_nil Rack::Attack.cache.store.fetch(key)
+      key = nil
+
+      # Freeze time during these statement to be sure that the key used by rack attack is the same
+      # we pre-calculate in local variable `key`
+      Timecop.freeze do
+        key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
+
+        get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+      end
+
+      assert Rack::Attack.cache.store.fetch(key)
+
+      sleep 2.1
+
+      assert_nil Rack::Attack.cache.store.fetch(key)
+    end
   end
 end

spec/acceptance/stores/active_support_mem_cache_store_spec.rb

@@ -1,38 +1,40 @@
 require_relative "../../spec_helper"
-require_relative "../../support/cache_store_helper"
 
-require "timecop"
+if defined?(::Dalli)
+  require_relative "../../support/cache_store_helper"
+  require "timecop"
 
-describe "ActiveSupport::Cache::MemCacheStore as a cache backend" do
-  before do
-    Rack::Attack.cache.store = ActiveSupport::Cache::MemCacheStore.new
-  end
-
-  after do
-    Rack::Attack.cache.store.flush_all
-  end
-
-  it_works_for_cache_backed_features
-
-  it "doesn't leak keys" do
-    Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
-      request.ip
+  describe "ActiveSupport::Cache::MemCacheStore as a cache backend" do
+    before do
+      Rack::Attack.cache.store = ActiveSupport::Cache::MemCacheStore.new
     end
 
-    key = nil
-
-    # Freeze time during these statement to be sure that the key used by rack attack is the same
-    # we pre-calculate in local variable `key`
-    Timecop.freeze do
-      key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
-
-      get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+    after do
+      Rack::Attack.cache.store.flush_all
     end
 
-    assert Rack::Attack.cache.store.get(key)
+    it_works_for_cache_backed_features
 
-    sleep 2.1
+    it "doesn't leak keys" do
+      Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
+        request.ip
+      end
 
-    assert_nil Rack::Attack.cache.store.get(key)
+      key = nil
+
+      # Freeze time during these statement to be sure that the key used by rack attack is the same
+      # we pre-calculate in local variable `key`
+      Timecop.freeze do
+        key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
+
+        get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+      end
+
+      assert Rack::Attack.cache.store.get(key)
+
+      sleep 2.1
+
+      assert_nil Rack::Attack.cache.store.get(key)
+    end
   end
 end

spec/acceptance/stores/active_support_redis_cache_store_pooled_spec.rb

@@ -1,9 +1,9 @@
 require_relative "../../spec_helper"
-require_relative "../../support/cache_store_helper"
 
-require "timecop"
+if defined?(::ConnectionPool) && defined?(::Redis) && defined?(::ActiveSupport::Cache::RedisCacheStore)
+  require_relative "../../support/cache_store_helper"
+  require "timecop"
 
-if ActiveSupport.version >= Gem::Version.new("5.2.0")
   describe "ActiveSupport::Cache::RedisCacheStore (pooled) as a cache backend" do
     before do
       Rack::Attack.cache.store = ActiveSupport::Cache::RedisCacheStore.new(pool_size: 2)

spec/acceptance/stores/active_support_redis_cache_store_spec.rb

@@ -1,9 +1,9 @@
 require_relative "../../spec_helper"
-require_relative "../../support/cache_store_helper"
 
-require "timecop"
+if defined?(::Redis) && defined?(::ActiveSupport::Cache::RedisCacheStore)
+  require_relative "../../support/cache_store_helper"
+  require "timecop"
 
-if ActiveSupport.version >= Gem::Version.new("5.2.0")
   describe "ActiveSupport::Cache::RedisCacheStore as a cache backend" do
     before do
       Rack::Attack.cache.store = ActiveSupport::Cache::RedisCacheStore.new

spec/acceptance/stores/active_support_redis_store_spec.rb

@@ -1,39 +1,40 @@
 require_relative "../../spec_helper"
-require_relative "../../support/cache_store_helper"
 
-require "redis-activesupport"
-require "timecop"
+if defined?(::ActiveSupport::Cache::RedisStore)
+  require_relative "../../support/cache_store_helper"
+  require "timecop"
 
-describe "ActiveSupport::Cache::RedisStore as a cache backend" do
-  before do
-    Rack::Attack.cache.store = ActiveSupport::Cache::RedisStore.new
-  end
-
-  after do
-    Rack::Attack.cache.store.flushdb
-  end
-
-  it_works_for_cache_backed_features
-
-  it "doesn't leak keys" do
-    Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
-      request.ip
+  describe "ActiveSupport::Cache::RedisStore as a cache backend" do
+    before do
+      Rack::Attack.cache.store = ActiveSupport::Cache::RedisStore.new
     end
 
-    key = nil
-
-    # Freeze time during these statement to be sure that the key used by rack attack is the same
-    # we pre-calculate in local variable `key`
-    Timecop.freeze do
-      key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
-
-      get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+    after do
+      Rack::Attack.cache.store.flushdb
     end
 
-    assert Rack::Attack.cache.store.read(key)
+    it_works_for_cache_backed_features
 
-    sleep 2.1
+    it "doesn't leak keys" do
+      Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
+        request.ip
+      end
 
-    assert_nil Rack::Attack.cache.store.read(key)
+      key = nil
+
+      # Freeze time during these statement to be sure that the key used by rack attack is the same
+      # we pre-calculate in local variable `key`
+      Timecop.freeze do
+        key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
+
+        get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+      end
+
+      assert Rack::Attack.cache.store.read(key)
+
+      sleep 2.1
+
+      assert_nil Rack::Attack.cache.store.read(key)
+    end
   end
 end

spec/acceptance/stores/connection_pool_dalli_client_spec.rb

@@ -1,40 +1,42 @@
 require_relative "../../spec_helper"
-require_relative "../../support/cache_store_helper"
 
-require "connection_pool"
-require "dalli"
-require "timecop"
+if defined?(::Dalli) && defined?(::ConnectionPool)
+  require_relative "../../support/cache_store_helper"
+  require "connection_pool"
+  require "dalli"
+  require "timecop"
 
-describe "ConnectionPool with Dalli::Client as a cache backend" do
-  before do
-    Rack::Attack.cache.store = ConnectionPool.new { Dalli::Client.new }
-  end
-
-  after do
-    Rack::Attack.cache.store.with { |client| client.flush_all }
-  end
-
-  it_works_for_cache_backed_features
-
-  it "doesn't leak keys" do
-    Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
-      request.ip
+  describe "ConnectionPool with Dalli::Client as a cache backend" do
+    before do
+      Rack::Attack.cache.store = ConnectionPool.new { Dalli::Client.new }
     end
 
-    key = nil
-
-    # Freeze time during these statement to be sure that the key used by rack attack is the same
-    # we pre-calculate in local variable `key`
-    Timecop.freeze do
-      key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
-
-      get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+    after do
+      Rack::Attack.cache.store.with { |client| client.flush_all }
     end
 
-    assert(Rack::Attack.cache.store.with { |client| client.fetch(key) })
+    it_works_for_cache_backed_features
 
-    sleep 2.1
+    it "doesn't leak keys" do
+      Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
+        request.ip
+      end
 
-    assert_nil(Rack::Attack.cache.store.with { |client| client.fetch(key) })
+      key = nil
+
+      # Freeze time during these statement to be sure that the key used by rack attack is the same
+      # we pre-calculate in local variable `key`
+      Timecop.freeze do
+        key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
+
+        get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+      end
+
+      assert(Rack::Attack.cache.store.with { |client| client.fetch(key) })
+
+      sleep 2.1
+
+      assert_nil(Rack::Attack.cache.store.with { |client| client.fetch(key) })
+    end
   end
 end

spec/acceptance/stores/dalli_client_spec.rb

@@ -1,39 +1,41 @@
 require_relative "../../spec_helper"
-require_relative "../../support/cache_store_helper"
 
-require "dalli"
-require "timecop"
+if defined?(::Dalli)
+  require_relative "../../support/cache_store_helper"
+  require "dalli"
+  require "timecop"
 
-describe "Dalli::Client as a cache backend" do
-  before do
-    Rack::Attack.cache.store = Dalli::Client.new
-  end
-
-  after do
-    Rack::Attack.cache.store.flush_all
-  end
-
-  it_works_for_cache_backed_features
-
-  it "doesn't leak keys" do
-    Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
-      request.ip
+  describe "Dalli::Client as a cache backend" do
+    before do
+      Rack::Attack.cache.store = Dalli::Client.new
     end
 
-    key = nil
-
-    # Freeze time during these statement to be sure that the key used by rack attack is the same
-    # we pre-calculate in local variable `key`
-    Timecop.freeze do
-      key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
-
-      get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+    after do
+      Rack::Attack.cache.store.flush_all
     end
 
-    assert Rack::Attack.cache.store.fetch(key)
+    it_works_for_cache_backed_features
 
-    sleep 2.1
+    it "doesn't leak keys" do
+      Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
+        request.ip
+      end
 
-    assert_nil Rack::Attack.cache.store.fetch(key)
+      key = nil
+
+      # Freeze time during these statement to be sure that the key used by rack attack is the same
+      # we pre-calculate in local variable `key`
+      Timecop.freeze do
+        key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
+
+        get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+      end
+
+      assert Rack::Attack.cache.store.fetch(key)
+
+      sleep 2.1
+
+      assert_nil Rack::Attack.cache.store.fetch(key)
+    end
   end
 end

spec/acceptance/stores/redis_store_spec.rb

@@ -1,39 +1,40 @@
 require_relative "../../spec_helper"
 require_relative "../../support/cache_store_helper"
 
-require "redis-store"
-require "timecop"
+if defined?(::Redis::Store)
+  require "timecop"
 
-describe "ActiveSupport::Cache::RedisStore as a cache backend" do
-  before do
-    Rack::Attack.cache.store = ::Redis::Store.new
-  end
-
-  after do
-    Rack::Attack.cache.store.flushdb
-  end
-
-  it_works_for_cache_backed_features
-
-  it "doesn't leak keys" do
-    Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
-      request.ip
+  describe "ActiveSupport::Cache::RedisStore as a cache backend" do
+    before do
+      Rack::Attack.cache.store = ::Redis::Store.new
     end
 
-    key = nil
-
-    # Freeze time during these statement to be sure that the key used by rack attack is the same
-    # we pre-calculate in local variable `key`
-    Timecop.freeze do
-      key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
-
-      get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+    after do
+      Rack::Attack.cache.store.flushdb
     end
 
-    assert Rack::Attack.cache.store.read(key)
+    it_works_for_cache_backed_features
 
-    sleep 2.1
+    it "doesn't leak keys" do
+      Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
+        request.ip
+      end
 
-    assert_nil Rack::Attack.cache.store.read(key)
+      key = nil
+
+      # Freeze time during these statement to be sure that the key used by rack attack is the same
+      # we pre-calculate in local variable `key`
+      Timecop.freeze do
+        key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
+
+        get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+      end
+
+      assert Rack::Attack.cache.store.read(key)
+
+      sleep 2.1
+
+      assert_nil Rack::Attack.cache.store.read(key)
+    end
   end
 end

spec/integration/offline_spec.rb

@@ -1,6 +1,4 @@
 require 'active_support/cache'
-require 'redis-activesupport'
-require 'dalli'
 require_relative '../spec_helper'
 
 OfflineExamples = Minitest::SharedExamples.new do
@@ -17,27 +15,31 @@ OfflineExamples = Minitest::SharedExamples.new do
   end
 end
 
-describe 'when Redis is offline' do
-  include OfflineExamples
+if defined?(::ActiveSupport::Cache::RedisStore)
+  describe 'when Redis is offline' do
+    include OfflineExamples
 
-  before do
-    @cache = Rack::Attack::Cache.new
-    # Use presumably unused port for Redis client
-    @cache.store = ActiveSupport::Cache::RedisStore.new(:host => '127.0.0.1', :port => 3333)
+    before do
+      @cache = Rack::Attack::Cache.new
+      # Use presumably unused port for Redis client
+      @cache.store = ActiveSupport::Cache::RedisStore.new(:host => '127.0.0.1', :port => 3333)
+    end
   end
 end
 
-describe 'when Memcached is offline' do
-  include OfflineExamples
+if defined?(::Dalli)
+  describe 'when Memcached is offline' do
+    include OfflineExamples
 
-  before do
-    Dalli.logger.level = Logger::FATAL
+    before do
+      Dalli.logger.level = Logger::FATAL
 
-    @cache = Rack::Attack::Cache.new
-    @cache.store = Dalli::Client.new('127.0.0.1:22122')
-  end
+      @cache = Rack::Attack::Cache.new
+      @cache.store = Dalli::Client.new('127.0.0.1:22122')
+    end
 
-  after do
-    Dalli.logger.level = Logger::INFO
+    after do
+      Dalli.logger.level = Logger::INFO
+    end
   end
 end

spec/spec_helper.rb

@@ -13,6 +13,19 @@ if RUBY_ENGINE == "ruby"
   require "byebug"
 end
 
+def safe_require(name)
+  begin
+    require name
+  rescue LoadError
+  end
+end
+
+safe_require "connection_pool"
+safe_require "dalli"
+safe_require "redis"
+safe_require "redis-activesupport"
+safe_require "redis-store"
+
 class MiniTest::Spec
   include Rack::Test::Methods