sc4ry 0.1.7 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86e9653534207c3b9809325a04d64da78f0636a1e62d800729cc15737ae0acf3
-  data.tar.gz: 1c00863a8330914acf9aea73f6022d7afaef73be50b3341f01e21a7490244125
+  metadata.gz: 5a0a0b0ccc0176505d96bfe85b978f155a989db942cc031972d7c31f24db0d2a
+  data.tar.gz: 1e0a528951e291efb0f04b05eaa6ae0897a6a98fb3834b11e7a8e45597848da4
 SHA512:
-  metadata.gz: 37c78c76dbb4a2a636ebbeb2bd70ac45949aa89983adda27810fb0bc3cf49078ef2e94e10b02f105ee6354109e2efeef9ed3f2b22678645fcf79e0cf097f0536
-  data.tar.gz: e32fe7cb84723bfcbbb1a90634d55cd3922c42bedb3e98c93d80f817ee6236ca966196c067a410a44affd04ff00c21560cdf18c702ad8e3f727e37ff9b248fbe
+  metadata.gz: c0159b1b8254dbc358eb68b33cb96cafdd5007c065e549ce307fbeacfeaf22f4739181b996fb62ce27dba3b33947eccd6e1d497970c0c218d8ec199633d3f480
+  data.tar.gz: 58280b4b7fe4cc20c30738aabaf258e35efc349dc0df1d2211a058e3b9acd7d61f55df9b3a9cda01b5493c9cfd48bd96993835460c5da8e4205f8a85f74e9559

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  container-job:
+    runs-on: ubuntu-latest
+    container: ruby:latest
+    services:
+      redis:
+        image: redis
+      pushgateway:
+        image: prom/pushgateway
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake
+      env:
+          # The hostname used to communicate with the Redis service container
+          REDIS_HOST: redis
+          REDIS_PORT: 6379
+          PROM_PG_PORT: 9091
+          PROM_PG_HOST: pushgateway

data/.gitignore

@@ -6,6 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+/yardoc/
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -0,0 +1,47 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-07-26 15:23:44 UTC using RuboCop version 1.32.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'spec/sc4ry_spec.rb'
+    - 'samples/test.rb'
+
+
+# definitive :
+Style/ClassVars:
+  Enabled: false
+Gemspec/RequireMFA:
+  Enabled: false
+Security/YAMLLoad:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+
+# to study :
+
+Metrics/ClassLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+
+
+
+
+
+
+
+

data/Gemfile

@@ -1,9 +1,13 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sc4ry.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "prometheus-client", "~> 3.0"
-gem "rest-client", "~> 2.1"
+gem 'prometheus-client', '~> 3.0'
+gem 'rake', '~> 12.0'
+gem 'redis', '~> 4.6'
+gem 'rest-client', '~> 2.1'
+gem 'rspec', '~> 3.0'
+gem 'version', '~> 1.1'

data/README.md

@@ -2,7 +2,25 @@
 
 Sc4ry provide the Circuit Breaker Design Pattern for your applications
 
