newshound 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: decd51fd02b481edd644a56bd700575010ae0b3d747fc2880803c68c32e50bfa
+  data.tar.gz: f44304b8a0f6621296ff13900a2e59ea702b62c08ed6491ad0a60b4839b76b6d
+SHA512:
+  metadata.gz: 813c1c7d310854f34722819c8321d24438cafd543bf9c4dcf164e90bcf716423953ae0583656fe97476d454342fb8c4dabdfa48b66d886d6adb21abc6466521b
+  data.tar.gz: 6c60ed849cd31e6e08066dc9893c2dcd3d3a82450923d97383717f2c5e21f2ea4943880b73ccce9926cbed83ead51b9cea0b2c08c91ba1fb8b63a6a8fb66e983

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.0"

data/README.md

@@ -0,0 +1,144 @@
+# Newshound 🐕
+
+A Ruby gem that sniffs out exceptions and job statuses in your Rails app and reports them daily to Slack.
+
+## Features
+
+- 📊 Daily Que job status reports (counts by job type, queue health)
+- 🚨 Last 4 exceptions from exception-track
+- 💬 Slack integration via webhook or Web API
+- ⏰ Automatic daily scheduling with que-scheduler
+- 🔧 Configurable report times and limits
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'newshound', path: 'path/to/newshound'  # or from git/rubygems when published
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+Create an initializer `config/initializers/newshound.rb`:
+
+```ruby
+Newshound.configure do |config|
+  # Slack configuration (choose one method)
+  config.slack_webhook_url = ENV['SLACK_WEBHOOK_URL']  # Option 1: Webhook
+  # OR set ENV['SLACK_API_TOKEN'] for Web API          # Option 2: Web API
+  
+  config.slack_channel = "#ops-alerts"     # Default: "#general"
+  config.report_time = "09:00"            # Default: "09:00" (24-hour format)
+  config.exception_limit = 4              # Default: 4 (last N exceptions)
+  config.time_zone = "America/New_York"   # Default: "America/New_York"
+  config.enabled = true                   # Default: true
+end
+```
+
+### Slack Setup
+
+#### Option 1: Webhook URL (Simpler)
+1. Go to https://api.slack.com/apps
+2. Create a new app or select existing
+3. Enable "Incoming Webhooks"
+4. Add a new webhook for your channel
+5. Copy the webhook URL to your config
+
+#### Option 2: Web API Token (More features)
+1. Create a Slack app at https://api.slack.com/apps
+2. Add OAuth scopes: `chat:write`, `chat:write.public`
+3. Install to workspace
+4. Copy the Bot User OAuth Token
+5. Set as `ENV['SLACK_API_TOKEN']`
+
+## Usage
+
+### Automatic Daily Reports
+
+If you have `que-scheduler` configured, Newshound will automatically schedule daily reports at your configured time.
+
+### Manual Reports
+
+```ruby
+# Send report immediately
+Newshound.report!
+
+# Or via rake task
+rake newshound:report_now
+
+# Enqueue for background processing
+rake newshound:schedule
+
+# Check configuration
+rake newshound:config
+```
+
+### Integration with que-scheduler
+
+Add to your `config/que_schedule.yml`:
+
+```yaml
+newshound_daily_report:
+  class: "Newshound::DailyReportJob"
+  cron: "0 9 * * *"  # 9:00 AM daily
+  queue: default
+```
+
+Or let Newshound auto-configure based on your settings.
+
+## Report Format
+
+The daily report includes:
+
+### Exception Section
+- Last 4 exceptions (configurable)
+- Exception class, message, controller/action
+- Count of same exception type in last 24 hours
+- Timestamp
+
+### Que Jobs Section
+- Job counts by type (success/failed/total)
+- Queue health status
+- Ready to run count
+- Scheduled jobs count
+- Failed jobs in retry queue
+- Jobs completed today
+
+## Development
+
+```bash
+# Run tests
+bundle exec rspec
+
+# Run linter
+bundle exec rubocop
+
+# Console
+bin/console
+```
+
+## Testing in Your App
+
+```ruby
+# In rails console
+Newshound.configuration.slack_webhook_url = "your-webhook"
+Newshound.report!  # Should post to Slack immediately
+```
+
+## Troubleshooting
+
+- **No reports sent**: Check `rake newshound:config` to verify configuration
+- **No exceptions showing**: Ensure `exception-track` gem is installed and logging
+- **No job data**: Verify Que is configured and `que_jobs` table exists
+- **Slack not receiving**: Verify webhook URL or API token is correct
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/newshound/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Newshound
+  class Configuration
+    attr_accessor :slack_webhook_url, :slack_channel, :report_time,
+                  :exception_limit, :time_zone, :enabled
+
+    def initialize
+      @slack_webhook_url = nil
+      @slack_channel = "#general"
+      @report_time = "09:00"
+      @exception_limit = 4
+      @time_zone = "America/New_York"
+      @enabled = true
+    end
+
+    def valid?
+      return false unless enabled
+      return false if slack_webhook_url.nil? || slack_webhook_url.empty?
+      
+      true
+    end
+  end
+end

