sc4ry 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+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"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Romain GEORGES
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Sc4ry : Simple CircuitBreacker For RubY
+
+Sc4ry provide the Circuit Breaker Design Pattern for your applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sc4ry'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sc4ry
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sc4ry/backends/init.rb

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

data/lib/sc4ry/backends/memory.rb

@@ -0,0 +1,35 @@
+module Sc4ry
+  module Backends
+
+    class Memory
+      def initialize(config=nil?)
+        @data = Hash::new
+      end
+
+      def list
+        return @data.keys
+      end
+
+      def get(options)
+        return @data[options[:key]]
+      end
+
+      def put(options)
+        @data[options[:key]] = options[:value]
+      end 
+
+      def del(options)
+        @data.delete options[:key]
+      end 
+
+      def flush
+        @data.clear
+      end
+
+      def exist?(options)
+        return @data.include? options[:key]
+      end
+
+    end
+  end
+end

data/lib/sc4ry/backends/redis.rb

@@ -0,0 +1,65 @@
+module Sc4ry
+    module Backends
+        # Redis backend definition
+        class Redis
+
+        # Constructor
+        # @param [Hash] config Config map 
+        # @return [Sc4ry::Backends::Redis] a Redis backend
+        def initialize(config)
+          @auth = config.slice(:auth)[:auth]
+          @config = config.slice(:host, :port, :db)
+          @be = ::Redis.new @config
+          @be.auth(@auth) if @auth
+        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 @store.keys('*')
+        end
+  
+  
+        # return value of queried record
+        # @param [Hash] options
+        # @option options [Symbol] :key the name of the record
+        # @return [String] content value of record
+        def get(options)
+          return @store.get(options[:key])
+        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
+        # @return [String] content value of record
+        def put(options)
+          @store.set options[:key], options[:value]
+        end
+  
+        # delete a specific record
+        # @param [Hash] options
+        # @option options [Symbol] :key the name of the record
+        # @return [Boolean] status of the operation
+        def del(options)
+          @store.del options[:key]
+        end
+  
+        # flush all records in backend
+        def flush
+          @store.flushdb
+        end
+  
+        # verifiy a specific record existance
+        # @param [Hash] options
+        # @option options [Symbol] :key the name of the record
+        # @return [Boolean] presence of the record
+        def exist?(options)
+          return ( not @store.get(options[:key]).nil?)
+        end
+      
+  
+      end
+  
+    end
+end  

data/lib/sc4ry/circuits.rb

@@ -0,0 +1,93 @@
+module Sc4ry
+  class Circuits
+
+    @@circuits_store = Sc4ry::Store.instance 
+
+    @@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 => [],
+                 :exceptions => [StandardError, RuntimeError]
+                 }
+
+    def Circuits.default_config
+      return @@config
+    end
+
+    def Circuits.register(options = {})
+      raise ":circuit is mandatory" unless options[:circuit]
+      name = options[:circuit]
+      override = (options[:config].class == Hash)? options[:config] : {}
+      config = @@config.merge override
+      @@circuits_store.put key: name, value: config 
+    end
+
+    def Circuits.list
+      return @@circuits_store.list
+    end
+
+
+    def Circuits.get(options)
+      @@circuits_store.get key: options[:circuit]
+    end
+
+    def Circuits.run(options = {}, &block)
+      circuits_list = Circuits.list
+      raise "No circuit block given" unless block_given?
+      raise "No circuits defined" if circuits_list.empty? 
+      circuit_name = (options[:circuit])? options[:circuit] : circuits_list.first
+      raise "Circuit #{circuit_name} not found" unless circuits_list.include? circuit_name
+      circuit = Circuits.get circuit: circuit_name
+      skip = false
+      if circuit.include? :status then
+        if circuit[:status][:general] == :open then 
+          @now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          skip = true if ((@now - circuit[:values].last[:end_time]) <  circuit[:check_delay])
+        end
+      end
+      unless skip 
+        controller = Sc4ry::RunController.new(circuit)
+        Circuits.control circuit: circuit_name, values: controller.run(block: block)
+      end
+      Sc4ry::Helpers.log level: :info, message: "Circuit #{circuit_name} : status #{circuit[:status]}"
+
+    end
+
+    private
+    def Circuits.control(options={})
+      data = @@circuits_store.get key: options[:circuit]
+      data[:status] = {:general => :closed, :failure_count => 0, :overtime_count => 0, :timeout_count => 0} unless data.include? :status
+      data[:values] = Array::new unless data.include? :values
+      level = [data[:max_failure_count].to_i, data[:max_timeout_count].to_i, data[:max_overtime_count].to_i].max
+      data[:values].shift if data[:values].size > level
+      data[:values].push options[:values]
+      worst_status = []
+      ['failure','overtime','timeout'].each do |control|
+        if options[:values][control.to_sym] == true then
+          data[:status]["#{control}_count".to_sym] += 1
+        else
+          data[:status]["#{control}_count".to_sym] = 0
+        end
+    
+        case data[:status]["#{control}_count".to_sym]
+        when 0
+          worst_status.push :closed
+        when 1..data["max_#{control}_count".to_sym]
+          worst_status.push :half_open
+        else
+          worst_status.push :open
+        end
+      end
+      save = data[:status][:general]
+      [: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]          
+      @@circuits_store.put key: options[:circuit], value: data
+    end
+  end
+end

