rails-index-now 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29bd23e10568ddc7089481dcd364de4a24521ab19dbab5b6c3e32be9d76abc3f
-  data.tar.gz: fa96fb54b6ec5e07b8ca025fd20d04addafb1f94eeb0a950f44ee35f4821527d
+  metadata.gz: 9f4ebc6b253eb75e25606e41f2a661f4b7c0feadcc415ce1d0ce84335862b0e6
+  data.tar.gz: c89f6d08b34d3a909a83af7140285c0d5263370c324d4d804d780e9471e92967
 SHA512:
-  metadata.gz: c0acabbc857d732648c638c570039330e4d170a78302c2d6e8be00ff1a22c6379e9a38163ebd0d5d7e1609c17946b1cf395f527ea86f385433bf089f45453fde
-  data.tar.gz: 18945e05c71b28de394f334a87e3a378010a6fdc8654c69912039a708e378b642fd22235a0f4ebe32482ee9c4fd5e62699f75b9814d9532512618e08902936e4
+  metadata.gz: b9cd737b9adf990105a53e8501392db8ccbffdf493fa925a630cf88a2ef3b41eeca675246d67994dbf790670f69c1d830afa9fd4a41aac0c494c7e4c04e6ece9
+  data.tar.gz: fb9c04d7bea5bedfd4bc7967b59de4e426fb197340cfe6951a945ea263450ac94bfd7b1ab37cb9ddb3ec11e0bee48704209f9d1bcafe6ab967eb5156af28b8e1

data/README.md

@@ -21,9 +21,9 @@ Traditional search engine indexing relies on crawlers periodically visiting your
 
 ### Why This Rails Engine?
 
-- **🚀 Plug-and-Play**: No manual controller or route setup required
-- **🔐 Automatic Verification**: The engine automatically serves your API key file at the correct URL
-- **⚡ Zero Configuration**: Just add the gem, run the generator, and you're ready
+- **🚀 Easy Setup**: Pre-built controller and simple route configuration
+- **🔐 Verification Ready**: Built-in controller serves your API key file for IndexNow verification
+- **⚡ Minimal Configuration**: Just add the gem, run generator, add one route, and you're ready
 - **🛡️ Production Ready**: Built-in error handling, logging, and environment controls
 
 ## Installation
