newshound 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79ace59ee869878db3221ca5d851c9bf10ae50354877d6b4a2b57ccc9489319e
-  data.tar.gz: 9a0e6d98ce5ac41b433c19d66ae920b207c090d7550df505645068c46f627feb
+  metadata.gz: f63cb577cdf9cc38edce00142a140f07263b9a59ddad4308fa4956b796617e60
+  data.tar.gz: ba96c4b481cc3de1b462bba4b53a482e0ece9ac05ebaebc56f65e601b638a2d2
 SHA512:
-  metadata.gz: 7124a65e125a08eea643486de24db7e84436c981ccd6e9c6fa12b205b33f1e2e30b062d38c766ab0f9df18bda79fd3d093b5bfccf23b5d9938b0c45e45d6a23e
-  data.tar.gz: d414aa404515671d71525214ebe0f601e456c6704e5bfccf29a49246454ea9f9d83e899576db2903cfe4d0491b8255a915d6b17a4c5cdefb879d5318b0476f66
+  metadata.gz: fb61b7b3f7bb65a5f0f888738ad78087cdc248e0dc512e82f467d4f85314428359443e6e3e5219e3d19c59e7cb63d9594b00e9d35505b4cda7e5e90ec25c9ad5
+  data.tar.gz: d86c02b4f21c5f2fc1780846848163a5d1205256c797f5c4138f1eed1ab1fb3c6003b10bdd60735232b375bb5cbf08196c1585bdd6f0d27edfa969896b07e6d4

data/CHANGELOG.md

@@ -5,39 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.1] - 2026-03-17
-
-### Changed
-
-- The authorize_with initializer will generate with the method inside the configure block. (2d6ef48)
+## [1.0.3] - 2026-04-21
 
 ### Added
 
-- Configurable banner links for exceptions, jobs, and warnings via string path patterns (1df1636)
-- Record ID in format_for_banner output for linking to individual records (e06d040)
-
-## [0.2.8] - 2026-02-10
+- failed_jobs_threshold configuration option (0caac13)
 
 ### Changed
 
-- Ruby support to 3.3+ and added Ruby 4.0 to CI matrix (24e5b86)
-- Job monitoring uses configurable adapter pattern via config.job_source (8d33d30)
-
-### Removed
-
-- Ruby 3.1 and 3.2 support (24e5b86)
-- Hard dependency on que gem (8d33d30)
-- QueReporter class (replaced by JobReporter + Jobs adapters) Version: major (8d33d30)
-
-### Fixed
+- Skip banner injection when there is nothing notable to display (0caac13)
 
-- Set the correct location for the repository on the web. (cb7bb88)
-- test_exceptions rake task calling report instead of banner_data (e440188)
-- Banner overlaying content in apps with !important body padding-top rules (16f22f1)
+## [1.0.2] - 2026-04-03
 
 ### Added
 
-- Jobs adapter pattern with Base class and registry (c50ba9c)
-- Jobs::Que adapter for Que job backend (c50ba9c)
-- JobReporter that delegates to a configurable job source adapter (c50ba9c)
-- ExceptionReporter#formatted_exception_count and #exception_summary helpers (e440188)
+- Bugsink exception source adapter for HTTP-based error tracking (6d3e2a1)
+- exception_source_config option for passing connection details to adapters (6d3e2a1)
+- Minimize button for banner (c686227)

data/lib/generators/newshound/install/templates/newshound.rb

@@ -19,6 +19,11 @@ Newshound.configure do |config|
   # config.job_source = :que # or a custom adapter instance
   # See Newshound::Jobs::Base for the adapter interface
 
+  # Number of failed jobs at or below which the banner is suppressed
+  # Set higher if your app tolerates occasional background job failures
+  # Default is 0 (any failed job triggers the banner)
+  # config.failed_jobs_threshold = 0
+
   # User roles that are authorized to view the Newshound banner
   # These should match the role values in your User model
   # Default is [:developer, :super_user]

data/lib/newshound/configuration.rb

@@ -4,7 +4,9 @@ module Newshound
   class Configuration
     attr_accessor :exception_limit, :enabled, :authorized_roles,
       :current_user_method, :authorization_block, :exception_source,
+      :exception_source_config,
       :warning_source, :warning_limit, :job_source,
+      :failed_jobs_threshold,
       :exception_links, :job_links, :warning_links
 
     def initialize
@@ -14,9 +16,11 @@ module Newshound
       @current_user_method = :current_user
       @authorization_block = nil
       @exception_source = :exception_track
+      @exception_source_config = {}
       @warning_source = nil
       @warning_limit = 10
       @job_source = nil
+      @failed_jobs_threshold = 0
       @exception_links = {}
       @job_links = {}
       @warning_links = {}

