sc4ry 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6880abfcd193901a6d55d19df6cfe8ad73f407fc1b58aa078f94e3f31c11042f
-  data.tar.gz: 6a32baa113d73a3f2a76c4df860385296c49382ed4829fdb971e246b79ed1933
+  metadata.gz: f4cbfc8c2a7a821c3374916cdd69650a91f1eca5faa4dbbd93ac94e29dae5f89
+  data.tar.gz: dfa68d210342122e96e6f9fcd234fa73f6fefee667addac8371424b39c1b63d4
 SHA512:
-  metadata.gz: f4471f2769356f0068651aa5d5b4ea218e9a6b0ce608bb76db4ac0bb57f5df1e121df5b912478beea341eadde4f47ddd74c51fd08f651945926b1679d1b19af6
-  data.tar.gz: a2393c0893d3850ad154efdfe54608927f7f567aa65db4c16f7550fe7a9e681b072c3f2ef0a306e9126040dc347e4a0b4c8535fa637113d57aac399671f54f2d
+  metadata.gz: 82590002c1ac457715776b0be304d77fa2903885cc4dc21ee45cea87ee070648661b48520453ab011cd287da49997990b4e607940a54954f5f82b5c884089715
+  data.tar.gz: 8b63d6b39cee270a1e1ab38ffcde491b746011126615bc4a5908b9f8790017f0c30c8899453ca1848ee4022f8528a0edd61587b583d58a8404e4eef139ecbb84

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/Gemfile

@@ -6,4 +6,7 @@ gemspec
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 gem "prometheus-client", "~> 3.0"
-gem "rest-client", "~> 2.1"
+gem "rest-client", "~> 2.1"
+gem "redis", "~> 4.6"
+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,6 +40,9 @@ Or install it yourself as:
 
 ## Usage
 
