gruf-circuit-breaker 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b16d5d48832a9bb1a168222fdac0de751f517556
-  data.tar.gz: a055a5833e82e781f0f9654325d6ca61bc74fb2e
+  metadata.gz: b812cddba85e6ed5a9a2efa6624b33c71b87b97d
+  data.tar.gz: c841e828ceefd724ca89fb7faeb4f218e7c5e850
 SHA512:
-  metadata.gz: 3e85e39daa737aa178b120d3a36f8393f3ac2082422399d73d0ea469af99a903f0bdac1bc2b9e1d5bddaa678979fec3f10ede2c1a351a3952517e2b24da7544d
-  data.tar.gz: c9ba632395b6fc61cfd7374910c8a4902e115e02cb7b37a3435417db4eb795cc2abe22d4216c65d51668bb26a01f58623dff45cee685903abc375fca43a8b276
+  metadata.gz: 3849d1ebcc7fd3569c18a836f2e1ccf25e8c4f0fc0ef95ba14ce375047a1aa4f36b9f387dc1c01b6ecdf9d23628083bbf1ccc82c5aba4b887dc2ed138d8f10f0
+  data.tar.gz: e4a2f4d405356141ec6c96c17a3839931a161b2e0ba23a566626b5c6f137d132c01bfe00caf193c035b96f37339da6c63b51f1b1b4da4b4d2ab31f1fabde2ce2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 Changelog for the gruf-circuit-breaker gem.
 
+h3. 1.0.0
+
+- gruf 2.0 support
+
 h3. 0.1.3
 
 - Add rubocop to test suite

data/README.md

@@ -1,8 +1,8 @@
 # gruf-circuit-breaker - Circuit Breaker for gruf
 
-[![Build Status](https://travis-ci.org/bigcommerce/gruf-circuit-breaker.svg?branch=master)](https://travis-ci.org/bigcommerce/gruf-circuit-breaker)
+[![Build Status](https://travis-ci.org/bigcommerce/gruf-circuit-breaker.svg?branch=master)](https://travis-ci.org/bigcommerce/gruf-circuit-breaker) [![Gem Version](https://badge.fury.io/rb/gruf-circuit-breaker.svg)](https://badge.fury.io/rb/gruf-circuit-breaker) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-circuit-breaker.svg?branch=master)](http://inch-ci.org/github/bigcommerce/gruf-circuit-breaker) 
 
-Adds circuit breaker support for [gruf](https://github.com/bigcommerce/gruf) 1.0.0 or later.
+Adds circuit breaker support for [gruf](https://github.com/bigcommerce/gruf) 2.0.0 or later.
 
 This uses the wonderful [stoplight](https://github.com/orgsync/stoplight) gem for handling
 the internals of circuit breaking.
@@ -26,7 +26,7 @@ You can further customize the tracing of gruf services via the configuration:
 
 ```ruby
 Gruf.configure do |c|
-  c.hook_options[:circuit_breaker] = {
+  c.interceptors.use(Gruf::CircuitBreaker::Interceptor, { 
     # set cool-off time in seconds (defaults to 60)
     cool_off_time: 15, 
     # set threshold count to 2
@@ -35,7 +35,7 @@ Gruf.configure do |c|
     failure_statuses: [GRPC::Internal, GRPC::Unknown, GRPC::Aborted],
     # use a redis instance for the stoplight data storage
     redis: Redis.new
-  }
+  })
 end
 ```
 

data/lib/gruf/circuit_breaker.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -16,9 +15,15 @@
 #
 require 'stoplight'
 require_relative 'circuit_breaker/version'
-require_relative 'circuit_breaker/hook'
+require_relative 'circuit_breaker/interceptor'
 
+##
+# Base gruf module
+#
 module Gruf
+  ##
+  # Base CircuitBreaker module
+  #
   module CircuitBreaker
   end
 end

data/lib/gruf/circuit_breaker/{hook.rb → interceptor.rb}

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -16,26 +15,25 @@
 #
 module Gruf
   module CircuitBreaker
-    class Hook < Gruf::Hooks::Base
-
+    ##
+    # Intercepts gruf requests and adds a circuit breaker implementation
+    #
+    class Interceptor < Gruf::Interceptors::ServerInterceptor
       ##
       # Sets up the stoplight gem
       #
-      def setup
+      def initialize(request, error, options = {})
         redis = options.fetch(:redis, nil)
         Stoplight::Light.default_data_store = Stoplight::DataStore::Redis.new(redis) if redis && redis.is_a?(Redis)
+        super(request, error, options)
       end
 
       ##
       # Handle the gruf around hook
       #
-      # @param [Symbol] call_signature
-      # @param [Object] request
-      # @param [GRPC::ActiveCall] active_call
-      #
-      def around(call_signature, request, active_call, &block)
-        light = Stoplight(method_key(call_signature)) do
-          block.call(call_signature, request, active_call)
+      def call
+        light = Stoplight(request.method_key) do
+          yield
         end
         light.with_cool_off_time(options.fetch(:cool_off_time, 60))
         light.with_error_handler do |error, handle|
@@ -45,24 +43,17 @@ module Gruf
           raise error unless failure_statuses.include?(error.class)
           handle.call(error)
         end
-        light.with_threshold(options.fetch(:threshold, 1)) if options.fetch(:threshold, false)
+        light.with_threshold(threshold) if threshold > 0
         light.run
       end
 
       private
 
       ##
-      # @return [String]
-      #
-      def method_key(call_signature)
-        "#{service_key}.#{call_signature.to_s.gsub('_without_intercept', '')}"
-      end
-
-      ##
-      # @return [String]
+      # @return [Integer]
       #
-      def service_key
-        service.class.name.underscore.tr('/', '.')
+      def threshold
+        options.fetch(:threshold, 0).to_i
       end
 
       ##
@@ -71,13 +62,6 @@ module Gruf
       def failure_statuses
         options.fetch(:failure_statuses, [GRPC::Internal, GRPC::Unknown])
       end
-
-      ##
-      # @return [Hash]
-      #
-      def options
-        @options.fetch(:circuit_breaker, {})
-      end
     end
   end
 end

data/lib/gruf/circuit_breaker/version.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -16,6 +15,6 @@
 #
 module Gruf
   module CircuitBreaker
-    VERSION = '0.1.3'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf-circuit-breaker
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,7 @@ files:
 - README.md
 - gruf-circuit-breaker.gemspec
 - lib/gruf/circuit_breaker.rb
-- lib/gruf/circuit_breaker/hook.rb
+- lib/gruf/circuit_breaker/interceptor.rb
 - lib/gruf/circuit_breaker/version.rb
 homepage: https://github.com/bigcommerce/gruf-circuit-breaker
 licenses:
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Plugin for implementing the circuit breaker pattern for gruf gRPC requests