bug_courier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44f75f93d09c399d9d3ed3f90cd8157c0da39d350163d7daa07fb1d10c183653
+  data.tar.gz: 828ced2624eca23b166bf697004b0fd571f74babed1a1fdb2aacff73f0f9237b
+SHA512:
+  metadata.gz: 6093f3699a16cf364746c1a0a80060d009ead749bf62476e1f46e419029b177e17c0f62caaa32847cb289b2d64ddd3e5ec6d8fe24f3b9262fbf606681ff7cb1f
+  data.tar.gz: b93af4116a9c047e955b476148989ccac2c2cc09b6eee643ff8c5245653208c44aa7ecb6b28f9f4db8513caf9d6c0b0c00275e7acd4091b539aea55112d7ae78

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Steffen Hansen
+
+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,76 @@
+# BugCourier
+
+A Rails gem that automatically creates GitHub issues when uncaught exceptions occur. Includes deduplication (comments on existing open issues instead of creating duplicates), rate limiting, request context capture, and async reporting.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "bug_courier"
+```
+
+Then run:
+
+```bash
+bundle install
+rails generate bug_courier:install
+```
+
+This creates an initializer at `config/initializers/bug_courier.rb`.
+
+## Configuration
+
+```ruby
+BugCourier.configure do |config|
+  # Required: GitHub personal access token with 'repo' scope
+  config.access_token = ENV["BUG_COURIER_GITHUB_TOKEN"]
+
+  # Required: GitHub repository in "owner/repo" format
+  config.repo = ENV["BUG_COURIER_GITHUB_REPO"]
+
+  # Labels applied to created issues (default: ["bug", "bug_courier"])
+  config.labels = ["bug", "bug_courier"]
+
+  # GitHub usernames to assign (default: [])
+  config.assignees = ["your-github-username"]
+
+  # Enable/disable (default: true)
+  config.enabled = Rails.env.production?
+
+  # Deduplicate — comments on existing open issues instead of creating new ones (default: true)
+  config.deduplicate = true
+
+  # Max issues created per hour (default: 10)
+  config.rate_limit = 10
+
+  # Optional callback after issue creation/commenting
+  config.callback = ->(action, issue) {
+    Rails.logger.info("[BugCourier] #{action}: #{issue['html_url']}")
+  }
+end
+```
+
+### GitHub Token
+
+Create a [GitHub personal access token](https://github.com/settings/tokens) with the `repo` scope (or `public_repo` for public repositories). Set it as the `BUG_COURIER_GITHUB_TOKEN` environment variable.
+
+## 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
+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
+
+### What Gets Reported
+
+Each issue includes:
+
+- **Exception class and message**
+- **Full backtrace** (first 30 lines)
+- **Request details** — method, URL, IP, user agent, filtered params
+- **Fingerprint** — SHA256 hash for identifying duplicate errors
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/bug_courier/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BugCourier
+  class Configuration
+    attr_accessor :access_token, :repo, :labels, :assignees, :enabled,
+                  :deduplicate, :rate_limit, :callback
+
+    def initialize
+      @access_token = nil
+      @repo = nil
+      @labels = ["bug", "bug_courier"]
+      @assignees = []
+      @enabled = true
+      @deduplicate = true
+      @rate_limit = 10 # max issues per hour
+      @callback = nil
+    end
+
+    def valid?
+      !!(access_token && !access_token.empty? && repo && !repo.empty?)
+    end
+  end
+end

data/lib/bug_courier/exception_handler.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module BugCourier
+  class RateLimiter
+    def initialize(max_per_hour:)
+      @max_per_hour = max_per_hour
+      @timestamps = []
+      @mutex = Mutex.new
+    end
+
+    def allow?
+      @mutex.synchronize do
+        now = Time.now
+        @timestamps.reject! { |t| now - t > 3600 }
+        return false if @timestamps.size >= @max_per_hour
+
+        @timestamps << now
+        true
+      end
+    end
+  end
+
+  class ExceptionHandler
+    def initialize
+      @rate_limiter = RateLimiter.new(max_per_hour: BugCourier.configuration.rate_limit)
+    end
+
+    def handle(exception, env = {})
+      return unless BugCourier.configuration.enabled
+      return unless BugCourier.configuration.valid?
+      return unless @rate_limiter.allow?
+
+      title = build_title(exception)
+      body = build_body(exception, env)
+
+      Thread.new do
+        report(title, body)
+      rescue StandardError => e
+        BugCourier.logger&.error("[BugCourier] Async reporting failed: #{e.message}")
+      end
+    end
+
+    private
+
+    def report(title, body)
+      config = BugCourier.configuration
+      client = GithubClient.new(access_token: config.access_token, repo: config.repo)
+
+      if config.deduplicate
+        existing = client.find_open_issue(title: title)
+        if existing
+          client.add_comment(
+            issue_number: existing["number"],
+            body: "**This error occurred again at #{Time.now.utc.iso8601}**\n\n#{body}"
+          )
+          config.callback&.call(:comment, existing)
+          return
+        end
+      end
+
+      result = client.create_issue(
+        title: title,
+        body: body,
+        labels: config.labels,
+        assignees: config.assignees
+      )
+
+      config.callback&.call(:created, result) if result
+    end
+
+    def build_title(exception)
+      location = exception.backtrace&.first&.gsub(Dir.pwd, ".")&.slice(0, 80) || "unknown"
+      "[BugCourier] #{exception.class}: #{exception.message.slice(0, 100)} (#{location})"
+    end
+
+    def build_body(exception, env)
+      request_info = extract_request_info(env)
+      fingerprint = Digest::SHA256.hexdigest("#{exception.class}#{exception.backtrace&.first}")[0, 12]
+
+      parts = []
+      parts << "## #{exception.class}"
+      parts << ""
+      parts << "**Message:** #{exception.message}"
+      parts << ""
+      parts << "**Fingerprint:** `#{fingerprint}`"
+      parts << ""
+
+      if request_info.any?
+        parts << "## Request Details"
+        parts << ""
+        request_info.each { |k, v| parts << "- **#{k}:** `#{v}`" }
+        parts << ""
+      end
+
+      parts << "## Backtrace"
+      parts << ""
+      parts << "```"
+      backtrace = exception.backtrace || ["No backtrace available"]
+      parts << backtrace.first(30).join("\n")
+      parts << "```"
+      parts << ""
+      parts << "---"
+      parts << "*Reported by [BugCourier](https://github.com/sgnh/bug-courier) at #{Time.now.utc.iso8601}*"
+
+      parts.join("\n")
+    end
+
+    def extract_request_info(env)
+      return {} if env.nil? || env.empty?
+
+      info = {}
+
+      if env.is_a?(Hash)
+        request = env["action_dispatch.request"] || (defined?(ActionDispatch::Request) && ActionDispatch::Request.new(env))
+
+        if request
+          info["Method"] = request.request_method rescue nil
+          info["URL"] = request.original_url rescue nil
+          info["IP"] = request.remote_ip rescue nil
+          info["User-Agent"] = request.user_agent rescue nil
+          info["Params"] = filtered_params(request) rescue nil
+        else
+          info["Method"] = env["REQUEST_METHOD"] if env["REQUEST_METHOD"]
+          info["Path"] = env["PATH_INFO"] if env["PATH_INFO"]
+          info["IP"] = env["REMOTE_ADDR"] if env["REMOTE_ADDR"]
+        end
+      end
+
+      info.compact
+    end
+
+    def filtered_params(request)
+      params = request.filtered_parameters rescue request.params rescue nil
+      return nil if params.nil? || params.empty?
+
+      params.except("controller", "action").to_s.slice(0, 500)
+    end
+  end
+end

