rails_webhook_outbox 0.3.0 → 0.4.0

data/app/views/rails_webhook_outbox/subscriptions/show.html.erb

@@ -0,0 +1,49 @@
+<%= link_to "← All Subscriptions", subscriptions_path, class: "rwo-back" %>
+
+<div class="rwo-header rwo-header-row">
+  <h1><%= @subscription.url %></h1>
+  <%= link_to "Edit", edit_subscription_path(@subscription), class: "rwo-btn" %>
+</div>
+
+<% if params[:rotation_error] %>
+  <p class="rwo-alert">Secret rotation already in progress — the previous secret is still within its grace period.</p>
+<% end %>
+
+<div class="rwo-detail">
+  <div class="rwo-detail-grid">
+    <div class="rwo-detail-item">
+      <div class="rwo-detail-label">Status</div>
+      <div class="rwo-detail-value"><%= active_badge(@subscription.active?) %></div>
+    </div>
+    <div class="rwo-detail-item">
+      <div class="rwo-detail-label">Events</div>
+      <div class="rwo-detail-value"><%= @subscription.events.join(", ") %></div>
+    </div>
+    <div class="rwo-detail-item">
+      <div class="rwo-detail-label">Consecutive Failures</div>
+      <div class="rwo-detail-value"><%= @subscription.consecutive_failures %></div>
+    </div>
+    <div class="rwo-detail-item">
+      <div class="rwo-detail-label">Description</div>
+      <div class="rwo-detail-value"><%= @subscription.description.presence || "—" %></div>
+    </div>
+  </div>
+</div>
+
+<h2 class="rwo-section-title">Signing Secret</h2>
+
+<div class="rwo-secret" data-controller="secret" data-secret-value-value="<%= @subscription.secret %>">
+  <span class="rwo-secret-display rwo-monospace" data-secret-target="display"><%= masked_secret(@subscription.secret) %></span>
+  <button type="button" class="rwo-btn-small" data-action="click->secret#reveal" data-secret-target="revealButton">Reveal</button>
+  <button type="button" class="rwo-btn-small" data-action="click->secret#copy" data-secret-target="copyButton">Copy</button>
+  <span class="rwo-muted" hidden data-secret-target="copiedHint">Copied!</span>
+</div>
+
+<% if @subscription.previous_secret_active? %>
+  <p class="rwo-muted">Previous secret valid until <%= @subscription.previous_secret_expires_at.strftime("%Y-%m-%d %H:%M:%S") %>.</p>
+<% end %>
+
+<%= button_to "Rotate Secret", rotate_secret_subscription_path(@subscription),
+      method: :patch,
+      class: "rwo-btn-danger",
+      form: { data: { turbo_confirm: "Rotate the signing secret? Subscribers must be updated within the grace period." } } %>

data/config/importmap.rb

@@ -0,0 +1,6 @@
+pin "@hotwired/turbo", to: "https://cdn.jsdelivr.net/npm/@hotwired/turbo@8.0.23/dist/turbo.es2017-esm.js"
+pin "@hotwired/stimulus", to: "https://cdn.jsdelivr.net/npm/@hotwired/stimulus@3.2.2/dist/stimulus.js"
+pin "rails_webhook_outbox",                                to: "rails_webhook_outbox/application.js"
+pin "rails_webhook_outbox/controllers",                    to: "rails_webhook_outbox/controllers/index.js"
+pin "rails_webhook_outbox/controllers/application",        to: "rails_webhook_outbox/controllers/application.js"
+pin "rails_webhook_outbox/controllers/secret_controller",  to: "rails_webhook_outbox/controllers/secret_controller.js"

data/config/routes.rb

@@ -1,2 +1,19 @@
 RailsWebhookOutbox::Engine.routes.draw do
+  root to: "overview#show"
+
+  # Explicit :only keeps new/edit routes on Rails 7.2 in api_only host apps,
+  # where resources would otherwise omit them.
+  resources :subscriptions, only: [:index, :show, :new, :create, :edit, :update, :destroy] do
+    member do
+      patch :rotate_secret
+    end
+  end
+
+  resources :deliveries, only: [:index, :show] do
+    member do
+      post :retry
+    end
+  end
+
+  resources :events, only: [:index]
 end

data/db/migrate/20260624000001_create_webhook_outbox_subscriptions.rb

@@ -1,6 +1,6 @@
 class CreateWebhookOutboxSubscriptions < ActiveRecord::Migration[7.2]
   def change