data/lib/newshound/daily_report_job.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Newshound
+  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
+end

data/lib/newshound/exception_reporter.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Newshound
+  class ExceptionReporter
+    def generate_report
+      return no_exceptions_block if recent_exceptions.empty?
+      
+      [
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: "*🚨 Recent Exceptions (Last 24 Hours)*"
+          }
+        },
+        *format_exceptions
+      ]
+    end
+
+    private
+
+    def recent_exceptions
+      @recent_exceptions ||= fetch_recent_exceptions
+    end
+
+    def fetch_recent_exceptions
+      return [] unless defined?(ExceptionTrack::Log)
+      
+      ExceptionTrack::Log
+        .where("created_at >= ?", 24.hours.ago)
+        .order(created_at: :desc)
+        .limit(Newshound.configuration.exception_limit)
+    end
+
+    def format_exceptions
+      recent_exceptions.map.with_index do |exception, index|
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: format_exception_text(exception, index + 1)
+          }
+        }
+      end
+    end
+
+    def format_exception_text(exception, number)
+      <<~TEXT
+        *#{number}. #{exception.title || exception.exception_class}*
+        • *Time:* #{exception.created_at.strftime('%I:%M %p')}
+        • *Controller:* #{exception.controller_name}##{exception.action_name}
+        • *Count:* #{exception_count(exception)}
+        #{format_message(exception)}
+      TEXT
+    end
+
+    def format_message(exception)
+      return "" unless exception.message.present?
+      
+      message = exception.message.truncate(100)
+      "• *Message:* `#{message}`"
+    end
+
+    def exception_count(exception)
+      ExceptionTrack::Log
+        .where(exception_class: exception.exception_class)
+        .where("created_at >= ?", 24.hours.ago)
+        .count
+    end
+
+    def no_exceptions_block
+      [
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: "*✅ No Exceptions in the Last 24 Hours*"
+          }
+        }
+      ]
+    end
+  end
+end

data/lib/newshound/que_reporter.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Newshound
+  class QueReporter
+    def generate_report
+      [
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: "*📊 Que Jobs Status*"
+          }
+        },
+        job_counts_section,
+        queue_health_section
+      ].compact
+    end
+
+    private
+
+    def job_counts_section
+      counts = job_counts_by_type
+      
+      return no_jobs_section if counts.empty?
+      
+      {
+        type: "section",
+        text: {
+          type: "mrkdwn",
+          text: format_job_counts(counts)
+        }
+      }
+    end
+
+    def job_counts_by_type
+      return {} unless defined?(::Que::Job)
+      
+      ::Que::Job
+        .group(:job_class)
+        .group(:error_count)
+        .count
+        .each_with_object({}) do |((job_class, error_count), count), hash|
+          hash[job_class] ||= { success: 0, failed: 0, total: 0 }
+          
+          if error_count.zero?
+            hash[job_class][:success] += count
+          else
+            hash[job_class][:failed] += count
+          end
+          
+          hash[job_class][:total] += count
+        end
+    end
+
+    def format_job_counts(counts)
+      lines = ["*Job Counts by Type:*"]
+      
+      counts.each do |job_class, stats|
+        status_emoji = stats[:failed] > 0 ? "⚠️" : "✅"
+        lines << "• #{status_emoji} *#{job_class}*: #{stats[:total]} total (#{stats[:success]} success, #{stats[:failed]} failed)"
+      end
+      
+      lines.join("\n")
+    end
+
+    def queue_health_section
+      stats = queue_statistics
+      
+      {
+        type: "section",
+        text: {
+          type: "mrkdwn",
+          text: format_queue_health(stats)
+        }
+      }
+    end
+
+    def queue_statistics
+      return default_stats unless defined?(::Que::Job)
+      
+      {
+        ready: ::Que::Job.where(finished_at: nil, expired_at: nil).where("run_at <= ?", Time.current).count,
+        scheduled: ::Que::Job.where(finished_at: nil, expired_at: nil).where("run_at > ?", Time.current).count,
+        failed: ::Que::Job.where.not(error_count: 0).where(finished_at: nil).count,
+        finished_today: ::Que::Job.where("finished_at >= ?", Date.current.beginning_of_day).count
+      }
+    rescue StandardError => e
+      Rails.logger.error "Failed to fetch Que statistics: #{e.message}"
+      default_stats
+    end
+
+    def default_stats
+      { ready: 0, scheduled: 0, failed: 0, finished_today: 0 }
+    end
+
+    def format_queue_health(stats)
+      health_emoji = stats[:failed] > 10 ? "🔴" : stats[:failed] > 5 ? "🟡" : "🟢"
+      
+      <<~TEXT
+        *Queue Health #{health_emoji}*
+        • *Ready to Run:* #{stats[:ready]}
+        • *Scheduled:* #{stats[:scheduled]}
+        • *Failed (Retry Queue):* #{stats[:failed]}
+        • *Completed Today:* #{stats[:finished_today]}
+      TEXT
+    end
+
+    def no_jobs_section
+      {
+        type: "section",
+        text: {
+          type: "mrkdwn",
+          text: "*No jobs found in the queue*"
+        }
+      }
+    end
+  end
+end

