rails-index-now 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad4c124b41275b81f3299ce0afd7b1721638e238173b81bcae8df2548f1f2167
-  data.tar.gz: db7d4b448d2c646de1a875976ad3c005ca6206796864f4f5990877f4d7529073
+  metadata.gz: 29bd23e10568ddc7089481dcd364de4a24521ab19dbab5b6c3e32be9d76abc3f
+  data.tar.gz: fa96fb54b6ec5e07b8ca025fd20d04addafb1f94eeb0a950f44ee35f4821527d
 SHA512:
-  metadata.gz: 3a9c62210fcb82e0a3bbe815bc81865b4b579c559e31863831bed609ae2da6d8718afcae6469c8ea48aebd528840b6ed61f41b49ec3de9771c2a3bc2eeff8e82
-  data.tar.gz: 55932415ba6e8795add3d1f1bed9b47c2ed1953fe9cc39069b7784d65342fd6f0ae3083187a26e46a4f215f2539aeae0910e44385f048d8f96d9541e4542a873
+  metadata.gz: c0acabbc857d732648c638c570039330e4d170a78302c2d6e8be00ff1a22c6379e9a38163ebd0d5d7e1609c17946b1cf395f527ea86f385433bf089f45453fde
+  data.tar.gz: 18945e05c71b28de394f334a87e3a378010a6fdc8654c69912039a708e378b642fd22235a0f4ebe32482ee9c4fd5e62699f75b9814d9532512618e08902936e4

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/rails-index-now.svg)](https://badge.fury.io/rb/rails-index-now)
 [![Build Status](https://github.com/aleksdavtian/rails-index-now/workflows/CI/badge.svg)](https://github.com/aleksdavtian/rails-index-now/actions)
 
-A modern, lightweight Rails gem for seamless integration with Microsoft's IndexNow protocol. Get your content indexed by search engines instantly, without waiting for crawlers.
+A modern, plug-and-play Rails Engine for seamless integration with Microsoft's IndexNow protocol. Get your content indexed by search engines instantly, with automatic API key verification and zero manual configuration.
 
 ## What is IndexNow?
 
@@ -19,6 +19,13 @@ A modern, lightweight Rails gem for seamless integration with Microsoft's IndexN
 
 Traditional search engine indexing relies on crawlers periodically visiting your site. With IndexNow, you proactively tell search engines exactly what has changed, when it changed, making the indexing process nearly instantaneous.
 
+### 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
+- **🛡️ Production Ready**: Built-in error handling, logging, and environment controls
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -39,42 +46,59 @@ Or install it yourself as:
 gem install rails-index-now
 ```
 
-## Configuration
+## Quick Setup
+
+### 1. Install the Gem
 
-Generate the initializer file:
+Add to your Gemfile and run `bundle install`:
+
+```ruby
+gem 'rails-index-now'
+```
+
+### 2. Generate Configuration
 
 ```bash
 rails generate index_now:install
 ```
 
-This creates `config/initializers/index_now.rb`. Configure your IndexNow settings:
+### 3. Configure Your API Key
+
+Get your free API key from [Bing IndexNow](https://www.bing.com/indexnow/getstarted) and add it to your environment:
+
+```bash
+# .env or your environment
+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
+
+### Configuration Options
+
+The generator creates `config/initializers/index_now.rb` with these options:
 
 ```ruby
 Rails::Index::Now.configure do |config|
   # Required: Your IndexNow API key
-  # Get one free at https://www.indexnow.org/
-  config.api_key = ENV['INDEXNOW_API_KEY']
+  config.api_key = ENV.fetch("INDEXNOW_API_KEY", nil)
+  
+  # Required: Key file name (automatically set from your API key)
+  config.key_file_name = "#{ENV.fetch('INDEXNOW_API_KEY', 'your-api-key')}.txt"
   
   # Optional: Set a specific host for all submissions
-  # If not set, the gem will extract the host from submitted URLs
-  config.host = "yourdomain.com"
+  # config.host = "yourdomain.com"
   
-  # Optional: Disable IndexNow in specific environments
-  # Recommended for test and development environments
+  # Optional: Disable IndexNow in specific environments  
   config.disabled = Rails.env.test? || Rails.env.development?
   
   # Optional: Set a custom logger
-  # Defaults to Rails.logger
-  config.logger = Rails.logger
+  # config.logger = Rails.logger
 end
 ```
 
-### Getting Your IndexNow API Key
-
-1. Visit [IndexNow.org](https://www.indexnow.org/)
-2. Generate a free API key
-3. Add the key to your environment variables or Rails credentials
-
 ## Usage
 
 ### Basic Usage
@@ -92,12 +116,12 @@ Rails::Index::Now.submit([
 ])
 ```
 
-### Background Processing (Recommended)
+### Background Processing (Optional)
 
-For production applications, use background jobs to avoid blocking web requests:
+For production applications, use background jobs to avoid blocking web requests. **Note: This requires ActiveJob to be available in your application.**
 
 ```ruby
-# Submit URLs asynchronously using ActiveJob
+# Submit URLs asynchronously using ActiveJob (requires ActiveJob)
 Rails::Index::Now.submit_async("https://yourdomain.com/articles/123")
 
 Rails::Index::Now.submit_async([
@@ -106,26 +130,23 @@ Rails::Index::Now.submit_async([
 ])
 ```
 
-The gem works seamlessly with any ActiveJob backend (Sidekiq, SolidQueue, GoodJob, etc.).
+The gem works seamlessly with any ActiveJob backend (Sidekiq, SolidQueue, GoodJob, etc.) when ActiveJob is available.
 
-### Real-World Rails Integration
+### Rails Model Integration
 
-Here's how to integrate IndexNow with your Rails models for automatic indexing:
+The magic happens when you integrate IndexNow with your Rails models. Here's a complete example:
 
 ```ruby
 class Article < ApplicationRecord
-  # Submit to IndexNow after creating or updating articles
+  # Automatically notify search engines when articles are created or updated
   after_commit :submit_to_index_now, on: [:create, :update]
   
-  # Also submit when articles are published
-  after_commit :submit_to_index_now, if: :saved_change_to_published_at?
-  
   private
   
   def submit_to_index_now
     return unless published? && Rails.env.production?
     
-    # Submit asynchronously to avoid blocking the web request
+    # The engine handles everything - just submit the URL!
     Rails::Index::Now.submit_async(article_url)
   end
   
@@ -138,12 +159,18 @@ class Article < ApplicationRecord
 end
 ```
 
+**What happens automatically:**
+1. 🔥 Your article gets saved 
+2. 🚀 `after_commit` triggers IndexNow submission
+3. 🎯 Search engines are notified within seconds
+4. ✅ Your content appears in search results faster
+
 ### Advanced Usage
 
-For more complex scenarios, you can also use the job directly:
+For more complex scenarios, you can also use the job directly (requires ActiveJob):
 
 ```ruby
-# Use the provided ActiveJob directly
+# Use the provided ActiveJob directly (requires ActiveJob)
 Rails::Index::Now::SubmitJob.perform_later([
   "https://yourdomain.com/page1",
   "https://yourdomain.com/page2"
@@ -153,6 +180,8 @@ Rails::Index::Now::SubmitJob.perform_later([
 Rails::Index::Now::SubmitJob.perform_now(["https://yourdomain.com/page"])
 ```
 
+**Note:** If ActiveJob is not available, use the synchronous `submit` method instead.
+
 ### Error Handling
 
 The gem includes comprehensive error handling and logging:
@@ -169,22 +198,25 @@ Rails::Index::Now.submit("invalid-url")
 
 ## Framework Compatibility
 
-This gem is designed specifically for Rails applications and requires:
+This Rails Engine requires:
 
-- **Rails 6.0+** (for ActiveJob support)
+- **Rails 5.0+** (for Rails Engine support)
 - **Ruby 2.7+**
+- **ActiveJob** (optional, only needed for `submit_async` functionality)
 
-The gem automatically integrates with your existing Rails infrastructure:
+The engine automatically integrates with your Rails application:
 
-- **ActiveJob**: Works with any ActiveJob backend (Sidekiq, SolidQueue, etc.)
-- **Logging**: Uses Rails.logger by default
-- **Environment Awareness**: Easy to disable in development/test environments
-- **Rails Generators**: Includes installation generator for easy setup
+- **🔄 Automatic Routing**: No need to manually add routes - the engine handles it
+- **🎛️ Controller Integration**: Built-in controller serves API key verification file
+- **⚡ 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
+- **🛠️ Rails Generators**: One-command setup with `rails generate index_now:install`
 
 ## Performance Considerations
 
-- **Asynchronous by Design**: The `submit_async` method queues jobs to avoid blocking web requests
-- **Lightweight**: Zero external dependencies beyond Rails
+- **Asynchronous by Design**: The `submit_async` method queues jobs to avoid blocking web requests (when ActiveJob is available)
+- **Lightweight**: Zero runtime dependencies - uses only Ruby standard library
 - **Efficient**: Batches multiple URLs in single API calls when possible
 - **Fault Tolerant**: Gracefully handles network failures and API errors
 

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Rails
+  module Index
+    module Now
+      class VerificationController < ActionController::Base
+        # Skip CSRF protection for this simple text response
+        skip_before_action :verify_authenticity_token, only: [:index_now_key]
+
+        def index_now_key
+          config = Rails::Index::Now.configuration
+
+          unless config.engine_valid?
+            render plain: "IndexNow configuration invalid", status: :internal_server_error
+            return
+          end
+
+          render plain: config.api_key, content_type: "text/plain"
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+# 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
+end

data/lib/generators/index_now/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module IndexNow
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates an IndexNow initializer file"
+
+      def create_initializer_file
+        template "index_now.rb", "config/initializers/index_now.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# IndexNow Configuration
+# 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"
+
+  # Optional: Set a specific host for all submissions
+  # If not set, the gem will extract the host from the submitted URLs
+  # config.host = "example.com"
+
+  # Optional: Disable IndexNow in specific environments
+  # Recommended for test and development environments
+  config.disabled = Rails.env.test? || Rails.env.development?
+
+  # Optional: Set a custom logger
+  # Defaults to Rails.logger if available, otherwise STDOUT
+  # config.logger = Rails.logger
+end

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

@@ -4,13 +4,14 @@ module Rails
   module Index
     module Now
       class Configuration
-        attr_accessor :api_key, :host, :disabled, :logger
+        attr_accessor :api_key, :host, :disabled, :logger, :key_file_name
 
         def initialize
           @api_key = nil
           @host = nil
           @disabled = false
           @logger = default_logger
+          @key_file_name = nil
         end
 
         def disabled?
@@ -21,6 +22,10 @@ module Rails
           !api_key.nil? && !api_key.empty?
         end
 
+        def engine_valid?
+          valid? && !key_file_name.nil? && !key_file_name.empty?
+        end
+
         private
 
         def default_logger

data/lib/rails/index/now/generators/templates/index_now.rb

@@ -5,9 +5,14 @@
 
 Rails::Index::Now.configure do |config|
   # Required: Your IndexNow API key
-  # You can get one from https://www.indexnow.org/
+  # 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"
+
   # Optional: Set a specific host for all submissions
   # If not set, the gem will extract the host from the submitted URLs
   # config.host = "example.com"

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

@@ -1,13 +1,25 @@
 # frozen_string_literal: true
 
-require "rails/railtie"
+require "rails/engine"
 
 module Rails
   module Index
     module Now
-      class Railtie < ::Rails::Railtie
+      class Engine < ::Rails::Engine
+        isolate_namespace Rails::Index::Now
+
         generators do
-          require_relative "generators/install_generator"
+          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

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

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

data/lib/rails/index/now.rb

@@ -4,7 +4,7 @@ require_relative "now/version"
 require_relative "now/configuration"
 require_relative "now/client"
 require_relative "now/submit_job" if defined?(ActiveJob::Base)
-require_relative "now/railtie" if defined?(Rails::Railtie)
+require_relative "now/railtie" if defined?(Rails::Engine)
 
 module Rails
   module Index

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails-index-now
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Aleks Ulanov
 bindir: exe
 cert_chain: []
-date: 2025-07-26 00:00:00.000000000 Z
+date: 2025-07-27 00:00:00.000000000 Z
 dependencies: []
 description: Instantly notify search engines like Bing and DuckDuckGo of content changes
   in your Rails app. This gem provides a simple client and Active Job integration
@@ -26,6 +26,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/rails/index/now/verification_controller.rb
+- config/routes.rb
+- lib/generators/index_now/install_generator.rb
+- lib/generators/index_now/templates/index_now.rb
 - lib/rails/index/now.rb
 - lib/rails/index/now/client.rb
 - lib/rails/index/now/configuration.rb