-    create_table :webhook_outbox_subscriptions do |t|
+    create_table :webhook_outbox_subscriptions, if_not_exists: true do |t|
       t.string :url, null: false
       t.string :secret, null: false
       t.json :events, null: false, default: []

data/db/migrate/20260624000002_create_webhook_outbox_deliveries.rb

@@ -1,6 +1,6 @@
 class CreateWebhookOutboxDeliveries < ActiveRecord::Migration[7.2]
   def change
-    create_table :webhook_outbox_deliveries do |t|
+    create_table :webhook_outbox_deliveries, if_not_exists: true do |t|
       t.references :subscription, null: false, foreign_key: { to_table: :webhook_outbox_subscriptions }
       t.string :event, null: false
       t.json :payload, null: false
@@ -13,8 +13,8 @@ class CreateWebhookOutboxDeliveries < ActiveRecord::Migration[7.2]
       t.timestamps
     end
 
-    add_index :webhook_outbox_deliveries, :status
-    add_index :webhook_outbox_deliveries, :event
-    add_index :webhook_outbox_deliveries, [:subscription_id, :created_at]
+    add_index :webhook_outbox_deliveries, :status, if_not_exists: true
+    add_index :webhook_outbox_deliveries, :event, if_not_exists: true
+    add_index :webhook_outbox_deliveries, [:subscription_id, :created_at], if_not_exists: true
   end
 end

data/db/migrate/20260629000002_add_idempotency_key_to_webhook_outbox_deliveries.rb

@@ -1,6 +1,6 @@
 class AddIdempotencyKeyToWebhookOutboxDeliveries < ActiveRecord::Migration[7.2]
   def change
-    add_column :webhook_outbox_deliveries, :idempotency_key, :string
-    add_index :webhook_outbox_deliveries, :idempotency_key, unique: true
+    add_column :webhook_outbox_deliveries, :idempotency_key, :string, if_not_exists: true
+    add_index :webhook_outbox_deliveries, :idempotency_key, unique: true, if_not_exists: true
   end
 end

data/db/migrate/20260701000001_add_secret_rotation_to_webhook_outbox_subscriptions.rb

@@ -1,6 +1,6 @@
 class AddSecretRotationToWebhookOutboxSubscriptions < ActiveRecord::Migration[7.2]
   def change
-    add_column :webhook_outbox_subscriptions, :previous_secret, :string
-    add_column :webhook_outbox_subscriptions, :previous_secret_expires_at, :datetime
+    add_column :webhook_outbox_subscriptions, :previous_secret, :string, if_not_exists: true
+    add_column :webhook_outbox_subscriptions, :previous_secret_expires_at, :datetime, if_not_exists: true
   end
 end

data/db/migrate/20260701000002_add_consecutive_failures_to_webhook_outbox_subscriptions.rb

@@ -1,5 +1,5 @@
 class AddConsecutiveFailuresToWebhookOutboxSubscriptions < ActiveRecord::Migration[7.2]
   def change
-    add_column :webhook_outbox_subscriptions, :consecutive_failures, :integer, null: false, default: 0
+    add_column :webhook_outbox_subscriptions, :consecutive_failures, :integer, null: false, default: 0, if_not_exists: true
   end
 end

data/db/migrate/20261027000001_create_webhook_outbox_delivery_attempts.rb

@@ -0,0 +1,16 @@
+class CreateWebhookOutboxDeliveryAttempts < ActiveRecord::Migration[7.2]
+  def change
+    create_table :webhook_outbox_delivery_attempts, if_not_exists: true do |t|
+      t.references :delivery, null: false, index: false,
+        foreign_key: { to_table: :webhook_outbox_deliveries, on_delete: :cascade }
+      t.integer :attempt_number, null: false
+      t.integer :outcome, null: false
+      t.integer :response_code
+      t.text :response_body
+      t.integer :duration_ms
+      t.datetime :created_at, null: false
+    end
+
+    add_index :webhook_outbox_delivery_attempts, [:delivery_id, :attempt_number], if_not_exists: true
+  end
+end

data/lib/generators/rails_webhook_outbox/install/install_generator.rb

@@ -1,29 +1,11 @@
 require "rails/generators"
-require "rails/generators/active_record"
 
 module RailsWebhookOutbox
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-
       source_root File.expand_path("templates", __dir__)
 
