gruf-circuit-breaker 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b16d5d48832a9bb1a168222fdac0de751f517556
+  data.tar.gz: a055a5833e82e781f0f9654325d6ca61bc74fb2e
+SHA512:
+  metadata.gz: 3e85e39daa737aa178b120d3a36f8393f3ac2082422399d73d0ea469af99a903f0bdac1bc2b9e1d5bddaa678979fec3f10ede2c1a351a3952517e2b24da7544d
+  data.tar.gz: c9ba632395b6fc61cfd7374910c8a4902e115e02cb7b37a3435417db4eb795cc2abe22d4216c65d51668bb26a01f58623dff45cee685903abc375fca43a8b276

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+Changelog for the gruf-circuit-breaker gem.
+
+h3. 0.1.3
+
+- Add rubocop to test suite
+- Add bundler-audit to test suite
+- Various cleanups to pass rubocop suite
+
+h3. 0.1.2
+
+- Updated to MIT license
+
+h3. 0.1.1
+
+- Fix to grpc error catching
+
+h3. 0.1.0
+
+- Initial public release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at splittingred@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/README.md

@@ -0,0 +1,57 @@
+# 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)
+
+Adds circuit breaker support for [gruf](https://github.com/bigcommerce/gruf) 1.0.0 or later.
+
+This uses the wonderful [stoplight](https://github.com/orgsync/stoplight) gem for handling
+the internals of circuit breaking.
+
+## Installation
+
+```ruby
+gem 'gruf-circuit-breaker'
+```
+
+Then in an initializer or before use, after loading gruf:
+
+```ruby
+require 'gruf/circuit_breaker'
+Gruf::Hooks::Registry.add(:circuit_breaker, Gruf::CircuitBreaker::Hook)
+```
+
+## Configuration
+
+You can further customize the tracing of gruf services via the configuration:
+
+```ruby
+Gruf.configure do |c|
+  c.hook_options[:circuit_breaker] = {
+    # set cool-off time in seconds (defaults to 60)
+    cool_off_time: 15, 
+    # set threshold count to 2
+    threshold: 2, 
+    # set the gRPC failure statuses that will cause a circuit to trip 
+    failure_statuses: [GRPC::Internal, GRPC::Unknown, GRPC::Aborted],
+    # use a redis instance for the stoplight data storage
+    redis: Redis.new
+  }
+end
+```
+
+## License
+
+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 
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the 
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit 
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the 
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/gruf-circuit-breaker.gemspec

@@ -0,0 +1,40 @@
+# 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
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+$:.push File.expand_path("../lib", __FILE__)
+require 'gruf/circuit_breaker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gruf-circuit-breaker'
+  spec.version       = Gruf::CircuitBreaker::VERSION
+  spec.authors       = ['Shaun McCormick']
+  spec.email         = ['shaun.mccormick@bigcommerce.com']
+
+  spec.summary       = %q{Plugin for implementing the circuit breaker pattern for gruf gRPC requests}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/bigcommerce/gruf-circuit-breaker'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-circuit-breaker.gemspec']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'pry', '~> 0'
+
+  spec.add_runtime_dependency 'stoplight', '~> 2.1'
+end

data/lib/gruf/circuit_breaker.rb

@@ -0,0 +1,24 @@
+# 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
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'stoplight'
+require_relative 'circuit_breaker/version'
+require_relative 'circuit_breaker/hook'
+
+module Gruf
+  module CircuitBreaker
+  end
+end

data/lib/gruf/circuit_breaker/hook.rb

@@ -0,0 +1,83 @@
+# 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
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Gruf
+  module CircuitBreaker
+    class Hook < Gruf::Hooks::Base
+
+      ##
+      # Sets up the stoplight gem
+      #
+      def setup
+        redis = options.fetch(:redis, nil)
+        Stoplight::Light.default_data_store = Stoplight::DataStore::Redis.new(redis) if redis && redis.is_a?(Redis)
+      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)
+        end
+        light.with_cool_off_time(options.fetch(:cool_off_time, 60))
+        light.with_error_handler do |error, handle|
+          # if it's not a gRPC::BadStatus, pass it through
+          raise error unless error.is_a?(GRPC::BadStatus)
+          # only special handling for GRPC error statuses. We want to pass-through any normal exceptions
+          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.run
+      end
+
+      private
+
+      ##
+      # @return [String]
+      #
+      def method_key(call_signature)
+        "#{service_key}.#{call_signature.to_s.gsub('_without_intercept', '')}"
+      end
+
+      ##
+      # @return [String]
+      #
+      def service_key
+        service.class.name.underscore.tr('/', '.')
+      end
+
+      ##
+      # @return [Array<Class>]
+      #
+      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

@@ -0,0 +1,21 @@
+# 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
+# documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+# Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module Gruf
+  module CircuitBreaker
+    VERSION = '0.1.3'.freeze
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: gruf-circuit-breaker
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Shaun McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stoplight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Plugin for implementing the circuit breaker pattern for gruf gRPC requests
+email:
+- shaun.mccormick@bigcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- gruf-circuit-breaker.gemspec
+- lib/gruf/circuit_breaker.rb
+- lib/gruf/circuit_breaker/hook.rb
+- lib/gruf/circuit_breaker/version.rb
+homepage: https://github.com/bigcommerce/gruf-circuit-breaker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Plugin for implementing the circuit breaker pattern for gruf gRPC requests
+test_files: []