idempotency_lock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2433a11192a9d10ad05520f94d7b60854531c2c23ee0e2c674318c34aa77739c
+  data.tar.gz: 6b7e54105e42bee7122d20670a9bfc18192b4d0846e58b131939cf46274fa98f
+SHA512:
+  metadata.gz: 102949944e74ef10b4f9ba6d3d62221abb307aaf79da156b6e25277eea4fd11032a435a1ea726044e228635c30e00511d7df46a10fe5f66621bf24dac901721b
+  data.tar.gz: 110b05bb0e03d952e5a44051dc4dfbb51c728e06f63e58aa46d2379482ab34ee261a39410fed5d90db4c0abe800948cfb509b4f4a17ec03d0a2ffb8b5e2513e0

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-12-06
+
+### Added
+
+- `IdempotencyLock.once` - Execute a block exactly once per lock name
+- `Result` object with `executed?`, `skipped?`, `success?`, `error?`, and `value` methods
+- TTL/expiration support via `ttl:` option (accepts ActiveSupport durations or seconds)
+- Multiple error handling strategies via `on_error:` option:
+  - `:keep` (default) - keep lock on error
+  - `:unlock` - release lock to allow retry
+  - `:raise` - re-raise exception after releasing lock
+  - `Proc` - custom error handler
+- `IdempotencyLock.locked?` - Check if an operation is locked
+- `IdempotencyLock.release` - Manually release a lock
+- `IdempotencyLock.cleanup_expired` - Remove all expired locks
+- Rails generator: `rails generate idempotency_lock:install`
+- `wrap` alias for `once` method

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 John Nagro
+
+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,222 @@
+# IdempotencyLock
+
+A simple, robust idempotency solution for Ruby on Rails applications. Ensures operations run exactly once using database-backed locks with support for TTL expiration, multiple error handling strategies, and clean return value handling.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "idempotency_lock"
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Generate the migration:
+
+```bash
+rails generate idempotency_lock:install
+rails db:migrate
+```
+
+## Usage
+
+### Basic Usage
+
+Wrap any operation that should only run once:
+
+```ruby
+result = IdempotencyLock.once("send-welcome-email-user-#{user.id}") do
+  UserMailer.welcome(user).deliver_now
+end
+
+if result.executed?
+  puts "Email sent!"
+else
+  puts "Email already sent (skipped)"
+end
+```
+
+The `once` method returns a `Result` object that tells you what happened:
+
+```ruby
+result.executed?  # true if the block ran
+result.skipped?   # true if skipped due to existing lock
+result.success?   # true if executed without error
+result.error?     # true if an error occurred
+result.value      # the return value of the block
+result.error      # the exception if one was raised
+```
+
+### TTL / Expiration
+
+Sometimes you want "run once per hour" instead of "run once forever":
+
+```ruby
+# Run daily report once per day
+IdempotencyLock.once("daily-report", ttl: 24.hours) do
+  ReportGenerator.daily_summary
+end
+
+# Run cleanup once per hour
+IdempotencyLock.once("hourly-cleanup", ttl: 1.hour) do
+  TempFile.cleanup_old
+end
+
+# TTL also accepts integer seconds
+IdempotencyLock.once("periodic-task", ttl: 3600) do
+  some_periodic_work
+end
+```
+
+### Error Handling
+
+Control what happens when an error occurs inside the block:
+
+```ruby
+# :keep (default) - Keep the lock, don't allow retry
+IdempotencyLock.once("risky-op", on_error: :keep) do
+  might_fail
+end
+
+# :unlock - Release the lock so another process can retry
+IdempotencyLock.once("retriable-op", on_error: :unlock) do
+  external_api_call
+end
+
+# :raise - Re-raise the exception after releasing the lock
+IdempotencyLock.once("critical-op", on_error: :raise) do
+  must_succeed_or_alert
+end
+
+# Custom handler with a Proc
+IdempotencyLock.once("custom-error", on_error: ->(e) { Bugsnag.notify(e) }) do
+  something_important
+end
+```
+
+### Manual Lock Management
+
+```ruby
+# Check if an operation is locked
+IdempotencyLock.locked?("my-operation")  # => true/false
+
+# Release a lock manually (useful for testing or manual intervention)
+IdempotencyLock.release("my-operation")
+
+# Clean up all expired locks (good for a periodic job)
+IdempotencyLock.cleanup_expired
+```
+
+### Alias
+
+The `wrap` method is available as an alias for `once`:
+
+```ruby
+IdempotencyLock.wrap("operation-name") { do_something }
+```
+
+## Use Cases
+
+### Preventing Duplicate Webhook Processing
+
+```ruby
+class WebhooksController < ApplicationController
+  def stripe
+    event_id = params[:id]
+    
+    result = IdempotencyLock.once("stripe-webhook-#{event_id}") do
+      StripeWebhookProcessor.process(params)
+    end
+    
+    head :ok
+  end
+end
+```
+
+### Ensuring One-Time Migrations
+
+```ruby
+IdempotencyLock.once("backfill-user-preferences-2024-01") do
+  User.find_each do |user|
+    user.create_preferences! unless user.preferences.present?
+  end
+end
+```
+
+### Rate-Limited Operations
+
+```ruby
+# Only send one reminder per user per day
+IdempotencyLock.once("reminder-user-#{user.id}", ttl: 24.hours) do
+  ReminderMailer.daily_reminder(user).deliver_later
+end
+```
+
+### Preventing Duplicate Sidekiq Jobs
+
+```ruby
+class ImportantJob
+  include Sidekiq::Job
+
+  def perform(record_id)
+    IdempotencyLock.once("important-job-#{record_id}", on_error: :unlock) do
+      # If this fails, another job can retry
+      ImportantService.process(record_id)
+    end
+  end
+end
+```
+
+## Database Schema
+
+The gem creates an `idempotency_locks` table with:
+
+| Column | Type | Description |
+|--------|------|-------------|
+| `name` | string (max 255) | Unique identifier for the lock |
+| `expires_at` | datetime | When the lock expires (null = never) |
+| `executed_at` | datetime | When the operation was executed |
+| `created_at` | datetime | Standard Rails timestamp |
+| `updated_at` | datetime | Standard Rails timestamp |
+
+Indexes:
+- Unique index on `name` (provides atomicity)
+- Partial index on `expires_at` where not null (for efficient TTL queries)
+
+**Note on name length:** Lock names are limited to 255 characters to ensure compatibility with database unique index limits. MySQL users with `utf8mb4` encoding may need to reduce this to 191 characters by modifying the migration before running it.
+
+## How It Works
+
+1. **Lock Acquisition**: Attempts to create a record with the given name. The unique index ensures only one process succeeds.
+
+2. **TTL Support**: If a TTL is provided, the lock includes an `expires_at` timestamp. Expired locks can be claimed by new operations via an atomic UPDATE.
+
+3. **Error Handling**: Different strategies control whether the lock is released on error, allowing for retry semantics.
+
+4. **Return Values**: The block's return value is captured and returned in the `Result` object.
+
+## Thread Safety
+
+The gem relies on database-level uniqueness constraints for atomicity. This means:
+
+- ✅ Safe across multiple processes (web servers, job workers)
+- ✅ Safe across multiple machines
+- ✅ Safe in multi-threaded environments
+- ✅ Survives application restarts
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## 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,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/generators/idempotency_lock/install_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module IdempotencyLock
+  module Generators
+    # Generator to create the idempotency_locks table migration.
+    # Run with: rails generate idempotency_lock:install
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates the idempotency_locks table migration"
+
+      def create_migration_file
+        migration_template(
+          "create_idempotency_locks.rb.erb",
+          "db/migrate/create_idempotency_locks.rb"
+        )
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/idempotency_lock/templates/create_idempotency_locks.rb.erb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class CreateIdempotencyLocks < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :idempotency_locks do |t|
+      # Limit ensures compatibility with unique index on most databases.
+      # MySQL with utf8mb4 supports max 191 chars; adjust if needed.
+      t.string :name, null: false, limit: 255
+      t.datetime :expires_at
+      t.datetime :executed_at
+
+      t.timestamps
+    end
+
+    add_index :idempotency_locks, :name, unique: true
+    add_index :idempotency_locks, :expires_at, where: "expires_at IS NOT NULL"
+  end
+end
+