data/lib/sc4ry/dependencies.rb

@@ -0,0 +1,23 @@
+require 'rest-client'
+require 'prometheus/client'
+require 'prometheus/client/push'
+
+require 'logger' 
+require 'timeout'
+require 'forwardable'
+require 'singleton'
+require 'socket'
+require 'openssl'
+require 'net/http'
+require 'uri'
+require 'json'
+
+
+require_relative 'helpers'
+require_relative 'logger'
+require_relative 'backends/init'
+require_relative 'store'
+require_relative 'run_controller'
+require_relative 'circuits'
+require_relative 'notifiers/init'
+require_relative 'exporters/init'

data/lib/sc4ry/exporters/init.rb

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

data/lib/sc4ry/helpers.rb

@@ -0,0 +1,49 @@
+
+module Sc4ry
+  module Helpers
+
+    def Helpers.log(options)
+      Sc4ry::Logger.current = options[:target] if options[:target]
+      Sc4ry::Logger.get.send options[:level], "Sc4ry : #{options[:message]}"  
+    end
+
+    # TCP/IP service checker
+    # @return [Bool] status
+    # @param [Hash] options
+    # @option options [String] :host hostname
+    # @option options [String] :port TCP port
+    # @option options [String] :url full URL, priority on :host and :port
+    def Helpers.verify_service(options ={})
+      begin
+        if options[:url] then
+          uri = URI.parse(options[:url])
+          host = uri.host
+          port = uri.port
+        else
+          host = options[:host]
+          port = options[:port]
+        end
+        Timeout::timeout(1) do
+          begin
+            s = TCPSocket.new(host, port)
+            s.close
+            return true
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            return false
+          end
+        end
+      rescue Timeout::Error
+        return false
+      end
+    end
+
+
+    def Helpers.notify(options = {})
+      Sc4ry::Notifiers.list.each do |record|
+        notifier = Sc4ry::Notifiers.get name: record
+        notifier[:class].notify(options) if options[:config][:notifiers].include? record 
+      end
+    end
+
+  end 
+end

data/lib/sc4ry/logger.rb

@@ -0,0 +1,30 @@
+
+module Sc4ry
+  class Logger
+    
+    @@loggers = {:stdout => ::Logger.new(STDOUT)}
+    @@current = :stdout
+    
+    def Logger.list_avaible
+      return @@loggers
+    end
+    
+    def Logger.current
+      return @@current
+    end
+    
+    def Logger.get
+      return @@loggers[@@current]
+    end
+    
+    def Logger.current=(sym)
+      raise "Logger not define : #{sim}" unless @@loggers.keys.include? sim
+      @@default = sym
+    end
+    
+    def Logger.register(options = {})
+      @@loggers[options[:name]] = options[:instance] 
+    end
+    
+  end
+end

