sc4ry 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad841dbab3af84cbf8d7153d083add74200824d502a73aacc6d452f8e42a58d8
-  data.tar.gz: 7a6fdee9c2e076ba750adcd421bbf1d2115acd9db7778b75e6ffe475234d4db3
+  metadata.gz: 9cc6197c11f5b2946c2a7d7ac2057de82866228b4628f5b2d3c0613a3c821ca2
+  data.tar.gz: 306af4cfc3217b7ccc174b9f93407a995faad9fd691b83b0c6848a620313647f
 SHA512:
-  metadata.gz: dc1df50beebe4fb869ee88118c0cd922c45a02a79bf64b3f5dd9f539942980e0003b1444a1928f6ef0fced339a7672f8b6a65de463cec7ae87976a0c6f7e074e
-  data.tar.gz: 3b0d6aed86e5196a7ac829c6efe692d621a410933f2b0213ba37b6fc56748b405e036195cd91375ba581b71a6bfe24d7386fc8335ba600ebc0e0913f2db86f9b
+  metadata.gz: d501193d93a2c0fca6db0b0d7429ff00510253f741347a03a6c6b26b872acb24cb14490ea8a9a61e8b768fce541fbda8c56555e2ba940a1bebe225c4b9065c9b
+  data.tar.gz: e7416163124dee124d7573f37cd2ef51f7d8152105727d057256b5b6738435ab28949c2ebfd5ff5a0d5604b20b40dad32b1ff5f755e3b0b0ab26409b605c710a

data/README.md

@@ -2,6 +2,8 @@
 
 Sc4ry provide the Circuit Breaker Design Pattern for your applications
 
+![Sc4ry logo](assets/images/logo_sc4ry.png) _Simple CircuitBreacker 4 RubY_
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,7 +22,51 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### sample with Restclient
+
+```ruby
+
+require 'rubygems'
+require 'sc4ry'
+
+
+# defining a circuit, config must be empty or override from default
+Sc4ry::Circuits.register({:circuit =>:test, :config => {:notifiers => [:prometheus, :mattermost], :exceptions => [Errno::ECONNREFUSED], :timeout =>  true, :timeout_value => 3, :check_delay => 5 }})
+
+# display the list of known circuit
+pp Sc4ry::Circuits.list
+
+# display default config, must be override with a nested hash by calling default_config= method
+pp  Sc4ry::Circuits.default_config
+
+# default values, circuit is half open before one of the max count is reached
+
+# {:max_failure_count=>5,                      => maximum failure before opening circuit
+#  :timeout_value=>20,                         => timeout value, if :timeout => true
+#  :timeout=>false,                            => activate internal timeout
+#  :max_timeout_count=>5,                      => maximum timeout try before opening circuit
+#  :max_time=>10,                              => maximum time for a circuit run
+#  :max_overtime_count=>3,                     => maximum count of overtime before opening circuit
+#  :check_delay=>30,                           => delay after opening, before trying again to closed circuit or after an other check
+#  :notifiers=>[],                             => active notifier, must be :symbol in [:prometheus, :mattermost]
+#  :exceptions=>[StandardError, RuntimeError]} => list of selected Exceptions considered for failure, others are SKIPPED. 
+
+# display configuration for a specific circuit
+pp Sc4ry::Circuits.get circuit: :test
+
+# sample Mattermost notification
+#Sc4ry::Notifiers::config({:name => :mattermost, :config =>  {:url => 'https://mattermost.mycorp.com', :token => "<TOKEN>"}})
+
+# sample loop
+100.times do
+  sleep 1
+  Sc4ry::Circuits.run circuit: :test do 
+   # for the test choose or build an endpoint you must shutdown  
+   puts RestClient.get('http://<URL_OF_A_ENDPOINT>')
+  end
+end
+
+```
 
 ## Development
 

data/lib/sc4ry/circuits.rb

@@ -11,6 +11,8 @@ module Sc4ry
                  :max_overtime_count => 3,
                  :check_delay => 30,
                  :notifiers => [],
+                 :forward_unknown_exceptions => true,
+                 :raise_on_opening => false,
                  :exceptions => [StandardError, RuntimeError]
                  }
 
@@ -86,7 +88,10 @@ module Sc4ry
       [:closed,:half_open,:open].each do |status|
         data[:status][:general] = status if worst_status.include? status
       end
-      Sc4ry::Helpers.notify circuit: options[:circuit], config: data if save != data[:status][:general]          
+      if save != data[:status][:general] then
+        raise Sc4ry::Exceptions:CircuitBreaked if data[:status][:general] == :open and data[:raise_on_opening]
+        Sc4ry::Helpers.notify circuit: options[:circuit], config: data 
+      end          
       @@circuits_store.put key: options[:circuit], value: data
     end
   end

data/lib/sc4ry/dependencies.rb

@@ -13,7 +13,9 @@ require 'uri'
 require 'json'
 
 
+
 require_relative 'helpers'
+require_relative 'exceptions'
 require_relative 'logger'
 require_relative 'backends/init'
 require_relative 'store'

data/lib/sc4ry/exceptions.rb

@@ -0,0 +1,6 @@
+module Sc4ry
+    module Exceptions
+        class CircuitBreaked < StandardError; end
+
+    end
+end

data/lib/sc4ry/logger.rb

@@ -18,8 +18,8 @@ module Sc4ry
     end
     
     def Logger.current=(sym)
-      raise "Logger not define : #{sim}" unless @@loggers.keys.include? sim
-      @@default = sym
+      raise "Logger not define : #{sym}" unless @@loggers.keys.include? sym
+      @@current = sym
     end
     
     def Logger.register(options = {})

data/lib/sc4ry/run_controller.rb

@@ -43,7 +43,12 @@ module Sc4ry
         elsif @circuit[:exceptions].include? e.class
           @failure = true
         else  
-          Sc4ry::Loggers.warning "skipped : #{@last_exception}"
+          if @circuit[:forward_unknown_exceptions] then
+            raise @last_exception.class, "Sc4ry forward: #{@last_exception.message}" 
+          else
+            Sc4ry::Loggers.warning "skipped : #{@last_exception}"
+          end
+          
         end 
       end
       @end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)

data/lib/sc4ry/version.rb

@@ -1,3 +1,3 @@
 module Sc4ry
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sc4ry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies: []
 description: Sc4ry provide the design pattern Circuit breaker for your application.
 email:
@@ -23,6 +23,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/images/logo_sc4ry.png
+- assets/logo_sc4ry.png
 - bin/console
 - bin/setup
 - lib/sc4ry.rb
@@ -31,6 +33,7 @@ files:
 - lib/sc4ry/backends/redis.rb
 - lib/sc4ry/circuits.rb
 - lib/sc4ry/dependencies.rb
+- lib/sc4ry/exceptions.rb
 - lib/sc4ry/exporters/init.rb
 - lib/sc4ry/helpers.rb
 - lib/sc4ry/logger.rb