webhukhs 0.6.0 → 0.8.0

data/test/webhukhs_test.rb

@@ -1,14 +1,29 @@
 # frozen_string_literal: true
 
 require "test_helper"
-require_relative "test_app"
 
-class TestWebhukhs < ActionDispatch::IntegrationTest
-  teardown { Webhukhs::ReceivedWebhook.delete_all }
+class FailingLookupReceiveWebhooksController < Webhukhs::ReceiveWebhooksController
+  def initialize(error)
+    super()
+    @error = error
+  end
+
+  def service_id = "broken"
 
-  def test_that_it_has_a_version_number
-    refute_nil ::Webhukhs::VERSION
+  def lookup_handler(_service_id)
+    raise @error
   end
+end
+
+class TestWebhukhs < ActionDispatch::IntegrationTest
+  cover "Webhukhs*"
+  cover "Webhukhs::BaseHandler*"
+  cover "Webhukhs::Configuration*"
+  cover "Webhukhs::ProcessingJob*"
+  cover "Webhukhs::ReceiveWebhooksController*"
+  cover "Webhukhs::ReceivedWebhook*"
+
+  teardown { Webhukhs::ReceivedWebhook.delete_all }
 
   def webhook_body
     <<~JSON
@@ -28,15 +43,25 @@ class TestWebhukhs < ActionDispatch::IntegrationTest
     test(msg) { skip }
   end
 
-  test "ensure webhook is processed only once during creation" do
-    tf = Tempfile.new
-    body = {isValid: true, outputToFilename: tf.path}
-    body_json = body.to_json
+  test "returns a memoized configuration object and yields it to configure" do
+    original_configuration = Webhukhs.instance_variable_get(:@configuration)
+    Webhukhs.remove_instance_variable(:@configuration) if Webhukhs.instance_variable_defined?(:@configuration)
 
-    assert_enqueued_jobs 1, only: Webhukhs::ProcessingJob do
-      post "/webhukhs/test", params: body_json, headers: {"CONTENT_TYPE" => "application/json"}
-      assert_response 200
-    end
+    configuration = Webhukhs.configuration
+
+    assert_instance_of Webhukhs::Configuration, configuration
+    assert_same configuration, Webhukhs.configuration
+
+    yielded = nil
+    Webhukhs.configure { |config| yielded = config }
+
+    assert_same configuration, yielded
+  ensure
+    Webhukhs.instance_variable_set(:@configuration, original_configuration)
+  end
+
+  test "loads engine generators" do
+    assert_nothing_raised { Webhukhs::Engine.load_generators }
   end
 
   test "accepts a webhook, stores and processes it" do
@@ -46,20 +71,25 @@ class TestWebhukhs < ActionDispatch::IntegrationTest
 
     post "/webhukhs/test", params: body_json, headers: {"CONTENT_TYPE" => "application/json"}
     assert_response 200
+    assert_equal({"ok" => true, "error" => nil}, response.parsed_body)
 
     webhook = Webhukhs::ReceivedWebhook.last!
 
-    assert_predicate webhook, :received?
-    assert_equal "WebhookTestHandler", webhook.handler_module_name
-    assert_equal webhook.status, "received"
-    assert_equal webhook.body, body_json
-
     perform_enqueued_jobs
     assert_predicate webhook.reload, :processed?
     tf.rewind
     assert_equal tf.read, body_json
   end
 
+  test "stores the body of a form-encoded webhook" do
+    # Rails parses the form into params before the handler sees the request, which leaves the body
+    # stream at its end
+    post "/webhukhs/test", params: "event=paid&amount=12.50", headers: {"CONTENT_TYPE" => "application/x-www-form-urlencoded"}
+    assert_response 200
+
+    assert_equal "event=paid&amount=12.50", Webhukhs::ReceivedWebhook.last!.body
+  end
+
   test "accepts a webhook but does not process it if it is invalid" do
     tf = Tempfile.new
     body = {isValid: false, outputToFilename: tf.path}
@@ -70,11 +100,6 @@ class TestWebhukhs < ActionDispatch::IntegrationTest
 
     webhook = Webhukhs::ReceivedWebhook.last!
 
-    assert_predicate webhook, :received?
-    assert_equal "WebhookTestHandler", webhook.handler_module_name
-    assert_equal webhook.status, "received"
-    assert_equal webhook.body, body_json
-
     perform_enqueued_jobs
     assert_predicate webhook.reload, :failed_validation?
 
@@ -92,11 +117,6 @@ class TestWebhukhs < ActionDispatch::IntegrationTest
 
     webhook = Webhukhs::ReceivedWebhook.last!
 
