redis-rack 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea9e8af24cb2b8cef86500d98934f84122c07443
-  data.tar.gz: 7d86691418586edeeaa29732185ed94db70b4818
+  metadata.gz: 66572ef2577985ef4e66d8eff099b41cd2522452
+  data.tar.gz: 021ff43d18f10505f52187456132922eddea15b8
 SHA512:
-  metadata.gz: 1c0eef6bd5df36c175f431075feb97de8c582cc6bf5df53b95b58977a125053071dc200ac17b3524280850142c72e0f41950ddf581a30aa1c85c82123429e1be
-  data.tar.gz: da4347e50edbed58a98a461caa57791819195cdd8ba6458144f0e4d0080604eaed0613d6f190479c7970a477a2d14542490f70988b03ca602a99f98b6a2bf845
+  metadata.gz: dd6ac3b843ebadac7e56d802680badd2163ac0320a90377e94f730465c739ee74738e5c2b347a34c4fae1b6d94160a8f988c8e748ab540c820750ed7792b2ae0
+  data.tar.gz: b26ae6bfb3306d19260454d41ce2559e88997365bfc713c10fd33168b8e70ea052b45be7fed5e5370a8c36b0b66c5415935df19d77ae2a6cef1db64fd925e36c

data/README.md

@@ -42,6 +42,11 @@ require 'rack'
 require 'rack/session/redis'
 
 use Rack::Session::Redis
