bug_courier 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36cb1c6c27aafcb8c121c7c45abd1096704ba4f2c93dac261cfc65edac80cf48
-  data.tar.gz: 6331194fdee5a7140ab0bc951efe0d4a18d16415813275a0991b58fe30aaa2d0
+  metadata.gz: b6b455974d2717751253d5102bf28f36bb04a4ec924f318904ab6341ab1b11c1
+  data.tar.gz: '047847d8a4b32ec1c6777a5640d135b722118175258c8124096166d8b939a671'
 SHA512:
-  metadata.gz: cdb705a50f9c96731d8acf9f2c0960ad5bedc34a477e452b3e68895db8f22ca5001f91d461546e03eeafcae6957729dfc41b284442825cada9e7df093ed8d2bf
-  data.tar.gz: 1c185ff6306357c3b1cec72dff37018c97cf42c0c8b1054da8683fc52c5a242c5afd9f80a3bf9809e3ec587fe01df0a85a63b59bd12daf27f52ee3d2cb7601c4
+  metadata.gz: 8331b81d74c0b238d7fdaf51f1c7fc8b1ef896677a4ac93456e1334d803a2f886a383f30ebd5205d743a9c4739400a9041f42ac165a9943701966682455950ef
+  data.tar.gz: 17b29320dcd0919006c8b8db017eece9ade5298191ae6e96ec8f5e840d5c44038bdf222a797b0b8e7b0d6c676ae1cde0e8a2b8779d824bf0d1c940aa1bc42e47

data/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+All notable changes to BugCourier are documented in this file.
+
+## [v1.1.1](https://github.com/sgnh/bug-courier/compare/v1.1.0...v1.1.1) — 2026-03-11
+
+### Fixed
+
+- Middleware now rescues only `StandardError`, avoiding interception of fatal Ruby exceptions such as `SystemExit` and `SignalException`
+- `GithubClient` now handles transport failures that return no HTTP response without raising secondary `NoMethodError` exceptions
+
+## [v1.1.0](https://github.com/sgnh/bug-courier/compare/v1.0.0...v1.1.0) — 2026-03-11
+
+### Added
+
+- `ignore_exceptions` configuration option to skip reporting for specific exception classes (e.g., `ActiveRecord::RecordNotFound`, `ActionController::RoutingError`)
+- Supports both class constants and string class names in the ignore list
+- Install generator now includes commented-out `ignore_exceptions` example in the initializer
+
+### Changed
+
+- `ExceptionHandler#handle` checks ignored exceptions before processing
+
+## [v1.0.0](https://github.com/sgnh/bug-courier/compare/v0.1.2...v1.0.0) — 2026-03-10
+
+### Changed
+
+- Bumped to first stable release (1.0.0)
+
+### Documentation
+
+- Added GitHub Copilot integration section to README explaining automatic issue creation and pull request workflows
+
+## [v0.1.2](https://github.com/sgnh/bug-courier/compare/v0.1.1...v0.1.2) — 2026-03-10
+
+### Fixed
+
+- Changed middleware insertion order from `insert_before(0, ...)` to `insert_after(ActionDispatch::DebugExceptions, ...)` to ensure proper functionality within the Rails middleware stack
+
+## [v0.1.1](https://github.com/sgnh/bug-courier/compare/v0.1.0...v0.1.1) — 2026-03-10
+
+### Changed
+
+- Lowered required Ruby version from `>= 3.2.0` to `>= 2.7.0`
+- Lowered `railties` dependency from `>= 7.0` to `>= 6.1` for broader Rails compatibility
+
+## [v0.1.0] — 2026-03-10
+
+### Added
+
+- Initial open source release
+- Rack middleware to catch uncaught exceptions automatically
+- `ExceptionHandler` with full error details, backtraces, and request context
+- `GithubClient` for creating GitHub issues via the API
+- Deduplication support to avoid duplicate issues (comments on existing ones instead)
+- Rate limiting (default: 10 issues per hour)
+- Configurable labels, assignees, and optional callback after issue creation
+- Rails generator (`rails generate bug_courier:install`) to scaffold an initializer
+- Railtie for automatic middleware integration in Rails apps

data/README.md