-    assert_predicate webhook, :received?
-    assert_equal "WebhookTestHandler", webhook.handler_module_name
-    assert_equal webhook.status, "received"
-    assert_equal webhook.body, body_json
-
     assert_raises(StandardError) { perform_enqueued_jobs }
     assert_predicate webhook.reload, :error?
 
@@ -133,23 +153,46 @@ class TestWebhukhs < ActionDispatch::IntegrationTest
   end
 
   test "raises an error if the service_id is not known" do
-    post "/webhukhs/missing_service", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
-    assert_response 404
+    report = assert_error_reported(Webhukhs::ReceiveWebhooksController::UnknownHandler) do
+      post "/webhukhs/missing_service", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+
+      assert_response 404
+      assert_equal "No handler found for \"missing_service\"", response.parsed_body["error"]
+    end
+
+    assert_predicate report, :handled?
+    assert_equal :error, report.severity
   end
 
   test "returns a 503 when a handler is inactive" do
-    post "/webhukhs/inactive", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+    report = assert_error_reported(Webhukhs::ReceiveWebhooksController::HandlerInactive) do
+      post "/webhukhs/inactive", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+
+      assert_response 503
+      assert_equal 'Webhook handler "inactive" is inactive', response.parsed_body["error"]
+    end
 
-    assert_response 503
-    assert_equal 'Webhook handler "inactive" is inactive', response.parsed_body["error"]
+    assert_predicate report, :handled?
+    assert_equal :error, report.severity
   end
 
   test "returns a 200 status and error message if the handler does not expose errors" do
-    post "/webhukhs/failing-with-concealed-errors", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+    original_error_context = Webhukhs.configuration.error_context
+    Webhukhs.configuration.error_context = {component: "webhooks"}
 
-    assert_response 200
-    assert_equal false, response.parsed_body["ok"]
-    assert response.parsed_body["error"]
+    report = assert_error_reported(RuntimeError) do
+      post "/webhukhs/failing-with-concealed-errors", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+
+      assert_response 200
+      assert_false response.parsed_body["ok"]
+      assert_equal "Internal error (oops)", response.parsed_body["error"]
+    end
+
+    assert_predicate report, :handled?
+    assert_equal :error, report.severity
+    assert_equal "webhooks", report.context[:component]
+  ensure
+    Webhukhs.configuration.error_context = original_error_context
   end
 
   test "returns a 500 status and error message if the handler does not expose errors" do
@@ -160,6 +203,37 @@ class TestWebhukhs < ActionDispatch::IntegrationTest
     # common Rails error page
   end
 
+  test "re-raises lookup errors before a handler has been assigned" do
+    original_active_handlers = Webhukhs.configuration.active_handlers
+    Webhukhs.configuration.active_handlers = original_active_handlers.merge(broken: "MissingHandler")
+
+    post "/webhukhs/broken", params: webhook_body, headers: {"CONTENT_TYPE" => "application/json"}
+
+    assert_response 500
+    assert_includes response.body, "NameError"
+    assert_includes response.body, "MissingHandler"
+  ensure
+    Webhukhs.configuration.active_handlers = original_active_handlers
+  end
+
+  test "re-raises the original error when lookup fails before assigning a handler" do
+    original_error = NameError.new("uninitialized constant MissingHandler")
+    controller = FailingLookupReceiveWebhooksController.new(original_error)
+
+    raised_error = assert_raises(NameError) { controller.create }
+
+    assert_same original_error, raised_error
+  end
+
+  test "accepts handlers configured as class constants" do
+    original_active_handlers = Webhukhs.configuration.active_handlers
+    Webhukhs.configuration.active_handlers = original_active_handlers.merge(class_handler: WebhookTestHandler)
+
+    assert_instance_of WebhookTestHandler, Webhukhs::ReceiveWebhooksController.new.lookup_handler("class_handler")
+  ensure
+    Webhukhs.configuration.active_handlers = original_active_handlers
+  end
+
   test "deduplicates received webhooks based on the event ID" do
     body = {event_id: SecureRandom.uuid, body: "test"}.to_json
 
@@ -200,16 +274,4 @@ class TestWebhukhs < ActionDispatch::IntegrationTest
       assert_equal "received", webhook.status
     end
   end