data/lib/newshound/exception_reporter.rb

@@ -51,7 +51,7 @@ module Newshound
 
     def resolve_exception_source(source)
       source ||= @configuration.exception_source
-      source.is_a?(Symbol) ? Exceptions.source(source) : source
+      source.is_a?(Symbol) ? Exceptions.source(source, @configuration.exception_source_config) : source
     end
 
     def recent_exceptions

data/lib/newshound/exceptions/base.rb

@@ -10,6 +10,10 @@ module Newshound
     # - #format_for_report(exception) - Formats a single exception for Slack/report display
     # - #format_for_banner(exception) - Formats a single exception for banner UI
     class Base
+      def initialize(config = {})
+        @config = config
+      end
+
       # Fetches recent exceptions from the exception tracking system
       #
       # @param time_range [ActiveSupport::Duration] Time duration to look back (e.g., 24.hours)

data/lib/newshound/exceptions/bugsink.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+require "time"
+
+module Newshound
+  module Exceptions
+    class Bugsink < Base
+      def self.required_keys
+        %i[url token project_id].freeze
+      end
+
+      def initialize(config = {})
+        super
+        config = config.transform_keys(&:to_sym)
+
+        missing = self.class.required_keys.select { |key| config[key].nil? }
+        if missing.any?
+          raise ArgumentError,
+            "Bugsink requires #{missing.map { |k| ":#{k}" }.join(", ")} in exception_source_config"
+        end
+
+        @url = config[:url]
+        @token = config[:token]
+        @project_id = config[:project_id]
+      end
+
+      def recent(time_range:, limit:)
+        issues = fetch_issues
+        cutoff = Time.now.utc - time_range
+
+        issues
+          .select { |i| Time.parse(i["last_seen"]) >= cutoff }
+          .first(limit)
+      end
+
+      def format_for_report(issue, number)
+        <<~TEXT
+          *#{number}. #{issue["calculated_type"] || "Unknown"}*
+          • *Time:* #{Time.parse(issue["last_seen"]).strftime("%I:%M %p")}
+          • *Message:* `#{(issue["calculated_value"] || "").truncate(100)}`
+        TEXT
+      end
+
+      def format_for_banner(issue)
+        {
+          id: issue["id"],
+          title: issue["calculated_type"] || "Unknown",
+          message: (issue["calculated_value"] || "").truncate(100),
+          location: issue["transaction"] || "",
+          time: Time.parse(issue["last_seen"]).strftime("%I:%M %p")
+        }
+      end
+
+      private
+
+      def fetch_issues
+        uri = URI("#{@url.chomp("/")}/api/canonical/0/issues/")
+        uri.query = URI.encode_www_form(project: @project_id, sort: "last_seen", order: "desc")
+
+        request = Net::HTTP::Get.new(uri)
+        request["Authorization"] = "Bearer #{@token}"
+        request["Accept"] = "application/json"
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+          http.request(request)
+        end
+
+        raise "Bugsink API error: #{response.code}" unless response.is_a?(Net::HTTPSuccess)
+
+        JSON.parse(response.body)["results"] || []
+      end
+    end
+  end
+end

data/lib/newshound/exceptions.rb

@@ -2,11 +2,11 @@ Dir[File.join(__dir__, "exceptions", "*.rb")].each { |file| require file }
 
 module Newshound
   module Exceptions
-    def self.source(source)
+    def self.source(source, config = {})
       constant = constants.find { |c| c.to_s.gsub(/(?<!^)([A-Z])/, "_\\1").downcase == source.to_s }
       raise "Invalid exception source: #{source}" unless constant
 
-      const_get(constant).new
+      const_get(constant).new(config)
     end
   end
 end

data/lib/newshound/middleware/banner_injector.rb

@@ -19,8 +19,9 @@ module Newshound
         return [status, headers, response] unless controller
         return [status, headers, response] unless Newshound::Authorization.authorized?(controller)
 
-        # Get banner HTML
+        # Get banner HTML (nil when nothing notable to display)
         banner_html = generate_banner_html
+        return [status, headers, response] unless banner_html
 
         # Inject banner after <body> tag
         new_response = inject_banner(response, banner_html)
@@ -62,10 +63,20 @@ module Newshound
         job_data = job_reporter.banner_data
         warning_data = warning_reporter.banner_data
 
-        # Generate HTML from template
+        return nil unless notable_data?(exception_data, job_data, warning_data)
+
         render_banner(exception_data, job_data, warning_data)
       end
 
