redis-kit 0.0.2

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+.ruby-version

data/.travis.yml

@@ -0,0 +1,17 @@
+script: make ci
+gemfile:
+  - test/railsapi/Gemfile.rails_3_2
+  - test/railsapi/Gemfile.rails_head
+branches:
+  only:
+    - master
+    - develop
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - rbx-19mode
+before_install:
+  - gem install bundler --version '= 1.3.1'
+

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+0.0.2
+=====
+
+* Add support for Ruby 2.0.0.
+* Drop support for Rails < 3.2 and Ruby < 1.9.3.
+* Fix bug whereby redis-kit would clobber Resque hooks, replacing them with its
+  own.
+* Allow MockRedis as a back-end (for tests).
+
+0.0.1
+=====
+
+* Initial release with support for:
+    * Rails 3.0, 3.1, 3.2
+    * Ruby 1.9.1, 1.9.2, 1.9.3, 2.0
+    * JRuby in 1.9 mode
+    * Rubinius in 1.9 mode
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    redis-kit (0.0.1)
+      hiredis (~> 0.4.0)
+      mock_redis (~> 0.6.0)
+      redis (~> 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.9)
+    guard (1.6.2)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      terminal-table (>= 1.4.3)
+      thor (>= 0.14.6)
+    guard-test (0.7.0)
+      guard (>= 1.1)
+      test-unit (~> 2.2)
+    hiredis (0.4.5)
+    hiredis (0.4.5-java)
+    listen (0.7.3)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    mock_redis (0.6.4)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry (0.9.12-java)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    rake (10.0.3)
+    rb-fsevent (0.9.3)
+    redis (3.0.3)
+    slop (3.4.3)
+    spoon (0.0.1)
+    terminal-table (1.4.5)
+    test-unit (2.5.4)
+    thor (0.17.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-test
+  rake
+  rb-fsevent
+  redis-kit!

data/Guardfile

@@ -0,0 +1,6 @@
+guard :test do
+  watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch('test/test_helper.rb')  { "test" }
+end
+

data/Makefile

@@ -0,0 +1,26 @@
+dependencies:
+	@bundle install
+	@cd test/railsapi/ ; BUNDLE_GEMFILE=Gemfile.rails_3_2 bundle install
+	@cd test/railsapi/ ; BUNDLE_GEMFILE=Gemfile.rails_head bundle install
+
+ci:
+	bundle exec rake
+	cd test/railsapi/ ; bundle exec rake
+
+test:
+	@echo "======================"
+	@echo "Running base gem tests"
+	@echo "======================"
+	@bundle exec rake
+	@echo ""
+	@echo "=================================="
+	@echo "Running tests against Rails 3.2..."
+	@echo "=================================="
+	@cd test/railsapi/ && BUNDLE_GEMFILE=Gemfile.rails_3_2 bundle exec rake
+	@echo ""
+	@echo "==================================="
+	@echo "Running tests against Edge Rails..."
+	@echo "==================================="
+	@cd test/railsapi/ && BUNDLE_GEMFILE=Gemfile.rails_head bundle exec rake
+
+.PHONY: test ci dependencies

data/README.md

@@ -0,0 +1,122 @@
+RedisKit
+========
+
+[![Build Status](https://travis-ci.org/stvp/redis-kit.png?branch=master)](https://travis-ci.org/stvp/redis-kit) (master)
+
+[![Build Status](https://travis-ci.org/stvp/redis-kit.png?branch=develop)](https://travis-ci.org/stvp/redis-kit) (develop)
+
+[![Dependency Status](https://gemnasium.com/stvp/redis-kit.png)](https://gemnasium.com/stvp/redis-kit)
+
+RedisKit is an (in-progress) gem that greatly simplifies the use of Redis in
+Ruby when used with any of the following:
+
+* Rails
+* Resque
+* *More soon...*
+
+Using RedisKit
+--------------
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem "redis-kit"
+```
+
+And run `bundle install`. This will install the RedisKit gem as well as the
+latest stable `redis` and `hiredis` gems.
+
+Redis connections created by RedisKit automatically use [Hiredis][hiredis], the
+the [fast][hiredis_bench] and reliable (and official) C client library for
+Redis. In JRuby, however, RedisKit falls back to the pure-Ruby Redis client
+because JRuby doesn't support C extensions like hiredis.
+
+[hiredis]: https://github.com/pietern/hiredis-rb
+[hiredis_bench]: https://gist.github.com/894026
+
+With Rails
+----------
+
+If you're using Rails, RedisKit includes a [Rails initializer][rails_init] that
+sets up a global Redis connection when your app loads. This Redis connection is
+available via `$redis`.
+
+[rails_init]: https://github.com/stvp/redis-kit/blob/master/lib/redis-kit/railtie.rb
+
+The configuration for Redis can come from one of two places:
+
+1. An environment variable like "REDIS_URL". Heroku add-ons like
+   [RedisGreen][rg] use environment variables to supply your Redis URL.
+
+2. A configuration file (`config/redis.yml`) containing a section for each
+   environment with settings that will be passed straight to `Redis.new`:
+
+    ```yaml
+    development:
+      url: <%= ENV['REDIS_URL']%>
+    test:
+      mock: true
+    production:
+      host: sprightly-lemur-251.redisgreen.net
+      port: 10092
+      password: foobarbazbiz
+    ```
+
+    This file will be passed through ERB, so you can include ERB tags as shown
+    above under "development" to evaluate the configuration at runtime.
+
+    You can also include "mock: true" to use a [MockRedis][mock_redis] object.
+    This should only be used in development and test environments.
+
+[rg]: http://redisgreen.net
+[mock_redis]: https://github.com/causes/mock_redis
+
+If the environment variable doesn't exist, RedisKit will use the settings from
+the config file.
+
+With Resque
+-----------
+
+If `$redis` is a different Redis connection than `Resque.redis`, RedisKit will
+handle reconnecting the connection after Resque forks. If they're the same
+connection, Resque will handle the connection as usual.
+
+Support
+-------
+
+RedisKit officially supports the following Rubies:
+
+* Ruby >= 1.9.3
+* JRuby >= 1.7.0 (in 1.9 mode)
+* Rubinius >= 1.2.0 (in 1.9 mode)
+
+And the following libraries:
+
+* Rails 3.2, 4.0
+* Resque >= 1.6
+
+Development
+-----------
+
+Set up and run tests with:
+
+    make dependencies
+    make test
+
+TODO
+----
+
+* Add generators for common files
+  * Resque initializer
+  * Unicorn config (after fork hook)
+* Under forking servers (Unicorn, Rainbows, Passenger), automatically
+  re-establish the connection after forking.
+* Under threaded servers, provide a connection pool of Redis connections.
+* Under Sidekiq, provide a pool of Redis connections for your workers to use
+  based on your Sidekiq settings (when Sidekiq's redis connection != your main
+  connection)
+* Ensure support for all servers:
+    * Multi-Process, preforking: Unicorn, Rainbows, Passenger
+    * Evented (suited for sinatra-synchrony): Thin, Rainbows, Zbatery
+    * Threaded: Net::HTTP::Server, Threaded Mongrel, Puma, Rainbows, Zbatery, Thin[1]
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+task :default => :test
+

data/lib/redis-kit/railtie.rb

@@ -0,0 +1,16 @@
+module RedisKit
+  class Railtie < Rails::Railtie
+    initializer "redis-kit.setup_redis" do |app|
+      # Register the path with Rails so that users can change it, if they want.
+      unless app.paths["config/redis"]
+        app.paths.add "config/redis", with: "config/redis.yml"
+      end
+
+      # Set up a new global Redis connection.
+      path = app.paths["config/redis"].first
+      env = Rails.env
+      $redis = RedisKit.new_redis( path, env )
+    end
+  end
+end
+

data/lib/redis-kit/resque.rb

@@ -0,0 +1,31 @@
+# Resque handles its own Redis connection, reconnecting after forks. If $redis
+# is a separate connection, however, we'll disconnect it automatically after a
+# fork so that the job can use the connection if it wants. If Resque is using
+# the $redis connection, we let Resque handle it.
+
+module RedisKit
+  module Resque
+    def self.setup
+      # Don't clobber any existing hooks.
+      if existing_hook = ::Resque.after_fork
+        ::Resque.after_fork do |job|
+          existing_hook.call( job )
+          check_redis
+        end
+      else
+        ::Resque.after_fork do |job|
+          check_redis
+        end
+      end
+    end
+
+    def self.check_redis
+      if $redis != ::Resque.redis.redis
+        $redis.client.disconnect
+      end
+    end
+  end
+end
+
+RedisKit::Resque.setup
+

data/lib/redis-kit/version.rb

@@ -0,0 +1,3 @@
+module RedisKit
+  VERSION = "0.0.2"
+end

data/lib/redis-kit.rb

@@ -0,0 +1,92 @@
+require "rubygems"
+require "bundler/setup"
+require "yaml"
+require "redis"
+require "hiredis" if RUBY_ENGINE != "jruby"
+
+module RedisKit
+  class MissingConfigError < StandardError ; end
+  class InvalidConfigSyntaxError < StandardError ; end
+
+  CUSTOM_CONFIG_KEYS = [:mock]
+
+  def self.new_redis( path, env )
+    config = load_config( path, env )
+    if config[:mock]
+      require 'mock_redis'
+      MockRedis.new
+    else
+      Redis.new( config.reject{ |k, v| CUSTOM_CONFIG_KEYS.include?( k ) } )
+    end
+  end
+
+  # Try loading the Redis config from an environment variable or, if there isn't
+  # one, a YAML config file.
+  def self.load_config( path, env )
+    opts = {}
+    opts[:driver] = :hiredis if use_hiredis?
+
+    if url = url_from_env
+      opts.merge( url: url )
+    else
+      config = config_from_yml( path, env )
+      opts.merge( config )
+    end
+  end
+
+  # Try to find a Redis URL in one of the usual ENV variables.
+  def self.url_from_env
+    %w{ REDIS_URL REDISGREEN_URL OPENREDIS_URL REDISTOGO_URL }.map do |var|
+      ENV[var]
+    end.find do |url|
+      url
+    end
+  end
+
+  # Load the Redis configuration for the given environment. The YAML file will
+  # be passed through ERB before being parsed.
+  def self.config_from_yml( path, env )
+    require 'erb'
+    config = YAML.load ERB.new( IO.read( path ) ).result
+
+    if config == false
+      raise MissingConfigError.new "The Redis configuration file at " \
+        "#{path} is empty. See the RedisKit README for information about how " \
+        "to format this file: https://github.com/stvp/redis-kit"
+    elsif config.key?( env )
+      symbolize_keys( config[env] )
+    else
+      raise MissingConfigError.new "There is no Redis config for the " \
+        "#{env.inspect} environment in #{path}. Either add one or set your "\
+        "Redis URL with an ENV variable like \"REDIS_URL\"."
+    end
+  rescue Errno::ENOENT
+    raise MissingConfigError.new "#{path} doesn't exist. Please add a Redis " \
+      "config YAML file or supply an ENV variable like \"REDIS_URL\"."
+  rescue Exception => e
+    if Object.const_defined?('Psych') && e.class == Psych::SyntaxError
+      raise InvalidConfigSyntaxError.new "A YAML syntax error occurred while " \
+        "parsing #{path}. Please note that YAML must be consistently indented " \
+        "using spaces. Tabs are not allowed.\nError: #{e.message}"
+    else
+      raise
+    end
+  end
+
+  private
+
+  def self.use_hiredis?
+    RUBY_ENGINE != "jruby"
+  end
+
+  def self.symbolize_keys( hash )
+    hash.each_with_object({}) do |(k,v), h|
+      h[k.to_sym] = v
+    end
+  end
+end
+
+require "redis-kit/version"
+require "redis-kit/railtie" if defined?( Rails )
+require "redis-kit/resque" if defined?( Resque )
+

data/redis-kit.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "redis-kit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "redis-kit"
+  s.version     = RedisKit::VERSION
+  s.authors     = ["Tyson Tate"]
+  s.email       = ["tyson@stovepipestudios.com"]
+  s.homepage    = "http://github.com/stvp/redis-kit-rb"
+  s.summary     = "simple redis init"
+  s.description = "simple redis init for rails projects"
+
+  s.rubyforge_project = "redis-kit"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "redis", "~> 3.0.0"
+  s.add_dependency "hiredis", "~> 0.4.0" if RUBY_ENGINE != "jruby"
+  s.add_dependency "mock_redis", "~> 0.6.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rb-fsevent"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-test"
+end

data/test/railsapi/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/test/railsapi/Gemfile.rails_3_2

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 3.2.0"
+gem "rails-api", "~> 0.0.3"
+gem "rake", "~> 0.9.0"
+gem "resque", "~> 1.23.0"
+
+gem "redis-kit", path: "../../"
+
+group :test do
+  gem "pry"
+  gem "minitest"
+end
+

data/test/railsapi/Gemfile.rails_3_2.lock

@@ -0,0 +1,139 @@
+PATH
+  remote: ../../
+  specs:
+    redis-kit (0.0.1)
+      hiredis (~> 0.4.0)
+      mock_redis (~> 0.6.0)
+      redis (~> 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.12)
+      actionpack (= 3.2.12)
+      mail (~> 2.4.4)
+    actionpack (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activerecord (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    coderay (1.0.9)
+    erubis (2.7.0)
+    hike (1.2.1)
+    hiredis (0.4.5)
+    hiredis (0.4.5-java)
+    i18n (0.6.4)
+    journey (1.0.4)
+    json (1.7.7)
+    json (1.7.7-java)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.1)
+    mime-types (1.21)
+    minitest (4.6.2)
+    mock_redis (0.6.4)
+    multi_json (1.6.1)
+    polyglot (0.3.3)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry (0.9.12-java)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+      spoon (~> 0.0)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-protection (1.4.0)
+      rack
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.12)
+      actionmailer (= 3.2.12)
+      actionpack (= 3.2.12)
+      activerecord (= 3.2.12)
+      activeresource (= 3.2.12)
+      activesupport (= 3.2.12)
+      bundler (~> 1.0)
+      railties (= 3.2.12)
+    rails-api (0.0.3)
+      actionpack (>= 3.2.6)
+      railties (>= 3.2.6)
+      tzinfo (~> 0.3.31)
+    railties (3.2.12)
+      actionpack (= 3.2.12)
+      activesupport (= 3.2.12)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.6)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    redis (3.0.3)
+    redis-namespace (1.2.1)
+      redis (~> 3.0.0)
+    resque (1.23.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    sinatra (1.3.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.3)
+      tilt (~> 1.3, >= 1.3.3)
+    slop (3.4.3)
+    spoon (0.0.1)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.17.0)
+    tilt (1.3.4)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.36)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  minitest
+  pry
+  rails (~> 3.2.0)
+  rails-api (~> 0.0.3)
+  rake (~> 0.9.0)
+  redis-kit!
+  resque (~> 1.23.0)

data/test/railsapi/Gemfile.rails_head

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem "rails", git: "git://github.com/rails/rails.git"
+gem "rails-api", "~> 0.0.3"
+gem "rake", "~> 0.9.0"
+gem "resque", "~> 1.23.0"
+
+gem "redis-kit", path: "../../"
+
+group :test do
+  gem "pry"
+  gem "minitest"
+end
+