data/lib/sc4ry/notifiers/init.rb

@@ -0,0 +1,30 @@
+Dir[File.dirname(__FILE__) + '/*.rb'].sort.each { |file| require file unless File.basename(file) == 'init.rb' }
+
+module Sc4ry 
+  module Notifiers
+    @@notifiers_list = {:prometheus => {:class => Sc4ry::Notifiers::Prometheus, :config => {:url => 'http://localhost:9091'}},
+                        :mattermost => {:class => Sc4ry::Notifiers::Mattermost, :config => {:url => 'http://localhost:9999', :token => "<CHANGE_ME>"}}                            
+                       }
+
+    def Notifiers.list
+      return @@notifiers_list.keys
+    end
+
+    def Notifiers.get(options ={})
+      return @@notifiers_list[options[:name]]
+    end
+
+    def Notifiers.register(options)
+      raise ":name is mandatory" unless options[:name]
+      raise ":definition is mandatory" unless options[:definition]
+      @@notifiers_list[options[:name]] = options[:definition]
+    end
+
+    def Notifiers.config(options)
+      raise ":name is mandatory" unless options[:name]
+      raise ":config is mandatory" unless options[:config]
+      @@notifiers_list[options[:name]][:config] = options[:config]
+    end
+ end
+end
+

data/lib/sc4ry/notifiers/mattermost.rb

@@ -0,0 +1,35 @@
+module Sc4ry
+    module Notifiers
+        
+        class Mattermost
+            
+            # send metrics to Prometheus PushGateway
+            # @return [Bool]
+            def Mattermost.notify(options = {})
+                config = Sc4ry::Notifiers.get({name: :mattermost})[:config]
+                status = options[:config][:status][:general]
+                circuit = options[:circuit]
+                status_map = {:open => 0, :half_open => 1, :closed => 2}
+                
+                uri = URI.parse("#{config[:url]}/hooks/#{config[:token]}")
+                message = "notifying for circuit #{circuit.to_s}, state : #{status.to_s}."
+                if Sc4ry::Helpers::verify_service url: config[:url] then
+                    request = ::Net::HTTP::Post.new(uri)
+                    request.content_type = "application/json"
+                    req_options = {
+                        use_ssl: uri.scheme == "https",
+                    }
+                    payload = { "text" => "message : #{message } from #{Socket.gethostname}", "username" => "Sc4ry" }
+                    Sc4ry::Helpers.log level: :debug, message: "Mattermost Notifier : #{message}"
+                    request.body = ::JSON.dump(payload)
+                    response = ::Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+                        http.request(request)
+                    end
+                    
+                else
+                    Sc4ry::Helpers.log level: :warn, message: "Mattermost Notifier : can't notify Mattermost not reachable."
+                end
+            end
+        end
+    end
+end

data/lib/sc4ry/notifiers/prometheus.rb

@@ -0,0 +1,37 @@
+module Sc4ry
+  module Notifiers
+
+  
+    class Prometheus
+
+      @@registry = ::Prometheus::Client::Registry::new
+      @@metric_circuit_state = ::Prometheus::Client::Gauge.new(:cuircuit_state, docstring: 'Sc4ry metric : state of a circuit', labels: [:circuit])
+
+      @@registry.register(@@metric_circuit_state)
+
+    
+
+      # send metrics to Prometheus PushGateway
+      # @return [Bool]
+      def Prometheus.notify(options = {})
+        @config = Sc4ry::Notifiers.get({name: :prometheus})[:config]
+        status = options[:config][:status][:general]
+        circuit = options[:circuit]
+        status_map = {:open => 0, :half_open => 1, :closed => 2}
+        if Sc4ry::Helpers::verify_service url: @config[:url] then
+          
+          @@metric_circuit_state.set(status_map[status], labels: {circuit: circuit.to_s })
+          Sc4ry::Helpers.log level: :debug, message: "Prometheus Notifier : notifying for circuit #{circuit.to_s}, state : #{status.to_s}."
+
+          return ::Prometheus::Client::Push.new(job: "Sc4ry", instance: Socket.gethostname, gateway: @config[:url]).add(@@registry)
+        else
+          Sc4ry::Helpers.log level: :warn, message: "Prometheus Notifier : can't notify Push Gateway not reachable."
+        end
+      end
+    end
+
+    
+    
+  end
+
+end