-      desc "Creates a RailsWebhookOutbox initializer and copies migrations to your application."
-
-      def self.next_migration_number(dirname)
-        ActiveRecord::Generators::Base.next_migration_number(dirname)
-      end
-
-      def copy_migrations
-        migration_template(
-          "create_webhook_outbox_subscriptions.rb.tt",
-          "db/migrate/create_webhook_outbox_subscriptions.rb"
-        )
-        migration_template(
-          "create_webhook_outbox_deliveries.rb.tt",
-          "db/migrate/create_webhook_outbox_deliveries.rb"
-        )
-      end
+      desc "Creates a RailsWebhookOutbox initializer. The engine supplies its own migrations; run `rails db:migrate` afterwards."
 
       def create_initializer
         template "initializer.rb", "config/initializers/rails_webhook_outbox.rb"

data/lib/rails_webhook_outbox/configuration.rb

@@ -6,7 +6,8 @@ module RailsWebhookOutbox
     attr_accessor :events, :signing_algorithm, :signing_header,
                   :max_retries, :retry_backoff, :request_timeout,
                   :delivery_job_queue, :max_payload_size, :test_mode,
-                  :secret_rotation_grace_period, :circuit_breaker_threshold
+                  :secret_rotation_grace_period, :circuit_breaker_threshold,
+                  :dashboard_enabled
 
     def initialize
       @events = []
@@ -20,6 +21,7 @@ module RailsWebhookOutbox
       @test_mode = false
       @secret_rotation_grace_period = 24.hours
       @circuit_breaker_threshold = 10
+      @dashboard_enabled = Rails.env.development?
     end
 
     def signing_algorithm=(value)

data/lib/rails_webhook_outbox/engine.rb

@@ -1,3 +1,6 @@
+require "turbo-rails"
+require "importmap-rails"
+
 module RailsWebhookOutbox
   class Engine < ::Rails::Engine
     isolate_namespace RailsWebhookOutbox
@@ -10,5 +13,18 @@ module RailsWebhookOutbox
         end
       end
     end
+
+    initializer "rails_webhook_outbox.assets" do |app|
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << RailsWebhookOutbox::Engine.root.join("app/javascript")
+      end
+    end
+
+    initializer "rails_webhook_outbox.importmap", before: "importmap" do |app|
+      if app.config.respond_to?(:importmap)
+        app.config.importmap.paths << RailsWebhookOutbox::Engine.root.join("config/importmap.rb")
+        app.config.importmap.cache_sweepers << RailsWebhookOutbox::Engine.root.join("app/javascript")
+      end
+    end
   end
 end

data/lib/rails_webhook_outbox/version.rb

@@ -1,3 +1,3 @@
 module RailsWebhookOutbox
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_webhook_outbox
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -23,6 +23,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  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: turbo-rails
+  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'
 description: A Rails engine for sending outgoing webhooks with HMAC signing, ActiveJob-based
   retry, and delivery logging.
 email:
@@ -34,22 +62,58 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- UPGRADING.md
+- app/assets/stylesheets/rails_webhook_outbox/_01_base.css
+- app/assets/stylesheets/rails_webhook_outbox/_02_layout.css
+- app/assets/stylesheets/rails_webhook_outbox/_03_table.css
+- app/assets/stylesheets/rails_webhook_outbox/_04_badges.css
+- app/assets/stylesheets/rails_webhook_outbox/_05_forms.css
+- app/assets/stylesheets/rails_webhook_outbox/_06_filters.css
+- app/assets/stylesheets/rails_webhook_outbox/_07_timeline.css
 - app/controllers/rails_webhook_outbox/application_controller.rb
+- app/controllers/rails_webhook_outbox/base_controller.rb
+- app/controllers/rails_webhook_outbox/deliveries_controller.rb
+- app/controllers/rails_webhook_outbox/events_controller.rb
+- app/controllers/rails_webhook_outbox/overview_controller.rb
+- app/controllers/rails_webhook_outbox/subscriptions_controller.rb
+- app/helpers/rails_webhook_outbox/application_helper.rb
+- app/javascript/rails_webhook_outbox/application.js
+- app/javascript/rails_webhook_outbox/controllers/application.js
+- app/javascript/rails_webhook_outbox/controllers/index.js
+- app/javascript/rails_webhook_outbox/controllers/secret_controller.js
 - app/jobs/rails_webhook_outbox/application_job.rb
 - app/jobs/rails_webhook_outbox/delivery_job.rb
 - app/mailers/rails_webhook_outbox/application_mailer.rb
 - app/models/rails_webhook_outbox/application_record.rb
 - app/models/rails_webhook_outbox/delivery.rb
