snitch-rails 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4510d9170b5fd671b0511a772c746a48b6ba9a0a6b959e967bd66eaf49bbd43
-  data.tar.gz: 55c50540ed460878b90d94276bd98e88b1dad1314fee74ecefc31983e49ac6cc
+  metadata.gz: 24e7f769e5a0ca5e3af5c85f174944fcb9883f6f70cef92f42dc29eedca8bcf5
+  data.tar.gz: e286ffc4b8320d31f5e1345005feb186991386a95197df8db9ae3dd7ecab62e2
 SHA512:
-  metadata.gz: 2a58f507595dd81b3ec81dc0746da75e3f48a0f779c17f2918057b720fc06abaa2da51a396eb4cfb8ee977686cf4ed42963be191d35d57f2075916589da8ba5e
-  data.tar.gz: 5d549635ee294c1365e76ca4750f3de3ab029e906d200bee99dbef2f65d6552c5f6f40231a8d2c91fcabe5b46956ef62d5d1784f63377ca072056f32febdff5e
+  metadata.gz: 64eda4f8fd955360c4f0dbf03cfc00ad4fff5ddb0bc99903bb2982d59b36a4cf48218fa934209d813d85d15c4cdb4fc7107ab58c598b9d6139de9b6de70f2678
+  data.tar.gz: b9e9e351fb45771c3863fc77127b53db784bd87ad49e8d599fab393bffd3b417a59886629ac4377336e5dc62cd89c82b05932ce8b671b9525ba516752a9d4741

data/README.md

@@ -1,6 +1,8 @@
 # Snitch
 
-Snitch automatically catches unhandled exceptions in your Rails application, persists them to the database, and reports them as GitHub issues that @mention Claude for automated investigation.
+Snitch catches unhandled exceptions in your Rails application, persists them to the database, and reports them as GitHub issues that @mention Claude for automated investigation.
+
+![Example GitHub issue created by Snitch](example.png)
 
 ## Installation
 
@@ -55,10 +57,23 @@ end
 
 Create a [personal access token](https://github.com/settings/tokens) with the `repo` scope and set it as an environment variable:
 
-```bash
-export SNITCH_GITHUB_TOKEN=ghp_your_token_here
+## Manual Reporting
+
+Snitch automatically catches unhandled exceptions via middleware, but you can also report exceptions you rescue yourself:
+
+```ruby
+begin
+  SomeExternalService.call(params)
+rescue ExternalService::Timeout => e
+  Snitch::ExceptionHandler.handle(e)
+  # continue with your fallback logic
+end
 ```
 
+This is useful for exceptions you want to recover from gracefully but still want visibility into — failed API calls, flaky third-party services, background job retries, etc.
+
+The same fingerprinting and deduplication rules apply. If the same exception is reported multiple times, Snitch will increment the occurrence count and comment on the existing GitHub issue rather than creating a new one.
+
 ## How It Works
 
 1. Rack middleware catches any unhandled exception (and re-raises it so normal error handling still applies)
@@ -67,6 +82,12 @@ export SNITCH_GITHUB_TOKEN=ghp_your_token_here
 4. An ActiveJob is enqueued to create a GitHub issue (or comment on the existing one for duplicate exceptions)
 5. The GitHub issue includes the full backtrace, request context, and an @mention for investigation
 
+## Roadmap
+
+- [ ] multi-db support
+- [ ] simple dashboard to view captured exceptions (linked to gh issue)
+- [ ] webhook to resolve snitch record, when issues resolve
+
 ## Requirements
 
 - Ruby >= 3.1

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

@@ -8,6 +8,23 @@ module Snitch
 
       source_root File.expand_path("templates", __dir__)
 
+      def ensure_gemfile_require
+        gemfile = File.join(destination_root, "Gemfile")
+        return unless File.exist?(gemfile)
+
+        content = File.read(gemfile)
+
+        # Skip if require: "snitch" is already present
+        return if content.match?(/gem\s+["']snitch-rails["'].*require:\s*["']snitch["']/)
+
+        # Add require: "snitch" to the existing gem line
+        if content.match?(/gem\s+["']snitch-rails["']/)
+          gsub_file "Gemfile",
+            /(gem\s+["']snitch-rails["'])/,
+            '\1, require: "snitch"'
+        end
+      end
+
       def create_migration_file
         migration_template "create_snitch_errors.rb.erb",
           "db/migrate/create_snitch_errors.rb"

data/lib/snitch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Snitch
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snitch-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - RiseKit