minimalist_circuit_breaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b39c4d9661b458a36db6d8780996d50e24a9bfb69a4b54ff6404d7b517a2476
+  data.tar.gz: ac5527ffe453c20f3336f1a519fb71860a8a7201b91836d24b3335b7c4316a2e
+SHA512:
+  metadata.gz: 61e25c691e33da9cb82b953aaad5426347765cc62481c0c59be03e6a2d9955ba5f2f495f566cc0730975e0124794c1c6b5adb4323a1dec773fd5446bce51acf2
+  data.tar.gz: bcde292ccf30b65934f74576e53ce20d69c7840d358d7cfd866303083f3b1e2a8ea6eff1475eec8fa30ab8137779954cf751b60c88bf64c801c66f143bad286e

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-01-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Aria Diniz
+
+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,114 @@
+# MinimalistCircuitBreaker
+
+A lightweight, thread-safe implementation of the Circuit Breaker pattern for Ruby.
+
+`MinimalistCircuitBreaker` protects your system from cascading failures by wrapping external service calls (like HTTP requests or database queries). It monitors success/failure rates and temporarily "opens the circuit" (blocking execution) when failures exceed a configured threshold, allowing the failing service time to recover.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add minimalist_circuit_breaker
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install minimalist_circuit_breaker
+```
+
+## Usage
+
+### Basic Usage
+
+Instantiate the circuit breaker and wrap your risky calls inside the `call` block. The block *must* return a `[status, result]` tuple, where `status` is an Integer (like an HTTP status code) or `nil`.
+
+```ruby
+require 'minimalist_circuit_breaker'
+
+# 1. Initialize with default settings
+cb = MinimalistCircuitBreaker::CircuitBreaker.new
+
+# 2. Wrap your external calls
+begin
+  status, body = cb.call do
+    # Perform your external request here
+    response = Net::HTTP.get_response(URI('[http://example.com](http://example.com)'))
+    
+    # Return [Integer Status, Object Result]
+    [response.code.to_i, response.body] 
+  end
+  
+  puts "Success: #{status}"
+
+rescue MinimalistCircuitBreaker::OpenCircuitError
+  # Circuit is open; fallback logic goes here
+  puts "Service unavailable (Circuit Open)"
+rescue MinimalistCircuitBreaker::HalfOpenCircuitError
+  # Circuit is testing the connection; handle gracefully
+  puts "Service unavailable (Throttled)"
+end
+```
+
+### Configuration
+
+You can customize the failure thresholds, timeouts, and ignored errors when initializing the breaker.
+
+```ruby
+cb = MinimalistCircuitBreaker::CircuitBreaker.new(
+  min_failures_before_open: 5,   # Minimum failures before checking percentage (default: 10)
+  failures_pct: 0.2,             # Open if > 20% fail (default: 0.5)
+  time_window: 60,               # Rolling stats window in seconds (default: 30)
+  timeout: 10,                   # Seconds to wait before testing Half-Open (default: 30)
+  codes_to_ignore: [404, 422],   # Treat these HTTP codes as "Success"
+  window_size: 100               # Max requests to keep in memory (default: 50)
+)
+```
+
+### Custom Error Messages
+
+You can override the default exceptions and messages. This is useful if you want to integrate with your application's specific error handling classes.
+
+```ruby
+cb = MinimalistCircuitBreaker::CircuitBreaker.new(
+  open_error: MyCustomError,
+  open_message: "External payment gateway is down",
+  half_open_error: MyCustomError,
+  half_open_message: "Gateway is recovering, please wait"
+)
+
+```
+
+### How it Works
+
+1. **Closed State:** Requests flow normally. Successes and failures are recorded in a sliding window.
+2. **Open State:** If the failure rate exceeds `failures_pct` (and `min_failures_before_open` is met), the circuit opens. All subsequent calls immediately raise `MinimalistCircuitBreaker::OpenCircuitError` without executing the block.
+3. **Half-Open State:** After `timeout` seconds, the circuit transitions to Half-Open. It allows **one** request to pass through:
+* **Success:** Circuit closes and resets stats.
+* **Failure:** Circuit opens again and resets the timeout timer.
+
+### Thread Safety
+
+This gem is thread-safe.
+
+* **I/O is Non-Blocking:** The potentially slow block execution happens *outside* the mutex lock. Multiple threads can make HTTP requests simultaneously.
+* **State is Consistent:** State transitions and registry updates are strictly synchronized.
+
+## 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 the created tag, 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/ariasdiniz/minimalist_circuit_breaker. 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/ariasdiniz/minimalist_circuit_breaker/blob/main/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 MinimalistCircuitBreaker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ariasdiniz/minimalist_circuit_breaker/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/minimalist_circuit_breaker/circuit_breaker.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require_relative 'circuit_errors'
+
+module MinimalistCircuitBreaker; end
+
+# A thread-safe implementation of the Circuit Breaker pattern.
+#
+# This class protects your system from cascading failures by wrapping external service calls.
+# It monitors the success/failure rates of these calls and temporarily stops execution ("opens the circuit")
+# when the failure rate exceeds a configured threshold.
+#
+# The circuit breaker cycles through three states:
+# * **:closed** - Normal operation. Requests are executed.
+# * **:open** - Failure threshold reached. Requests raise {OpenCircuitError} immediately without execution.
+# * **:half_open** - Timeout period elapsed. A single "test" request is allowed through.
+#   * If successful, the circuit returns to **:closed**.
+#   * If it fails, the circuit returns to **:open**.
+#
+# @example Basic Usage
+#   cb = MinimalistCircuitBreaker::CircuitBreaker.new(
+#     min_failures_before_open: 5,
+#     failures_pct: 0.5,
+#     timeout: 60
+#   )
+#
+#   result = cb.call do
+#     Net::HTTP.get(URI('http://example.com'))
+#   end
+#
+class MinimalistCircuitBreaker::CircuitBreaker
+  # @return [Symbol] The current state of the circuit breaker (:closed, :open, or :half_open).
+  attr_reader :state
+
+  # Initializes a new CircuitBreaker instance.
+  #
+  # @param min_failures_before_open [Integer] The minimum number of failed requests required before the circuit can trip.
+  #   This prevents the circuit from opening on a single failure if the volume is low. Default is 10.
+  # @param failures_pct [Float] The failure rate threshold (0.0 to 1.0) required to trip the circuit.
+  #   For example, 0.5 means 50% failures. Default is 0.5.
+  # @param time_window [Integer] The rolling time window in seconds. Failures older than this window
+  #   are discarded from the statistics calculation. Default is 30 seconds.
+  # @param timeout [Integer] The duration in seconds the circuit remains **:open** before transitioning
+  #   to **:half_open** to test the connection. Default is 30 seconds.
+  # @param codes_to_ignore [Array<Integer>] A list of HTTP status codes (or integer return values)
+  #   that should be treated as successes (e.g., 404 Not Found might be a valid business result).
+  # @param customize [Hash] specific error classes and messages.
+  # @option customize [Class] :half_open_error The exception class to raise when the circuit is half-open.
+  # @option customize [String] :half_open_message The error message for half-open exceptions.
+  # @option customize [Class] :open_error The exception class to raise when the circuit is open.
+  # @option customize [String] :open_message The error message for open exceptions.
+  # @option customize [Integer] :window_size The maximum number of request results to keep in the registry
+  #   before dropping the oldest (Sliding Window size). Default is 50.
+  def initialize(
+    min_failures_before_open: 10,
+    failures_pct: 0.5,
+    time_window: 30,
+    timeout: 30,
+    codes_to_ignore: [],
+    **customize
+  )
+    @state = :closed
+    @time_window = time_window
+    @failures_before_open = min_failures_before_open
+    @failures_pct = failures_pct
+    @ignored_codes = codes_to_ignore
+    @registry = []
+    @state_mutex = Mutex.new
+    @timeout = timeout
+    @last_timeout = nil
+    @half_open_error = customize[:half_open_error] || MinimalistCircuitBreaker::HalfOpenCircuitError
+    @half_open_message = customize[:half_open_message] || 'Circuit is half open and handling another request'
+    @open_error = customize[:open_error] || MinimalistCircuitBreaker::OpenCircuitError
+    @open_message = customize[:open_message] || 'Circuit is open'
+    @window_size = customize[:window_size] || 50
+  end
+
+  # Executes the provided block within the protection of the circuit breaker.
+  #
+  # If the circuit is **:closed**, the block is executed.
+  # If the circuit is **:open**, an {OpenCircuitError} is raised immediately.
+  # If the circuit is **:half_open**, only one thread is allowed to execute the block as a test probe.
+  #
+  # The method captures exceptions raised within the block to update the internal circuit health metrics,
+  # then re-raises the original exception to the caller.
+  #
+  # @yieldparam args [Array] Any arguments passed to #call are forwarded to the block.
+  # @yieldreturn [Array<Integer, Object>] The block is expected to return a tuple of `[status, response]`,
+  #   where `status` is an Integer (e.g., HTTP status code) used to determine success/failure.
+  #
+  # @return [Array<Integer, Object>] The result returned by the block.
+  #
+  # @raise [MinimalistCircuitBreaker::OpenCircuitError] If the circuit is currently open.
+  # @raise [MinimalistCircuitBreaker::HalfOpenCircuitError] If the circuit is half-open and handling another request.
+  # @raise [StandardError] Re-raises any exception that occurs during the block execution.
+  def call(*args)
+    return nil unless block_given?
+
+    call_status_check
+
+    begin
+      status, response = yield(*args)
+    rescue StandardError => e
+      execution_error = e
+      status = nil
+      response = nil
+    ensure
+      update_state(status)
+    end
+
+    raise execution_error if execution_error
+
+    [status, response]
+  end
+
+  private
+
+  def call_status_check
+    @state_mutex.synchronize do
+      raise @half_open_error, @half_open_message if check_state == :half_open
+      raise @open_error, @open_message if check_state == :open && Time.now - check_last_timeout < @timeout
+
+      set_state(state: :half_open) if check_state == :open
+    end
+  end
+
+  def update_state(status)
+    @state_mutex.synchronize do
+      if (!status.nil? && status.to_i < 400) || @ignored_codes.include?(status.to_i)
+        set_state(state: :closed)
+        register_call
+      else
+        register_call(success: false)
+        evaluate_state
+      end
+    end
+  end
+
+  def register_call(success: true)
+    @registry.push({ success: success, tstamp: Time.now })
+    @registry.shift if @registry.length > @window_size
+  end
+
+  def evaluate_state
+    if check_state == :half_open
+      set_state(state: :open, update_timeout: true)
+      return
+    end
+    return if check_state == :open
+
+    success_count, len = filter_registry
+    should_open = success_count.to_f / len < 1 - @failures_pct && len - success_count > @failures_before_open
+    return unless should_open
+
+    set_state(state: :open, update_timeout: true)
+  end
+
+  def check_last_timeout = @last_timeout
+
+  def check_state = @state
+
+  def set_state(state: :closed, update_timeout: false)
+    @state = state
+    @last_timeout = Time.now if update_timeout
+  end
+
+  def filter_registry
+    now = Time.now
+    @registry.filter! { |r| now - r[:tstamp] < @time_window }
+    success_count = @registry.filter { |r| r[:success] }.length
+    len = @registry.length
+    [success_count, len]
+  end
+end

data/lib/minimalist_circuit_breaker/circuit_errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MinimalistCircuitBreaker; end
+
+class MinimalistCircuitBreaker::OpenCircuitError < StandardError
+end
+
+class MinimalistCircuitBreaker::HalfOpenCircuitError < StandardError
+end

data/lib/minimalist_circuit_breaker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MinimalistCircuitBreaker
+  VERSION = '0.1.0'
+end

data/lib/minimalist_circuit_breaker.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'minimalist_circuit_breaker/version'
+require_relative 'minimalist_circuit_breaker/circuit_breaker'
+require_relative 'minimalist_circuit_breaker/circuit_errors'
+
+module MinimalistCircuitBreaker; end

data/sig/simple_circuit_breaker.rbs

@@ -0,0 +1,4 @@
+module MinimalistCircuitBreaker
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: minimalist_circuit_breaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aria Diniz
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: This gem is a very minimalist circuit breaker for Ruby, designed just
+  as a test side project.
+email:
+- aria.diniz.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minimalist_circuit_breaker.rb
+- lib/minimalist_circuit_breaker/circuit_breaker.rb
+- lib/minimalist_circuit_breaker/circuit_errors.rb
+- lib/minimalist_circuit_breaker/version.rb
+- sig/simple_circuit_breaker.rbs
+homepage: https://github.com/ariasdiniz/minimalist_circuit_breaker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ariasdiniz/minimalist_circuit_breaker
+  source_code_uri: https://github.com/ariasdiniz/minimalist_circuit_breaker
+  changelog_uri: https://github.com/ariasdiniz/minimalist_circuit_breaker
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: A Minimalist Circuit Breaker for Ruby
+test_files: []