sc4ry 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad841dbab3af84cbf8d7153d083add74200824d502a73aacc6d452f8e42a58d8
-  data.tar.gz: 7a6fdee9c2e076ba750adcd421bbf1d2115acd9db7778b75e6ffe475234d4db3
+  metadata.gz: 0cf4e754e862f6af5921390386a8138d61168ca2dcc74be2af5024d554c16d27
+  data.tar.gz: f3b6bd16ed96d045058e2d05b7c7c24eb0e8feb9c57368301489f76d6fe1e4c5
 SHA512:
-  metadata.gz: dc1df50beebe4fb869ee88118c0cd922c45a02a79bf64b3f5dd9f539942980e0003b1444a1928f6ef0fced339a7672f8b6a65de463cec7ae87976a0c6f7e074e
-  data.tar.gz: 3b0d6aed86e5196a7ac829c6efe692d621a410933f2b0213ba37b6fc56748b405e036195cd91375ba581b71a6bfe24d7386fc8335ba600ebc0e0913f2db86f9b
+  metadata.gz: ed8241fdf174a9c6f6be4e61ada6627c62a246d574910bb83579fec77a0e919227bae3b2a1c00d3cfd469e5fbcab134d275fa19c7566536120901073ffee8ba0
+  data.tar.gz: 3d20056f6e08c289307beef56473f71e1a60b115d38ff119e0177317ffb8fca6b336451c62437fd8d7eb737463234b9734b962ddf02a936e3afc692d0588c0d5

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/logger.rb

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

data/lib/sc4ry/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sc4ry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2022-03-01 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