-![Sc4ry logo](assets/images/logo_sc4ry.png) _Simple CircuitBreacker 4 RubY_
+[![Ruby](https://github.com/Ultragreen/Sc4ry/workflows/Ruby/badge.svg)](https://github.com/Ultragreen/sc4ry/actions?query=workflow%3ARuby+branch%3Amaster)
+![GitHub](https://img.shields.io/github/license/Ultragreen/sc4ry)
+
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-brightgreen)](https://rubydoc.info/gems/sc4ry)
+![GitHub issues](https://img.shields.io/github/issues/Ultragreen/sc4ry)
+![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/Ultragreen/sc4ry)
+![GitHub top language](https://img.shields.io/github/languages/top/Ultragreen/sc4ry)
+![GitHub milestones](https://img.shields.io/github/milestones/open/Ultragreen/sc4ry)
+
+![Gem](https://img.shields.io/gem/dt/sc4ry)
+[![Gem Version](https://badge.fury.io/rb/sc4ry.svg)](https://badge.fury.io/rb/sc4ry)
+![Twitter Follow](https://img.shields.io/twitter/follow/Ultragreen?style=social)
+![GitHub Org's stars](https://img.shields.io/github/stars/Ultragreen?style=social)
+![GitHub watchers](https://img.shields.io/github/watchers/Ultragreen/sc4ry?style=social)
+
+<noscript><a href="https://liberapay.com/ruydiaz/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a></noscript>
+
+![Sc4ry logo](assets/images/logo_sc4ry.png) 
+_Simple CircuitBreacker 4 RubY_
 
 ## Installation
 
@@ -22,58 +40,285 @@ Or install it yourself as:
 
 ## Usage
 
-### sample with Restclient
+### Circuits States Worflow
+
+![Sc4ry workflow](assets/images/sc4ry_workflow.png) 
+### Quickstart : sample with Restclient
+
+A quick circuit test :
+create a test script lile test.rb :
 
 ```ruby
 
-require 'rubygems'
-require 'sc4ry'
+  require 'rubygems'
+  require 'sc4ry'
 
+  include 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 }})
+  Circuits.register circuit: :mycircuit, config: {:notifiers => [:prometheus,:mattermost], 
+                                                  :exceptions => [Errno::ECONNREFUSED, URI::InvalidURIError]}
 
-# display the list of known circuit
-pp Sc4ry::Circuits.list
+  Circuits.run  do # circuit: :mycircuit is optional, run work with the first circuit registered
+    puts RestClient.get('http://your_service/endpoint')
+  end
 
-# display default config, must be override with a nested hash by calling default_config= method
-pp  Sc4ry::Circuits.default_config
+  
 
+```
 
-# Config an alternate logger 
-Sc4ry::Logger.register name: :perso, instance: ::Logger.new('/tmp/logfile.log')
-Sc4ry::Logger::current = :perso
+### the Sc4ry Config default values :
 
+Default values, circuit is half open before one of the max count is reached :
 
-# default values, circuit is half open before one of the max count is reached
+* _:max_failure_count_
+<br>*description* : maximum failure before opening circuit
+<br>*default value* : 5
+<br>
 
-# {:max_failure_count=>5,                      => maximum failure before opening circuit
-#  :timeout_value=>20,                         => timeout value, if :timeout => true
-#  :timeout=>false,                            => (de)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]
-#  :forward_unknown_exceptions => true,        => (de)activate forwarding of unknown exceptions, just log in DEBUG if false
-#  :raise_on_opening => false,                 => (de)activate raise specific Sc4ry exceptions ( CircuitBreaked ) if circuit opening
-#  :exceptions=>[StandardError, RuntimeError]} => list of selected Exceptions considered for failure, others are SKIPPED. 
+*  _:timeout_value_
+<br>*description* : timeout value, if :timeout => true
+<br>*default value* : 20
+<br>
 
-# display configuration for a specific circuit
-pp Sc4ry::Circuits.get circuit: :test
+*  _:timeout_
+<br>*description* : (de)activate internal timeout
+<br>*default value* : false
+<br>
 
-# sample Mattermost notification
-#Sc4ry::Notifiers::config({:name => :mattermost, :config =>  {:url => 'https://mattermost.mycorp.com', :token => "<TOKEN>"}})
+*  _:max_timeout_count_
+<br>*description* : maximum timeout try before opening circuit
+<br>*default value** : 5
+<br>
 
-# 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
+*  _:max_time_
+<br>*description* : maximum time for a circuit run
+<br>*default value* : 10
+<br>
+
+*  _:max_overtime_count_
+<br>*description* : maximum count of overtime before opening circuit
+<br>*default value* : 3
+<br>
+
+*  _:check_delay_
+<br>*description* : delay after opening, before trying again to closed circuit or after an other check
+<br>*default value* : 30
+<br>
+
+*  _:notifiers_
+<br>*description* : active notifier, must be :symbol in [:prometheus, :mattermost]
+<br>*default value* : []
+<br>
+
+*  _:forward_unknown_exceptions_
+<br>*description* : (de)activate forwarding of unknown exceptions, just log in DEBUG if false
+<br>*default value* : true
+<br>
+
+*  _:raise_on_opening_
+<br>*description* : (de)activate raise specific Sc4ry exceptions ( CircuitBreaked ) if circuit opening
+<br>*default value* : false
+<br>
+
+*  _:exceptions_
+<br>*description* : [StandardError, RuntimeError]
+<br>*default value* : list of selected Exceptions considered for failure, others are SKIPPED.  
+
+### Global overview for all features
+
+This script could be usefull to test all feature on your installation 
+
+You need: 
+* Redis 
+* Prometheus pushgateway
+* an endpoint if you want to check real endpoint
+* a Mattermost/Slack incoming webhook (optional)
+
+You could gate all this pre-requistes simply if you jave docker up on your machine
 
+```
+    $ docker pull redis:latest
+    $ docker run --rm -d  -p 6379:6379/tcp redis:latest
+    $ docker pull prom/pushgateway:latest
+    $ docker run --rm -d -p 9091:9091 prom/pushgateway:latest
+    $ git clone https://github.com/Ultragreen/MockWS.git
+    $ cd MockWS
+    $ rackup
+```
+
+create the test script like :
+
+```ruby
+
+    require 'rubygems'
+    require 'sc4ry'
+
+
+    include Sc4ry
+
+    # display of default Sc4ry config
+    puts '1.1/ CONFIG : Initial default config'
+    Circuits.default_config.each do |item,value|
+      puts " * #{item} : #{value}"
+    end
+    puts ''
+
+    # testing the two ways to configure Sc4ry default config
+    puts "1.2/ CONFIG : modifying default config activate timout and set max_time to 12"
+    Circuits.merge_default_config diff: {timeout: true }
+    Circuits.configure do |spec|
+      spec.max_time = 12
+    end
+    puts ''
+
+    # display default config, must be override with a nested hash by calling default_config= method
+    puts '1.3/ CONFIG : Default config updated:'
+    Circuits.default_config.each do |item,value|
+      puts " * #{item} : #{value}"
+    end
+    puts ''
+
+    # display current data Store
+    print "2.1/ STORE : Current datastore backend : "
+    puts Circuits.store.current
+    puts ''
+
+
+    # display available backend
+    puts "2.2/ STORE : List of existing backends : "
+    Circuits.store.list_backend.each do |backend|
+      puts " - #{backend}"
+    end
+    puts ''
+
+
+    # display Redis backend config in store before change
+    puts '2.3/ STORE : display default config of redis backend'
+    Circuits.store.get_config(backend: :redis).each do |item,value|
+      puts " * #{item} : #{value}"
+    end
+    puts ''
+
+    # reconfigure a backend
+    puts "2.4/ STORE : reconfigure Redis backend"
+    Circuits.store.config_backend name: :redis, config: {:host => 'localhost', :port => 6379, :db => 10 }
+    puts
+
+    # display after
+    puts '2.5/ STORE : display altered config of redis backend'
+    Circuits.store.get_config(backend: :redis).each do |item,value|
+      puts " * #{item} : #{value}"
+    end
+    puts ''
+
+
+    # change backend
+
+    puts '2.6/ STORE : change to redis backend (NEED a Redis installed) '
+    puts "  $ docker pull redis:latest"
+    puts "  $ docker run --rm -d  -p 6379:6379/tcp redis:latest"
+    Circuits.store.change_backend name: :redis
+    puts ''
+
+    puts '2.7/ STORE : flush redis backend, just for test, and for idempotency (NEED a Redis installed) '
+    Circuits.store.flush
+    puts ''
+
+    # defining a circuit, config must be empty or override from default
+    puts "3.1/ CIRCUIT : registering a circuit by merge :"
+    Circuits.register circuit: :test, config: {:notifiers => [:prometheus,:mattermost], :exceptions => [Errno::ECONNREFUSED, URI::InvalidURIError] }
+    puts ""
+
+    puts "3.2/ CIRCUIT : registering a circuit by block :"
+    Circuits.register circuit: :test2 do |spec|
+      spec.exceptions = [Errno::ECONNREFUSED]
+    end
+    puts ''
+
+    puts "3.3/ CIRCUIT : registering a circuit by default :"
+    Circuits.register circuit: :test3
+    puts ''
+
+    puts "3.4/ CIRCUITS : Circuits list"
+    Circuits::list.each do |circuit|
+      puts " * #{circuit}"
+    end
+    puts ""
+
+    puts "3.5/ CIRCUIT : display a circuit config :test3 :"
+    Circuits.get(circuit: :test3).each do |item,value|
+      puts " * #{item} : #{value}"
+    end
+    puts ""
+
+    puts "3.6/ CIRCUIT : update config of :test3 => :raise_on_opening == true  :"
+    Circuits.update_config circuit: :test3, config: {raise_on_opening: true}
+    puts ''
+
+    puts "3.7/ CIRCUIT : display a circuit config :test3 after change :"
+    Circuits.get(circuit: :test3).each do |item,value|
+      puts " * #{item} : #{value}"
+    end
+    puts ""
+
+
+    puts "3.8/ unregister a circuit : :test2 :"
+    Circuits.unregister circuit: :test2
+    puts ''
+
+    puts "3.9/ CIRCUITS : Circuits list after unregister"
+    Circuits::list.each do |circuit|
+      puts " * #{circuit}"
+    end
+    puts ""
+
+    # Config an alternate logger
+
+    puts "4.1/ LOGGER : register a logger on file "
+    Circuits.loggers.register name: :perso, instance: ::Logger.new('/tmp/logfile.log')
+    puts ''
+
+    puts "4.2/ LOGGER : get the list of available loggers"
+    Circuits.loggers.list_available.each do |logger|
+      puts " * #{logger}"
+    end
+    puts ''
+
+    puts "4.3/ LOGGER : change logger to :perso"
+    Circuits.loggers.current = :perso
+    puts ""
+
+
+
+
+
+    # sample Mattermost notification
+    puts "5/ set notifier mattermost on dummy url, change with your slack or mattermost server"
+    Sc4ry::Notifiers::config name: :mattermost, config: {:url => 'https://mattermost.mycorp.com', :token => "<TOKEN>"}
+    puts ""
+
+
+    # sample loop
+    puts "6/ running circuits test, please wait ... (see /tmp/logfile.log for result)"
+    puts " check endoint status for different result, you cloud use http://github.com/Ultragreen/MockWS for testing endpoint, on an other tty"
+    puts "  $ git clone https://github.com/Ultragreen/MockWS.git"
+    puts "  $ cd MockWS"
+    puts "  $ rackup"
+    begin
+      10.times do
+        sleep 1
+        Circuits.run circuit: :test do
+          # for the test choose or build an endpoint you must shutdown
+          puts RestClient.get('http://localhost:9292/test2/data')
+        end
+      end
+    rescue Interrupt
+      puts 'Interrputed'
+    ensure
+      Circuits.store.flush
+    end
+
+    puts "end"
 ```
 
 ## Development
@@ -84,8 +329,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sc4ry. 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]/sc4ry/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ultragreen/sc4ry. 
 
 ## License
 

data/Rakefile

@@ -1,6 +1,44 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+require 'code_statistics'
+require 'version'
+require 'rake/version_task'
+require 'rubocop//rake_task'
+
+Rake::VersionTask.new
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', '-', 'doc/**/*', 'spec/**/*_spec.rb']
+  t.options += ['-o', 'yardoc']
+end
+YARD::Config.load_plugin('yard-rspec')
+
+namespace :yardoc do
+  task :clobber do
+    begin
+      rm_r 'yardoc'
+    rescue StandardError
+      nil
+    end
+    begin
+      rm_r '.yardoc'
+    rescue StandardError
+      nil
+    end
+    begin
+      rm_r 'pkg'
+    rescue StandardError
+      nil
+    end
+  end
+end
+
+task clobber: 'yardoc:clobber'

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "sc4ry"
+require 'bundler/setup'
+require 'sc4ry'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "sc4ry"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/sc4ry/backends/init.rb

@@ -1 +1,3 @@
-Dir[File.dirname(__FILE__) + '/*.rb'].sort.each { |file| require file unless File.basename(file) == 'init.rb' }
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/*.rb"].sort.each { |file| require file unless File.basename(file) == 'init.rb' }

data/lib/sc4ry/backends/memory.rb

@@ -1,35 +1,60 @@
+# frozen_string_literal: true
+
+# Sc4ry module
+# @note namespace
 module Sc4ry
+  # Sc4ry:Backends module
+  # @note namespace
   module Backends
-
+    # class of the memory backend
     class Memory
-      def initialize(config=nil?)
-        @data = Hash::new
+      # Constructor
+      # @param [Hash] config Config map
+      # @return [Sc4ry::Backends::Memory] a in Memory backend
+      def initialize(_config = nil?)
+        @data = {}
       end
 
+      # return the list of find records in backend for a specific pattern
+      # @return [Array] list of record (for all hostname if hostname is specified)
       def list
-        return @data.keys
+        @data.keys
       end
 
-      def get(options)
-        return @data[options[:key]]
+      # return value of queried record
+      # @param key [Symbol] the name of the record
+      # @return [String] content value of record
+      def get(key:)
+        @data[key]
       end
 
-      def put(options)
-        @data[options[:key]] = options[:value]
-      end 
+      # defined and store value for specified key
+      # @param key [Symbol] :key the name of the record
+      # @param value [Symbol] :value the content value of the record
+      # @return [String] content value of record
+      def put(key:, value:)
+        @data[key] = value
+      end
 
-      def del(options)
-        @data.delete options[:key]
-      end 
+      # delete a specific record
+      # @param params [Symbol] the name of the record
+      # @return [Boolean] status of the operation
+      def del(key:)
+        @data.delete key
+      end
 
+      # flush all records in backend
+      # @return [Boolean] status of the operation
       def flush
         @data.clear
       end
 
-      def exist?(options)
-        return @data.include? options[:key]
+      # verifiy a specific record existence
+      # @param key [Symbol] the name of the record
+      # @return [Boolean] presence of the record
+      def exist?(key:)
+        @data.include? key
       end
-
     end
   end
-end
+end