+### Circuits States Worflow
+
+![Sc4ry workflow](assets/images/sc4ry_workflow.png) 
 ### sample with Restclient
 
 ```ruby
@@ -30,39 +51,64 @@ require 'rubygems'
 require 'sc4ry'
 
 
+puts 'Initial default config'
+pp Sc4ry::Circuits.default_config
+
+
+Sc4ry::Circuits.merge_default_config diff: {timeout: true }
+# or with a block
+Sc4ry::Circuits.configure do |spec|
+  spec.max_time = 12
+end
+
+
+# display default config
+puts 'Default config'
+pp Sc4ry::Circuits.default_config
+
+
 # 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 }})
+Sc4ry::Circuits.register circuit: :test, config: {:notifiers => [:prometheus,:mattermost], :exceptions => [Errno::ECONNREFUSED, URI::InvalidURIError] }
+# or with a block
+Sc4ry::Circuits.register circuit: :test2 do |spec|
+  spec.exceptions = [Errno::ECONNREFUSED]
+end
+# or 
+Sc4ry::Circuits.register circuit: :test3
 
-# 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
 
+puts "Circuits list"
+pp Sc4ry::Circuits::list
 
-# Config an alternate logger 
+# Config an alternate logger
 Sc4ry::Logger.register name: :perso, instance: ::Logger.new('/tmp/logfile.log')
-Sc4ry::Logger::current = :perso
+Sc4ry::Logger::current = :stdout
 
 
 # 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,                            => (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. 
+# DEFAULT_CONFIG = { 
+#             :max_failure_count => 5,
+#             :timeout_value => 20,
+#             :timeout => false,
+#             :max_timeout_count => 5,
+#             :max_time => 10,
+#             :max_overtime_count => 3,
+#             :check_delay => 30,
+#             :notifiers => [],
+#             :forward_unknown_exceptions => true,
+#             :raise_on_opening => false,
+#             :exceptions => [StandardError, RuntimeError]
+#             }
 
 # display configuration for a specific circuit
-pp Sc4ry::Circuits.get circuit: :test
+Sc4ry::Circuits::list.each do |circuit|
+  puts "Config #{circuit} :"
+  pp Sc4ry::Circuits.get circuit: circuit
+end
 
-# sample Mattermost notification
+ # sample Mattermost notification
 #Sc4ry::Notifiers::config({:name => :mattermost, :config =>  {:url => 'https://mattermost.mycorp.com', :token => "<TOKEN>"}})
 
 # sample loop
@@ -70,7 +116,7 @@ pp Sc4ry::Circuits.get circuit: :test
   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>')
+   puts RestClient.get('http://<URL_OF_AN_ENDPOINT>')
   end
 end
 
@@ -84,8 +130,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,37 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'yard'
+require 'yard/rake/yardoc_task.rb'
+require 'code_statistics'
+require "roodi"
+require "roodi_task"
+require "version"
+require 'rake/version_task'
+Rake::VersionTask.new
+
+
+RoodiTask.new() do | t |
+  t.patterns = %w(lib/**/*.rb)
+  t.config = "ultragreen_roodi_coding_convention.yml"
+end
+
 
 RSpec::Core::RakeTask.new(: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
+    rm_r "yardoc" rescue nil
+    rm_r ".yardoc" rescue nil
+    rm_r "pkg" rescue nil
+end
+end
+task :clobber => "yardoc:clobber"

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/sc4ry/backends/memory.rb

@@ -1,33 +1,60 @@
+# Sc4ry module
+# @note namespace
 module Sc4ry
+
+  # Sc4ry:Backends module
+  # @note namespace
   module Backends
 
+    # class of the memory backend
     class Memory
+              
+      # Constructor
+      # @param [Hash] config Config map 
+      # @return [Sc4ry::Backends::Memory] a in Memory backend
       def initialize(config=nil?)
         @data = Hash::new
       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
       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: )
+        return @data[key]
       end
 
-      def put(options)
-        @data[options[:key]] = options[:value]
+      # 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]
+      # 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: )
+        return @data.include? key
       end
 
     end

data/lib/sc4ry/backends/redis.rb

@@ -16,46 +16,47 @@ module Sc4ry
         # 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 @store.keys('*')
+           return @be.keys('*').map(&:to_sym)
         end
   
   
         # return value of queried record
-        # @param [Hash] options
-        # @option options [Symbol] :key the name of the record
+        # @param key [Symbol] the name of the record
         # @return [String] content value of record
-        def get(options)
-          return @store.get(options[:key])
+        def get(key:)
+          res = YAML.load(@be.get(key))
+          res[:exceptions].map! {|item|  item = Object.const_get(item) if item.class == String }
+          return res
         end
   
         # defined and store value for specified key
-        # @param [Hash] options
-        # @option options [Symbol] :key the name of the record
-        # @option options [Symbol] :value the content value of the record
+        # @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(options)
-          @store.set options[:key], options[:value]
+        def put(key: ,value:)
+          data = value.dup
+          data[:exceptions].map! {|item| item = item.name.to_s if item.class == Class }
+          @be.set key, data.to_yaml
         end
   
         # delete a specific record
-        # @param [Hash] options
-        # @option options [Symbol] :key the name of the record
+        # @param key [Symbol] the name of the record
         # @return [Boolean] status of the operation
-        def del(options)
-          @store.del options[:key]
+        def del(key: )
+          @be.del key
         end
   
         # flush all records in backend
+        # @return [Boolean] status of the operation
         def flush
-          @store.flushdb
+          @be.flushdb
         end
   
-        # verifiy a specific record existance
-        # @param [Hash] options
-        # @option options [Symbol] :key the name of the record
+        # verifiy a specific record existence
+        # @param key [Symbol] the name of the record
         # @return [Boolean] presence of the record
-        def exist?(options)
-          return ( not @store.get(options[:key]).nil?)
+        def exist?(key: )
+          return ( not @be.get(key).nil?)
         end