@@ -70,8 +70,8 @@ Create a [GitHub personal access token](https://github.com/settings/tokens) with
 
 ## How It Works
 
-1. BugCourier inserts a Rack middleware at the top of your middleware stack
-2. When an uncaught exception propagates up, the middleware catches it, reports it asynchronously, then re-raises it so normal error handling continues
+1. BugCourier inserts a Rack middleware after `ActionDispatch::DebugExceptions` in the Rails middleware stack
+2. When a `StandardError` propagates up to that layer, the middleware reports it asynchronously, then re-raises it so normal error handling continues
 3. If deduplication is enabled, it searches for an existing open issue with the same title and adds a comment instead of creating a duplicate
 4. Rate limiting prevents flooding your repository with issues during error spikes
 

data/lib/bug_courier/configuration.rb

@@ -3,7 +3,7 @@
 module BugCourier
   class Configuration
     attr_accessor :access_token, :repo, :labels, :assignees, :enabled,
-                  :deduplicate, :rate_limit, :callback
+                  :deduplicate, :rate_limit, :callback, :ignore_exceptions
 
     def initialize
       @access_token = nil
@@ -14,6 +14,7 @@ module BugCourier
       @deduplicate = true
       @rate_limit = 10 # max issues per hour
       @callback = nil
+      @ignore_exceptions = []
     end
 
     def valid?

data/lib/bug_courier/exception_handler.rb

@@ -30,6 +30,7 @@ module BugCourier
     def handle(exception, env = {})
       return unless BugCourier.configuration.enabled
       return unless BugCourier.configuration.valid?
+      return if ignored?(exception)
       return unless @rate_limiter.allow?
 
       title = build_title(exception)
@@ -137,5 +138,14 @@ module BugCourier
 
       params.except("controller", "action").to_s.slice(0, 500)
     end
+
+    def ignored?(exception)
+      BugCourier.configuration.ignore_exceptions.any? do |klass|
+        klass = Object.const_get(klass) if klass.is_a?(String)
+        exception.is_a?(klass)
+      rescue NameError
+        false
+      end
+    end
   end
 end

data/lib/bug_courier/github_client.rb

@@ -26,7 +26,7 @@ module BugCourier
       response = post(uri, payload)
 
       unless response.is_a?(Net::HTTPCreated)
-        BugCourier.logger&.error("[BugCourier] Failed to create GitHub issue: #{response.code} #{response.body}")
+        log_failure("Failed to create GitHub issue", response)
         return nil
       end
 
@@ -41,7 +41,7 @@ module BugCourier
       response = get(uri)
 
       unless response.is_a?(Net::HTTPOK)
-        BugCourier.logger&.error("[BugCourier] Failed to search GitHub issues: #{response.code} #{response.body}")
+        log_failure("Failed to search GitHub issues", response)
         return nil
       end
 
@@ -56,7 +56,7 @@ module BugCourier
       response = post(uri, { body: body })
 
       unless response.is_a?(Net::HTTPCreated)
-        BugCourier.logger&.error("[BugCourier] Failed to add comment to issue ##{issue_number}: #{response.code} #{response.body}")
+        log_failure("Failed to add comment to issue ##{issue_number}", response)
         return nil
       end
 
@@ -95,5 +95,15 @@ module BugCourier
       BugCourier.logger&.error("[BugCourier] HTTP request failed: #{e.message}")
       nil
     end
+
+    def log_failure(message, response)
+      details = if response.nil?
+                  "no response received"
+                else
+                  "#{response.code} #{response.body}"
+                end
+
+      BugCourier.logger&.error("[BugCourier] #{message}: #{details}")
+    end
   end
 end

data/lib/bug_courier/middleware.rb

@@ -9,7 +9,7 @@ module BugCourier
 
     def call(env)
       @app.call(env)
-    rescue Exception => exception # rubocop:disable Lint/RescueException
+    rescue StandardError => exception
       @handler.handle(exception, env)
       raise
     end

data/lib/bug_courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BugCourier
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/generators/bug_courier/install_generator.rb

@@ -34,6 +34,12 @@ module BugCourier
             # Maximum number of issues to create per hour (default: 10)
             # config.rate_limit = 10
 
+            # Exception classes to ignore — these will not be reported (default: [])
+            # config.ignore_exceptions = [
+            #   ActiveRecord::RecordNotFound,
+            #   ActionController::RoutingError,
+            # ]
+
             # Optional callback — called after issue creation or commenting
             # config.callback = ->(action, issue) {
             #   Rails.logger.info("[BugCourier] \#{action}: \#{issue['html_url']}")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bug_courier
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Steffen Hansen
@@ -46,6 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile