rcb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61b7b710d6681c43cbe7b7d538d0eeda7199ee7e7c892e3aa2b0ddd1455a5a08
+  data.tar.gz: 18449ecc9021e6dace52a8b07834544564234d1fe06170d81830a0c36aca5021
+SHA512:
+  metadata.gz: 263813bdacad4713d2cf411aa6f5caae798166290142e96aabce52c2b1bd95220fd008fbbd46188afd3f59834c58edcacc43d0537865cd0e7e0b90260829966f
+  data.tar.gz: 95c4afc987cef799fbf40dbb29bbcaf08a94110d5b7996d076560951430975894bb2f35fa29a69b1cc24a6022ca54ff25f4587ff39e0d7b525cfff055651f67a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at violethero0820@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rcb.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 petitviolet
+
+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,95 @@
+# Rcb - Ruby Circuit Breaker
+
+[Circuit Breaker](https://martinfowler.com/bliki/CircuitBreaker.html) implementation for/by Ruby.  
+CircuitBreaker is a great pattern to build robust system consists of bunch of microservices.
+
+- Close
+    - A operational state
+- Open
+    - A not operational state
+- Half Open
+    - On the way of it's state to Close from Open.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rcb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rcb
+
+## Usage
+
+### Import
+
+To use rcb, insert this line:
+
+```ruby
+require 'rcb'
+```
+
+### Configuration
+
+Add configuration with specifying `tag` like:
+
+```ruby
+Rcb.configure('fooo.com') do |config|
+    config.max_failure_count 1
+    config.reset_timeout_msec 100
+end
+
+Rcb.configure('hoge.com') do |config|
+    config.max_failure_count 3
+    config.reset_timeout_msec 300
+end
+```
+
+These configurations are for both 'fooo.com' and 'hoge.com'.
+
+- `max_failure_count`: a threshold for execution failures. 
+    - if the breaker reaches the given `max_failure_count`, enters Open state from Close 
+- `reset_timeout_msec`: milliseconds to wait for next try
+    - after the given `reset_timeout_msec`, the circuit breaker enters a Half-Open state from Open
+
+### Apply circuit breaker to executions
+
+Pass a block to a method `Rcb::Instance#run!` to apply circuit-breaker to a execution.
+
+```ruby
+Rcb.for('example.com').run! do # pass a block
+    if rand(2) == 0
+        raise 'fail!'
+    else
+        true
+    end
+end
+```
+
+You can see more example in [tests](./test).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/petitviolet/rcb. 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/petitviolet/rcb/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).
+
+## Code of Conduct
+
+Everyone interacting in the Rcb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/petitviolet/rcb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rcb"
+
+# 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/rcb/configuration.rb

@@ -0,0 +1,77 @@
+require 'logger'
+
+module Rcb
+  Config = Struct.new(:tag, :max_failure_count, :reset_timeout_msec)do
+    MAX_FAILURE_COUNT = 0.freeze
+    RESET_TIMEOUT_MSEC = 0.freeze
+
+    @logger = Logger.new($stderr)
+
+    def self.create(tag, max_failure_count: nil, reset_timeout_msec: nil)
+      raise 'Rcb tag must not be nil' if tag.nil?
+
+      if max_failure_count.nil? && reset_timeout_msec.nil?
+        @logger.warn("Rcb for '#{tag}' is not configured!")
+      end
+
+      Config.new(
+        tag.to_s.to_sym,
+        max_failure_count || MAX_FAILURE_COUNT,
+        reset_timeout_msec || RESET_TIMEOUT_MSEC
+      )
+    end
+  end
+
+  class ConfigBuilder
+    def initialize(tag)
+      @tag = tag
+      @max_failure_count = nil
+      @reset_timeout_msec = nil
+    end
+
+    def max_failure_count(num)
+      @max_failure_count = num
+    end
+
+    def reset_timeout_msec(msec)
+      @reset_timeout_msec = msec
+    end
+
+    def build
+      Config.create(
+        @tag,
+        max_failure_count:@max_failure_count,
+        reset_timeout_msec: @reset_timeout_msec
+      ).freeze
+    end
+  end
+
+  def Rcb.configure(tag, &block)
+    c = ConfigBuilder.new(tag.to_s.to_sym)
+          .tap { |cb| block.call(cb) }
+          .build
+
+    Configurations.add(c)
+  end
+
+  module Configurations
+    @configs = {}
+
+    def self.for(tag, max_failure_count: nil, reset_timeout_msec: nil)
+      @configs[tag.to_s.to_sym] || Config.create(tag,
+                                                 max_failure_count: max_failure_count,
+                                                 reset_timeout_msec: reset_timeout_msec)
+    end
+
+    def self.add(config)
+      # return if @configs.include?(config.tag)
+      # overwrite
+      @configs[config.tag] = config
+    end
+
+    def self.clear
+      @configs = {}
+    end
+  end
+
+end

data/lib/rcb/error.rb

@@ -0,0 +1,7 @@
+module Rcb
+  class CircuitBreakerOpenError < RuntimeError
+    def initialize(tag, since)
+      super(msg = "CircuitBreaker for '#{tag}' is open since #{since}")
+    end
+  end
+end

data/lib/rcb/instance.rb

