RubyGems - newshound - Versions diffs - 0.1.1 → 0.2.0 - Mend

newshound 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

checksums.yaml +4 -4
data/README.md +152 -155
data/lib/generators/newshound/install/install_generator.rb +9 -50
data/lib/generators/newshound/install/templates/newshound.rb +27 -33
data/lib/newshound/authorization.rb +46 -0
data/lib/newshound/configuration.rb +12 -18
data/lib/newshound/middleware/banner_injector.rb +288 -0
data/lib/newshound/railtie.rb +32 -36
data/lib/newshound/version.rb +1 -1
data/lib/newshound.rb +5 -43
data/newshound.gemspec +2 -7
metadata +6 -52
data/lib/newshound/daily_report_job.rb +0 -31
data/lib/newshound/scheduler.rb +0 -42
data/lib/newshound/slack_notifier.rb +0 -44
data/lib/newshound/transport/base.rb +0 -28
data/lib/newshound/transport/slack.rb +0 -67
data/lib/newshound/transport/sns.rb +0 -115

data/lib/newshound/middleware/banner_injector.rb ADDED Viewed

@@ -0,0 +1,288 @@
+# frozen_string_literal: true
+module Newshound
+  module Middleware
+    class BannerInjector
+      def initialize(app)
+        @app = app
+      end
+      def call(env)
+        status, headers, response = @app.call(env)
+        # Only inject into HTML responses
+        return [status, headers, response] unless html_response?(headers)
+        return [status, headers, response] unless status == 200
+        # Check authorization
+        controller = env['action_controller.instance']
+        return [status, headers, response] unless controller
+        return [status, headers, response] unless Newshound::Authorization.authorized?(controller)
+        # Get banner HTML
+        banner_html = generate_banner_html
+        # Inject banner after <body> tag
+        new_response = inject_banner(response, banner_html)
+        # Update Content-Length header
+        if headers['Content-Length']
+          headers['Content-Length'] = new_response.bytesize.to_s
+        end
+        [status, headers, [new_response]]
+      end
+      private
+      def html_response?(headers)
+        content_type = headers['Content-Type']
+        content_type && content_type.include?('text/html')
+      end
+      def inject_banner(response, banner_html)
+        body = response_body(response)
+        # Inject after <body> tag
+        body.sub(/(<body[^>]*>)/i, "\\1\n#{banner_html}")
+      end
+      def response_body(response)
+        body = ""
+        response.each { |part| body << part }
+        body
+      end
+      def generate_banner_html
+        exception_reporter = Newshound::ExceptionReporter.new
+        que_reporter = Newshound::QueReporter.new
+        exception_data = exception_reporter.report
+        job_data = que_reporter.report
+        # Generate HTML from template
+        render_banner(exception_data, job_data)
+      end
+      def render_banner(exception_data, job_data)
+        <<~HTML
+          <div id="newshound-banner" class="newshound-banner newshound-collapsed">
+            #{render_styles}
+            <div class="newshound-header" onclick="document.getElementById('newshound-banner').classList.toggle('newshound-collapsed')">
+              <span class="newshound-title">
+                🐕 Newshound
+                #{summary_badge(exception_data, job_data)}
+              </span>
+              <span class="newshound-toggle">▼</span>
+            </div>
+            <div class="newshound-content">
+              #{render_exceptions(exception_data)}
+              #{render_jobs(job_data)}
+            </div>
+          </div>
+        HTML
+      end
+      def render_styles
+        <<~CSS
+          <style>
+            .newshound-banner {
+              position: fixed;
+              top: 0;
+              left: 0;
+              right: 0;
+              background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
+              color: white;
+              z-index: 10000;
+              box-shadow: 0 2px 10px rgba(0,0,0,0.3);
+              font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
+              font-size: 14px;
+            }
+            .newshound-header {
+              padding: 12px 20px;
+              cursor: pointer;
+              display: flex;
+              justify-content: space-between;
+              align-items: center;
+              user-select: none;
+            }
+            .newshound-title {
+              font-weight: 600;
+              display: flex;
+              align-items: center;
+              gap: 10px;
+            }
+            .newshound-badge {
+              display: inline-block;
+              padding: 2px 8px;
+              border-radius: 12px;
+              font-size: 12px;
+              font-weight: 600;
+              background: rgba(255,255,255,0.2);
+            }
+            .newshound-badge.error {
+              background: #ef4444;
+            }
+            .newshound-badge.warning {
+              background: #f59e0b;
+            }
+            .newshound-badge.success {
+              background: #10b981;
+            }
+            .newshound-toggle {
+              transition: transform 0.3s;
+            }
+            .newshound-banner.newshound-collapsed .newshound-toggle {
+              transform: rotate(-90deg);
+            }
+            .newshound-content {
+              max-height: 400px;
+              overflow-y: auto;
+              border-top: 1px solid rgba(255,255,255,0.2);
+              transition: max-height 0.3s ease-out;
+            }
+            .newshound-banner.newshound-collapsed .newshound-content {
+              max-height: 0;
+              overflow: hidden;
+              border-top: none;
+            }
+            .newshound-section {
+              padding: 15px 20px;
+              border-bottom: 1px solid rgba(255,255,255,0.1);
+            }
+            .newshound-section:last-child {
+              border-bottom: none;
+            }
+            .newshound-section-title {
+              font-weight: 600;
+              margin-bottom: 10px;
+              font-size: 15px;
+            }
+            .newshound-item {
+              background: rgba(255,255,255,0.1);
+              padding: 10px;
+              margin-bottom: 8px;
+              border-radius: 6px;
+              font-size: 13px;
+            }
+            .newshound-item:last-child {
+              margin-bottom: 0;
+            }
+            .newshound-item-title {
+              font-weight: 600;
+              margin-bottom: 4px;
+            }
+            .newshound-item-detail {
+              opacity: 0.9;
+              font-size: 12px;
+            }
+            .newshound-grid {
+              display: grid;
+              grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
+              gap: 10px;
+            }
+            .newshound-stat {
+              background: rgba(255,255,255,0.1);
+              padding: 12px;
+              border-radius: 6px;
+              text-align: center;
+            }
+            .newshound-stat-value {
+              font-size: 24px;
+              font-weight: 700;
+              display: block;
+            }
+            .newshound-stat-label {
+              font-size: 11px;
+              opacity: 0.8;
+              text-transform: uppercase;
+              letter-spacing: 0.5px;
+            }
+          </style>
+        CSS
+      end
+      def summary_badge(exception_data, job_data)
+        exception_count = exception_data[:exceptions]&.length || 0
+        failed_jobs = job_data.dig(:queue_stats, :failed) || 0
+        if exception_count > 0 || failed_jobs > 10
+          badge_class = "error"
+          text = "#{exception_count} exceptions, #{failed_jobs} failed jobs"
+        elsif failed_jobs > 5
+          badge_class = "warning"
+          text = "#{failed_jobs} failed jobs"
+        else
+          badge_class = "success"
+          text = "All clear"
+        end
+        %(<span class="newshound-badge #{badge_class}">#{text}</span>)
+      end
+      def render_exceptions(data)
+        exceptions = data[:exceptions] || []
+        if exceptions.empty?
+          return %(<div class="newshound-section"><div class="newshound-section-title">✅ Exceptions</div><div class="newshound-item">No exceptions in the last 24 hours</div></div>)
+        end
+        items = exceptions.take(5).map do |ex|
+          <<~HTML
+            <div class="newshound-item">
+              <div class="newshound-item-title">#{escape_html(ex[:title])}</div>
+              <div class="newshound-item-detail">
+                #{escape_html(ex[:message])} • #{escape_html(ex[:location])} • #{escape_html(ex[:time])}
+              </div>
+            </div>
+          HTML
+        end.join
+        <<~HTML
+          <div class="newshound-section">
+            <div class="newshound-section-title">⚠️ Recent Exceptions (#{exceptions.length})</div>
+            #{items}
+          </div>
+        HTML
+      end
+      def render_jobs(data)
+        stats = data[:queue_stats] || {}
+        <<~HTML
+          <div class="newshound-section">
+            <div class="newshound-section-title">📊 Job Queue Status</div>
+            <div class="newshound-grid">
+              <div class="newshound-stat">
+                <span class="newshound-stat-value">#{stats[:ready_to_run] || 0}</span>
+                <span class="newshound-stat-label">Ready</span>
+              </div>
+              <div class="newshound-stat">
+                <span class="newshound-stat-value">#{stats[:scheduled] || 0}</span>
+                <span class="newshound-stat-label">Scheduled</span>
+              </div>
+              <div class="newshound-stat">
+                <span class="newshound-stat-value">#{stats[:failed] || 0}</span>
+                <span class="newshound-stat-label">Failed</span>
+              </div>
+              <div class="newshound-stat">
+                <span class="newshound-stat-value">#{stats[:completed_today] || 0}</span>
+                <span class="newshound-stat-label">Completed Today</span>
+              </div>
+            </div>
+          </div>
+        HTML
+      end
+      def escape_html(text)
+        return "" unless text
+        text.to_s
+          .gsub('&', '&amp;')
+          .gsub('<', '&lt;')
+          .gsub('>', '&gt;')
+          .gsub('"', '&quot;')
+          .gsub("'", '&#39;')
+      end
+    end
+  end
+end

data/lib/newshound/railtie.rb CHANGED Viewed

@@ -4,59 +4,55 @@ require "rails/railtie"
 module Newshound
   class Railtie < Rails::Railtie
+    # Register middleware to inject banner
+    initializer "newshound.middleware" do |app|
+      if Newshound.configuration.enabled
+        app.middleware.use Newshound::Middleware::BannerInjector
+      end
+    end
     rake_tasks do
       namespace :newshound do
-        desc "Send daily report immediately"
-        task report_now: :environment do
-          puts "Sending Newshound daily report..."
-          Newshound.report!
-          puts "Report sent successfully!"
-        rescue StandardError => e
-          puts "Failed to send report: #{e.message}"
-        end
-        desc "Schedule daily report job"
-        task schedule: :environment do
-          puts "Scheduling Newshound daily report..."
-          Newshound::Scheduler.run_now!
-          puts "Job enqueued successfully!"
-        end
         desc "Show current configuration"
         task config: :environment do
           config = Newshound.configuration
           puts "Newshound Configuration:"
           puts "  Enabled: #{config.enabled}"
-          puts "  Slack Webhook: #{config.slack_webhook_url.present? ? '[CONFIGURED]' : '[NOT SET]'}"
-          puts "  Slack Channel: #{config.slack_channel}"
-          puts "  Report Time: #{config.report_time}"
           puts "  Exception Limit: #{config.exception_limit}"
-          puts "  Time Zone: #{config.time_zone}"
-          puts "  Valid: #{config.valid?}"
+          puts "  Authorized Roles: #{config.authorized_roles.join(', ')}"
+          puts "  Current User Method: #{config.current_user_method}"
+          puts "  Custom Authorization: #{config.authorization_block.present? ? 'Yes' : 'No'}"
+        end
+        desc "Test exception reporter"
+        task test_exceptions: :environment do
+          reporter = Newshound::ExceptionReporter.new
+          data = reporter.report
+          puts "Exception Report:"
+          puts "  Total exceptions: #{data[:exceptions]&.length || 0}"
+          data[:exceptions]&.each_with_index do |ex, i|
+            puts "  #{i + 1}. #{ex[:title]} - #{ex[:message]}"
+          end
         end
-      end
-    end
-    initializer "newshound.configure_que_scheduler" do
-      ActiveSupport.on_load(:active_record) do
-        if defined?(::Que::Scheduler)
-          require_relative "scheduler"
-          # Add our job to the que-scheduler configuration
-          schedule = Newshound::Scheduler.schedule_daily_report
-          Rails.logger.info "Newshound: Scheduled daily report at #{Newshound.configuration.report_time}"
-        else
-          Rails.logger.warn "Newshound: que-scheduler not found. Daily reports will need to be triggered manually."
+        desc "Test job reporter"
+        task test_jobs: :environment do
+          reporter = Newshound::QueReporter.new
+          data = reporter.report
+          puts "Job Queue Report:"
+          puts "  Ready to run: #{data.dig(:queue_stats, :ready_to_run)}"
+          puts "  Scheduled: #{data.dig(:queue_stats, :scheduled)}"
+          puts "  Failed: #{data.dig(:queue_stats, :failed)}"
+          puts "  Completed today: #{data.dig(:queue_stats, :completed_today)}"
         end
       end
     end
     config.after_initialize do
       if Newshound.configuration.valid?
-        Rails.logger.info "Newshound initialized and ready to report!"
+        Rails.logger.info "Newshound initialized - banner will be shown to authorized users"
       else
-        Rails.logger.warn "Newshound is not properly configured. Please check your configuration."
+        Rails.logger.warn "Newshound is disabled"
       end
     end
   end

data/lib/newshound/version.rb CHANGED Viewed

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

data/lib/newshound.rb CHANGED Viewed

@@ -4,9 +4,8 @@ require_relative "newshound/version"
 require_relative "newshound/configuration"
 require_relative "newshound/exception_reporter"
 require_relative "newshound/que_reporter"
-require_relative "newshound/slack_notifier"
-require_relative "newshound/daily_report_job"
-require_relative "newshound/scheduler"
+require_relative "newshound/authorization"
+require_relative "newshound/middleware/banner_injector"
 require_relative "newshound/railtie" if defined?(Rails)
 module Newshound
@@ -21,46 +20,9 @@ module Newshound
       yield(configuration)
     end
-    def report!
-      slack_notifier = SlackNotifier.new
-      exception_report = ExceptionReporter.new.generate_report
-      que_report = QueReporter.new.generate_report
-      message = format_daily_report(exception_report, que_report)
-      slack_notifier.post(message)
-    end
-    private
-    def format_daily_report(exception_report, que_report)
-      {
-        blocks: [
-          {
-            type: "header",
-            text: {
-              type: "plain_text",
-              text: "🐕 Daily Newshound Report",
-              emoji: true
-            }
-          },
-          {
-            type: "section",
-            text: {
-              type: "mrkdwn",
-              text: "*Date:* #{Date.current.strftime('%B %d, %Y')}"
-            }
-          },
-          {
-            type: "divider"
-          },
-          *exception_report,
-          {
-            type: "divider"
-          },
-          *que_report
-        ]
-      }
+    # Allow setting custom authorization logic
+    def authorize_with(&block)
+      configuration.authorize_with(&block)
     end
   end
 end

data/newshound.gemspec CHANGED Viewed

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["salbanez"]
   spec.email = ["salbanez@example.com"]
-  spec.summary = "Daily Slack reporter for Que jobs status and exception tracking"
-  spec.description = "Newshound sniffs out exceptions and job statuses in your Rails app and reports them daily to Slack"
+  spec.summary = "Real-time web UI banner for monitoring Que jobs and exception tracking"
+  spec.description = "Newshound displays exceptions and job statuses in a collapsible banner for authorized users in your Rails app"
   spec.homepage = "https://github.com/salbanez/newshound"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.7.0"
@@ -29,11 +29,6 @@ Gem::Specification.new do |spec|
   # Runtime dependencies
   spec.add_dependency "rails", ">= 6.0"
-  spec.add_dependency "slack-ruby-client", "~> 2.0"
   spec.add_dependency "que", ">= 1.0"
-  spec.add_dependency "que-scheduler", ">= 4.0"
   spec.add_dependency "exception-track", ">= 0.1"
-  # Optional dependency for SNS transport
-  spec.add_development_dependency "aws-sdk-sns", "~> 1.0"
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newshound
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - salbanez
@@ -23,20 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: slack-ruby-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: que
   requirement: !ruby/object:Gem::Requirement
@@ -51,20 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: que-scheduler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: exception-track
   requirement: !ruby/object:Gem::Requirement
@@ -79,22 +51,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: aws-sdk-sns
-  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'
-description: Newshound sniffs out exceptions and job statuses in your Rails app and
-  reports them daily to Slack
+description: Newshound displays exceptions and job statuses in a collapsible banner
+  for authorized users in your Rails app
 email:
 - salbanez@example.com
 executables: []
@@ -110,16 +68,12 @@ files:
 - lib/generators/newshound/install/install_generator.rb
 - lib/generators/newshound/install/templates/newshound.rb
 - lib/newshound.rb
+- lib/newshound/authorization.rb
 - lib/newshound/configuration.rb
-- lib/newshound/daily_report_job.rb
 - lib/newshound/exception_reporter.rb
+- lib/newshound/middleware/banner_injector.rb
 - lib/newshound/que_reporter.rb
 - lib/newshound/railtie.rb
-- lib/newshound/scheduler.rb
-- lib/newshound/slack_notifier.rb
-- lib/newshound/transport/base.rb
-- lib/newshound/transport/slack.rb
-- lib/newshound/transport/sns.rb
 - lib/newshound/version.rb
 - newshound.gemspec
 homepage: https://github.com/salbanez/newshound
@@ -145,5 +99,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Daily Slack reporter for Que jobs status and exception tracking
+summary: Real-time web UI banner for monitoring Que jobs and exception tracking
 test_files: []

data/lib/newshound/daily_report_job.rb DELETED Viewed

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-module Newshound
-  if defined?(::Que::Job)
-    class DailyReportJob < ::Que::Job
-      def run
-        return unless Newshound.configuration.valid?
-        Newshound.report!
-        destroy
-      rescue StandardError => e
-        Rails.logger.error "Newshound::DailyReportJob failed: #{e.message}"
-        Rails.logger.error e.backtrace.join("\n")
-        # Re-raise to let Que handle retry logic
-        raise
-      end
-    end
-  else
-    class DailyReportJob
-      def self.enqueue(*args)
-        Rails.logger.warn "Que is not available. DailyReportJob cannot be enqueued."
-      end
-      def run
-        Rails.logger.warn "Que is not available. DailyReportJob cannot be run."
-      end
-    end
-  end
-end

data/lib/newshound/scheduler.rb DELETED Viewed

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-module Newshound
-  class Scheduler
-    def self.schedule_daily_report
-      return unless defined?(::Que::Scheduler)
-      config = Newshound.configuration
-      return unless config.valid?
-      # Note: Que-scheduler uses a YAML config file (config/que_schedule.yml)
-      # This method returns the configuration that should be added to that file
-      # or can be used to manually schedule the job
-      schedule_config = {
-        "newshound_daily_report" => {
-          "class" => "Newshound::DailyReportJob",
-          "cron" => build_cron_expression(config.report_time),
-          "queue" => "default",
-          "args" => []
-        }
-      }
-      # Log the configuration for visibility
-      if defined?(Rails) && Rails.logger
-        Rails.logger.info "Newshound daily report scheduled for #{config.report_time} (cron: #{schedule_config['newshound_daily_report']['cron']})"
-      end
-      schedule_config
-    end
-    def self.build_cron_expression(time_string)
-      # Convert "09:00" format to cron expression
-      # Format: minute hour * * *
-      hour, minute = time_string.split(":").map(&:to_i)
-      "#{minute} #{hour} * * *"
-    end
-    def self.run_now!
-      Newshound::DailyReportJob.enqueue
-    end
-  end
-end

data/lib/newshound/slack_notifier.rb DELETED Viewed

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-require "slack-ruby-client"
-module Newshound
-  class SlackNotifier
-    attr_reader :configuration, :logger, :transport
-    def initialize(configuration: nil, logger: nil, transport: nil)
-      @configuration = configuration || Newshound.configuration
-      @logger = logger || (defined?(Rails) ? Rails.logger : Logger.new(STDOUT))
-      @transport = transport || build_transport
-    end
-    def post(message)
-      return unless configuration.valid?
-      transport.deliver(message)
-    rescue StandardError => e
-      logger.error "Newshound: Failed to send notification: #{e.message}"
-    end
-    private
-    def build_transport
-      case configuration.transport_adapter
-      when :sns, "sns"
-        require_relative "transport/sns"
-        Transport::Sns.new(configuration: configuration, logger: logger)
-      when :slack, "slack", nil
-        require_relative "transport/slack"
-        Transport::Slack.new(configuration: configuration, logger: logger)
-      else
-        if configuration.transport_adapter.is_a?(Class)
-          configuration.transport_adapter.new(configuration: configuration, logger: logger)
-        elsif configuration.transport_adapter.respond_to?(:new)
-          configuration.transport_adapter.new(configuration: configuration, logger: logger)
-        else
-          raise ArgumentError, "Invalid transport adapter: #{configuration.transport_adapter}"
-        end
-      end
-    end
-  end
-end