smart_retry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5e73411f89b1989931a962cdb74265dec45dc2a0a0239f9129eb02fb476046a
+  data.tar.gz: 89d7614b764e99ffe1da6f11a4ec2c201185f313353d174ab503075167d87368
+SHA512:
+  metadata.gz: 4bf95a913511190a7851feed2cc653f8d71f0333e92183732149ce9c3e2040c2a0922ec973b261488f3d1b59aceb3cb213a9b04b5f4b4bab2a22c084811beb7f
+  data.tar.gz: 6641c96647266bb667e9293475cbebb3e08beb7d50bacab18dd4e1ccd8e48029aa23ddb2e9c56b47ac0027a418f0b22dff2d4c725a882dbe34b44363fdefda7c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-01-24
+
+- 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) 2026 Mohammad Hifzan
+
+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,82 @@
+# SmartRetry
+
+SmartRetry provides **robust retry and circuit breaker patterns** for Ruby and Rails applications. It helps your services recover from transient failures, avoid cascading outages, and gracefully handle sustained outages.
+
+---
+
+## Installation
+
+```ruby
+gem "smart_retry"
+
+base_delay = 2s, backoff = exponential
+
+:full jitter → delay randomly chosen from 0..current_delay
+:equal jitter → delay randomly in the second half of the current_delay
+
+
+circuit_breaker.call do
+  retry_policy.call do
+    service.call
+  end
+end
+
+
+timeout_policy = SmartRetry::TimeoutPolicy.new(timeout: 5) # seconds
+
+circuit_breaker = SmartRetry::CircuitBreaker.new(
+  failure_threshold: 3,
+  cooldown: 10,
+  half_open_requests: 1,
+  retry_policy: retry_policy,
+  timeout_policy: timeout_policy
+)
+
+retry_policy = SmartRetry::RetryPolicy.new(max_attempts: 3, sleep_fn: ->(_) {})
+circuit_breaker = SmartRetry::CircuitBreaker.new(clock: -> { simulated_time })
+
+require "smart_retry"
+
+retry_policy = SmartRetry::RetryPolicy.new(
+  max_attempts: 3,
+  base_delay: 0.5,
+  jitter: :full
+)
+
+circuit_breaker = SmartRetry::CircuitBreaker.new(
+  failure_threshold: 2,
+  cooldown: 10,
+  half_open_requests: 1,
+  retry_policy: retry_policy
+)
+
+service = -> {
+  # simulate service call
+  raise "down" if rand < 0.5
+  "ok"
+}
+
+result = circuit_breaker.call do
+  retry_policy.call { service.call }
+end
+
+puts result # => "ok"
+
+retry_policy = SmartRetry::RetryPolicy.new(max_attempts: 3, sleep_fn: ->(_) {})
+circuit_breaker = SmartRetry::CircuitBreaker.new(clock: -> { simulated_time })
+
+┌───────────────────────────┐
+│       CircuitBreaker      │   ← protects the system
+│   ┌───────────────────┐  │
+│   │    RetryPolicy     │  │   ← retries transient failures
+│   │   ┌───────────┐   │  │
+│   │   │  Service  │   │  │
+│   │   └───────────┘   │  │
+│   └───────────────────┘  │
+└───────────────────────────┘
+
+---
+
+## 8. Simulating a Production Outage
+
+You can test SmartRetry behavior under a **sustained outage** scenario, including retries, circuit breaker transitions, and recovery.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/smart_retry/circuit_breaker.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'monitor'
+module SmartRetry
+  class CircuitBreaker
+    attr_reader :state, :failure_count
+
+    def initialize(
+      failure_threshold:,
+      cooldown:,
+      half_open_requests:,
+      retry_policy: nil,
+      timeout_policy: nil,
+      clock: -> { Time.now }
+    )
+      @failure_threshold = failure_threshold
+      @cooldown = cooldown
+      @half_open_requests = half_open_requests
+      @retry_policy = retry_policy
+      @timeout_policy = timeout_policy
+      @clock = clock
+
+      @state = :closed
+      @failure_count = 0
+      @opened_at = nil
+      @half_open_attempts = 0
+
+      @lock = Monitor.new
+    end
+
+    def call(&block)
+      # ---------
+      # Phase 1: permission + state transition
+      # ---------
+      @lock.synchronize do
+        transition_if_needed
+        enforce_call_permission
+      end
+
+      # ---------
+      # Phase 2: execute user code (NO LOCK)
+      # ---------
+      execute(&block)
+    end
+
+    def open? = @state == :open
+    def closed? = @state == :closed
+    def half_open? = @state == :half_open
+
+    private
+
+    # -------------------------
+    # State transitions
+    # -------------------------
+
+    def transition_if_needed
+      return unless @state == :open
+      return unless cooldown_elapsed?
+
+      @state = :half_open
+      @half_open_attempts = 0
+    end
+
+    # -------------------------
+    # Permission checks
+    # -------------------------
+
+    def enforce_call_permission
+      case @state
+      when :open
+        raise CircuitOpenError
+      when :half_open
+        raise CircuitOpenError if @half_open_attempts >= @half_open_requests
+
+        @half_open_attempts += 1
+      end
+    end
+
+    # -------------------------
+    # Execution
+    # -------------------------
+
+    def execute(&block)
+      wrapped = block
+      wrapped = wrap_with_timeout(wrapped)
+      wrapped = wrap_with_retry(wrapped)
+
+      wrapped.call.tap { on_success }
+    rescue StandardError => e
+      on_failure
+      raise e
+    end
+
+    # -------------------------
+    # Call results
+    # -------------------------
+
+    def on_success
+      @lock.synchronize do
+        case @state
+        when :half_open
+          close_circuit
+        when :closed
+          @failure_count = 0
+        end
+      end
+    end
+
+    def on_failure
+      @lock.synchronize do
+        case @state
+        when :closed
+          @failure_count += 1
+          open_circuit if @failure_count >= @failure_threshold
+        when :half_open
+          open_circuit
+        end
+      end
+    end
+
+    # -------------------------
+    # Helpers
+    # -------------------------
+
+    def open_circuit
+      @state = :open
+      @opened_at = @clock.call
+      @failure_count = 0
+      @half_open_attempts = 0
+    end
+
+    def close_circuit
+      @state = :closed
+      @opened_at = nil
+      @failure_count = 0
+      @half_open_attempts = 0
+    end
+
+    def cooldown_elapsed?
+      return false unless @opened_at
+
+      (@clock.call - @opened_at) >= @cooldown
+    end
+
+    def wrap_with_retry(block)
+      return block unless @retry_policy
+
+      -> { @retry_policy.call { block.call } }
+    end
+
+    def wrap_with_timeout(block)
+      return block unless @timeout_policy
+
+      -> { @timeout_policy.call { block.call } }
+    end
+  end
+end

data/lib/smart_retry/config.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SmartRetry
+  class Config
+    attr_accessor :clock
+
+    def initialize
+      @clock = -> { Time.now }
+      @services = {}
+    end
+
+    def default(&block)
+      service(:default, &block)
+    end
+
+    def service(name, &block)
+      @services[name.to_sym] ||= ServiceConfig.new
+      block.call(@services[name.to_sym])
+    end
+
+    def fetch(name)
+      @services[name.to_sym] || @services[:default]
+    end
+  end
+end

data/lib/smart_retry/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SmartRetry
+  class Error < StandardError; end
+  class CircuitOpenError < Error; end
+  class MaxRetriesExceededError < Error; end
+  class ConfigurationError < Error; end
+end

data/lib/smart_retry/notifier.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SmartRetry
+  module Notifier
+    @subscribers = []
+
+    def self.subscribe(&block)
+      @subscribers << block
+    end
+
+    def self.publish(event)
+      @subscribers.each { |s| s.call(event) }
+    end
+  end
+end

data/lib/smart_retry/retry_policy.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SmartRetry
+  class RetryPolicy
+    def initialize(
+      max_attempts:,
+      base_delay: 0.1,
+      max_delay: 5,
+      backoff: :exponential,
+      retry_on: [StandardError],
+      jitter: :none,
+      sleep_fn: ->(seconds) { sleep(seconds) }
+    )
+      @max_attempts = max_attempts
+      @base_delay = base_delay
+      @max_delay = max_delay
+      @backoff = backoff
+      @retry_on = Array(retry_on)
+      @jitter = jitter
+      @sleep_fn = sleep_fn
+    end
+
+    def call
+      attempts = 0
+
+      begin
+        attempts += 1
+        yield
+      rescue StandardError => e
+        raise e unless retryable?(e)
+        raise e if attempts >= @max_attempts
+
+        delay = compute_delay(attempts)
+        delay = apply_jitter(delay)
+        @sleep_fn.call(delay)
+        retry
+      end
+    end
+
+    private
+
+    def retryable?(error)
+      @retry_on.any? { |klass| error.is_a?(klass) }
+    end
+
+    def apply_jitter(delay)
+      case @jitter
+      when :full
+        rand(0.0..delay)
+      when :equal
+        (delay / 2) + rand(0.0..(delay / 2))
+      else
+        delay
+      end
+    end
+
+    def compute_delay(attempt)
+      delay =
+        case @backoff
+        when :exponential
+          @base_delay * (2**(attempt - 1))
+        when :linear
+          @base_delay * attempt
+        else
+          @base_delay
+        end
+
+      [delay, @max_delay].min
+    end
+  end
+end

data/lib/smart_retry/service_registry.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SmartRetry
+  class ServiceRegistry
+    def self.fetch(name)
+      Service.new(name)
+    end
+  end
+end

data/lib/smart_retry/timeout_policy.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'timeout'
+
+module SmartRetry
+  class TimeoutError < StandardError; end
+
+  class TimeoutPolicy
+    def initialize(timeout:)
+      @timeout = timeout
+    end
+
+    def call(&block)
+      Timeout.timeout(@timeout, TimeoutError, &block)
+    end
+  end
+end

data/lib/smart_retry/version.rb

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

data/lib/smart_retry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'smart_retry/version'
+require_relative 'smart_retry/config'
+require_relative 'smart_retry/service_registry'
+require_relative 'smart_retry/retry_policy'
+require_relative 'smart_retry/circuit_breaker'
+require_relative 'smart_retry/notifier'
+require_relative 'smart_retry/errors'
+
+module SmartRetry
+  class << self
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def call(service, &block)
+      ServiceRegistry.fetch(service).call(&block)
+    end
+
+    def subscribe(&block)
+      Notifier.subscribe(&block)
+    end
+  end
+end

data/sig/smart_retry.rbs

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: smart_retry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mohammad Hifzan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2026-01-26 00:00:00.000000000 Z
+dependencies: []
+description: SmartRetry provides configurable retry policies with exponential backoff
+  and a circuit breaker to protect Ruby and Rails applications from unreliable external
+  services.
+email:
+- hifzan743@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smart_retry.rb
+- lib/smart_retry/circuit_breaker.rb
+- lib/smart_retry/config.rb
+- lib/smart_retry/errors.rb
+- lib/smart_retry/notifier.rb
+- lib/smart_retry/retry_policy.rb
+- lib/smart_retry/service_registry.rb
+- lib/smart_retry/timeout_policy.rb
+- lib/smart_retry/version.rb
+- sig/smart_retry.rbs
+homepage: https://gitlab.com/Hifzan/smart_retry.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/Hifzan/smart_retry.git
+  source_code_uri: https://gitlab.com/Hifzan/smart_retry.git
+  changelog_uri: https://gitlab.com/Hifzan/smart_retry.git/-/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+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.4.19
+signing_key: 
+specification_version: 4
+summary: Smart retry and circuit breaker for Ruby and Rails
+test_files: []