data/lib/idempotency_lock/lock.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module IdempotencyLock
+  # ActiveRecord model for storing idempotency locks.
+  #
+  # This model expects a database table with the following schema:
+  #   - name: string (unique, indexed, max 255 chars)
+  #   - expires_at: datetime (nullable, indexed)
+  #   - executed_at: datetime
+  #   - created_at: datetime
+  #   - updated_at: datetime
+  #
+  # Use the provided generator to create the migration:
+  #   rails generate idempotency_lock:install
+  #
+  class Lock < ActiveRecord::Base
+    self.table_name = "idempotency_locks"
+
+    # Maximum length for lock names. Ensures compatibility with database
+    # unique index limits (MySQL utf8mb4 = 191, most others = 255+).
+    MAX_NAME_LENGTH = 255
+
+    validates :name, presence: true, uniqueness: true, length: { maximum: MAX_NAME_LENGTH }
+
+    # Check if this lock has expired
+    # @return [Boolean]
+    def expired?
+      expires_at.present? && expires_at < Time.current
+    end
+
+    # Check if this lock is still valid (not expired)
+    # @return [Boolean]
+    def valid_lock?
+      expires_at.nil? || expires_at >= Time.current
+    end
+
+    class << self
+      # Attempt to acquire a lock for the given name.
+      # Returns true if the lock was acquired, false otherwise.
+      #
+      # @param name [String] unique identifier for the operation
+      # @param expires_at [Time, nil] when the lock should expire (nil = never)
+      # @param now [Time] current time reference
+      # @return [Boolean] true if lock was acquired
+      def acquire(name, expires_at: nil, now: Time.current)
+        # Try to insert first (most common case for new keys)
+        begin
+          create!(name: name, expires_at: expires_at, executed_at: now)
+          return true
+        rescue ActiveRecord::RecordNotUnique, ActiveRecord::RecordInvalid
+          # Lock exists, check if it's expired
+        end
+
+        # Atomic update: claim the lock only if it's expired
+        # Returns number of rows updated (0 or 1)
+        updated = where(name: name)
+                  .where("expires_at IS NOT NULL AND expires_at < ?", now)
+                  .update_all(expires_at: expires_at, executed_at: now, updated_at: now)
+
+        updated.positive?
+      end
+
+      # Release a lock by name (removes the record entirely)
+      #
+      # @param name [String] unique identifier for the operation
+      # @return [Boolean] true if a lock was removed
+      def release(name)
+        deleted = where(name: name).delete_all
+        deleted.positive?
+      end
+
+      # Check if a valid (non-expired) lock exists for the given name
+      #
+      # @param name [String] unique identifier for the operation
+      # @return [Boolean]
+      def locked?(name)
+        lock = find_by(name: name)
+        return false if lock.nil?
+
+        lock.valid_lock?
+      end
+
+      # Clean up expired locks
+      #
+      # @return [Integer] number of locks removed
+      def cleanup_expired
+        where("expires_at IS NOT NULL AND expires_at < ?", Time.current).delete_all
+      end
+    end
+  end
+end

