resilient 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a7441e56169aaa25eeeb4e40a73901f939e3af2d
-  data.tar.gz: 04f4f827c3fc3de69439b40590ab1c3615e43376
+SHA256:
+  metadata.gz: 2e439a74385ae133b7d375d90c75dcc302a1cd77a56d69facda7b04f2de07124
+  data.tar.gz: bceca2780a2b2b71ff1b0084db9e2c6ed206345114d2849d1da1c957e1995365
 SHA512:
-  metadata.gz: e54a1abc95f5ba114b2eb4064a2d8f0190014268c7061a6869bc7811278f075331ec13cfa5758738be1690e427cfc38ca768d5f34f2258007eece41b9fc707e6
-  data.tar.gz: bf752309fd26f431ae9c04b7dffeb68827bb05835afee1b2beed0548ecbd70333ce53c7983e2855bb2c5ae2bcdfd1f1ce1b70849c03c609f67fe061e31a9cf77
+  metadata.gz: 8a58ea0dce1f90dc61f4a3d34d0fa6f7ad7ca64fd246776a6696ee2e7ae1f2df9447b9f1ba394a914503320b40a1d3a2b326fd27e0e954e826fb985209233330
+  data.tar.gz: '088e66a7f364869da5da43f926dead2cd62af861baaa07b3a4615e521ac1ab75ecdeb4e6c7aee0b1f40ce2a692e66cca25cd2737bfe2c3fdc1635142fb96fb3a'

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7']
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - name: Do some action caching
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gem-
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install bundler
+        run: gem install bundler
+      - name: Run bundler
+        run: bundle install --jobs 4 --retry 3
+      - name: Run Tests
+        run: script/test

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.1
+
+* [Added two new events open_circuit and close_circuit](https://github.com/jnunemaker/resilient/pull/16) and [renamed them here](https://github.com/jnunemaker/resilient/commit/407e673eb5268912814398bebdeb173793d0af05).
+
 ## 0.5.0
 
 * [tweaked interface for metrics](https://github.com/jnunemaker/resilient/pull/15)

data/README.md

@@ -2,7 +2,7 @@
 
 Some tools to aid in resiliency in Ruby. For now, just a circuit breaker (~~stolen from~~ based on [hystrix](https://github.com/netflix/hystrix)). Soon much more...
 
-Nothing asynchronous or thread safe yet either, but open to it and would like to see more around it in the future.
+Nothing asynchronous or thread safe yet either, but open to it and would like to see more around it in the future. See more here: [jnunemaker/resilient#18](https://github.com/jnunemaker/resilient/issues/18).
 
 ## Installation
 
@@ -29,7 +29,7 @@ require "resilient/circuit_breaker"
 # CircuitBreaker.new as `get` keeps a registry of circuits by key to prevent
 # creating multiple instances of the same circuit breaker for a key; not using
 # `get` means you would have multiple instances of the circuit breaker and thus
-# separate state and metrics; you can read more in examples/for_vs_new.rb
+# separate state and metrics; you can read more in examples/get_vs_new.rb
 circuit_breaker = Resilient::CircuitBreaker.get("example")
 if circuit_breaker.allow_request?
   begin
@@ -86,15 +86,15 @@ circuit_breaker = Resilient::CircuitBreaker.get("example", {
 
 Property                        | Default                | Notes
 --------------------------------|------------------------|--------
-**:force_open**                 | false                  | allows forcing the circuit open (stopping all requests)
-**:force_closed**               | false                  | allows ignoring errors and therefore never trip "open" (ie. allow all traffic through); normal instrumentation will still happen, thus allowing you to "test" configuration live without impact
-**:instrumenter**               | Instrumenters::Noop    | what to use to instrument all events that happen (ie: ActiveSupport::Notifications)
-**:sleep_window_seconds**       | 5                      | seconds after tripping circuit before allowing retry
-**:request_volume_threshold**   | 20                     | number of requests that must be made within a statistical window before open/close decisions are made using stats
-**:error_threshold_percentage** | 50                     |  % of "marks" that must be failed to trip the circuit
-**:window_size_in_seconds**     | 60                     | number of seconds in the statistical window
-**:bucket_size_in_seconds**     | 10                     | size of buckets in statistical window
-**:metrics**                    | Resilient::Metrics.new | metrics instance used to keep track of success and failure
+**:force_open**                 | `false`                  | allows forcing the circuit open (stopping all requests)
+**:force_closed**               | `false`                  | allows ignoring errors and therefore never trip "open" (e.g. allow all traffic through); normal instrumentation will still happen, thus allowing you to "test" configuration live without impact
+**:instrumenter**               | `Instrumenters::Noop`    | what to use to instrument all events that happen (e.g.  `ActiveSupport::Notifications`)
+**:sleep_window_seconds**       | `5`                      | seconds after tripping circuit before allowing retry
+**:request_volume_threshold**   | `20`                     | number of requests that must be made within a statistical window before open/close decisions are made using stats
+**:error_threshold_percentage** | `50`                     |  % of "marks" that must be failed to trip the circuit
+**:window_size_in_seconds**     | `60`                     | number of seconds in the statistical window
+**:bucket_size_in_seconds**     | `10`                     | size of buckets in statistical window
+**:metrics**                    | `Resilient::Metrics.new` | metrics instance used to keep track of success and failure
 
 ## Tests
 

data/lib/resilient/circuit_breaker.rb

@@ -106,13 +106,20 @@ module Resilient
     private
 
     def open_circuit
-      @opened_or_last_checked_at_epoch = Time.now.to_i
-      @open = true
+      instrument("resilient.circuit_breaker.open_circuit", key: @key) { |payload|
+        @opened_or_last_checked_at_epoch = Time.now.to_i
+        @open = true
+        payload[:open] = @open
+      }
     end
 
     def close_circuit
-      @open = false
-      @opened_or_last_checked_at_epoch = 0
+      instrument("resilient.circuit_breaker.close_circuit", key: @key) { |payload|
+        @open = false
+        payload[:open] = @open
+        payload[:interval] = Time.now.to_i - @opened_or_last_checked_at_epoch
+        @opened_or_last_checked_at_epoch = 0
+      }
       metrics.reset
     end
 

data/lib/resilient/version.rb

@@ -1,3 +1,3 @@
 module Resilient
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/resilient.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "bundler", "< 3.0"
   spec.add_development_dependency "minitest", "~> 5.8"
   spec.add_development_dependency "timecop", "~> 0.8.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: resilient
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-05 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -59,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -114,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: toolkit for resilient ruby apps

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 2.1.4
-  - 2.2.3
-before_install: gem install bundler -v 1.10.6
-bundler_args: --without=development
-script: script/test