circuit-hiatus 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ae4ee84b9cb2ac232e1413ba93e6bc2cbdf94b3cb4663adf08201e1f7fd56be
-  data.tar.gz: a5ddb3f5c6d8c3b5468c02a49733fbd585cd7f240fdbd4b4e5baba376e9750fb
+  metadata.gz: 825bf2d8532d2256b192f94bf2849ff967fb707fb10dd2119e365443111c7344
+  data.tar.gz: d62210a847b67eb4b62afac769e661e8fb78b0c8c457db7b27f90f51478290a7
 SHA512:
-  metadata.gz: 9411ffa270d0f7dab195cbac02cfbadf4bc9d50056701ae9e31a75884879d444a3e1dbab0393a271c6253ead4847111cc87038244b74e59495180c56b3b50b34
-  data.tar.gz: 1d3822b0977b2b987f232cb68b1c0e1af6433bc7d73818003273d70e0a5fa130fa6d0a10f7bc7230f518753b41022529a4335af93e4e6fa199941752d104ee2a
+  metadata.gz: ebff39e24f74d3a901e452cd3bd92296c997ed1012d1a689f3ec58340b447e4ac8bb10045778342d231c4cddd52b5e17aba00bbc02fc5b75d053afdefe5f67a0
+  data.tar.gz: '0804b534b0bd125ea612d64148ed52a35e5a2116ee37d665e3e6a0abe9e6b053bb24c56ef839bd4ffc4f7f4aeae86bf10e25683f898388d63cc1ad96136c9ee5'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    circuit-hiatus (0.4.0)
+    circuit-hiatus (0.5.1)
 
 GEM
   remote: https://rubygems.org/
@@ -12,6 +12,7 @@ GEM
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
+    json (2.3.1)
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
@@ -34,10 +35,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    simplecov (0.18.5)
+    simplecov (0.17.1)
       docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     timecop (0.9.1)
 
 PLATFORMS
@@ -49,7 +51,7 @@ DEPENDENCIES
   pry
   rake (~> 12.0)
   rspec (~> 3.0)
-  simplecov
+  simplecov (= 0.17.1)
   timecop
 
 BUNDLED WITH

data/README.md

