sidekiq_queue_manager 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eef3dc6b819cf03669fde2b5d5ccd75d7a1e298f1d3c1e5d81b8505ff80e417f
-  data.tar.gz: 2a8c6d262806309608cec3a67ab0a142377654fcbf179f2d82c5b6afc957cf57
+  metadata.gz: 3b2640e2b918627c813a711db3487c4261b08f153a4ed3717fa5a6f9eb3811f7
+  data.tar.gz: 833e2540f832309dbbd3dd06387ce5b0b92c8ef0a2970638aa6eefe90bc186b2
 SHA512:
-  metadata.gz: 586476818da88f4add4f3ce87f9c6723117e1ae106fb5130febee6c3140759649e5d387f872af7708826753752f2db1d7b09dfa2d6878012a8035579b1b51593
-  data.tar.gz: c6e20b1619c17a975a5f98ecc727f8044037b1677493f51ee9840c32be3276a09f7b2ed9c07f5fd323a3e32b226be98ab00b434d38e70a62f96f0c135fd109b5
+  metadata.gz: 712ae0ef4321710938a3af0295de9983d09d62ea02c73068da3f3a4003d12c131850ff2c74ab78e4cccccc9d5de49be6bbcb723703efba12c4ab1de93464ef58
+  data.tar.gz: f72ebc6d34524cad3d7f7a0bbd38d3a873403706b1900bfed6edc438b4e3883afbfa527048ffe0ee9e56b1d3b21c06f82c0a004d9343e6defa1f10995ff09215

data/INSTALLATION.md

@@ -22,7 +22,8 @@ Create `config/initializers/sidekiq_queue_manager.rb`:
 
 ```ruby
 SidekiqQueueManager.configure do |config|
-  # REQUIRED: Set basic auth password (follows Sidekiq Web UI pattern)
+  # Enable authentication (recommended for production)
+  config.basic_auth_enabled = true
   config.basic_auth_password = 'your-secure-password-here'
   
   # Optional: Protect critical queues
@@ -30,7 +31,7 @@ SidekiqQueueManager.configure do |config|
 end
 ```
 
-**⚠️ Professional Standard**: Like Sidekiq Web UI, this gem requires explicit authentication configuration. You must set a password or configure custom authentication.
+**🔒 Security Note**: Authentication is **disabled by default** for easy development setup. **Enable it for production** by setting `basic_auth_enabled = true` and providing a secure password.
 
 ### **2. Mount the Engine**
 

data/README.md

@@ -309,9 +309,14 @@ GET /live    # Server-Sent Events stream for real-time updates
 
 ### Production Recommendations
 
-1. **Authentication Required**
+1. **Enable Authentication** (disabled by default for development)
 
    ```ruby
+   # Enable basic auth
+   config.basic_auth_enabled = true
+   config.basic_auth_password = 'secure-password'
+   
+   # OR use custom authentication
    config.authentication_method = :authenticate_admin!
    ```
 

data/lib/sidekiq_queue_manager/configuration.rb

@@ -14,16 +14,19 @@ module SidekiqQueueManager
     # Internal options (sensible defaults, not typically user-configured)
     attr_reader :redis_key_prefix, :redis_timeout, :log_level, :enable_csp, :cache_ttl
 
+    # Track whether user has explicitly configured the gem
+    attr_reader :explicitly_configured
+
     def initialize
       # Essential defaults (what most users care about)
       @authentication_method = nil          # Custom auth method (optional)
       @critical_queues = []                 # No protected queues by default
       @theme = 'auto'                       # Auto light/dark theme
 
-      # Basic HTTP Authentication (professional standard - explicit configuration required)
-      @basic_auth_enabled = true            # Secure by default like Sidekiq Web UI
+      # Basic HTTP Authentication - safer defaults for gem installation
+      @basic_auth_enabled = false           # Disabled by default - user must opt-in
       @basic_auth_username = 'admin'        # Standard admin username
-      @basic_auth_password = nil            # MUST be explicitly set by user
+      @basic_auth_password = nil            # MUST be explicitly set by user when enabled
 
       # Advanced defaults (rarely changed)
       @refresh_interval = 5000              # 5 second UI refresh
@@ -37,18 +40,33 @@ module SidekiqQueueManager
       @log_level = :info                    # Standard logging level
       @enable_csp = true                    # Security headers enabled
       @cache_ttl = 300                      # 5 minute cache TTL
+
+      # Track explicit configuration
+      @explicitly_configured = false
+    end
+
+    # Mark that user has explicitly configured the gem
+    def mark_as_configured!
+      @explicitly_configured = true
     end
 
     # Validate essential user-provided configuration
-    def validate!
+    def validate!(skip_auth_unless_configured: false)
       validate_basic_settings!
-      validate_authentication!
+
+      # Only validate authentication if explicitly configured or forced
+      if skip_auth_unless_configured && !@explicitly_configured
+        Rails.logger.debug '[SidekiqQueueManager] Skipping authentication validation - not explicitly configured'
+      else
+        validate_authentication!
+      end
+
       self # Return self for method chaining (Ruby idiom)
     end
 
     # Check if configuration is valid without raising (Ruby's truthiness approach)
-    def valid?
-      validate!
+    def valid?(skip_auth_unless_configured: false)
+      validate!(skip_auth_unless_configured: skip_auth_unless_configured)
       true
     rescue ConfigurationError
       false

data/lib/sidekiq_queue_manager/engine.rb

@@ -88,8 +88,16 @@ module SidekiqQueueManager
     # Dependency validation with Ruby's case pattern matching
     def validate_and_configure!
       SidekiqQueueManager.validate_dependencies!
-      SidekiqQueueManager.configuration.validate!
-      Rails.logger.info '[SidekiqQueueManager] Configuration validated successfully'
+
+      # Skip authentication validation during startup unless explicitly configured
+      # This prevents crashes when gem is just added to Gemfile without configuration
+      SidekiqQueueManager.configuration.validate!(skip_auth_unless_configured: true)
+
+      if SidekiqQueueManager.configuration.explicitly_configured
+        Rails.logger.info '[SidekiqQueueManager] Configuration validated successfully'
+      else
+        Rails.logger.info '[SidekiqQueueManager] Engine loaded - authentication validation deferred until first access'
+      end
     end
 
     def handle_configuration_error(error)

data/lib/sidekiq_queue_manager/version.rb

@@ -7,6 +7,6 @@ module SidekiqQueueManager
   # - MAJOR: Incompatible API changes
   # - MINOR: Add functionality in backward compatible manner
   # - PATCH: Backward compatible bug fixes
-  VERSION = '1.1.1'
+  VERSION = '2.0.0'
 end
 

data/lib/sidekiq_queue_manager.rb

@@ -59,8 +59,11 @@ module SidekiqQueueManager
     # @yield [Configuration] the configuration instance
     # @return [Configuration] the updated configuration
     def configure
-      yield(configuration) if block_given?
-      configuration.tap(&:validate!) # Ruby idiom: tap for side effects
+      return configuration unless block_given?
+
+      yield(configuration)
+      configuration.mark_as_configured! # Mark as explicitly configured
+      configuration.tap(&:validate!) # Ruby idiom: tap for side effects - full validation when explicitly configured
     end
 
     # Resets configuration to defaults (primarily for testing)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_queue_manager
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jamal Awad