flipper-fallback 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d348aae14d3835102e2e6f3cdbe4dbe349a773a5
-  data.tar.gz: a148a40a28bcbc21b8be31bf72fabfe3ce37fbcc
+  metadata.gz: 72e22e996ecb958f8d9204b4706dd925de7f6946
+  data.tar.gz: 2b9ec63f46d922af3724107f81978126935a45a7
 SHA512:
-  metadata.gz: 3402c8cba68227f6c3d979b07b71f810921ba41affaf49f679ab9e587ba6535e3a25eb1126ab71f655360514868e40dcc22109add286f1866d184ee1096bdc36
-  data.tar.gz: eb2436868fd66066b25286f8c4cf0ce1dacd4bd8849de03df48b6e73f86632c4b1b3d1771b8ba727edef72c193bfda795d6dd3751a803ae537d39ab0c6435767
+  metadata.gz: b3d2de1ebd7064194bb1afc1a836fdb44e1bb61f0b28fad1737fbf76f86aabd2d6545a58f58fe27e1c0350c17126100bc49f34716ee9d4cd0295a6e3e5a2893d
+  data.tar.gz: fc0b8fa00eb954da53b79b3dd20e4b62c5077383cdd38cbcec422c2a8f2f7d9da2324c49d617b5704c16b786b337a46c206bd7572a3bb089d63503b8686443c0

data/README.md

@@ -1,6 +1,9 @@
 # Flipper::Fallback
 
-TODO: Write a gem description
+This gem lets you utilize multiple flipper adapters by providing a fall back pattern.
+If the primary adapter fails by throwing an exception, the secondary adapter will be called.
+By default, the fall back adapter is the in memory adapter which should not fail.
+However, by default, the memory adapter is empty and ***everything will fail closed***
 
 ## Installation
 
@@ -18,7 +21,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Basic usage might look like this
+```ruby
+require 'flipper/adapters/redis'
+require 'flipper/adapters/fallback'
+
+flipper_adapter ||= Flipper::Adapters::Fallback.new(Flipper::Adapters::Redis.new(App.redis))
+@flipper ||= Flipper.new(flipper_adapter)
+```
+
+If you wanted to set how things will fail, you should be able to do something like this.
+```ruby
+# Untested
+# Please give me a better example of how one might do this
+memory = Flipper::Adapters::Memory.new()
+template = Flipper.new(memory)
+template[:search].enable
+template[:experimental].disable
+
+# Template has modified our "memory" adapter to how we want
+adapter = Flipper::Adapters::Fallback.new(Flipper::Adapters::Redis.new(App.redis), options = {}, memory)
+```
+
+Advanced usage might look like this
+```ruby
+error_handler = lambda do |error, primary_adapter, fallback_adapter|
+  # Keep stats on how many and what kind of error we are seeing
+  # There is probably a better way to do this
+  statsd.increment("flipper.#{primary_adapter.name}.errors.#{error.to_s.gsub('.','_')}")
+end
+
+# Throw a timeout exception if we take more than 2 seconds.
+# Timeout wraps both the primary and fallback adapters.
+# If the primary adapter takes longer than 2 seconds, we won't even try the fallback
+timeout_in_seconds = 2
+
+flipper_adapter ||= Flipper::Adapters::Fallback.new(Flipper::Adapters::Redis.new(App.redis), :on_error => error_handler, :timeout => timeout_in_seconds)
+@flipper ||= Flipper.new(flipper_adapter)
+```
+
+Some "creative" usage might look like this
+```ruby
+# Untested
+# Make a list of adapters to try
+head = Flipper::Adapters::Fallback.new(Flipper::Adapters::Memcache.new(Rails.cache))
+head = Flipper::Adapters::Fallback.new(Flipper::Adapters::Redis.new(App.redis), { :timeout => 1 }, head)
+head = Flipper::Adapters::Fallback.new(Flipper::Adapters::ElasticSearch.new(App.search), { :timeout => 1 }, head)
+
+# This would try ES -> Redis -> Memcache -> Memory.
+@flipper ||= Flipper.new(head)
+```
 
 ## Contributing
 

data/lib/flipper/adapters/fallback.rb

@@ -1,25 +1,37 @@
 require 'flipper'
 require 'flipper/adapters/memory'
 require 'delegate'
+require 'timeout'
 
 module Flipper
   module Adapters
     class Fallback < SimpleDelegator
-      VERSION = '0.0.2'
-      def initialize(primary_adapter, fallback_adapter = Flipper::Adapters::Memory.new)
+      VERSION = '0.1.0'
+
+      def initialize(primary_adapter, options = {}, fallback_adapter = Flipper::Adapters::Memory.new)
         super(primary_adapter)
         @primary_adapter = primary_adapter
         @fallback_adapter = fallback_adapter
 
         @delegate_sd_obj = primary_adapter
+
+        @on_error = options[:on_error] || lambda do |error, primary_adapter, fallback_adapter|
+          STDERR.puts("[Flipper::Adapters::Fallback] Primary adapter(#{primary_adapter.inspect}) Failure! #{error}")
+          STDERR.puts("[Flipper::Adapters::Fallback] Falling back to #{fallback_adapter.inspect})")
+        end
+
+        @timeout = options[:timeout]
       end
 
       def method_missing(m, *args, &block)
-        super
-      rescue => e
-        STDERR.puts("[Flipper::Adapters::Fallback] Primary adapter(#{@primary_adapter.inspect}) Failure! #{e}")
-        STDERR.puts("[Flipper::Adapters::Fallback] Falling back to #{@fallback_adapter.inspect})")
-        @fallback_adapter.__send__(m, *args, &block)
+        Timeout::timeout(@timeout) do
+          begin
+            super
+          rescue => error
+            @on_error.call(error, @primary_adapter, @fallback_adapter)
+            @fallback_adapter.__send__(m, *args, &block)
+          end
+        end
       end
     end
   end

data/spec/fallback_spec.rb

@@ -35,7 +35,12 @@ describe Flipper::Adapters::Fallback do
       Redis.new(options)
     }
 
-    subject { described_class.new(Flipper::Adapters::Redis.new(client)) }
+    let(:on_error) do
+      lambda do |error, primary_adapter, fallback_adapter|
+        # noop
+      end
+    end
+    subject { described_class.new(Flipper::Adapters::Redis.new(client), { :on_error => on_error, :timeout => 0.1 }) }
 
     it_should_behave_like 'a flipper adapter'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-fallback
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Lundquist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-26 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper