instructure-redis-store 1.0.0.1.instructure1

data/Rakefile

@@ -0,0 +1,60 @@
+$:.unshift 'lib'
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+task :default => "spec:suite"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = "instructure-redis-store"
+    gemspec.summary     = "Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks."
+    gemspec.description = "Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks."
+    gemspec.email       = "brianp@instructure.com"
+    gemspec.homepage    = "http://github.com/instructure/redis-store"
+    gemspec.authors     = [ "Luca Guidi", "Brian Palmer" ]
+    gemspec.executables = [ ]
+    gemspec.add_dependency "redis", "3.0.1"
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+namespace :spec do
+  desc "Run all the examples by starting a detached Redis instance"
+  task :suite => :prepare do
+    invoke_with_redis_replication "spec:run"
+  end
+
+  Spec::Rake::SpecTask.new(:run) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = %w(-fs --color)
+  end
+end
+
+desc "Run all examples with RCov"
+task :rcov => :prepare do
+  invoke_with_redis_replication "rcov_run"
+end
+
+Spec::Rake::SpecTask.new(:rcov_run) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+task :prepare do
+  `mkdir -p tmp && rm tmp/*.rdb`
+end
+
+namespace :bundle do
+  task :clean do
+    system "rm -rf ~/.bundle/ ~/.gem/ .bundle/ Gemfile.lock"
+  end
+end
+
+load "tasks/redis.tasks.rb"

data/VERSION

@@ -0,0 +1 @@
+1.0.0.1.instructure1

data/lib/action_controller/session/redis_session_store.rb

@@ -0,0 +1,81 @@
+require "redis-store"
+
+module RedisStore
+  module Rack
+    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
+      module Rails
+        def initialize(app, options = {})
+          # Support old :expires option
+          options[:expire_after] ||= options[:expires]
+
+          super
+
+          options = options.dup
+          servers = [ options.delete(:servers) ].flatten.compact
+          servers = [ "redis://localhost:6379/0" ] if servers.empty?
+          servers.map! do |server|
+            server = Redis::Factory.convert_to_redis_client_options(server)
+            server.merge(options)
+          end
+
+          @pool = Redis::Factory.create(*servers)
+        end
+
+        private
+          def get_session(env, sid)
+            sid ||= generate_sid
+            begin
+              session = @pool.get(sid) || {}
+            rescue Errno::ECONNREFUSED
+              session = {}
+            end
+            [sid, session]
+          end
+
+          def set_session(env, sid, session_data, opts=nil)
+            options = env['rack.session.options']
+            @pool.set(sid, session_data, options)
+            return(::Redis::Store.rails3? ? sid : true)
+          rescue Errno::ECONNREFUSED
+            return false
+          end
+
+          def destroy(env)
+            if sid = current_session_id(env)
+              @pool.del(sid)
+              sid
+            end
+          rescue Errno::ECONNREFUSED
+            false
+          end
+      end
+    end
+  end
+end
+if ::Redis::Store.rails31?
+  require 'action_dispatch/middleware/session/abstract_store'
+  class ActionDispatch::Session::RedisSessionStore < Rack::Session::Redis
+    include ActionDispatch::Session::Compatibility
+    include ActionDispatch::Session::StaleSessionCheck
+  end
+elsif ::Redis::Store.rails3?
+  class ActionDispatch::Session::RedisSessionStore < ActionDispatch::Session::AbstractStore
+    include RedisStore::Rack::Session::Rails
+  end
+else
+  class ActionController::Session::RedisSessionStore < ActionController::Session::AbstractStore
+    include RedisStore::Rack::Session::Rails
+  end
+end
+

data/lib/active_support/cache/redis_store.rb