@@ -71,10 +71,39 @@ Get your free API key from [Bing IndexNow](https://www.bing.com/indexnow/getstar
 INDEXNOW_API_KEY=your_api_key_here
 ```
 
-**That's it!** The engine automatically:
-- ✅ Serves your API key at `/your_api_key_here.txt` (for IndexNow verification)  
-- ✅ Handles all routing and controller logic
-- ✅ Configures sensible defaults for all environments
+### 4. Mount the Engine
+
+Add this to your `config/routes.rb` file:
+
+**Option A: Mount at root (recommended):**
+```ruby
+Rails.application.routes.draw do
+  mount Rails::Index::Now::Engine, at: "/"
+  
+  # ... your other routes
+end
+```
+
+**Option B: Mount at a path (if you have conflicts):**
+```ruby
+Rails.application.routes.draw do
+  mount Rails::Index::Now::Engine, at: "/indexnow"
+  
+  # ... your other routes
+end
+```
+
+**Note:** 
+- Option A serves your key at `/your_api_key.txt` (IndexNow standard)
+- Option B serves your key at `/indexnow/your_api_key.txt` 
+- The engine only responds to API key files (alphanumeric + hyphens/underscores ending in `.txt`)
+- Files like `/robots.txt`, `/sitemap.txt` are not affected
+
+**That's it!** The engine automatically provides:
+- ✅ API key verification at `/your_api_key.txt` (IndexNow requirement)
+- ✅ Built-in controller with comprehensive error handling  
+- ✅ Secure validation (only serves configured key file)
+- ✅ Sensible defaults for all environments
 
 ### Configuration Options
 
@@ -204,10 +233,10 @@ This Rails Engine requires:
 - **Ruby 2.7+**
 - **ActiveJob** (optional, only needed for `submit_async` functionality)
 
-The engine automatically integrates with your Rails application:
+The engine integrates with your Rails application:
 
-- **🔄 Automatic Routing**: No need to manually add routes - the engine handles it
 - **🎛️ Controller Integration**: Built-in controller serves API key verification file
+- **🔄 Simple Routing**: One-line route addition to connect IndexNow verification
 - **⚡ ActiveJob**: Optional - enables `submit_async` method with any backend (Sidekiq, SolidQueue, etc.)
 - **📝 Smart Logging**: Uses Rails.logger with helpful [IndexNow] prefixes
 - **🌍 Environment Awareness**: Easy to disable in development/test environments

data/app/controllers/rails/index/now/verification_controller.rb

@@ -9,9 +9,22 @@ module Rails
 
         def index_now_key
           config = Rails::Index::Now.configuration
+          requested_file = params[:key_file_name]
 
           unless config.engine_valid?
-            render plain: "IndexNow configuration invalid", status: :internal_server_error
+            error_details = []
+            error_details << "api_key missing" if config.api_key.nil? || config.api_key.empty?
+            error_details << "key_file_name missing" if config.key_file_name.nil? || config.key_file_name.empty?
+            
+            error_message = "IndexNow configuration invalid: #{error_details.join(', ')}"
+            Rails.logger.error "[IndexNow] #{error_message}"
+            render plain: error_message, status: :internal_server_error
+            return
+          end
+
+          # Verify the requested file matches our configured key file
+          unless requested_file == config.key_file_name
+            head :not_found
             return
           end
 

data/config/routes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 Rails::Index::Now::Engine.routes.draw do
-  # This route will be dynamically configured based on the key_file_name
-  # The actual route registration happens in the engine's initialization
+  # Only match files that look like API keys (alphanumeric + hyphens/underscores, ending in .txt)
+  get "/:key_file_name", to: "verification#index_now_key", 
+      constraints: { key_file_name: /[a-zA-Z0-9_-]+\.txt/ }
 end

data/lib/generators/index_now/templates/index_now.rb

@@ -4,14 +4,13 @@
 # See https://github.com/your-username/rails-index-now for full documentation
 
 Rails::Index::Now.configure do |config|
-  # Required: Your IndexNow API key
-  # You can get one from https://www.bing.com/indexnow/getstarted
-  config.api_key = ENV.fetch("INDEXNOW_API_KEY", nil)
-
-  # Required: Key file name for IndexNow verification
-  # This should be "YOUR_API_KEY.txt" (replace YOUR_API_KEY with your actual key)
-  # The gem will automatically serve this file at /YOUR_API_KEY.txt
-  config.key_file_name = "#{ENV.fetch("INDEXNOW_API_KEY", "your-api-key")}.txt"
+  # The gem automatically reads INDEXNOW_API_KEY from ENV
+  # You can override it here if needed:
+  # config.api_key = "your-custom-key"
+  
+  # The gem automatically sets key_file_name to "#{ENV['INDEXNOW_API_KEY']}.txt"
+  # You can override it here if needed:
+  # config.key_file_name = "custom-filename.txt"
 
   # Optional: Set a specific host for all submissions
   # If not set, the gem will extract the host from the submitted URLs
@@ -25,3 +24,15 @@ Rails::Index::Now.configure do |config|
   # Defaults to Rails.logger if available, otherwise STDOUT
   # config.logger = Rails.logger
 end
+
+# IMPORTANT: Add this to your config/routes.rb file:
+#
+# Option A (recommended - serves key at /your_api_key.txt):
+# Rails.application.routes.draw do
+#   mount Rails::Index::Now::Engine, at: "/"
+# end
+#
+# Option B (if you have routing conflicts):
+# Rails.application.routes.draw do
+#   mount Rails::Index::Now::Engine, at: "/indexnow"
+# end

data/lib/rails/index/now/configuration.rb

@@ -14,6 +14,14 @@ module Rails
           @key_file_name = nil
         end
 
+        def api_key
+          @api_key || ENV['INDEXNOW_API_KEY']
+        end
+
+        def key_file_name
+          @key_file_name || (ENV['INDEXNOW_API_KEY'] ? "#{ENV['INDEXNOW_API_KEY']}.txt" : nil)
+        end
+
         def disabled?
           @disabled
         end

data/lib/rails/index/now/railtie.rb

@@ -12,15 +12,6 @@ module Rails
           require "generators/index_now/install_generator"
         end
 
-        initializer "rails_index_now.add_routes" do |app|
-          app.routes.prepend do
-            config = Rails::Index::Now.configuration
-            if config.engine_valid?
-              get "/#{config.key_file_name}",
-                  to: "rails/index/now/verification#index_now_key"
-            end
-          end
-        end
       end
     end
   end

data/lib/rails/index/now/version.rb

@@ -3,7 +3,7 @@
 module Rails
   module Index
     module Now
-      VERSION = "0.1.2"
+      VERSION = "0.1.3"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-index-now
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Aleks Ulanov