data/lib/newshound/railtie.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module Newshound
+  class Railtie < Rails::Railtie
+    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?}"
+        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."
+        end
+      end
+    end
+
+    config.after_initialize do
+      if Newshound.configuration.valid?
+        Rails.logger.info "Newshound initialized and ready to report!"
+      else
+        Rails.logger.warn "Newshound is not properly configured. Please check your configuration."
+      end
+    end
+  end
+end

data/lib/newshound/scheduler.rb

@@ -0,0 +1,41 @@
+# 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?
+      
+      # Schedule the job using que-scheduler
+      # This will be picked up by que-scheduler's configuration
+      schedule_config = {
+        "newshound_daily_report" => {
+          "class" => "Newshound::DailyReportJob",
+          "cron" => build_cron_expression(config.report_time),
+          "queue" => "default",
+          "args" => []
+        }
+      }
+      
+      # Merge with existing schedule if any
+      if defined?(::Que::Scheduler.configuration)
+        ::Que::Scheduler.configuration.merge!(schedule_config)
+      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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "slack-ruby-client"
+
+module Newshound
+  class SlackNotifier
+    def initialize
+      configure_slack_client
+    end
+
+    def post(message)
+      return unless valid_configuration?
+      
+      if webhook_configured?
+        post_via_webhook(message)
+      elsif web_api_configured?
+        post_via_web_api(message)
+      else
+        Rails.logger.error "Newshound: No valid Slack configuration found"
+      end
+    rescue StandardError => e
+      Rails.logger.error "Newshound: Failed to send Slack notification: #{e.message}"
+    end
+
+    private
+
+    def configure_slack_client
+      Slack.configure do |config|
+        config.token = ENV["SLACK_API_TOKEN"] if ENV["SLACK_API_TOKEN"]
+      end
+    end
+
+    def valid_configuration?
+      return false unless Newshound.configuration.valid?
+      
+      webhook_configured? || web_api_configured?
+    end
+
+    def webhook_configured?
+      Newshound.configuration.slack_webhook_url.present?
+    end
+
+    def web_api_configured?
+      ENV["SLACK_API_TOKEN"].present?
+    end
+
+    def post_via_webhook(message)
+      client = Slack::Incoming::Webhook.new(Newshound.configuration.slack_webhook_url)
+      client.post(message)
+    end
+
+    def post_via_web_api(message)
+      client = Slack::Web::Client.new
+      client.chat_postMessage(
+        channel: Newshound.configuration.slack_channel,
+        blocks: message[:blocks],
+        text: "Daily Newshound Report"
+      )
+    end
+  end
+end

data/lib/newshound/version.rb

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

data/lib/newshound.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+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/railtie" if defined?(Rails)
+
+module Newshound
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      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
+        ]
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: newshound
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- salbanez
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Newshound sniffs out exceptions and job statuses in your Rails app and
+  reports them daily to Slack
+email:
+- salbanez@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/newshound.rb
+- lib/newshound/configuration.rb
+- lib/newshound/daily_report_job.rb
+- lib/newshound/exception_reporter.rb
+- lib/newshound/que_reporter.rb
+- lib/newshound/railtie.rb
+- lib/newshound/scheduler.rb
+- lib/newshound/slack_notifier.rb
+- lib/newshound/version.rb
+homepage: https://github.com/salbanez/newshound
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/salbanez/newshound
+  source_code_uri: https://github.com/salbanez/newshound
+  changelog_uri: https://github.com/salbanez/newshound/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Daily Slack reporter for Que jobs status and exception tracking
+test_files: []