@@ -0,0 +1,254 @@
+require "redis-store"
+
+module ::RedisStore
+  module Cache
+    module Rails2
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new
+      #     # => host: localhost,   port: 6379,  db: 0
+      #
+      #   RedisStore.new "example.com"
+      #     # => host: example.com, port: 6379,  db: 0
+      #
+      #   RedisStore.new "example.com:23682"
+      #     # => host: example.com, port: 23682, db: 0
+      #
+      #   RedisStore.new "example.com:23682/1"
+      #     # => host: example.com, port: 23682, db: 1
+      #
+      #   RedisStore.new "example.com:23682/1/theplaylist"
+      #     # => host: example.com, port: 23682, db: 1, namespace: theplaylist
+      #
+      #   RedisStore.new "localhost:6379/0", "localhost:6380/0"
+      #     # => instantiate a cluster
+      def initialize(*addresses)
+        @data = ::Redis::Factory.create(addresses)
+      end
+
+      def write(key, value, options = nil)
+        super
+        method = options && options[:unless_exist] ? :setnx : :set
+        @data.send method, key, value, options
+      end
+
+      def read(key, options = nil)
+        super
+        @data.get key, options
+      end
+
+      def delete(key, options = nil)
+        super
+        @data.del key
+      end
+
+      def exist?(key, options = nil)
+        super
+        @data.exists key
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.del_matched "rab*"
+      def delete_matched(matcher, options = nil)
+        instrument(:delete_matched, matcher, options) do
+          !(keys = @data.keys(matcher)).empty? && @data.del(*keys)
+        end
+      end
+
+      private
+        def instrument(operation, key, options = nil)
+          log(operation.to_s, key, options)
+          yield
+        end
+    end
+
+    module Rails3
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new
+      #     # => host: localhost,   port: 6379,  db: 0
+      #
+      #   RedisStore.new "example.com"
+      #     # => host: example.com, port: 6379,  db: 0
+      #
+      #   RedisStore.new "example.com:23682"
+      #     # => host: example.com, port: 23682, db: 0
+      #
+      #   RedisStore.new "example.com:23682/1"
+      #     # => host: example.com, port: 23682, db: 1
+      #
+      #   RedisStore.new "example.com:23682/1/theplaylist"
+      #     # => host: example.com, port: 23682, db: 1, namespace: theplaylist
+      #
+      #   RedisStore.new "localhost:6379/0", "localhost:6380/0"
+      #     # => instantiate a cluster
+      def initialize(*addresses)
+        @data = ::Redis::Factory.create(addresses)
+        super(addresses.extract_options!)
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.del_matched "rab*"
+      def delete_matched(matcher, options = nil)
+        options = merged_options(options)
+        instrument(:delete_matched, matcher.inspect) do
+          matcher = key_matcher(matcher, options)
+          begin
+            !(keys = @data.keys(matcher)).empty? && @data.del(*keys)
+          rescue Errno::ECONNREFUSED => e
+            false
+          end
+        end
+      end
+
+      protected
+        def write_entry(key, entry, options)
+          method = options && options[:unless_exist] ? :setnx : :set
+          @data.send method, key, entry, options
+        rescue Errno::ECONNREFUSED => e
+          false
+        end
+
+        def read_entry(key, options)
+          entry = @data.get key, options
+          if entry
+            entry.is_a?(ActiveSupport::Cache::Entry) ? entry : ActiveSupport::Cache::Entry.new(entry)
+          end
+        rescue Errno::ECONNREFUSED => e
+          nil
+        end
+
+        ##
+        # Implement the ActiveSupport::Cache#delete_entry
+        #
+        # It's really needed and use
+        #
+        def delete_entry(key, options)
+          @data.del key
+        rescue Errno::ECONNREFUSED => e
+          false
+        end
+
+
+        # Add the namespace defined in the options to a pattern designed to match keys.
+        #
+        # This implementation is __different__ than ActiveSupport:
+        # __it doesn't accept Regular expressions__, because the Redis matcher is designed
+        # only for strings with wildcards.
+        def key_matcher(pattern, options)
+          prefix = options[:namespace].is_a?(Proc) ? options[:namespace].call : options[:namespace]
+          if prefix
+            raise "Regexps aren't supported, please use string with wildcards." if pattern.is_a?(Regexp)
+            "#{prefix}:#{pattern}"
+          else
+            pattern
+          end
+        end
+    end
+
+    module Store
+      include ::Redis::Store.rails3? ? Rails3 : Rails2
+    end
+  end
+end
+
+module ActiveSupport
+  module Cache
+    class RedisStore < Store
+      include ::RedisStore::Cache::Store
+
+      # Reads multiple keys from the cache using a single call to the
+      # servers for all keys. Options can be passed in the last argument.
+      #
+      # Example:
+      #   cache.read_multi "rabbit", "white-rabbit"
+      #   cache.read_multi "rabbit", "white-rabbit", :raw => true
+      def read_multi(*names)
+        values = @data.mget(*names)
+        
+        # Remove the options hash before mapping keys to values
+        names.extract_options!
+        
+        result = Hash[names.zip(values)]
+        result.reject!{ |k,v| v.nil? }
+        result
+      end
+
+      # Increment a key in the store.
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.increment "counter"
+      #   cache.read "counter", :raw => true      # => "24"
+      #
+      #   cache.increment "counter", 6
+      #   cache.read "counter", :raw => true      # => "30"
+      #
+      #   cache.increment "a counter"
+      #   cache.read "a counter", :raw => true    # => "1"
+      #
+      #   cache.increment "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "1"
+      def increment(key, amount = 1)
+        instrument(:increment, key, :amount => amount) do
+          @data.incrby key, amount
+        end
+      end
+
+      # Decrement a key in the store
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.decrement "counter"
+      #   cache.read "counter", :raw => true      # => "22"
+      #
+      #   cache.decrement "counter", 2
+      #   cache.read "counter", :raw => true      # => "20"
+      #
+      #   cache.decrement "a counter"
+      #   cache.read "a counter", :raw => true    # => "-1"
+      #
+      #   cache.decrement "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "-1"
+      def decrement(key, amount = 1)
+        instrument(:decrement, key, :amount => amount) do
+          @data.decrby key, amount
+        end
+      end
+
+      # Clear all the data from the store.
+      def clear
+        instrument(:clear, nil, nil) do
+          @data.flushdb
+        end
+      end
+
+      def stats
+        @data.info
+      end
+
+      # Force client reconnection, useful Unicorn deployed apps.
+      def reconnect
+        @data.reconnect
+      end
+    end
+  end
+end