data/lib/bug_courier/github_client.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+
+module BugCourier
+  class GithubClient
+    GITHUB_API_BASE = "https://api.github.com"
+
+    def initialize(access_token:, repo:)
+      @access_token = access_token
+      @repo = repo
+    end
+
+    def create_issue(title:, body:, labels: [], assignees: [])
+      uri = URI("#{GITHUB_API_BASE}/repos/#{@repo}/issues")
+
+      payload = {
+        title: title,
+        body: body,
+        labels: labels,
+        assignees: assignees
+      }.compact
+
+      response = post(uri, payload)
+
+      unless response.is_a?(Net::HTTPCreated)
+        BugCourier.logger&.error("[BugCourier] Failed to create GitHub issue: #{response.code} #{response.body}")
+        return nil
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def find_open_issue(title:)
+      query = "repo:#{@repo} is:issue is:open in:title #{title}"
+      uri = URI("#{GITHUB_API_BASE}/search/issues")
+      uri.query = URI.encode_www_form(q: query, per_page: 1)
+
+      response = get(uri)
+
+      unless response.is_a?(Net::HTTPOK)
+        BugCourier.logger&.error("[BugCourier] Failed to search GitHub issues: #{response.code} #{response.body}")
+        return nil
+      end
+
+      data = JSON.parse(response.body)
+      items = data["items"] || []
+      items.find { |issue| issue["title"] == title }
+    end
+
+    def add_comment(issue_number:, body:)
+      uri = URI("#{GITHUB_API_BASE}/repos/#{@repo}/issues/#{issue_number}/comments")
+
+      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}")
+        return nil
+      end
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def post(uri, payload)
+      request = Net::HTTP::Post.new(uri)
+      request["Authorization"] = "Bearer #{@access_token}"
+      request["Accept"] = "application/vnd.github+json"
+      request["X-GitHub-Api-Version"] = "2022-11-28"
+      request["Content-Type"] = "application/json"
+      request.body = JSON.generate(payload)
+
+      execute(uri, request)
+    end
+
+    def get(uri)
+      request = Net::HTTP::Get.new(uri)
+      request["Authorization"] = "Bearer #{@access_token}"
+      request["Accept"] = "application/vnd.github+json"
+      request["X-GitHub-Api-Version"] = "2022-11-28"
+
+      execute(uri, request)
+    end
+
+    def execute(uri, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.open_timeout = 10
+      http.read_timeout = 10
+      http.request(request)
+    rescue StandardError => e
+      BugCourier.logger&.error("[BugCourier] HTTP request failed: #{e.message}")
+      nil
+    end
+  end
+end

data/lib/bug_courier/middleware.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module BugCourier
+  class Middleware
+    def initialize(app)
+      @app = app
+      @handler = ExceptionHandler.new
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue Exception => exception # rubocop:disable Lint/RescueException
+      @handler.handle(exception, env)
+      raise
+    end
+  end
+end

data/lib/bug_courier/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module BugCourier
+  class Railtie < Rails::Railtie
+    initializer "bug_courier.configure_middleware" do |app|
+      app.middleware.insert_before(0, BugCourier::Middleware)
+    end
+
+    initializer "bug_courier.set_logger" do
+      BugCourier.logger = Rails.logger
+    end
+  end
+end

data/lib/bug_courier/version.rb

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

data/lib/bug_courier.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "bug_courier/version"
+require_relative "bug_courier/configuration"
+require_relative "bug_courier/github_client"
+require_relative "bug_courier/exception_handler"
+require_relative "bug_courier/middleware"
+
+module BugCourier
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :logger
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset!
+      @configuration = Configuration.new
+    end
+  end
+end
+
+require_relative "bug_courier/railtie" if defined?(Rails::Railtie)

data/lib/generators/bug_courier/install_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module BugCourier
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates a BugCourier initializer file at config/initializers/bug_courier.rb"
+
+      def create_initializer_file
+        create_file "config/initializers/bug_courier.rb", <<~RUBY
+          # frozen_string_literal: true
+
+          BugCourier.configure do |config|
+            # Required: GitHub personal access token with 'repo' scope
+            config.access_token = ENV["BUG_COURIER_GITHUB_TOKEN"]
+
+            # Required: GitHub repository in "owner/repo" format
+            config.repo = ENV["BUG_COURIER_GITHUB_REPO"]
+
+            # Labels to apply to created issues (default: ["bug", "bug_courier"])
+            # config.labels = ["bug", "bug_courier"]
+
+            # GitHub usernames to assign to created issues (default: [])
+            # config.assignees = ["your-github-username"]
+
+            # Enable/disable BugCourier (default: true)
+            # config.enabled = Rails.env.production?
+
+            # Deduplicate issues — adds comments to existing open issues instead
+            # of creating new ones (default: true)
+            # config.deduplicate = true
+
+            # Maximum number of issues to create per hour (default: 10)
+            # config.rate_limit = 10
+
+            # Optional callback — called after issue creation or commenting
+            # config.callback = ->(action, issue) {
+            #   Rails.logger.info("[BugCourier] \#{action}: \#{issue['html_url']}")
+            # }
+          end
+        RUBY
+      end
+    end
+  end
+end

data/sig/bug_courier.rbs

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

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: bug_courier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steffen Hansen
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: net-http
+  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 gem that catches uncaught exceptions and automatically creates
+  GitHub issues with full error details, backtraces, and request context. Includes
+  deduplication to avoid flooding your repo with duplicate issues.
+email:
+- sgnh@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/bug_courier.rb
+- lib/bug_courier/configuration.rb
+- lib/bug_courier/exception_handler.rb
+- lib/bug_courier/github_client.rb
+- lib/bug_courier/middleware.rb
+- lib/bug_courier/railtie.rb
+- lib/bug_courier/version.rb
+- lib/generators/bug_courier/install_generator.rb
+- sig/bug_courier.rbs
+homepage: https://github.com/sgnh/bug-courier
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sgnh/bug-courier
+  source_code_uri: https://github.com/sgnh/bug-courier
+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: 4.0.7
+specification_version: 4
+summary: Automatically create GitHub issues from uncaught Rails exceptions.
+test_files: []