@@ -0,0 +1,65 @@
+require 'byebug'
+require 'rstructural'
+require_relative './state'
+require_relative './configuration'
+require_relative './error'
+
+module Rcb
+  class Instance
+    attr_reader :config
+
+    # @param config [Rcb::Config]
+    def initialize(config)
+      @config = config
+    end
+
+    def run!(&block)
+      result =
+        case States.of(config.tag)
+        in State::Close => s
+          s.run(config, &block)
+        in State::Open => s
+          s.run(config, &block)
+        in s
+          raise "Unknown state: #{s}"
+        end
+
+      case result
+      in Result::Ok[state, result]
+        States.update(config.tag, state)
+        return result
+      in Result::Ng[state, error]
+        States.update(config.tag, state)
+        raise error
+      end
+    end
+
+    def state
+      States.show(config)
+    end
+
+  end
+
+  private
+
+    class States
+      @states = {}
+
+      def self.show(config)
+        self.of(config.tag).state(config)
+      end
+
+      def self.of(tag)
+        @states[tag.to_sym] ||= State::Close.create
+      end
+
+      def self.update(tag, state)
+        @states[tag] = state
+      end
+
+      def self.clear
+        @states = {}
+      end
+    end
+
+end

data/lib/rcb/result.rb

@@ -0,0 +1,10 @@
+require 'rstructural'
+
+module Rcb
+  module Result
+    extend ADT
+
+    Ok = data :new_state, :result
+    Ng = data :new_state, :error
+  end
+end

data/lib/rcb/state.rb

@@ -0,0 +1,79 @@
+require 'rstructural'
+require_relative './result'
+require_relative './error'
+
+module Rcb::State
+  extend ADT
+
+  Close = data :failure_count do
+    def self.create(failure_count = 0)
+      new(failure_count)
+    end
+
+    def run(config, &block)
+      case try_call(&block)
+      in Either::Right[result]
+        Rcb::Result::Ok.new(self, result)
+      in Either::Left[e]
+        if config.max_failure_count > failure_count
+          Rcb::Result::Ng.new(Close.create(failure_count + 1), e)
+        else
+          Rcb::Result::Ng.new(Open.create, e)
+        end
+      end
+    end
+  end
+
+  Open = data :since do
+    def self.create
+      new(Time.now.utc)
+    end
+
+    def run(config, now: Time.now.utc, &block)
+      if half_open?(now, config.reset_timeout_msec)
+        HalfOpen.run(&block)
+      else
+        Rcb::Result::Ng.new(self, Rcb::CircuitBreakerOpenError.new(config.tag, since))
+      end
+    end
+
+    def half_open?(now = Time.now.utc, reset_timeout_msec)
+      ((now - since) * 1000) >= reset_timeout_msec
+    end
+  end
+
+  HalfOpen = const do
+    # only executed from Open#run
+    def run(&block)
+      case try_call(&block)
+      in Either::Right[result]
+        Rcb::Result::Ok.new(Close.create, result)
+      in Either::Left[e]
+        Rcb::Result::Ng.new(Open.create, e)
+      end
+    end
+  end
+
+  interface do
+    def state(config)
+      case self
+      in Open if self.half_open?(config.reset_timeout_msec)
+        :half_open
+      in Open
+        :open
+      in Close
+        :close
+      end
+    end
+
+    private
+
+    def try_call(&block)
+      result = block.call
+      Either.right(result)
+    rescue => e
+      Either.left(e)
+    end
+  end
+end
+

data/lib/rcb/version.rb

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

data/lib/rcb.rb

@@ -0,0 +1,15 @@
+require_relative "./rcb/instance"
+require_relative "./rcb/configuration"
+
+module Rcb
+  module ClassMethods
+    def for(tag, max_failure_count: nil, reset_timeout_msec: nil)
+      config = Rcb::Configurations.for(tag,
+                                       max_failure_count: max_failure_count,
+                                       reset_timeout_msec: reset_timeout_msec)
+      Instance.new(config)
+    end
+  end
+
+  extend ClassMethods
+end

data/rcb.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/rcb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rcb"
+  spec.version       = Rcb::VERSION
+  spec.authors       = ["petitviolet"]
+  spec.email         = ["violethero0820@gmail.com"]
+
+  spec.summary       = %q{Ruby Circuit Breaker}
+  spec.description   = %q{Ruby Circuit Breaker}
+  spec.homepage      = "https://github.com/petitviolet/rcb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/petitviolet/rcb"
+  spec.metadata["changelog_uri"] = "https://github.com/petitviolet/rcb"
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rstructural"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rcb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- petitviolet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rstructural
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Circuit Breaker
+email:
+- violethero0820@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rcb.rb
+- lib/rcb/configuration.rb
+- lib/rcb/error.rb
+- lib/rcb/instance.rb
+- lib/rcb/result.rb
+- lib/rcb/state.rb
+- lib/rcb/version.rb
+- rcb.gemspec
+homepage: https://github.com/petitviolet/rcb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/petitviolet/rcb
+  source_code_uri: https://github.com/petitviolet/rcb
+  changelog_uri: https://github.com/petitviolet/rcb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: Ruby Circuit Breaker
+test_files: []