sc4ry 0.1.7 → 0.2.1

data/lib/sc4ry/store.rb

@@ -1,42 +1,111 @@
+# frozen_string_literal: true
+
+# Sc4ry module
+# @note namespace
 module Sc4ry
+  # Sc4ry::Store class
+  # Store Class Provider/manager singleton Forwarder on {Sc4ry::Backends::Memory} or {Sc4ry::Backends::Redis}
+  # @note must be accessed by {Sc4ry::Circuits.store}
   class Store
-
     @@current = :memory
 
     extend Forwardable
     include Singleton
 
-    @@backends = {:memory => {:class => Sc4ry::Backends::Memory},
-                  :redis  => {:class => Sc4ry::Backends::Redis, :config => {:host => 'localhost', :port => 6379, :db => 10 }}}
+    @@backends = { memory: { class: Sc4ry::Backends::Memory, config: {} },
+                   redis: { class: Sc4ry::Backends::Redis, config: { host: 'localhost', port: 6379, db: 1 } } }
 
+    # accessor on current backend (default :memory)
     attr_reader :be
+
     def_delegators :@be, :put, :get, :flush, :exist?, :del, :list
 
+    # constructor pointing on :memory backend
     def initialize
-      change_backend name: @@current 
-    end 
+      change_backend name: @@current
+    end
 
+    # return the current backend
+    # @return [Object] in {Sc4ry::Backends::Memory} or {Sc4ry::Backends::Redis}
+    # @example usage
+    #    include Sc4ry
+    #    puts Circuits.store.current
     def current
-      return @@current
+      @@current
     end
 
-    def change_backend(options)
-      @@current = options[:name]
-      @be = @@backends[@@current][:class]::new(@@backends[@@current][:config])
+    # return  the config of a specific backend
+    # @param [Symbol] backend the name the backend
+    # @return [Hash] the config of the backend
+    # @raise  Sc4ry::Exceptions::Sc4ryBackendError if backend is not found
+    # @example usage
+    #    include Sc4ry
+    #    puts Circuits.store.get_config backend: :redis
+    def get_config(backend:)
+      raise Sc4ry::Exceptions::Sc4ryBackendError, "backend #{backend} not found" unless @@backends.include? backend
+
+      @@backends[backend][:config]
     end
 
-    def register_backend(options)
-      raise ":name is mandatory" unless options[:name]
-      raise ":definition is mandatory" unless options[:definition]
-      @@backends[options[:name]] = options[:definition]
+    # list backend available
+    # @return [Array] of Symbol the list of backend name
+    # @example usage
+    #    include Sc4ry
+    #    puts Circuits.store.list_backend
+    def list_backend
+      @@backends.keys
     end
 
-    def config_backend(options)
-      raise ":name is mandatory" unless options[:name]
-      raise ":config is mandatory" unless options[:config]
-      @@backends[options[:name]][:config] = options[:config]
+    # change the current backend
+    # @note if changing form :memory to :redis => all values and result are lost and circuits will be lost
+    # @note if changing to :redis, get all the define circuits with values and status (ideal)
+    # @note for distributed worker/instance/runner/services
+    # @param [Symbol] name the name of the target backend
+    # @return [Symbol] the name of the new current backend
+    # @raise Sc4ry::Exceptions::Sc4ryBackendError if backend is not found
+    def change_backend(name:)
+      raise Sc4ry::Exceptions::Sc4ryBackendError, "backend #{name} not found" unless @@backends.include? name
+
+      @@current =  name
+      @be = @@backends[@@current][:class].new(@@backends[@@current][:config])
+      name
     end
 
+    # register a new backend
+    # @param [Symbol] name the name of the backend
+    # @param [Hash] config the config for this backend
+    # @param [Class] backend_class the class name of the new backend
+    # @raise Sc4ry::Exceptions::Sc4ryBackendError if backend already exist
+    # @return [Symbol] the name of the backend
+    def register_backend(name:, backend_class:, config: {})
+      raise Sc4ry::Exceptions::Sc4ryBackendError, "backend #{name} already exist" if @@backends.include? name
 