@@ -4,6 +4,11 @@
   + *a pause or gap in a sequence, series, or process.*
   + *A temporary gap, pause, break*
 
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/f525ee829216ceed6006/maintainability)](https://codeclimate.com/github/cesartalves/hiatus/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f525ee829216ceed6006/test_coverage)](https://codeclimate.com/github/cesartalves/hiatus/test_coverage)
+[![Build Status](https://travis-ci.org/cesartalves/hiatus.svg)](https://travis-ci.org/cesartalves/hiatus)
+
 Dead simple circuit breaker pattern implementation.
 
 Currently this is an unambitious project for future reference and talks. Thought the pattern was interesting and wanted to give it a shot :)
@@ -18,13 +23,16 @@ Here is a great article about it: https://martinfowler.com/bliki/CircuitBreaker.
 
 ## Installation
 
-Add `gem 'hiatus', git: https://github.com/cesartalves/hiatus` to your Gemfile
+Add `gem 'circuit-hiatus'` to your Gemfile and `bundle install`, or `gem install circuit-hiatus`
 
 ## Usage
 
-Once threshold is reached, will raise a `Hiatus:CircuitBrokenError` till `half_open_interval` passes. Then, it will half-open: a failed call trips the circuit again, a successful call closes it.
+Once threshold is reached, the circuit will raise a `Hiatus:CircuitBrokenError` until `half_open_interval` passes. Then, it will half-open: a failed call trips the circuit again, a successful call closes it.
 
 ```ruby
+
+require 'hiatus' # not circuit-hiatus!
+
 threshold = Hiatus::CountThreshold.new 5 # will be broken on the 5th failed attempt
 
 circuit_breaker = Hiatus::CircuitBreaker.new threshold: threshold, half_open_interval: 60 # after 60 seconds, circuit is apt to make calls again
@@ -47,42 +55,105 @@ end # => Hiatus:CircuitBrokenError
 You can also include a Mixin in your class, since apparently this is what the ruby kids like. No idea why you'd like to tie your code to my little gem, but here it goes:
 
 ```ruby
- class Service
+require 'hiatus'
+
+class Service
+
+include Hiatus::Mixin
+
+# this gives you great flexiblity on which circuit to use
+# you can even have your classes sharing the same circuit breaker :)
+circuit_factory -> { Hiatus::Circuits::CountCircuitBreaker.new threshold: 3 }
+
+circuit_protected def call
+  raise 'Error'
+end
+
+# Check `spec/hiatus_mixin_spec.rb` for the full example
+
+```
+
+To configure a default factory:
+
+```ruby
+
+Hiatus::Mixin.config do |c|
+  c.default_circuit_factory = { Hiatus::Circuits::PercentageCircuitBreaker.new threshold: 0.5 }
+end
+
+```
+
+*Available Circuit types*
+
+- `Hiatus::Circuits::PercentageCircuitBreaker` => shorthand for circuit with threshold= `Hiatus::CountThreshold.new`. Opens once requests fails enough times
+
+- `Hiatus::Circuits::CountCircuitBreaker` => shorthand for circuit with threshold=  `Hiatus::PercentageThreshold.new`. Opens once failure percentage passes the given threshold
 
-  include Hiatus::Mixin
+## Advanced configuration
 
-  # this gives you great flexiblity on which circuit to use
-  # you can even have your classes sharing the same circuit breaker :)
-  circuit_factory -> { Hiatus::Circuits::CountCircuitBreaker.new threshold: 3 }
+You can easily create new instances of Threshold, so that they can be stored anywhere (database, redis, your dog's house - anything that responds to the interface), effectively creating a circuit breaker that can be used across applications:
 
-  circuit_protected def call
-    raise 'Error'
+```ruby
+
+class RedisThreshold < CountThreshold
+  def initialize(options)
+
+  def increment
+    super
+    serialize
   end
 
-  # Check `spec/hiatus_mixin_spec.rb` for the full example
+  def reached?
+    failure_count, threshold = *deserialize
+    failure_count >= threshold
+  end
+
+  def reset
+    super
+    serialize
+  end
+
+  private
+
+  def deserialize
+    # get stuff from redis here
+  end
+
+  def serialize
+    # put stuff into redis here
+  end
+end
+
+threshold = RedisThreshold.new(url:, threshold: 15)
+
+redis_cb = Hiatus::CircuitBreaker.new threshold: threshold, half_open_interval: 90
 
 ```
 
-## Development
+You can find an example of a Threshold stored in a file in extras/file_count_threshold.rb
 
-TODO: fill
+## Possible improvements
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- Figure out why travis badge says error even though the build is passing ¬ ¬'
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- Create health-check mechanism to test connection once circuit has half-opened
 
 ## Contributing
 
-TODO: fill
+PRs are welcome :)
+- PRs must be 100% test-covered
+- PRs must please my code aesthetical preferences
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/circuit_breaker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/circuit_breaker/blob/master/CODE_OF_CONDUCT.md).
+## Development
 
-## License
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-TODO: fill
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the CircuitBreaker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/circuit_breaker/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the CircuitBreaker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cesartalves/hiatus/blob/master/CODE_OF_CONDUCT.md).

data/{hiatus.gemspec → circuit-hiatus.gemspec}

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'httparty'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'timecop'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov', '0.17.1'
 end

data/lib/hiatus/mixin.rb

@@ -1,37 +1,51 @@
 module Hiatus
+
   module Mixin
 
+    class << self
+      attr_accessor :default_circuit_factory
+    end
+
+    def self.config
+      yield self
+    end
+
     def self.included(base)
       base.extend ClassMethods
     end
 
     module ClassMethods
 
+      class NoCircuitFactoryProvided < StandardError; end
+
       def circuit_factory(callable)
-        @@circuit_factory = callable
+        @circuit_factory = callable || Hiatus::Mixin.default_circuit_factory
       end
 
-      def circuit_break(method)
-        unbounded_method_to_decorate = instance_method method
+      def _circuit_factory_; @circuit_factory; end
 
-        define_method :circuit_breaker do
-          @_circuit_breaker_
-        end
+      def circuit_break(method)
+        raise NoCircuitFactoryProvided unless @circuit_factory
 
-        private :circuit_breaker
+        unbounded_method_to_decorate = instance_method method
 
         define_method method do |*args, &block|
-          @_circuit_breaker_ ||= @@circuit_factory[]
+          @_circuit_breaker_ ||= self.class._circuit_factory_[]
 
           @_circuit_breaker_.run do
             unbounded_method_to_decorate.bind(self)[*args, &block]
           end
         end
+
+        define_method :circuit_breaker do
+          @_circuit_breaker_
+        end
+
+        private :circuit_breaker
       end
 
       alias_method :circuit_protected, :circuit_break
 
     end
-
   end
 end

data/lib/hiatus/version.rb

@@ -1,3 +1,3 @@
 module Hiatus
-  VERSION = "0.4.1"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuit-hiatus
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - cesartalvez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -56,16 +56,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
 description: " Write a longer description or delete this line."
 email:
 - cesartalvez@gmail.com
@@ -84,7 +84,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- hiatus.gemspec
+- circuit-hiatus.gemspec
 - lib/hiatus.rb
 - lib/hiatus/circuit_breaker.rb
 - lib/hiatus/circuits/count_circuit_breaker.rb
@@ -114,7 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.