data/lib/sc4ry/run_controller.rb

@@ -0,0 +1,59 @@
+
+module Sc4ry
+  class RunController
+
+    attr_reader :execution_time
+
+    def initialize(circuit = {})
+      @circuit = circuit
+      @execution_time = 0
+      @timeout = false
+      @failure = false
+      @overtime = false
+    end
+
+    def failed?
+      return @failure
+    end 
+    
+    def overtimed? 
+      return @overtime
+    end
+
+    def timeout? 
+      return @timeout
+    end
+
+    
+    def run(options = {})
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      begin 
+        if @circuit[:timeout] == true
+          Timeout::timeout(@circuit[:timeout_value]) do 
+            options[:block].call
+          end
+          @timeout = false
+        else
+          options[:block].call
+        end
+      rescue Exception => e
+        @last_exception = e.class
+        if e.class  == Timeout::Error then 
+          @timeout = true
+        elsif @circuit[:exceptions].include? e.class
+          @failure = true
+        else  
+          Sc4ry::Loggers.warning "skipped : #{@last_exception}"
+        end 
+      end
+      @end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      @execution_time = @end_time - start_time
+      @overtime = @execution_time > @circuit[:max_time] 
+      return {failure: @failure, overtime: @overtime, timeout: @timeout, execution_time: @execution_time, end_time: @end_time, last_exception: @last_exception}
+
+    end
+
+
+
+  end
+end

data/lib/sc4ry/store.rb

@@ -0,0 +1,42 @@
+module Sc4ry
+  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 }}}
+
+    attr_reader :be
+    def_delegators :@be, :put, :get, :flush, :exist?, :del, :list
+
+    def initialize
+      change_backend name: @@current 
+    end 
+
+    def current
+      return @@current
+    end
+
+    def change_backend(options)
+      @@current = options[:name]
+      @be = @@backends[@@current][:class]::new(@@backends[@@current][: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]
+    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]
+    end
+
+
+  end
+end

data/lib/sc4ry/version.rb

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

data/lib/sc4ry.rb

@@ -0,0 +1,10 @@
+require "sc4ry/version"
+require "sc4ry/dependencies"
+
+
+
+
+
+
+
+

data/sc4ry.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/sc4ry/version'
+
+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")
+
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: sc4ry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Romain GEORGES
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-21 00:00:00.000000000 Z
+dependencies: []
+description: Sc4ry provide the design pattern Circuit breaker for your application.
+email:
+- romain.georges@orange.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sc4ry.rb
+- lib/sc4ry/backends/init.rb
+- lib/sc4ry/backends/memory.rb
+- lib/sc4ry/backends/redis.rb
+- lib/sc4ry/circuits.rb
+- lib/sc4ry/dependencies.rb
+- lib/sc4ry/exporters/init.rb
+- lib/sc4ry/helpers.rb
+- lib/sc4ry/logger.rb
+- lib/sc4ry/notifiers/init.rb
+- lib/sc4ry/notifiers/mattermost.rb
+- lib/sc4ry/notifiers/prometheus.rb
+- lib/sc4ry/run_controller.rb
+- lib/sc4ry/store.rb
+- lib/sc4ry/version.rb
+- sc4ry.gemspec
+homepage: https://github.com/Ultragreen/sc4ry
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Sc4Ry is Simple Circuitbreaker 4 RubY
+test_files: []