data/lib/idempotency_lock/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module IdempotencyLock
+  # Rails integration for IdempotencyLock.
+  # Automatically configures the logger and loads generators.
+  class Railtie < Rails::Railtie
+    generators do
+      require_relative "../generators/idempotency_lock/install_generator"
+    end
+
+    initializer "idempotency_lock.configure" do
+      IdempotencyLock.logger = Rails.logger
+    end
+  end
+end

data/lib/idempotency_lock/result.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module IdempotencyLock
+  # Represents the result of an idempotency operation.
+  #
+  # @example Checking if the block was executed
+  #   result = IdempotencyLock.once("my-operation") { expensive_work }
+  #   if result.executed?
+  #     puts "Operation ran, got: #{result.value}"
+  #   else
+  #     puts "Operation was skipped (already ran)"
+  #   end
+  #
+  class Result
+    attr_reader :value, :error
+
+    def initialize(executed:, value: nil, skipped: false, error: nil)
+      @executed = executed
+      @value = value
+      @skipped = skipped
+      @error = error
+    end
+
+    # @return [Boolean] true if the block was executed
+    def executed?
+      @executed
+    end
+
+    # @return [Boolean] true if the operation was skipped due to existing lock
+    def skipped?
+      @skipped
+    end
+
+    # @return [Boolean] true if an error occurred during execution
+    def error?
+      !@error.nil?
+    end
+
+    # @return [Boolean] true if executed successfully without error
+    def success?
+      @executed && !error?
+    end
+  end
+end

data/lib/idempotency_lock/version.rb

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

