newshound 0.1.1 → 0.2.1

data/newshound.gemspec

@@ -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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newshound
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 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

@@ -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

@@ -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

@@ -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

data/lib/newshound/transport/base.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Newshound
-  module Transport
-    class Base
-      attr_reader :configuration, :logger
-
-      def initialize(configuration: nil, logger: nil)
-        @configuration = configuration || Newshound.configuration
-        @logger = logger || default_logger
-      end
-
-      def deliver(message)
-        raise NotImplementedError, "Subclasses must implement the #deliver method"
-      end
-
-      protected
-
-      def default_logger
-        if defined?(Rails)
-          Rails.logger
-        else
-          Logger.new(STDOUT)
-        end
-      end
-    end
-  end
-end

data/lib/newshound/transport/slack.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require "slack-ruby-client"
-require_relative "base"
-
-module Newshound
-  module Transport
-    class Slack < Base
-      attr_reader :webhook_client, :web_api_client
-
-      def initialize(configuration: nil, logger: nil, webhook_client: nil, web_api_client: nil)
-        super(configuration: configuration, logger: logger)
-        @webhook_client = webhook_client
-        @web_api_client = web_api_client
-        configure_slack_client
-      end
-
-      def deliver(message)
-        return unless configuration.valid?
-
-        if webhook_configured?
-          deliver_via_webhook(message)
-        elsif web_api_configured?
-          deliver_via_web_api(message)
-        else
-          logger.error "Newshound: No valid Slack configuration found"
-          false
-        end
-      rescue StandardError => e
-        logger.error "Newshound: Failed to send Slack notification: #{e.message}"
-        false
-      end
-
-      private
-
-      def configure_slack_client
-        ::Slack.configure do |config|
-          config.token = ENV["SLACK_API_TOKEN"] if ENV["SLACK_API_TOKEN"]
-        end
-      end
-
-      def webhook_configured?
-        !configuration.slack_webhook_url.nil? && !configuration.slack_webhook_url.empty?
-      end
-
-      def web_api_configured?
-        !ENV["SLACK_API_TOKEN"].nil? && !ENV["SLACK_API_TOKEN"].empty?
-      end
-
-      def deliver_via_webhook(message)
-        client = webhook_client || ::Slack::Incoming::Webhook.new(configuration.slack_webhook_url)
-        client.post(message)
-        true
-      end
-
-      def deliver_via_web_api(message)
-        client = web_api_client || ::Slack::Web::Client.new
-        client.chat_postMessage(
-          channel: configuration.slack_channel,
-          blocks: message[:blocks],
-          text: "Daily Newshound Report"
-        )
-        true
-      end
-    end
-  end
-end

data/lib/newshound/transport/sns.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module Newshound
-  module Transport
-    class Sns < Base
-      attr_reader :sns_client
-
-      def initialize(configuration: nil, logger: nil, sns_client: nil)
-        super(configuration: configuration, logger: logger)
-        @sns_client = sns_client || build_sns_client
-      end
-
-      def deliver(message)
-        return false unless valid_sns_configuration?
-
-        formatted_message = format_message(message)
-
-        response = sns_client.publish(
-          topic_arn: configuration.sns_topic_arn,
-          message: formatted_message,
-          subject: extract_subject(message)
-        )
-
-        logger.info "Newshound: Message sent to SNS, MessageId: #{response.message_id}"
-        true
-      rescue StandardError => e
-        logger.error "Newshound: Failed to send SNS notification: #{e.message}"
-        false
-      end
-
-      private
-
-      def build_sns_client
-        require "aws-sdk-sns"
-
-        options = {
-          region: configuration.aws_region || ENV["AWS_REGION"] || "us-east-1"
-        }
-
-        if configuration.aws_access_key_id && configuration.aws_secret_access_key
-          options[:credentials] = Aws::Credentials.new(
-            configuration.aws_access_key_id,
-            configuration.aws_secret_access_key
-          )
-        end
-
-        Aws::SNS::Client.new(options)
-      end
-
-      def valid_sns_configuration?
-        if configuration.sns_topic_arn.nil? || configuration.sns_topic_arn.empty?
-          logger.error "Newshound: SNS topic ARN not configured"
-          false
-        else
-          true
-        end
-      end
-
-      def format_message(message)
-        case message
-        when Hash
-          if message[:blocks]
-            format_slack_blocks_for_sns(message[:blocks])
-          else
-            JSON.pretty_generate(message)
-          end
-        when String
-          message
-        else
-          message.to_s
-        end
-      end
-
-      def format_slack_blocks_for_sns(blocks)
-        lines = []
-
-        blocks.each do |block|
-          case block[:type]
-          when "section"
-            if block[:text]
-              lines << format_text_element(block[:text])
-            end
-          when "header"
-            if block[:text]
-              lines << "=== #{format_text_element(block[:text])} ==="
-            end
-          when "divider"
-            lines << "---"
-          end
-        end
-
-        lines.join("\n\n")
-      end
-
-      def format_text_element(text_element)
-        return "" unless text_element
-
-        text = text_element[:text] || ""
-        text.gsub(/:([a-z_]+):/, '')
-            .gsub(/\*(.+?)\*/, '\1')
-            .gsub(/_(.+?)_/, '\1')
-      end
-
-      def extract_subject(message)
-        if message.is_a?(Hash)
-          message[:subject] || "Newshound Notification"
-        else
-          "Newshound Notification"
-        end
-      end
-    end
-  end
-end