rbsafecircuit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd861744f8366c9aa9daa35ae58adaf5949d1332b99e461e89d1e512948de0cd
+  data.tar.gz: 0fb40867dee016efaa68d7817f814d60ac6ed970bfe8112fb05ca0f72da03808
+SHA512:
+  metadata.gz: 48b4a46b90becc52facd6fc81b6094408f70258152931bffbff34071c3810b209d33734176a04cf2b771bd9d34faebec49b5940159c6e76f0aebac48a608cc8b
+  data.tar.gz: a13af84505ce51c389d5e34af27045bd1f793e400129d679ceaeb66d843f2ec13bf921932d944f9292c489de4cf6045287950ef5c5702bfd2ad0821f4376e268

data/LICENSE

@@ -0,0 +1,23 @@
+
+
+MIT License
+
+Copyright (c) [2024] [fadedreams7@gmail.com]
+
+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,63 @@
+# rbsafecircuit
+
+rbsafecircuit is a Ruby gem for implementing a circuit breaker pattern with event handling capabilities using `event_emitter`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rbsafecircuit'
+```
+And then execute:
+```ruby
+bundle install
+```
+Or install it yourself as: 
+```ruby
+gem install rbsafecircuit
+```
+### Example Usage
+
+```ruby
+require 'rbsafecircuit'
+
+# Example usage of CircuitBreaker
+max_failures = 3
+timeout = 10
+pause_time = 5  # in seconds for simplicity
+max_consecutive_successes = 2
+
+cb = CircuitBreaker.new(max_failures, timeout, pause_time, max_consecutive_successes)
+
+# Define a function to be executed (replace with your actual function)
+test_function = lambda do
+  # Simulate some work that might succeed or fail
+  if rand < 0.8  # 80% success chance
+    puts "Function succeeded!"
+    "Success"
+  else
+    puts "Function failed!"
+    raise StandardError.new("Function failed")
+  end
+end
+
+# Execute the function with CircuitBreaker protection
+cb.execute(&test_function)
+
+# Event handling examples
+cb.on_success { |result| puts "Success: #{result}" }
+cb.on_failure { |error| puts "Error: #{error.message}" }
+cb.set_on_open(lambda { puts "Circuit breaker is open!" })
+cb.set_on_close(lambda { puts "Circuit breaker is closed." })
+cb.set_on_half_open(lambda { puts "Circuit breaker is half-open." })
+
+# Example: Let's wait for a while to see the events (just for demonstration)
+sleep(15)
+
+# Cleanup or final operations
+# ...
+```
+
+### License
+The gem is available as open source under the terms of the MIT License.

data/lib/rbsafecircuit/circuit_breaker.rb

@@ -0,0 +1,105 @@
+
+require 'event_emitter'
+
+module CircuitBreakerState
+  CLOSED = 'closed'
+  OPEN = 'open'
+  HALF_OPEN = 'half_open'
+end
+
+class CircuitBreaker
+  include EventEmitter
+
+  def initialize(max_failures, timeout, pause_time, max_consecutive_successes)
+    super()
+    @state = CircuitBreakerState::CLOSED
+    @consecutive_failures = 0
+    @total_failures = 0
+    @total_successes = 0
+    @max_failures = max_failures
+    @timeout = timeout
+    @open_timeout = Time.at(0)
+    @pause_time = pause_time
+    @consecutive_successes = 0
+    @max_consecutive_successes = max_consecutive_successes
+  end
+
+  def execute(&fn)
+    thread = Thread.new do
+      begin
+        result = fn.call
+        handle_success
+        emit('success', result)
+      rescue StandardError => error
+        handle_failure
+        emit('failure', error)
+      end
+    end
+
+    thread.join
+
+    case @state
+    when CircuitBreakerState::OPEN
+      if Time.now > @open_timeout
+        @state = CircuitBreakerState::HALF_OPEN
+        emit('halfOpen')
+      else
+        emit('open')
+        raise RuntimeError.new("Circuit breaker is open")
+      end
+    when CircuitBreakerState::HALF_OPEN
+      delay(@pause_time)
+      return
+    end
+  end
+
+  def handle_failure
+    @consecutive_failures += 1
+    @total_failures += 1
+    trip if @consecutive_failures >= @max_failures
+  end
+
+  def handle_success
+    reset
+    @total_successes += 1
+  end
+
+  def trip
+    @state = CircuitBreakerState::OPEN
+    @consecutive_failures = 0
+    @consecutive_successes = 0
+    @open_timeout = Time.now + @timeout
+    emit('open')
+  end
+
+  def reset
+    @state = CircuitBreakerState::CLOSED
+    @consecutive_failures = 0
+    @consecutive_successes = 0
+    emit('close')
+  end
+
+  def delay(ms)
+    sleep(ms / 1000.0)
+  end
+
+  def on_success(&block)
+    on('success', &block)
+  end
+
+  def on_failure(&block)
+    on('failure', &block)
+  end
+
+  def set_on_open(callback)
+    on('open', &callback)
+  end
+
+  def set_on_close(callback)
+    on('close', &callback)
+  end
+
+  def set_on_half_open(callback)
+    on('halfOpen', &callback)
+  end
+end

data/lib/rbsafecircuit/version.rb

@@ -0,0 +1,4 @@
+
+module Rbsafecircuit
+  VERSION = "0.1.0"  # Replace with your actual gem version
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: rbsafecircuit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fadedreams7
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: event_emitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: rbsafecircuit is a Ruby gem that provides a robust implementation of
+  the circuit breaker pattern, designed to enhance the resilience of applications
+  by managing failures and reducing the impact of network or service-related issues.
+  It includes features such as state management (closed, open, half-open), failure
+  thresholds, timeout handling, and event-driven callbacks for handling success, failure,
+  open, close, and half-open states. Built with flexibility and reliability in mind,
+  rbsafecircuit helps developers ensure their applications remain responsive and reliable
+  in the face of unreliable external dependencies.
+email:
+- fadedreams7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rbsafecircuit/circuit_breaker.rb
+- lib/rbsafecircuit/version.rb
+homepage: https://github.com/fadedreams/rbsafecircuit
+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.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: A Ruby gem for implementing a circuit breaker pattern with event handling
+  capabilities.
+test_files: []