data/lib/idempotency_lock.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require_relative "idempotency_lock/version"
+require_relative "idempotency_lock/result"
+require_relative "idempotency_lock/lock"
+
+# Database-backed idempotency locks for Ruby on Rails.
+#
+# Ensures operations run exactly once using database-backed locks with support
+# for TTL expiration, multiple error handling strategies, and clean return
+# value handling.
+#
+# @example Basic usage
+#   result = IdempotencyLock.once("send-welcome-email-user-123") do
+#     UserMailer.welcome(user).deliver_now
+#   end
+#   puts "Email sent!" if result.executed?
+#
+# @example With TTL
+#   IdempotencyLock.once("daily-report", ttl: 24.hours) { generate_report }
+#
+module IdempotencyLock
+  class Error < StandardError; end
+
+  # Error handling strategies
+  ON_ERROR_UNLOCK = :unlock       # Remove lock so operation can be retried
+  ON_ERROR_KEEP_LOCKED = :keep    # Keep lock in place (default)
+  ON_ERROR_RAISE = :raise         # Re-raise after cleanup/logging
+
+  class << self
+    # Execute a block exactly once for the given operation name.
+    #
+    # @param name [String] unique identifier for this operation
+    # @param ttl [ActiveSupport::Duration, Integer, nil] time-to-live for the lock
+    # @param on_error [Symbol, Proc] error handling strategy (:keep, :unlock, :raise, or Proc)
+    # @yield The block to execute (exactly once per lock name)
+    # @return [Result] containing execution status and return value
+    def once(name, ttl: nil, on_error: ON_ERROR_KEEP_LOCKED, &)
+      raise ArgumentError, "Block required" unless block_given?
+
+      now = Time.current
+      expires_at = calculate_expires_at(ttl, now)
+      acquired = Lock.acquire(name, expires_at: expires_at, now: now)
+
+      unless acquired
+        log_debug("Lock already exists for '#{name}', skipping execution")
+        return Result.new(executed: false, skipped: true)
+      end
+
+      log_debug("Lock acquired for '#{name}', executing block")
+      execute_with_lock(name, on_error, &)
+    end
+
+    # Convenience alias for `once`
+    alias wrap once
+
+    # Release a lock manually (useful for testing or manual intervention)
+    #
+    # @param name [String] the lock name to release
+    # @return [Boolean] true if a lock was released
+    def release(name)
+      Lock.release(name)
+    end
+
+    # Check if an operation is currently locked
+    #
+    # @param name [String] the lock name to check
+    # @return [Boolean] true if locked and not expired
+    def locked?(name)
+      Lock.locked?(name)
+    end
+
+    # Clean up all expired locks
+    #
+    # @return [Integer] number of locks cleaned up
+    def cleanup_expired
+      Lock.cleanup_expired
+    end
+
+    # Configure the logger (uses Rails.logger by default if available)
+    attr_writer :logger
+
+    def logger
+      @logger ||= defined?(Rails) ? Rails.logger : nil
+    end
+
+    private
+
+    def calculate_expires_at(ttl, now)
+      return nil if ttl.nil?
+
+      if ttl.respond_to?(:from_now)
+        # ActiveSupport::Duration
+        now + ttl
+      else
+        # Assume seconds
+        now + ttl.to_i
+      end
+    end
+
+    def execute_with_lock(name, on_error)
+      value = yield
+      Result.new(executed: true, value: value)
+    rescue StandardError => e
+      handle_error(name, e, on_error)
+    end
+
+    def handle_error(name, exception, on_error)
+      log_error("Exception in idempotent block '#{name}': #{exception.class} - #{exception.message}")
+
+      case on_error
+      when :unlock then handle_unlock_error(name, exception)
+      when :raise then handle_raise_error(name, exception)
+      when :keep, ON_ERROR_KEEP_LOCKED then handle_keep_error(name, exception)
+      when Proc then handle_proc_error(name, exception, on_error)
+      else Result.new(executed: true, error: exception)
+      end
+    end
+
+    def handle_unlock_error(name, exception)
+      Lock.release(name)
+      log_debug("Lock released for '#{name}' due to error (on_error: :unlock)")
+      Result.new(executed: true, error: exception)
+    end
+
+    def handle_raise_error(name, exception)
+      Lock.release(name)
+      log_debug("Lock released for '#{name}', re-raising error (on_error: :raise)")
+      raise exception
+    end
+
+    def handle_keep_error(name, exception)
+      log_debug("Lock kept for '#{name}' despite error (on_error: :keep)")
+      Result.new(executed: true, error: exception)
+    end
+
+    def handle_proc_error(name, exception, handler)
+      Lock.release(name)
+      handler.call(exception)
+      Result.new(executed: true, error: exception)
+    end
+
+    def log_debug(message)
+      logger&.debug("[IdempotencyLock] #{message}")
+    end
+
+    def log_error(message)
+      logger&.error("[IdempotencyLock] #{message}")
+    end
+  end
+end
+
+# Load Rails integration if Rails is present
+require_relative "idempotency_lock/railtie" if defined?(Rails::Railtie)

data/sig/idempotency_lock.rbs

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: idempotency_lock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Nagro
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: |
+  A simple, robust idempotency solution for Rails applications. Ensures operations
+  run exactly once using database-backed locks with support for TTL expiration,
+  multiple error handling strategies, and clean return value handling.
+email:
+- john@noreastergroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/idempotency_lock/install_generator.rb
+- lib/generators/idempotency_lock/templates/create_idempotency_locks.rb.erb
+- lib/idempotency_lock.rb
+- lib/idempotency_lock/lock.rb
+- lib/idempotency_lock/railtie.rb
+- lib/idempotency_lock/result.rb
+- lib/idempotency_lock/version.rb
+- sig/idempotency_lock.rbs
+homepage: https://github.com/noreastergroup/idempotency_lock
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/noreastergroup/idempotency_lock
+  source_code_uri: https://github.com/noreastergroup/idempotency_lock
+  changelog_uri: https://github.com/noreastergroup/idempotency_lock/blob/main/CHANGELOG.md
+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.6.9
+specification_version: 4
+summary: Database-backed idempotency locks for Ruby on Rails
+test_files: []