goncalossilva_redis-session-store 0.1.8

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Mathias Meyer
+
+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,46 @@
+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 = {
+      :key          => 'your_session_key',
+      :secret       => 'your_long_secret',
+      :redis        => {
+        :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
+
+Changes
+=======
+
+* Use setex for a single command instead of sending two commands. (Thanks dplummer)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/redis-session-store.rb

@@ -0,0 +1,61 @@
+require 'redis'
+
+# 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 < ActionController::Session::AbstractStore
+
+  def initialize(app, options = {})
+    super
+
+    redis_options = {}
+    @default_options.merge!(:namespace => 'rack:session')
+    @default_options.merge!(options[:redis]) if options[:redis]
+
+    @redis = Redis.new(redis_options)
+  end
+
+  private
+    def prefixed(sid)
+      "#{@default_options[:key_prefix]}#{sid}"
+    end
+
+    def get_session(env, sid)
+      sid ||= generate_sid
+      begin
+        data = @redis.get(prefixed(sid))
+        session = data.nil? ? {} : Marshal.load(ActiveSupport::Base64.decode64(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
+      if expiry
+        @redis.setex(prefixed(sid), expiry, ActiveSupport::Base64.encode64(Marshal.dump(session_data))) if session_data
+      else
+        @redis.set(prefixed(sid), ActiveSupport::Base64.encode64(Marshal.dump(session_data))) if session_data
+      end
+      return true
+    rescue Errno::ECONNREFUSED
+      return false
+    end
+
+    def destroy(env)
+      @redis.del prefixed(env['rack.request.cookie_hash'][@key])
+    rescue
+      Rails.logger.warn("RedisSessionStore#destroy: Connection to redis refused")
+    end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: goncalossilva_redis-session-store
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+  prerelease: 
+platform: ruby
+authors:
+- Mathias Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70119372463320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70119372463320
+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
+homepage: http://github.com/goncalossilva/redis-session-store
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+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: []