+- app/models/rails_webhook_outbox/delivery_attempt.rb
+- app/models/rails_webhook_outbox/overview.rb
 - app/models/rails_webhook_outbox/subscription.rb
+- app/views/layouts/rails_webhook_outbox/application.html.erb
+- app/views/rails_webhook_outbox/deliveries/_detail.html.erb
+- app/views/rails_webhook_outbox/deliveries/_row.html.erb
+- app/views/rails_webhook_outbox/deliveries/_timeline.html.erb
+- app/views/rails_webhook_outbox/deliveries/index.html.erb
+- app/views/rails_webhook_outbox/deliveries/retry.turbo_stream.erb
+- app/views/rails_webhook_outbox/deliveries/show.html.erb
+- app/views/rails_webhook_outbox/events/index.html.erb
+- app/views/rails_webhook_outbox/overview/_recent_failures.html.erb
+- app/views/rails_webhook_outbox/overview/_stats.html.erb
+- app/views/rails_webhook_outbox/overview/show.html.erb
+- app/views/rails_webhook_outbox/subscriptions/_form.html.erb
+- app/views/rails_webhook_outbox/subscriptions/edit.html.erb
+- app/views/rails_webhook_outbox/subscriptions/index.html.erb
+- app/views/rails_webhook_outbox/subscriptions/new.html.erb
+- app/views/rails_webhook_outbox/subscriptions/show.html.erb
+- config/importmap.rb
 - config/routes.rb
 - db/migrate/20260624000001_create_webhook_outbox_subscriptions.rb
 - db/migrate/20260624000002_create_webhook_outbox_deliveries.rb
 - db/migrate/20260629000002_add_idempotency_key_to_webhook_outbox_deliveries.rb
 - db/migrate/20260701000001_add_secret_rotation_to_webhook_outbox_subscriptions.rb
 - db/migrate/20260701000002_add_consecutive_failures_to_webhook_outbox_subscriptions.rb
+- db/migrate/20261027000001_create_webhook_outbox_delivery_attempts.rb
 - lib/generators/rails_webhook_outbox/install/install_generator.rb
-- lib/generators/rails_webhook_outbox/install/templates/create_webhook_outbox_deliveries.rb.tt
-- lib/generators/rails_webhook_outbox/install/templates/create_webhook_outbox_subscriptions.rb.tt
 - lib/generators/rails_webhook_outbox/install/templates/initializer.rb
 - lib/rails_webhook_outbox.rb
 - lib/rails_webhook_outbox/configuration.rb

data/lib/generators/rails_webhook_outbox/install/templates/create_webhook_outbox_deliveries.rb.tt

@@ -1,21 +0,0 @@
-class CreateWebhookOutboxDeliveries < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
-  def change
-    create_table :webhook_outbox_deliveries do |t|
-      t.references :subscription, null: false, foreign_key: { to_table: :webhook_outbox_subscriptions }
-      t.string :event, null: false
-      t.json :payload, null: false
-      t.integer :status, null: false, default: 0
-      t.integer :response_code
-      t.text :response_body
-      t.integer :attempts, null: false, default: 0
-      t.string :idempotency_key
-      t.datetime :delivered_at
-      t.datetime :next_retry_at
-      t.timestamps
-    end
-
-    add_index :webhook_outbox_deliveries, :status
-    add_index :webhook_outbox_deliveries, :event
-    add_index :webhook_outbox_deliveries, [:subscription_id, :created_at]
-  end
-end

data/lib/generators/rails_webhook_outbox/install/templates/create_webhook_outbox_subscriptions.rb.tt

@@ -1,16 +0,0 @@
-class CreateWebhookOutboxSubscriptions < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
-  def change
-    create_table :webhook_outbox_subscriptions do |t|
-      t.string :url, null: false
-      t.string :secret, null: false
-      t.string :previous_secret
-      t.datetime :previous_secret_expires_at
-      t.json :events, null: false, default: []
-      t.boolean :active, null: false, default: true
-      t.integer :consecutive_failures, null: false, default: 0
-      t.string :description
-      t.json :metadata, default: {}
-      t.timestamps
-    end
-  end
-end