circuitbox 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb9f064a8178b7bfef8be4552f91410d0783acf5
-  data.tar.gz: ca1e8126ff01603f881c351c28c47396a8fa7d97
+  metadata.gz: 6b50bdb4f6ad77ee69e5f67bc61f9ae5e70e32b4
+  data.tar.gz: 86c89e7e0e10bd67349f76e3fee069218b5bb01a
 SHA512:
-  metadata.gz: f9e3f74178e1cf6200d5dbbf99925ddb1f235ebf3d287e3c82bd0894d1430b69a4ed062bbaf9afb9cacd5b5707c32cf2dcbd10cd78293b5f438f3b738b956837
-  data.tar.gz: fe2a7be07392bd92a0a9e731550f82f1b4e3c6d2ed21759c25d91776e5734d538bb4e7d5bc33da09edd8de5ea2ccdb731e6e8baa36946ea02a7e908415b5c17e
+  metadata.gz: fb6c0076a6689dc2fcc153f11f5060347a544a678b2a74304fa53a1659fa5456037d9642b34d90ce862f48edbc8215dcc0187549d91cface993757afc8413594
+  data.tar.gz: 6cdecb23e5598ae81f621099d5329fc1d133f9acf5f9163a168ba8645615d777441b15045c51e0d16c1c24df56e9210d4bc235fcc6c158bb1ededaced99c1fdb

data/README.md

@@ -53,8 +53,11 @@ class ExampleServiceClient
 
       # seconds the circuit stays open once it has passed the error threshold
       sleep_window:     300,
+      
+      # length of interval (in seconds) over which it calculates the error rate
+      time_window:      60,
 
-      # number of requests within 1 minute before it calculates error rates
+      # number of requests within `time_window` seconds before it calculates error rates
       volume_threshold: 10,
 
       # the store you want to use to save the circuit state so it can be
@@ -263,7 +266,7 @@ c.use Circuitbox::FaradayMiddleware, exceptions: [Faraday::Error::TimeoutError]
   with either
   * a static value
   * a `lambda` which is passed the `original_response` and `original_error`.
-    `original_response` will be populated if Faraday returne an error response,
+    `original_response` will be populated if Faraday returns an error response,
     `original_error` will be populated if an error was thrown before Faraday
     returned a response.  (It will also accept a lambda with arity 1 that is
     only passed `original_response`.  This use is deprecated and will be removed

data/Rakefile

@@ -1,18 +1,30 @@
-require 'rake/testtask'
+require "rake/testtask"
 require "bundler/gem_version_tasks"
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
-end
+namespace :test do
+  desc "Run complete test suite"
+  task :all => [:unit, :integration]
+
+  desc "Run unit tests"
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << "test"
+    t.test_files = FileList["test/*_test.rb"]
+  end
+
+  desc "Run integration tests"
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << "test"
+    t.test_files = FileList["test/integration/*_test.rb"]
+  end
 
-desc "run the circuitbox benchmark scripts"
-task :benchmark do
-  benchmark_scripts = FileList.new("./benchmark/*_benchmark.rb")
-  benchmark_scripts.each do |script|
-    system "bundle exec ruby #{script}"
+  desc "Run the circuitbox benchmarks"
+  task :benchmark do
+    benchmark_scripts = FileList.new("./benchmark/*_benchmark.rb")
+    benchmark_scripts.each do |script|
+      system "bundle exec ruby #{script}"
+    end
   end
 end
 
 desc "Run tests"
-task :default => :test
+task :default => ["test:all"]

data/lib/circuitbox.rb

@@ -1,15 +1,12 @@
 require 'uri'
-require 'singleton'
-require 'active_support'
 require 'logger'
 require 'timeout'
 require 'moneta'
+require 'active_support/all'
 
 require 'circuitbox/version'
-require 'circuitbox/memcache_store'
 require 'circuitbox/circuit_breaker'
 require 'circuitbox/notifier'
-
 require 'circuitbox/errors/error'
 require 'circuitbox/errors/open_circuit_error'
 require 'circuitbox/errors/service_failure_error'

data/lib/circuitbox/circuit_breaker.rb

@@ -47,6 +47,7 @@ class Circuitbox
       if open?
         logger.debug "[CIRCUIT] open: skipping #{service}"
         open! unless open_flag?
+        skipped!
         raise Circuitbox::OpenCircuitError.new(service)
       else
         close! if was_open?
@@ -170,6 +171,10 @@ class Circuitbox
       log_event :failure
     end
 
+    def skipped!
+      log_event :skipped
+    end
+
     # Store success/failure/open/close data in memcache
     def log_event(event)
       notifier.new(service,partition).notify(event)
@@ -208,15 +213,6 @@ class Circuitbox
       end
     end
 
-    # Logs to Memcache.
-    def log_event_to_stat_store(key)
-      if stat_store.read(key, raw: true)
-        stat_store.increment(key)
-      else
-        stat_store.store(key, 1)
-      end
-    end
-
     # For returning stale responses when the circuit is open
     def response_key(args)
       Digest::SHA1.hexdigest(storage_key(:cache, args.inspect.to_s))

data/lib/circuitbox/version.rb

@@ -1,3 +1,3 @@
 class Circuitbox
-VERSION='1.1.0'
+VERSION='1.1.1'
 end

data/test/circuit_breaker_test.rb

@@ -231,6 +231,14 @@ class CircuitBreakerTest < Minitest::Test
     emulate_circuit_run(circuit, :failure, Timeout::Error)
   end
 
+  def test_records_response_skipped
+    circuit = Circuitbox::CircuitBreaker.new(:yammer)
+    circuit.stubs(:open? => true)
+    circuit.stubs(:log_event)
+    circuit.expects(:log_event).with(:skipped)
+    emulate_circuit_run(circuit, :failure, Timeout::Error)
+  end
+
   def test_records_response_success
     circuit = Circuitbox::CircuitBreaker.new(:yammer)
     circuit.expects(:log_event).with(:success)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuitbox
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Fahim Ferdous
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2017-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -257,7 +257,6 @@ files:
 - lib/circuitbox/errors/service_failure_error.rb
 - lib/circuitbox/excon_middleware.rb
 - lib/circuitbox/faraday_middleware.rb
-- lib/circuitbox/memcache_store.rb
 - lib/circuitbox/notifier.rb
 - lib/circuitbox/version.rb
 - test/circuit_breaker_test.rb
@@ -290,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A robust circuit breaker that manages failing external services.

data/lib/circuitbox/memcache_store.rb

@@ -1,31 +0,0 @@
-module ActiveSupport
-  module Cache
-    class MemcacheStore
-      def initialize(cache)
-        @cache = cache
-      end
-
-      def read(key, options = {})
-        @cache.get(key, options)
-      rescue Memcached::NotFound
-        nil
-      end
-
-      def increment(key)
-        @cache.incr(key)
-      end
-
-      def write(key, value, options = {})
-        if expires_in = options.delete(:expires_in)
-          options[:expiry] = expires_in.to_i
-        end
-
-        @cache.set(key, value, options)
-      end
-
-      def delete(key)
-        @cache.delete(key)
-      end
-    end
-  end
-end