data/lib/cache/merb/redis_store.rb

@@ -0,0 +1,79 @@
+module Merb
+  module Cache
+    class RedisStore < AbstractStore
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new
+      #     # => host: localhost,   port: 6379,  db: 0
+      #
+      #   RedisStore.new :servers => ["example.com"]
+      #     # => host: example.com, port: 6379,  db: 0
+      #
+      #   RedisStore.new :servers => ["example.com:23682"]
+      #     # => host: example.com, port: 23682, db: 0
+      #
+      #   RedisStore.new :servers => ["example.com:23682/1"]
+      #     # => host: example.com, port: 23682, db: 1
+      #
+      #   RedisStore.new :servers => ["example.com:23682/1/theplaylist"]
+      #     # => host: example.com, port: 23682, db: 1, namespace: theplaylist
+      #
+      #   RedisStore.new :servers => ["localhost:6379/0", "localhost:6380/0"]
+      #     # => instantiate a cluster
+      def initialize(config = { })
+        @data = Redis::Factory.create config[:servers]
+      end
+
+      def writable?(key, parameters = {}, conditions = {})
+        true
+      end
+
+      def read(key, parameters = {}, conditions = {})
+        @data.get normalize(key, parameters), conditions
+      end
+
+      def write(key, data = nil, parameters = {}, conditions = {})
+        if writable?(key, parameters, conditions)
+          method = conditions && conditions[:unless_exist] ? :setnx : :set
+          @data.send method, normalize(key, parameters), data, conditions
+        end
+      end
+
+      def write_all(key, data = nil, parameters = {}, conditions = {})
+        write key, data, parameters, conditions
+      end
+
+      def fetch(key, parameters = {}, conditions = {}, &blk)
+        (data = read(key, parameters)) || block_given? && begin
+          data = yield
+          write(key, data, parameters, conditions)
+        end
+        data || nil
+      end
+      
+      def exists?(key, parameters = {})
+        @data.exists normalize(key, parameters)
+      end
+
+      def delete(key, parameters = {})
+        @data.del normalize(key, parameters)
+      end
+
+      def delete_all
+        @data.flushdb
+      end
+
+      def delete_all!
+        delete_all
+      end
+
+      private
+        # Returns cache key calculated from base key
+        # and SHA2 hex from parameters.
+        def normalize(key, parameters = {})
+          parameters.empty? ? "#{key}" : "#{key}--#{parameters.to_sha2}"
+        end
+    end
+  end
+end