redis_failover-rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 477b89feb234392eeeb44fb9dabd817f590bf5db
-  data.tar.gz: 3ef6dff5c7175ec11c21ae7fdee9220b77c18daf
+  metadata.gz: 815798df4dad8e2808c91aa05a7eb4113bbe43d3
+  data.tar.gz: a369751f3867d1cd900d9fbd23a5448f965e7c39
 SHA512:
-  metadata.gz: edb014657c027a0f07d41026a6fe837ae9bcde3461eb7d9e80774be2548b8729dfc65080d8b5bdb848697df1fcb3775f93a5e4b6f3ceabfbe1240d6895d46218
-  data.tar.gz: 4e43aa4f71e251fcc9e799473bd54497062ce3dea4a4cc699f21e9802b8ce70c8be63a89f5b469d93296154675a722dd64b42fc8c8f5b1aa7ce7fdb8121de53b
+  metadata.gz: 819937fdc09c7dedab7f77c5504c701941aaaa709b99ee0198c43cbc16ffcd9657e06c8138886508eeb2cf41eadb5b88e4a4bf92b387e614742ce9eb1df20e7c
+  data.tar.gz: 70c10548893ab1e8caae9ae0a34465b0180e25f6f796b656ecee8f7ad81d336bc97b78c5254716d3a104e559e3664b4f546c2a6b5770a18c6693d04b3419edb9

data/README.md

@@ -2,6 +2,7 @@
 
 [ ![Codeship Status for surfdome/redis_failover-rails](https://codeship.io/projects/1f022be0-c7b8-0131-24ea-6eafa0062d3a/status?branch=master)](https://codeship.io/projects/22198)
 [![Code Climate](https://codeclimate.com/github/surfdome/redis_failover-rails.png)](https://codeclimate.com/github/surfdome/redis_failover-rails)
+[![Gem Version](https://badge.fury.io/rb/redis_failover-rails.svg)](http://badge.fury.io/rb/redis_failover-rails)
 
 An ActiveSupport::Cache store using redis_failover (a zookeeper based implementation of HA redis) for Rails apps.
 
@@ -22,12 +23,29 @@ Just don't specify zkservers in the config file.
 Just add the dependency to your Gemfile...
 
     # Gemfile
-    gem 'redis_failover-rails', github: 'surfdome/redis_failover-rails' # Not in rubygems.org, yet...
+    gem 'redis_failover-rails'
 
  and run bundle install.
 
     bundle install
 
+**NOTE:** If you are running passenger or unicorn, you definitely want to add this to your `config/initializers/passenger.rb` of your app.
+
+This is **_THIS IS VERY IMPORTANT IN PRODUCTION ENVIRONMENTS!!_**
+
+    if defined?(PhusionPassenger)
+      PhusionPassenger.on_event(:starting_worker_process) do |forked|
+        if forked
+          # We're in smart spawning mode.
+
+          # Reset redis failover clients
+          RedisFactory.reconnect
+        end
+      end
+    end
+
+This generates a reconnect after the app is forked so the redis clients get reset.
+
 ## Usage
 In your application.rb (or environment), you should use something like:
 
@@ -45,14 +63,16 @@ For running the tests, just:
     bundle exec rake
 
 ## Configuration
-In order to define your redis and redis_failover configurations, you just need to use the `redis.yml` config file.
+In order to define your redis and redis_failover configurations, you just need to use the `redis.yml` config file
+
+This is mandatory at the moment of integrating the gem with your Rails app, there are no defaults. The existing config file in the repo is used for tests only, when you run the gem inside the Rails app, it tries to find the proper `redis.yml` file and if it doesn't exist, the app just doesn't start.
 
 This follows a format like this:
 
     environment:
       instance:
-        parameter1:
-        parameter2:
+        parameter1: value1
+        parameter2: value2
 
 This gem automatically selects a redis_failover client if you define `:zkservers` in the config file. If not, it just uses the standard redis client.
 
@@ -80,6 +100,31 @@ Typical configuration parameters for standard redis clients are:
 
 Please keep in mind that this options are not validated, just passed to the client configuration.
 
+Basic `redis.yml` examples:
+
+    # Standard redis
+    development:
+      cache:
+        host: localhost
+        port: 6379
+        db: 1
+
+    # HA redis_failover in development
+    production:
+      hacache:
+        thread_safe: true
+        zkservers: localhost:2181, localhost:2182, localhost:2183
+        db: 1
+        znode_path: /redis_failover   #sometimes required...
+
+    # HA redis_failover for a production environment
+    production:
+      hacache:
+        thread_safe: true
+        zkservers: zk-1:2181, zk-2:2181, zk-3:2181
+        db: 1
+        znode_path: /redis_failover   #sometimes required...
+
 ## License
 This gem is released with MIT licensing. Please see [LICENSE](https://github.com/surfdome/redis_failover-rails/blob/master/LICENSE) for details.
 

data/lib/redis_failover-rails/version.rb

@@ -1,3 +1,3 @@
 module RedisFailoverRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_failover-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jose Pettoruti - Surfdome.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis_failover
@@ -183,7 +183,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- config/initializers/passenger.rb
 - config/redis.yml
 - lib/active_support/cache/redis_cache_store.rb
 - lib/redis_factory.rb

data/config/initializers/passenger.rb

@@ -1,12 +0,0 @@
-if defined?(PhusionPassenger)
-  PhusionPassenger.on_event(:starting_worker_process) do |forked|
-    if forked
-      # We're in smart spawning mode.
-
-      # Reset redis failover clients
-      RedisFactory.reconnect
-    else
-      # We're in conservative spawning mode. We don't need to do anything.
-    end
-  end
-end