rails3-redis-session-store 0.1.7

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mathias Meyer
+
+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 @@
+A simple Redis-based session store for Redis. But why, you ask,
+when there's [redis-store](http://github.com/jodosha/redis-store/)?
+redis-store is a one-fits-all solution, and I found it not to work
+properly with Rails, mostly due to a problem that seemed to lie in
+Rack's Abstract::ID class. I wanted something that worked, so I
+blatantly stole the code from Rails' MemCacheStore and turned it
+into a Redis version. No support for fancy stuff like distributed
+storage across several Redis instances. Feel free to add what you
+seem fit.
+
+This library doesn't offer anything related to caching, and is
+only suitable for Rails applications. For other frameworks or
+drop-in support for caching, check out
+[redis-store](http://github.com/jodosha/redis-store/)
+
+Installation
+============
+
+    gem install redis-session-store
+
+Configuration
+=============
+
+See lib/redis-session-store.rb for a list of valid options.
+Set them using:
+
+    ActionController::Base.session = {
+      :db => 2,
+      :expire_after => 120.minutes,
+      :key_prefix => "myapp:session:"
+    }
+    
+
+In your Rails app, throw in an initializer with the following contents
+and the configuration above:
+
+    ActionController::Base.session_store = RedisSessionStore

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'rails3-redis-session-store'
+  s.version = '0.1.7'
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["LICENSE"]
+  s.summary = "A drop-in replacement for e.g. MemCacheStore to store Rails sessions (and Rails sessions only) in Redis."
+  s.description = s.summary
+  s.authors = "Mathias Meyer"
+  s.email = "meyer@paperplanes.de"
+  s.homepage = "http://github.com/mattmatt/redis-session-store"
+  s.add_dependency "redis"
+  s.require_path = 'lib'
+  s.files = %w(README.md Rakefile) + Dir.glob("{lib}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/lib/redis-session-store.rb

@@ -0,0 +1,69 @@
+require 'redis'
+
+module ActionDispatch
+  module Session
+
+    # Redis session storage for Rails, and for Rails only. Derived from
+    # the MemCacheStore code, simply dropping in Redis instead.
+    #
+    # Options:
+    #  :key     => Same as with the other cookie stores, key name
+    #  :secret  => Encryption secret for the key
+    #  :host    => Redis host name, default is localhost
+    #  :port    => Redis port, default is 6379
+    #  :db      => Database number, defaults to 0. Useful to separate your session storage from other data
+    #  :key_prefix  => Prefix for keys used in Redis, e.g. myapp-. Useful to separate session storage keys visibly from others
+    #  :expire_after => A number in seconds to set the timeout interval for the session. Will map directly to expiry in Redis
+
+    class RedisSessionStore < AbstractStore
+
+      def initialize(app, options = {})
+        # Support old :expires option
+        options[:expire_after] ||= options[:expires]
+
+        super
+
+        @default_options = {
+          :namespace => 'rack:session',
+          :host => 'localhost',
+          :port => '6379',
+          :db => 0,
+          :key_prefix => ""
+        }.update(options)
+
+        @pool = Redis.new(@default_options)
+      end
+
+      private
+        def prefixed(sid)
+          "#{@default_options[:key_prefix]}#{sid}"
+        end
+    
+        def get_session(env, sid)
+          sid ||= generate_sid
+          begin
+            data = @pool.call_command([:get, prefixed(sid)])
+            session = data.nil? ? {} : Marshal.load(data)
+          rescue Errno::ECONNREFUSED
+            session = {}
+          end
+          [sid, session]
+        end
+
+        def set_session(env, sid, session_data)
+          options = env['rack.session.options']
+          expiry  = options[:expire_after] || nil
+      
+          @pool.pipelined do |redis|
+            redis.set(prefixed(sid), Marshal.dump(session_data))
+            redis.expire(prefixed(sid), expiry) if expiry
+          end
+        
+          return true
+        rescue Errno::ECONNREFUSED
+          return false
+        end
+  
+    end
+end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: rails3-redis-session-store
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 7
+  version: 0.1.7
+platform: ruby
+authors: 
+- Mathias Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A drop-in replacement for e.g. MemCacheStore to store Rails sessions (and Rails sessions only) in Redis.
+email: meyer@paperplanes.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- README.md
+- Rakefile
+- lib/redis-session-store.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/mattmatt/redis-session-store
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A drop-in replacement for e.g. MemCacheStore to store Rails sessions (and Rails sessions only) in Redis.
+test_files: []
+