rails-health-checker 0.1.0 → 0.2.0

data/SECURITY.md

@@ -1,41 +0,0 @@
-# Security
-
-## Authentication
-
-The health dashboard is protected by HTTP Basic Authentication to prevent unauthorized access to sensitive application information.
-
-### Default Credentials
-- **Username:** `admin`
-- **Password:** `health123`
-
-### Custom Credentials
-Set environment variables to use custom credentials:
-
-```bash
-export HEALTH_USERNAME=your_username
-export HEALTH_PASSWORD=your_secure_password
-```
-
-### Security Considerations
-
-1. **Change Default Password:** Always change the default password in production
-2. **Use Strong Passwords:** Use complex passwords with mixed characters
-3. **Environment Variables:** Store credentials in environment variables, not in code
-4. **HTTPS Only:** Use HTTPS in production to encrypt authentication headers
-5. **Access Logs:** Monitor access to health endpoints
-
-### Endpoints Protected
-
-- `/health` - Main health dashboard
-
-### What Information is Exposed
-
-The health dashboard shows:
-- Rails and Ruby versions
-- Database connection status
-- Gem dependencies and versions
-- Security vulnerabilities (outdated gems)
-- Background job status
-- System configuration details
-
-**Note:** This information should only be accessible to authorized personnel.

data/TESTING.md

@@ -1,64 +0,0 @@
-# Testing RailsHealthChecker Gem
-
-## 1. Basic Functionality Test
-```bash
-cd rails_health_checker
-ruby simple_test.rb
-```
-
-## 2. Test in Existing Rails App
-
-### Add to Gemfile:
-```ruby
-gem 'rails_health_checker', path: '/path/to/rails_health_checker'
-```
-
-### Run bundle:
-```bash
-bundle install
-```
-
-### Test rake tasks:
-```bash
-rake health:check
-rake health:gems
-rake health:database
-```
-
-### Test HTTP endpoint:
-```bash
-# Start Rails server
-rails server
-
-# Test health endpoint
-curl http://localhost:3000/health
-```
-
-## 3. Test with FinaSync Project
-
-```bash
-cd /Users/arshdeepsingh/Desktop/personal/PROJECTS/FinaSync/FinaSync-rails
-
-# Add gem to Gemfile
-echo "gem 'rails_health_checker', path: '../rails_health_checker'" >> Gemfile
-
-# Install
-bundle install
-
-# Test
-rake health:check
-```
-
-## 4. RSpec Tests
-```bash
-cd rails_health_checker
-bundle install
-bundle exec rspec
-```
-
-## Expected Output:
-- ✓ Version information
-- ✓ Rails/Ruby version checks  
-- ✓ Database connectivity
-- ✓ Gem dependency analysis
-- ✓ HTTP health endpoint (200 OK)

data/TEST_RESULTS.md

@@ -1,51 +0,0 @@
-# Test Results
-
-## ✅ Successfully Tested
-
-### 1. Basic Functionality
-- ✓ Gem loads correctly
-- ✓ Version: 0.1.0
-- ✓ Core modules work
-
-### 2. Rails Integration (FinaSync Project)
-- ✓ Gem installs in Rails app
-- ✓ Rake tasks work:
-  - `rake health:gems` → 93 total gems, 33 outdated
-  - `rake health:database` → Database connection healthy
-  - `rake health:check` → Complete health report
-
-### 3. Health Check Results
-```
-=== Rails Health Check Report ===
-Rails Version: 7.1.5.2 (healthy)
-Ruby Version: 3.0.6 (healthy)
-Database: healthy
-Gems: 93 total, 33 outdated
-Security: needs_attention
-================================
-```
-
-## How to Test:
-
-### Quick Test:
-```bash
-cd rails_health_checker
-ruby simple_test.rb
-```
-
-### Full Rails Test:
-```bash
-# Add to any Rails project Gemfile:
-gem 'rails_health_checker', path: '/path/to/rails_health_checker'
-
-# Install and test:
-bundle install
-rake health:check
-rake health:gems
-rake health:database
-
-# Test HTTP endpoint:
-curl http://localhost:3000/health
-```
-
-## ✅ Gem is Ready for Use!

data/example_usage.rb

@@ -1,23 +0,0 @@
-# Example usage in a Rails application
-
-# 1. Add to Gemfile:
-# gem 'rails_health_checker'
-
-# 2. In your Rails application, you can use:
-
-# Run complete health check
-results = RailsHealthChecker.check
-
-# Access specific health data
-puts "Rails version: #{results[:rails_version][:current]}"
-puts "Database status: #{results[:database][:status]}"
-puts "Total gems: #{results[:gems][:total]}"
-
-# Use rake tasks
-# rake health:check
-# rake health:gems  
-# rake health:database
-
-# Access health endpoint
-# GET /health
-# Returns JSON with health status

data/lib/rails_health_checker/checker.rb

@@ -1,88 +0,0 @@
-module RailsHealthChecker
-  class Checker
-    def run
-      results = {
-        rails_version: check_rails_version,
-        ruby_version: check_ruby_version,
-        database: check_database_connection,
-        gems: check_gems_health,
-        security: check_security_vulnerabilities,
-        jobs: check_background_jobs,
-        system: check_system_details
-      }
-      
-      generate_report(results)
-    end
-
-    private
-
-    def check_rails_version
-      {
-        current: Rails.version,
-        supported: rails_version_supported?,
-        status: rails_version_supported? ? "healthy" : "outdated"
-      }
-    end
-
-    def check_ruby_version
-      {
-        current: RUBY_VERSION,
-        supported: ruby_version_supported?,
-        status: ruby_version_supported? ? "healthy" : "outdated"
-      }
-    end
-
-    def check_database_connection
-      ActiveRecord::Base.connection.active?
-      { status: "healthy", connected: true }
-    rescue => e
-      { status: "unhealthy", connected: false, error: e.message }
-    end
-
-    def check_gems_health
-      GemAnalyzer.new.analyze
-    end
-
-    def check_security_vulnerabilities
-      outdated_gems = `bundle outdated --parseable`.split("\n")
-      {
-        outdated_count: outdated_gems.length,
-        status: outdated_gems.empty? ? "secure" : "needs_attention"
-      }
-    end
-
-    def check_background_jobs
-      JobAnalyzer.new.analyze
-    end
-
-    def check_system_details
-      SystemAnalyzer.new.analyze
-    end
-
-    def rails_version_supported?
-      Rails.version >= "6.0"
-    end
-
-    def ruby_version_supported?
-      RUBY_VERSION >= "2.7"
-    end
-
-    def generate_report(results)
-      puts "\n=== Rails Health Check Report ==="
-      puts "Rails Version: #{results[:rails_version][:current]} (#{results[:rails_version][:status]})"
-      puts "Ruby Version: #{results[:ruby_version][:current]} (#{results[:ruby_version][:status]})"
-      puts "Database: #{results[:database][:status]}"
-      puts "Gems: #{results[:gems][:total]} total, #{results[:gems][:outdated]} outdated"
-      puts "Security: #{results[:security][:status]}"
-      puts "Background Jobs: #{results[:jobs][:status]}"
-      puts "================================\n"
-      
-      # Generate markdown report
-      report_generator = ReportGenerator.new(results)
-      filename = report_generator.save_to_file
-      puts "📄 Detailed report saved to: #{filename} (previous report replaced)"
-      
-      results
-    end
-  end
-end