+      @@backends[name] = { config: config, class: backend_class }
+      name
+    end
+
+    # delete the specified backend reference
+    # @param [Symbol] name the name of the target backend
+    # @raise Sc4ry::Exceptions::Sc4ryBackendError if backend is not found, or name == :memory or :redis
+    # @return [Boolean]
+    def delete_backend(name:)
+      forbidden_mes = 'Delete forbidden for backend in [:redis,:memory]'
+      notfound_mes = "backend #{name} not found"
+      raise Sc4ry::Exceptions::Sc4ryBackendError, forbidden_mes if %i[memory redis].include? name
+      raise Sc4ry::Exceptions::Sc4ryBackendError, notfound_mes  unless @@backends.include? name
+
+      @@backends.delete(name)
+    end
+
+    # change the specified backend config
+    # @param [Symbol] name the name of the target backend
+    # @param [Hash] config the config of the specified backend
+    # @raise Sc4ry::Exceptions::Sc4ryBackendError if backend is not found, or name == :memory
+    def config_backend(name:, config:)
+      raise Sc4ry::Exceptions::Sc4ryBackendError, "backend #{name} not found" unless @@backends.include? name
+      raise Sc4ry::Exceptions::Sc4ryBackendError, 'backend :memory not need config' if name == :memory
+
+      @@backends[name][:config] = config
+    end
   end
-end
+end

data/lib/sc4ry/version.rb

@@ -1,3 +1,10 @@
+# frozen_string_literal: true
+
+require 'version'
+
+# Sc4ry module
+# @note namespace
 module Sc4ry
-  VERSION = "0.1.7"
+  # the version of Sc4ry
+  VERSION = Version.current
 end

data/lib/sc4ry.rb

@@ -1,10 +1,4 @@
-require "sc4ry/version"
-require "sc4ry/dependencies"
-
-
-
-
-
-
-
+# frozen_string_literal: true
 
+require 'sc4ry/version'
+require 'sc4ry/dependencies'

data/samples/test.rb

@@ -0,0 +1,159 @@
+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: %i[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'

data/sc4ry.gemspec

@@ -1,27 +1,31 @@
-require_relative 'lib/sc4ry/version'
+# frozen_string_literal: true
 
 Gem::Specification.new do |spec|
-  spec.name          = "sc4ry"
-  spec.version       = Sc4ry::VERSION
-  spec.authors       = ["Romain GEORGES"]
-  spec.email         = ["romain.georges@orange.com"]
-
-  spec.summary       = %q{Sc4Ry is Simple Circuitbreaker 4 RubY}
-  spec.description   = %q{Sc4ry provide the design pattern Circuit breaker for your application.}
-  spec.homepage      = "https://github.com/Ultragreen/sc4ry"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.name          = 'sc4ry'
+  spec.version       = `cat VERSION`.chomp
+  spec.authors       = ['Romain GEORGES']
+  spec.email         = ['romain.georges@orange.com']
 
+  spec.summary       = 'Sc4Ry is Simple Circuitbreaker 4 RubY'
+  spec.description   = 'Sc4ry provide the design pattern Circuit breaker for your application.'
+  spec.homepage      = 'https://github.com/Ultragreen/sc4ry'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.require_paths = ["lib"]
-  
-  spec.add_dependency "prometheus-client", "~> 3.0"
-  spec.add_dependency "rest-client", "~> 2.1"
+  spec.require_paths = ['lib']
 
+  spec.add_dependency 'prometheus-client', '~> 3.0'
+  spec.add_dependency 'redis', '~> 4.6'
+  spec.add_dependency 'rest-client', '~> 2.1'
 
+  spec.add_development_dependency 'code_statistics', '~> 0.2.13'
+  spec.add_development_dependency 'rubocop', '~> 1.32'
+  spec.add_development_dependency 'yard', '~> 0.9.27'
+  spec.add_development_dependency 'yard-rspec', '~> 0.1'
+  spec.add_dependency 'version', '~> 1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sc4ry
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.1
 platform: ruby
 authors:
 - Romain GEORGES
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: code_statistics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.13
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.27
+- !ruby/object:Gem::Dependency
+  name: yard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Sc4ry provide the design pattern Circuit breaker for your application.
 email:
 - romain.georges@orange.com
@@ -45,14 +129,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- VERSION
 - assets/images/logo_sc4ry.png
-- assets/logo_sc4ry.png
+- assets/images/sc4ry_workflow.png
 - bin/console
 - bin/setup
 - lib/sc4ry.rb
@@ -60,6 +147,8 @@ files:
 - lib/sc4ry/backends/memory.rb
 - lib/sc4ry/backends/redis.rb
 - lib/sc4ry/circuits.rb
+- lib/sc4ry/config.rb
+- lib/sc4ry/constants.rb
 - lib/sc4ry/dependencies.rb
 - lib/sc4ry/exceptions.rb
 - lib/sc4ry/exporters/init.rb
@@ -71,12 +160,13 @@ files:
 - lib/sc4ry/run_controller.rb
 - lib/sc4ry/store.rb
 - lib/sc4ry/version.rb
+- samples/test.rb
 - sc4ry.gemspec
 homepage: https://github.com/Ultragreen/sc4ry
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,15 +174,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Sc4Ry is Simple Circuitbreaker 4 RubY
 test_files: []