+
+# Alternatively you can specify options to use:
+use Rack::Session::Redis,
+  :redis_server => "redis://redis:6379/0",
+  :expires_in => 3600 # Seconds. If you are using ActiveSupport you can use 1.hour
 ```
 
 ## Development

data/lib/rack/session/redis.rb

@@ -1,38 +1,26 @@
 require 'rack/session/abstract/id'
 require 'redis-store'
 require 'thread'
+require 'redis/rack/connection'
 
 module Rack
   module Session
     class Redis < Abstract::ID
-      attr_reader :mutex, :pool
+      attr_reader :mutex
 
-      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge \
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge(
         :redis_server => 'redis://127.0.0.1:6379/0/rack:session'
+      )
 
       def initialize(app, options = {})
         super
 
         @mutex = Mutex.new
-        @pool = if @default_options[:pool]
-                 raise "pool must be an instance of ConnectionPool" unless @default_options[:pool].is_a?(ConnectionPool)
-                  @pooled = true
-                  @default_options[:pool]
-                elsif [:pool_size, :pool_timeout].any? { |key| @default_options.has_key?(key) }
-                  pool_options           = {}
-                  pool_options[:size]    = options[:pool_size] if options[:pool_size]
-                  pool_options[:timeout] = options[:pool_timeout] if options[:pool_timeout]
-                  @pooled = true
-                  ::ConnectionPool.new(pool_options) { ::Redis::Store::Factory.create(@default_options[:redis_server]) }
-                else
-                  @default_options.has_key?(:redis_store) ?
-                    @default_options[:redis_store] :
-                    ::Redis::Store::Factory.create(@default_options[:redis_server])
-
-                end
+        @conn = ::Redis::Rack::Connection.new(@default_options)
       end
 
       def generate_unique_sid(session)
+        return generate_sid if session.empty?
         loop do
           sid = generate_sid
           first = with do |c|
@@ -88,13 +76,8 @@ module Rack
       end
 
       def with(&block)
-        if @pooled
-          @pool.with(&block)
-        else
-          block.call(@pool)
-        end
+        @conn.with(&block)
       end
-
     end
   end
 end

data/lib/redis/rack/connection.rb

@@ -0,0 +1,42 @@
+class Redis
+  module Rack
+    class Connection
+      def initialize(options = {})
+        @options = options
+        @store = options[:redis_store]
+        @pool = options[:pool]
+
+        if @pool && !@pool.is_a?(ConnectionPool)
+          raise ArgumentError, "pool must be an instance of ConnectionPool"
+        end
+      end
+
+      def with(&block)
+        if pooled?
+          pool.with(&block)
+        else
+          block.call(store)
+        end
+      end
+
+      def pooled?
+        [:pool, :pool_size, :pool_timeout].any? { |key| @options.key?(key) }
+      end
+
+      def pool
+        @pool ||= ConnectionPool.new(pool_options) { store } if pooled?
+      end
+
+      def store
+        @store ||= Redis::Store::Factory.create(@options[:redis_server])
+      end
+
+      def pool_options
+        {
+          size: @options[:pool_size],
+          timeout: @options[:pool_timeout]
+        }
+      end
+    end
+  end
+end

data/lib/redis/rack/version.rb

@@ -1,6 +1,6 @@
 class Redis
   module Rack
-    VERSION = '2.0.4'
+    VERSION = '2.0.5'
   end
 end
 

data/test/rack/session/redis_test.rb

@@ -39,8 +39,9 @@ describe Rack::Session::Redis do
 
   it "can create it's own pool" do
     session_store = Rack::Session::Redis.new(incrementor, pool_size: 5, pool_timeout: 10)
-    session_store.pool.class.must_equal ::ConnectionPool
-    session_store.pool.instance_variable_get(:@size).must_equal 5
+    conn = session_store.instance_variable_get(:@conn)
+    conn.pool.class.must_equal ::ConnectionPool
+    conn.pool.instance_variable_get(:@size).must_equal 5
   end
 
   it "can create it's own pool using default Redis server" do
@@ -55,30 +56,33 @@ describe Rack::Session::Redis do
 
   it "can use a supplied pool" do
     session_store = Rack::Session::Redis.new(incrementor, pool: ::ConnectionPool.new(size: 1, timeout: 1) { ::Redis::Store::Factory.create("redis://127.0.0.1:6380/1")})
-    session_store.pool.class.must_equal ::ConnectionPool
-    session_store.pool.instance_variable_get(:@size).must_equal 1
+    conn = session_store.instance_variable_get(:@conn)
+    conn.pool.class.must_equal ::ConnectionPool
+    conn.pool.instance_variable_get(:@size).must_equal 1
   end
 
   it "uses the specified Redis store when provided" do
     store = ::Redis::Store::Factory.create('redis://127.0.0.1:6380/1')
     pool = Rack::Session::Redis.new(incrementor, :redis_store => store)
-    pool.pool.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/)
-    pool.pool.must_equal(store)
+    pool.with do |p|
+      p.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/)
+      p.must_equal(store)
+    end
   end
 
   it "uses the default Redis server and namespace when not provided" do
     pool = Rack::Session::Redis.new(incrementor)
-    pool.pool.to_s.must_match(/127\.0\.0\.1:6379 against DB 0 with namespace rack:session$/)
+    pool.with { |p| p.to_s.must_match(/127\.0\.0\.1:6379 against DB 0 with namespace rack:session$/) }
   end
 
   it "uses the specified namespace when provided" do
     pool = Rack::Session::Redis.new(incrementor, :redis_server => {:namespace => 'test:rack:session'})
-    pool.pool.to_s.must_match(/namespace test:rack:session$/)
+    pool.with { |p| p.to_s.must_match(/namespace test:rack:session$/) }
   end
 
   it "uses the specified Redis server when provided" do
     pool = Rack::Session::Redis.new(incrementor, :redis_server => 'redis://127.0.0.1:6380/1')
-    pool.pool.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/)
+    pool.with { |p| p.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/) }
   end
 
   it "is threadsafe by default" do
@@ -86,6 +90,12 @@ describe Rack::Session::Redis do
     sesion_store.threadsafe?.must_equal(true)
   end
 
+  it "does not store a blank session" do
+    session_store = Rack::Session::Redis.new(incrementor)
+    sid = session_store.generate_unique_sid({})
+    session_store.with { |c| c.get(sid).must_be_nil }
+  end
+
   it "locks the store mutex" do
     mutex = Mutex.new
     mutex.expects(:lock).once
@@ -260,15 +270,12 @@ describe Rack::Session::Redis do
   end
 
   it "does not hit with :skip option" do
-    with_pool_management(incrementor) do |pool|
-      skip = Rack::Utils::Context.new(pool, skip_session)
+    with_pool_management(incrementor) do |session_store|
+      skip = Rack::Utils::Context.new(session_store, skip_session)
       sreq = Rack::MockRequest.new(skip)
 
-      pool.instance_variable_set('@pool', MiniTest::Mock.new)
-
       res0 = sreq.get("/")
       res0.body.must_equal('{"counter"=>1}')
-      assert pool.pool.verify
     end
   end
 

data/test/redis/rack/connection_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+require 'connection_pool'
+require 'redis/rack/connection'
+
+class Redis
+  module Rack
+    describe Connection do
+      def setup
+        @defaults = {
+          host: 'localhost'
+        }
+      end
+
+      it "can create it's own pool" do
+        conn = Connection.new @defaults.merge(pool_size: 5, pool_timeout: 10)
+
+        conn.pooled?.must_equal true
+        conn.pool.class.must_equal ConnectionPool
+        conn.pool.instance_variable_get(:@size).must_equal 5
+      end
+
+      it "can create it's own pool using default Redis server" do
+        conn = Connection.new @defaults.merge(pool_size: 5, pool_timeout: 10)
+
+        conn.pooled?.must_equal true
+
+        conn.with do |connection|
+          connection.to_s.must_match(/127\.0\.0\.1:6379 against DB 0$/)
+        end
+      end
+
+      it "can create it's own pool using provided Redis server" do
+        conn = Connection.new(redis_server: 'redis://127.0.0.1:6380/1', pool_size: 5, pool_timeout: 10)
+        conn.pooled?.must_equal true
+        conn.with do |connection|
+          connection.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/)
+        end
+      end
+
+      it "can use a supplied pool" do
+        pool = ConnectionPool.new size: 1, timeout: 1 do
+          ::Redis::Store::Factory.create('redis://127.0.0.1:6380/1')
+        end
+        conn = Connection.new pool: pool
+        conn.pooled?.must_equal true
+        conn.pool.class.must_equal ConnectionPool
+        conn.pool.instance_variable_get(:@size).must_equal 1
+      end
+
+      it "uses the specified Redis store when provided" do
+        store = ::Redis::Store::Factory.create('redis://127.0.0.1:6380/1')
+        conn = Connection.new(redis_store: store)
+
+        conn.pooled?.must_equal false
+        conn.store.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/)
+        conn.store.must_equal(store)
+      end
+
+      it "uses the specified Redis server when provided" do
+        conn = Connection.new(redis_server: 'redis://127.0.0.1:6380/1')
+
+        conn.pooled?.must_equal false
+        conn.store.to_s.must_match(/127\.0\.0\.1:6380 against DB 1$/)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-rack
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-store
@@ -168,9 +168,11 @@ files:
 - gemfiles/rack_2.gemfile
 - lib/rack/session/redis.rb
 - lib/redis-rack.rb
+- lib/redis/rack/connection.rb
 - lib/redis/rack/version.rb
 - redis-rack.gemspec
 - test/rack/session/redis_test.rb
+- test/redis/rack/connection_test.rb
 - test/test_helper.rb
 homepage: http://redis-store.org/redis-rack
 licenses:
@@ -198,4 +200,5 @@ specification_version: 4
 summary: Redis Store for Rack
 test_files:
 - test/rack/session/redis_test.rb
+- test/redis/rack/connection_test.rb
 - test/test_helper.rb