-
-  test "ensure_id does not override id for integer primary key columns" do
-    webhook = Webhukhs::ReceivedWebhook.create!(
-      handler_event_id: SecureRandom.uuid,
-      handler_module_name: "WebhookTestHandler",
-      status: "received",
-      body: {isValid: true}.to_json
-    )
-
-    assert_kind_of Integer, webhook.id
-    assert webhook.id > 0
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webhukhs
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Stanislav Katkov
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: assiette
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: state_machine_enum
   requirement: !ruby/object:Gem::Requirement
@@ -107,10 +121,134 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-strict
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutant-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: ferrum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Webhukhs is a Rails engine for processing webhooks from various services.
-  Engine saves webhook in database first and later processes webhook in async process.
-  Supports custom handlers with Webhukhs::BaseHandler and integrates with Rails common
-  error reporter.
+  Engine saves webhook in database first and later processes in async job.
 email:
 - github@skatkov.com
 executables: []
@@ -120,15 +258,18 @@ files:
 - ".editorconfig"
 - ".rubocop.yml"
 - ".standard.yml"
+- ".yard-lint.yml"
+- AGENTS.md
 - Appraisals
 - CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile
+- config/mutant.rb
+- config/mutant.yml
 - config/routes.rb
 - example/.gitattributes
 - example/.gitignore
-- example/.ruby-version
 - example/Gemfile
 - example/Gemfile.lock
 - example/README.md
@@ -141,6 +282,9 @@ files:
 - example/app/models/application_record.rb
 - example/app/models/concerns/.keep
 - example/app/views/layouts/application.html.erb
+- example/app/webhooks/acme_handler.rb
+- example/app/webhooks/flaky_handler.rb
+- example/app/webhooks/signed_handler.rb
 - example/app/webhooks/webhook_test_handler.rb
 - example/bin/bundle
 - example/bin/rails
@@ -166,6 +310,7 @@ files:
 - example/config/puma.rb
 - example/config/routes.rb
 - example/db/migrate/20240523125859_create_webhukhs_tables.rb
+- example/db/migrate/20240601000000_add_headers_to_webhukhs_webhooks.rb
 - example/db/schema.rb
 - example/db/seeds.rb
 - example/lib/assets/.keep
@@ -187,18 +332,31 @@ files:
 - example/tmp/.keep
 - example/tmp/pids/.keep
 - example/vendor/.keep
-- gemfiles/rails_7.1.gemfile
-- gemfiles/rails_7.1.gemfile.lock
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_7.2.gemfile.lock
 - gemfiles/rails_8.0.gemfile
 - gemfiles/rails_8.0.gemfile.lock
 - gemfiles/rails_8.1.gemfile
 - gemfiles/rails_8.1.gemfile.lock
+- gemfiles/rails_master.gemfile
 - handler-examples/customer_io_handler.rb
 - handler-examples/revolut_business_v1_handler.rb
 - handler-examples/revolut_business_v2_handler.rb
 - handler-examples/starling_payments_handler.rb
 - lib/tasks/webhukhs_tasks.rake
 - lib/webhukhs.rb
+- lib/webhukhs/admin.rb
+- lib/webhukhs/admin/application_controller.rb
+- lib/webhukhs/admin/assets/admin.css
+- lib/webhukhs/admin/assets/admin.js
+- lib/webhukhs/admin/config/routes.rb
+- lib/webhukhs/admin/engine.rb
+- lib/webhukhs/admin/received_webhook_presenter.rb
+- lib/webhukhs/admin/received_webhooks_controller.rb
+- lib/webhukhs/admin/view_helper.rb
+- lib/webhukhs/admin/views/layouts/webhukhs/admin/application.html.erb
+- lib/webhukhs/admin/views/webhukhs/admin/received_webhooks/index.html.erb
+- lib/webhukhs/admin/views/webhukhs/admin/received_webhooks/show.html.erb
 - lib/webhukhs/base_handler.rb
 - lib/webhukhs/controllers/receive_webhooks_controller.rb
 - lib/webhukhs/engine.rb
@@ -209,7 +367,11 @@ files:
 - lib/webhukhs/templates/create_webhukhs_tables.rb.erb
 - lib/webhukhs/templates/webhukhs.rb
 - lib/webhukhs/version.rb
+- test/admin_test.rb
+- test/base_handler_test.rb
+- test/browser/admin_click_through.rb
 - test/processing_job_test.rb
+- test/received_webhook_test.rb
 - test/test-webhook-handlers/.DS_Store
 - test/test-webhook-handlers/extract_id_handler.rb
 - test/test-webhook-handlers/failing_with_concealed_errors.rb
@@ -235,14 +397,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.1
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Webhooks processing engine for Rails applications
 test_files: []

data/example/.ruby-version

@@ -1 +0,0 @@
-ruby-3.2.2