+      def notable_data?(exception_data, job_data, warning_data)
+        exception_count = exception_data[:exceptions]&.length || 0
+        failed_jobs = job_data.dig(:queue_stats, :failed) || 0
+        warning_count = warning_data[:warnings]&.length || 0
+        threshold = Newshound.configuration.failed_jobs_threshold
+
+        exception_count > 0 || warning_count > 0 || failed_jobs > threshold
+      end
+
       def render_banner(exception_data, job_data, warning_data = {})
         <<~HTML
           <div id="newshound-banner" class="newshound-banner newshound-collapsed">
@@ -75,13 +86,19 @@ module Newshound
                 🐕 Newshound
                 #{summary_badge(exception_data, job_data, warning_data)}
               </span>
-              <span class="newshound-toggle">▼</span>
+              <span class="newshound-header-controls">
+                <span class="newshound-minimize" onclick="event.stopPropagation(); document.getElementById('newshound-banner').classList.add('newshound-minimized'); localStorage.setItem('newshound-minimized','1'); window.newshoundUpdatePadding();" title="Minimize">−</span>
+                <span class="newshound-toggle">▼</span>
+              </span>
             </div>
             <div class="newshound-content">
               #{render_exceptions(exception_data)}
               #{render_warnings(warning_data)}
               #{render_jobs(job_data)}
             </div>
+            <div class="newshound-restore" onclick="document.getElementById('newshound-banner').classList.remove('newshound-minimized'); localStorage.removeItem('newshound-minimized'); window.newshoundUpdatePadding();" title="Restore Newshound">
+              🐕
+            </div>
           </div>
           #{render_script}
         HTML
@@ -91,6 +108,11 @@ module Newshound
         <<~JS
           <script>
             (function() {
+              // Restore minimized state from localStorage
+              if (localStorage.getItem('newshound-minimized')) {
+                document.getElementById('newshound-banner').classList.add('newshound-minimized');
+              }
+
               var cachedPriority, cachedBodyRule;
 
               // Detect once whether any non-newshound stylesheet uses !important on body padding-top
@@ -290,6 +312,48 @@ module Newshound
             a.newshound-stat:hover {
               background: rgba(255,255,255,0.2);
             }
+            .newshound-header-controls {
+              display: flex;
+              align-items: center;
+              gap: 12px;
+            }
+            .newshound-minimize {
+              cursor: pointer;
+              font-size: 18px;
+              font-weight: 700;
+              line-height: 1;
+              opacity: 0.7;
+              padding: 0 4px;
+            }
+            .newshound-minimize:hover {
+              opacity: 1;
+            }
+            .newshound-restore {
+              display: none;
+            }
+            .newshound-banner.newshound-minimized .newshound-header {
+              display: none;
+            }
+            .newshound-banner.newshound-minimized .newshound-content {
+              max-height: 0;
+              overflow: hidden;
+              border-top: none;
+            }
+            .newshound-banner.newshound-minimized .newshound-restore {
+              display: flex;
+              align-items: center;
+              justify-content: center;
+              width: 36px;
+              height: 36px;
+              cursor: pointer;
+              font-size: 16px;
+              user-select: none;
+            }
+            .newshound-banner.newshound-minimized {
+              left: auto;
+              border-radius: 0 0 0 8px;
+              box-shadow: -2px 2px 6px rgba(0,0,0,0.2);
+            }
           </style>
         CSS
       end
@@ -298,19 +362,17 @@ module Newshound
         exception_count = exception_data[:exceptions]&.length || 0
         failed_jobs = job_data.dig(:queue_stats, :failed) || 0
         warning_count = warning_data[:warnings]&.length || 0
+        threshold = Newshound.configuration.failed_jobs_threshold
 
-        if exception_count > 0 || failed_jobs > 10
+        if exception_count > 0
           badge_class = "newshound-error"
-          text = "#{exception_count} exceptions, #{failed_jobs} failed jobs"
-        elsif warning_count > 0 || failed_jobs > 5
+          text = "#{exception_count} exceptions"
+        else
           badge_class = "newshound-warning"
           parts = []
           parts << "#{warning_count} warnings" if warning_count > 0
-          parts << "#{failed_jobs} failed jobs" if failed_jobs > 5
+          parts << "#{failed_jobs} failed jobs" if failed_jobs > threshold
           text = parts.join(", ")
-        else
-          badge_class = "newshound-success"
-          text = "All clear"
         end
 
         %(<span class="newshound-badge #{badge_class}">#{text}</span>)

data/lib/newshound/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Newshound
-  VERSION = "1.0.1"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newshound
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Savannah Moore
@@ -49,6 +49,7 @@ files:
 - lib/newshound/exception_reporter.rb
 - lib/newshound/exceptions.rb
 - lib/newshound/exceptions/base.rb
+- lib/newshound/exceptions/bugsink.rb
 - lib/newshound/exceptions/exception_track.rb
 - lib/newshound/exceptions/solid_errors.rb
 - lib/newshound/job_reporter.rb