indexmap 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecbb344925e56757c840a508365932942f0344ce8fa38af6c3677e6eb6ec9bf3
-  data.tar.gz: 3facac318f7fb6553f672afc516910b176294b951d85ac61149cd665e00ded8f
+  metadata.gz: 513c19d20a8373690c66fa99a0251db934298589a19139c2b77654340ce7006a
+  data.tar.gz: '087bd725e6ecaf81ff07510f78f7c5fa1d613730cd7b735c9f0ed60ecb3f4676'
 SHA512:
-  metadata.gz: 57f1ef28f1339a5cd7afa18f01518a520463eea63087363e765467ffe57f7835b3464345e8a792450c7245c89dedb8338a14771261d99aa06da562ed50ca5e1c
-  data.tar.gz: 513b73b694d00775765fd8a7e86d52a4a77971cc67fee2b4bd6ca6c675a5ab1c2e5ecca4ef9e8bc77ca7ff2f55784640d0b58734f180e757b650d2ecf1e04b63
+  metadata.gz: 2f4065163991559ca5a1df38f1f01aafbdc539936f40aa81d78a3c5aa4abe34bdbc7cdb0df25d970a8a243e1b552c1946ec97c640f8d64350a46ef0d8de36006
+  data.tar.gz: d0ebff2036cefb30689a22ebddf313c89ac45a6dda11277a4a5322b6c39c6257e6d05e3615e0167ca876f985b14dc5ac21eba096f947876ab72be32bc6a73c33

data/CHANGELOG.md

@@ -5,14 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.3.1] - 2026-04-22
+## [0.4.1] - 2026-04-22
 
 
-### Fixed
+### Added
 
-- fix changelog generation (#2)
-
-- harden indexmap runtime defaults and test coverage (#3)
+- add output to ping tasks (#6)
 
 
 

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/indexmap.svg)](https://badge.fury.io/rb/indexmap)
 [![Ruby](https://github.com/ethos-link/indexmap/actions/workflows/ruby.yml/badge.svg)](https://github.com/ethos-link/indexmap/actions/workflows/ruby.yml)
 
-`indexmap` is a small Ruby gem for generating XML sitemap indexes and child sitemaps from explicit section definitions.
+`indexmap` is a small Ruby gem for generating XML sitemaps from explicit Ruby data.
 
 It is designed for Rails apps that want:
 
@@ -12,7 +12,7 @@ It is designed for Rails apps that want:
 - first-party rake tasks instead of a large DSL
 - easy extraction of sitemap logic into app-owned manifests
 
-The default output mode is a sitemap index plus one or more child sitemap files. For simpler sites, `indexmap` also supports an explicit single-file mode that writes a single `urlset` directly to `sitemap.xml`.
+By default, `indexmap` writes a sitemap index plus one or more child sitemap files. For simpler sites, it also supports `:single_file` mode, which writes a single `urlset` directly to `sitemap.xml`.
 
 ## Installation
 
@@ -34,7 +34,7 @@ Or install it directly:
 gem install indexmap
 ```
 
-## Ruby usage
+## Ruby Usage
 
 ```ruby
 require "indexmap"
@@ -56,7 +56,7 @@ Indexmap::Writer.new(
 ).write
 ```
 
-## Rails configuration
+## Rails Usage
 
 In an initializer:
 
@@ -77,14 +77,24 @@ Indexmap.configure do |config|
 end
 ```
 
-This enables:
+Then run:
 
 ```bash
 bin/rails sitemap:create
 bin/rails sitemap:format
+bin/rails sitemap:validate
 ```
 
-### Single-file mode
+`sitemap:create` is the main task. It writes sitemap files, formats them, and validates the result.
+
+### Default Index Mode
+
+This is the default behavior. `indexmap` writes:
+
+- `public/sitemap.xml` as a sitemap index
+- one or more child sitemap files from `config.sections`
+
+### Single-File Mode
 
 For sites that only want one `public/sitemap.xml` file:
 
@@ -102,9 +112,9 @@ Indexmap.configure do |config|
 end
 ```
 
-In `:single_file` mode, `indexmap` writes a `urlset` directly to `sitemap.xml`. In the default `:index` mode, it writes a sitemap index plus child sitemap files from `sections`.
+In `:single_file` mode, `indexmap` writes a `urlset` directly to `sitemap.xml` and reads entries from `config.entries` instead of `config.sections`.
 
-## Validation and Parsing
+## Validation And Parsing
 
 `indexmap` also includes small utilities for working with generated sitemap files:
 
@@ -124,27 +134,72 @@ The built-in validator checks for:
 
 ## Search Engine Ping
 
-The gem can ping Google Search Console and IndexNow once your app config provides the required credentials.
+`indexmap` can ping Google Search Console and IndexNow after sitemap generation.
+
+Available rake tasks:
+
+```bash
+bin/rails sitemap:validate
+bin/rails sitemap:google:ping
+bin/rails sitemap:index_now:ping
+bin/rails sitemap:index_now:write_key
+bin/rails sitemap:ping
+```
+
+### Google Search Console
+
+Google pinging requires service account credentials:
 
 ```ruby
 Indexmap.configure do |config|
   config.google.credentials = -> { ENV["GOOGLE_SITEMAP"] }
+end
+```
+
+If `config.google.credentials` is blank, `sitemap:google:ping` skips Google submission.
+
+You can optionally override the Search Console property identifier:
+
+```ruby
+Indexmap.configure do |config|
+  config.google.credentials = -> { ENV["GOOGLE_SITEMAP"] }
+  config.google.property = -> { "sc-domain:example.com" }
+end
+```
+
+If `config.google.property` is not set, `indexmap` defaults to `sc-domain:<host>`.
+
+### IndexNow
+
+IndexNow submission requires a key. `indexmap` supports two ways to provide it:
+
+- set `config.index_now.key`
+- or keep a valid verification file at `public/<key>.txt`
+
+Configured-key example:
+
+```ruby
+Indexmap.configure do |config|
   config.index_now.key = -> { ENV["INDEXNOW_KEY"] }
 end
 ```
 
-When `config.index_now.key` is set, `sitemap:create` also writes the matching `public/<key>.txt` verification file automatically.
+If `config.index_now.key` is set, `sitemap:create` also writes the matching `public/<key>.txt` verification file automatically.
 
-Available rake tasks:
+If you prefer the file-based flow, run:
 
 ```bash
-bin/rails sitemap:validate
-bin/rails sitemap:google:ping
-bin/rails sitemap:index_now:ping
-bin/rails sitemap:ping
 bin/rails sitemap:index_now:write_key
 ```
 
+That task:
+
+- reuses an existing valid key file when present
+- otherwise generates a new key in `public/<key>.txt`
+- makes that key available to `sitemap:index_now:ping` without adding `config.index_now.key`
+
+If neither a configured key nor a valid key file is present, `sitemap:index_now:ping` skips IndexNow submission.
+
 ## Development
 
 Run tests:
@@ -165,11 +220,7 @@ Run the full default task:
 bundle exec rake
 ```
 
-Tests generate a coverage report automatically. You can run either:
-
-```bash
-bundle exec rake test
-```
+Tests generate a coverage report automatically.
 
 Note: `Gemfile.lock` is intentionally not tracked for this gem, following normal Ruby library conventions.
 

data/lib/indexmap/index_now_configuration.rb

@@ -21,7 +21,7 @@ module Indexmap
       resolve(@key)
     end
 
-    def key_path(public_path:)
+    def key_path(public_path:, key: self.key)
       configured_path = resolve(@key_path)
       return Pathname(configured_path) unless configured_path.to_s.strip.empty?
       return if key.to_s.strip.empty?

data/lib/indexmap/pinger/google.rb

@@ -17,10 +17,13 @@ module Indexmap
       def ping
         if google_configuration.credentials.to_s.strip.empty?
           logger.debug("Google sitemap credentials not configured.")
-          return
+          return {status: :skipped, reason: :missing_credentials}
         end
 
-        super
+        results = sitemap_files.map { |sitemap_file| ping_sitemap(sitemap_file) }
+        return {status: :skipped, reason: :no_sitemaps} if results.empty?
+
+        summarize_results(results)
       end
 
       private
@@ -36,13 +39,26 @@ module Indexmap
 
         unless authorized?
           logger.error("Google Search Console does not have access to the site: #{root_domain}")
-          return
+          return {
+            status: :failed,
+            reason: :unauthorized,
+            property: property_identifier,
+            root_domain: root_domain
+          }
         end
 
         webmasters_service.submit_sitemap(property_identifier, sitemap_url)
         logger.debug { "Successfully pinged Google with sitemap: #{sitemap_url}" }
+        {status: :submitted, sitemap_url: sitemap_url}
       rescue ::Google::Apis::ClientError => e
         logger.debug { "Failed to ping Google for #{sitemap_url}. Status: #{e.status_code}, Body: #{e.body}" }
+        {
+          status: :failed,
+          reason: :client_error,
+          sitemap_url: sitemap_url,
+          status_code: e.status_code,
+          body: e.body
+        }
       end
 
       def authorized?
@@ -73,6 +89,21 @@ module Indexmap
           scope: scope
         )
       end
+
+      def summarize_results(results)
+        submitted = results.select { |result| result[:status] == :submitted }
+        failures = results.select { |result| result[:status] == :failed }
+
+        return {status: :submitted, sitemap_count: submitted.count, submitted: submitted} if failures.empty?
+        return {status: :failed, sitemap_count: 0, failures: failures} if submitted.empty?
+
+        {
+          status: :partial,
+          sitemap_count: submitted.count,
+          submitted: submitted,
+          failures: failures
+        }
+      end
     end
   end
 end

data/lib/indexmap/pinger/index_now.rb

@@ -2,6 +2,7 @@
 
 require "faraday"
 require "json"
+require "securerandom"
 require "time"
 
 module Indexmap
@@ -16,37 +17,49 @@ module Indexmap
         api_key = read_api_key
         unless api_key
           logger.debug("IndexNow API key is not configured.")
-          return
+          return {status: :skipped, reason: :missing_key}
         end
 
         entries = entries_to_ping
         if entries.empty?
           logger.debug("IndexNow: no URLs matched the current filter.")
-          return
+          return {status: :skipped, reason: :no_urls}
         end
 
-        entries.each_slice(max_urls_per_request) do |batch|
+        results = entries.each_slice(max_urls_per_request).map do |batch|
           urls = batch.map(&:loc)
 
           if dry_run?
             logger.debug { "IndexNow dry-run: would ping #{urls.count} URLs." }
-            next
+            next({status: :dry_run, url_count: urls.count})
           end
 
           submit_batch(api_key: api_key, urls: urls)
         end
+
+        summarize_results(results)
       end
 
-      def write_key_file
-        key = index_now_configuration.key.to_s.strip
+      def write_key_file(key: index_now_configuration.key, path: nil)
+        key = key.to_s.strip
         return if key.empty?
 
-        path = index_now_configuration.key_path(public_path: configuration.public_path)
+        path ||= index_now_configuration.key_path(public_path: configuration.public_path, key: key)
         FileUtils.mkdir_p(path.dirname)
         File.write(path, "#{key}\n")
         path
       end
 
+      def ensure_key_file
+        configured_key = index_now_configuration.key.to_s.strip
+        return write_key_file(key: configured_key) unless configured_key.empty?
+
+        return existing_key_file if existing_key_file
+
+        key = generated_key
+        write_key_file(key: key, path: configuration.public_path.join("#{key}.txt"))
+      end
+
       private
 
       attr_reader :connection
@@ -137,10 +150,10 @@ module Indexmap
 
         if response.success?
           logger.debug { "Successfully pinged IndexNow with #{urls.count} URLs." }
-          true
+          {status: :submitted, url_count: urls.count}
         else
           logger.debug { "Failed to ping IndexNow. Status: #{response.status}, Body: #{response.body}" }
-          false
+          {status: :failed, url_count: urls.count, status_code: response.status, body: response.body}
         end
       end
 
@@ -158,15 +171,65 @@ module Indexmap
         configured_key = index_now_configuration.key.to_s.strip
         return configured_key unless configured_key.empty?
 
-        key_file = configuration.public_path.glob("*.txt").find do |file|
-          filename = file.basename(".txt").to_s
-          next unless filename.match?(/\A[a-zA-Z0-9-]{8,128}\z/)
+        existing_key_file&.read&.strip
+      end
+
+      def existing_key_file
+        configured_path = index_now_configuration.key_path(public_path: configuration.public_path)
+        return configured_path if valid_key_file?(configured_path)
+
+        configuration.public_path.glob("*.txt").find { |file| valid_key_file?(file) }
+      end
+
+      def valid_key_file?(path)
+        return false unless path&.file?
+
+        filename = path.basename(".txt").to_s
+        return false unless filename.match?(/\A[a-zA-Z0-9-]{8,128}\z/)
+
+        path.read.strip == filename
+      end
+
+      def generated_key
+        SecureRandom.uuid
+      end
+
+      def summarize_results(results)
+        dry_runs = results.select { |result| result[:status] == :dry_run }
+        submitted = results.select { |result| result[:status] == :submitted }
+        failures = results.select { |result| result[:status] == :failed }
+
+        if dry_runs.any?
+          return {
+            status: :dry_run,
+            url_count: dry_runs.sum { |result| result[:url_count] },
+            batch_count: dry_runs.count
+          }
+        end
+
+        if failures.empty?
+          return {
+            status: :submitted,
+            url_count: submitted.sum { |result| result[:url_count] },
+            batch_count: submitted.count
+          }
+        end
 
-          File.read(file).strip == filename
+        if submitted.empty?
+          return {
+            status: :failed,
+            url_count: 0,
+            batch_count: 0,
+            failures: failures
+          }
         end
-        return nil unless key_file
 
-        File.read(key_file).strip
+        {
+          status: :partial,
+          url_count: submitted.sum { |result| result[:url_count] },
+          batch_count: submitted.count,
+          failures: failures
+        }
       end
     end
   end

data/lib/indexmap/task_runner.rb

@@ -11,7 +11,7 @@ module Indexmap
     def create
       remove_existing_sitemap_files
       configuration.writer.write
-      write_index_now_key
+      {files: sitemap_files, index_now_key_path: write_index_now_key}
     end
 
     def format
@@ -27,28 +27,38 @@ module Indexmap
 
         File.write(file_path, document.to_xml(indent: 2, save_with: save_options))
       end
+
+      sitemap_files
     end
 
     def validate
       Validator.new(configuration: configuration).validate!
+      sitemap_files
     end
 
-    def write_index_now_key
-      Pinger::IndexNow.new(configuration: configuration).write_key_file
+    def write_index_now_key(generate_if_missing: false)
+      pinger = Pinger::IndexNow.new(configuration: configuration)
+      return pinger.ensure_key_file if generate_if_missing
+
+      pinger.write_key_file
+    end
+
+    def public_path
+      configuration.public_path
     end
 
     private
 
     attr_reader :configuration
 
-    def sitemap_files
-      Dir.glob(configuration.public_path.join("sitemap*.xml"))
-    end
-
     def remove_existing_sitemap_files
       Dir.glob(configuration.public_path.join("sitemap*.xml*")).each do |file_path|
         File.delete(file_path)
       end
     end
+
+    def sitemap_files
+      Dir.glob(configuration.public_path.join("sitemap*.xml")).sort
+    end
   end
 end

data/lib/indexmap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Indexmap
-  VERSION = "0.3.1"
+  VERSION = "0.4.1"
 end

data/lib/tasks/indexmap_tasks.rake

@@ -2,19 +2,28 @@ namespace :sitemap do
   desc "Create sitemap files"
   task create: :environment do
     runner = Indexmap::TaskRunner.new
-    runner.create
+    create_result = runner.create
     runner.format
-    runner.validate
+    validated_files = runner.validate
+
+    puts "Created, formatted, and validated #{file_count(validated_files)} in #{public_directory(runner)}."
+    puts "IndexNow key file: #{create_result[:index_now_key_path]}" if create_result[:index_now_key_path]
   end
 
   desc "Format sitemap files for better readability"
   task format: :environment do
-    Indexmap::TaskRunner.new.format
+    runner = Indexmap::TaskRunner.new
+    formatted_files = runner.format
+
+    puts "Formatted #{file_count(formatted_files)} in #{public_directory(runner)}."
   end
 
   desc "Validate sitemap shape and URL hygiene"
   task validate: :environment do
-    Indexmap::TaskRunner.new.validate
+    runner = Indexmap::TaskRunner.new
+    validated_files = runner.validate
+
+    puts "Validated #{file_count(validated_files)} for sitemap shape and URL hygiene."
   end
 
   desc "Ping all configured search engines"
@@ -26,20 +35,101 @@ namespace :sitemap do
   namespace :google do
     desc "Ping Google Search Console"
     task ping: :environment do
-      Indexmap::Pinger::Google.new.ping
+      result = Indexmap::Pinger::Google.new.ping
+
+      case result[:status]
+      when :submitted
+        puts "Submitted #{result[:sitemap_count]} sitemap #{(result[:sitemap_count] == 1) ? "file" : "files"} to Google Search Console."
+      when :partial
+        puts "Submitted #{result[:sitemap_count]} sitemap #{(result[:sitemap_count] == 1) ? "file" : "files"} to Google Search Console, with #{result[:failures].count} failure#{"s" unless result[:failures].count == 1}."
+        result[:failures].each { |failure| puts format_google_ping_failure(failure) }
+      when :failed
+        result[:failures].each { |failure| puts format_google_ping_failure(failure) }
+      when :skipped
+        puts format_google_ping_skip(result)
+      end
     end
   end
 
   namespace :index_now do
     desc "Ping IndexNow. ENV: SINCE=2026-04-18T10:30:00Z or INDEXNOW_RECENT_HOURS=24"
     task ping: :environment do
-      Indexmap::Pinger::IndexNow.new.ping
+      result = Indexmap::Pinger::IndexNow.new.ping
+
+      case result[:status]
+      when :submitted
+        puts "Submitted #{result[:url_count]} URL#{"s" unless result[:url_count] == 1} to IndexNow in #{result[:batch_count]} request#{"s" unless result[:batch_count] == 1}."
+      when :partial
+        puts "Submitted #{result[:url_count]} URL#{"s" unless result[:url_count] == 1} to IndexNow in #{result[:batch_count]} request#{"s" unless result[:batch_count] == 1}, with #{result[:failures].count} failure#{"s" unless result[:failures].count == 1}."
+        result[:failures].each { |failure| puts format_index_now_ping_failure(failure) }
+      when :failed
+        result[:failures].each { |failure| puts format_index_now_ping_failure(failure) }
+      when :dry_run
+        puts "IndexNow dry-run: would submit #{result[:url_count]} URL#{"s" unless result[:url_count] == 1} in #{result[:batch_count]} request#{"s" unless result[:batch_count] == 1}."
+      when :skipped
+        puts format_index_now_ping_skip(result)
+      end
     end
 
-    desc "Write the IndexNow key file into public/"
+    desc "Ensure the IndexNow key file exists in public/"
     task write_key: :environment do
-      path = Indexmap::TaskRunner.new.write_index_now_key
-      puts "Wrote #{path}" if path
+      path = Indexmap::TaskRunner.new.write_index_now_key(generate_if_missing: true)
+      if path
+        puts "IndexNow key file available at #{path}."
+      else
+        puts "IndexNow key is not configured; skipped key file write."
+      end
+    end
+  end
+
+  def file_count(files)
+    count = Array(files).size
+    "#{count} sitemap #{(count == 1) ? "file" : "files"}"
+  end
+
+  def public_directory(runner)
+    runner.public_path
+  end
+
+  def format_google_ping_failure(failure)
+    case failure[:reason]
+    when :unauthorized
+      "Google Search Console does not have access to #{failure[:property]}."
+    when :client_error
+      "Google ping failed for #{failure[:sitemap_url]} (status #{failure[:status_code]})."
+    else
+      "Google ping failed."
+    end
+  end
+
+  def format_google_ping_skip(result)
+    case result[:reason]
+    when :missing_credentials
+      "Google sitemap credentials are not configured; skipped Google submission."
+    when :no_sitemaps
+      "No sitemap files found; skipped Google submission."
+    else
+      "Skipped Google submission."
+    end
+  end
+
+  def format_index_now_ping_failure(failure)
+    case failure[:status_code]
+    when nil
+      "IndexNow submission failed."
+    else
+      "IndexNow submission failed for #{failure[:url_count]} URL#{"s" unless failure[:url_count] == 1} (status #{failure[:status_code]})."
+    end
+  end
+
+  def format_index_now_ping_skip(result)
+    case result[:reason]
+    when :missing_key
+      "IndexNow key is not configured and no valid key file was found; skipped IndexNow submission."
+    when :no_urls
+      "No sitemap URLs matched the current IndexNow filter; skipped IndexNow submission."
+    else
+      "Skipped IndexNow submission."
     end
   end
 end

data/test/indexmap/pinger/google_test.rb

@@ -40,7 +40,7 @@ class IndexmapPingerGoogleTest < Minitest::Test
         :fake_authorizer
       end
 
-      Indexmap::Pinger::Google.new(
+      result = Indexmap::Pinger::Google.new(
         configuration: configuration,
         service: service,
         credentials_builder: credentials_builder
@@ -49,6 +49,8 @@ class IndexmapPingerGoogleTest < Minitest::Test
       assert_equal [["{\"type\":\"service_account\"}", "https://www.googleapis.com/auth/webmasters"]], builder_calls
       assert_equal :fake_authorizer, service.authorization
       assert_equal ["sc-domain:example.com", "https://www.example.com/sitemap.xml"], service.submitted
+      assert_equal :submitted, result[:status]
+      assert_equal 1, result[:sitemap_count]
     end
   end
 
@@ -63,9 +65,53 @@ class IndexmapPingerGoogleTest < Minitest::Test
 
       service = FakeWebmastersService.new(site_urls: ["sc-domain:example.com"])
 
-      Indexmap::Pinger::Google.new(configuration: configuration, service: service).ping
+      result = Indexmap::Pinger::Google.new(configuration: configuration, service: service).ping
 
       assert_nil service.submitted
+      assert_equal({status: :skipped, reason: :missing_credentials}, result)
+    end
+  end
+
+  def test_reports_missing_sitemap_files
+    Dir.mktmpdir do |dir|
+      configuration = Indexmap::Configuration.new
+      configuration.base_url = "https://www.example.com"
+      configuration.public_path = Pathname(dir)
+      configuration.google.credentials = "{\"type\":\"service_account\"}"
+
+      service = FakeWebmastersService.new(site_urls: ["sc-domain:example.com"])
+      result = Indexmap::Pinger::Google.new(
+        configuration: configuration,
+        service: service,
+        credentials_builder: ->(**) { :fake_authorizer }
+      ).ping
+
+      assert_equal({status: :skipped, reason: :no_sitemaps}, result)
+      assert_nil service.submitted
+    end
+  end
+
+  def test_reports_google_authorization_failure
+    Dir.mktmpdir do |dir|
+      public_path = Pathname(dir)
+      public_path.join("sitemap.xml").write("<sitemapindex/>")
+
+      configuration = Indexmap::Configuration.new
+      configuration.base_url = "https://www.example.com"
+      configuration.public_path = public_path
+      configuration.google.credentials = "{\"type\":\"service_account\"}"
+
+      service = FakeWebmastersService.new(site_urls: ["sc-domain:not-example.org"])
+      result = Indexmap::Pinger::Google.new(
+        configuration: configuration,
+        service: service,
+        credentials_builder: ->(**) { :fake_authorizer }
+      ).ping
+
+      assert_equal :failed, result[:status]
+      assert_equal 1, result[:failures].count
+      assert_equal :unauthorized, result[:failures].first[:reason]
+      assert_nil service.submitted
     end
   end
 end

data/test/indexmap/pinger/index_now_test.rb

@@ -17,6 +17,49 @@ class IndexmapPingerIndexNowTest < Minitest::Test
     end
   end
 
+  def test_ensure_key_file_generates_a_key_when_configuration_is_missing
+    Dir.mktmpdir do |dir|
+      configuration = Indexmap::Configuration.new
+      configuration.base_url = "https://www.example.com"
+      configuration.public_path = Pathname(dir)
+
+      path = Indexmap::Pinger::IndexNow.new(configuration: configuration).ensure_key_file
+
+      assert_match(/\A[a-z0-9-]{8,128}\.txt\z/, path.basename.to_s)
+      assert_equal "#{path.basename(".txt")}\n", path.read
+    end
+  end
+
+  def test_pings_using_existing_key_file_when_key_is_not_configured
+    Dir.mktmpdir do |dir|
+      public_path = Pathname(dir)
+      key_path = public_path.join("test-key-123.txt")
+      key_path.write("test-key-123\n")
+      write_sitemap_files(
+        public_path,
+        marketing_lastmod: "2026-04-18T00:00:00Z",
+        insights_lastmod: "2026-04-10T00:00:00Z"
+      )
+
+      configuration = Indexmap::Configuration.new
+      configuration.base_url = "https://www.example.com"
+      configuration.public_path = public_path
+
+      indexnow_url = "https://api.indexnow.org/indexnow"
+      stub_request(:post, indexnow_url).to_return(status: 200, body: "", headers: {})
+
+      result = Indexmap::Pinger::IndexNow.new(configuration: configuration).ping
+
+      assert_requested(:post, indexnow_url, times: 1) do |request|
+        payload = JSON.parse(request.body)
+        assert_equal "test-key-123", payload.fetch("key")
+      end
+      assert_equal :submitted, result[:status]
+      assert_equal 2, result[:url_count]
+      assert_equal 1, result[:batch_count]
+    end
+  end
+
   def test_pings_all_sitemap_urls_when_no_cutoff_is_provided
     Dir.mktmpdir do |dir|
       public_path = Pathname(dir)
@@ -34,7 +77,7 @@ class IndexmapPingerIndexNowTest < Minitest::Test
       indexnow_url = "https://api.indexnow.org/indexnow"
       stub_request(:post, indexnow_url).to_return(status: 200, body: "", headers: {})
 
-      Indexmap::Pinger::IndexNow.new(configuration: configuration).ping
+      result = Indexmap::Pinger::IndexNow.new(configuration: configuration).ping
 
       assert_requested(:post, indexnow_url, times: 1) do |request|
         payload = JSON.parse(request.body)
@@ -43,6 +86,9 @@ class IndexmapPingerIndexNowTest < Minitest::Test
           "https://www.example.com/insights/us/restaurants/overview"
         ].sort, payload.fetch("urlList").sort
       end
+      assert_equal :submitted, result[:status]
+      assert_equal 2, result[:url_count]
+      assert_equal 1, result[:batch_count]
     end
   end
 
@@ -64,7 +110,11 @@ class IndexmapPingerIndexNowTest < Minitest::Test
       stub_request(:post, indexnow_url).to_return(status: 200, body: "", headers: {})
 
       with_env("SINCE" => "2026-04-15T00:00:00Z") do
-        Indexmap::Pinger::IndexNow.new(configuration: configuration).ping
+        result = Indexmap::Pinger::IndexNow.new(configuration: configuration).ping
+
+        assert_equal :submitted, result[:status]
+        assert_equal 1, result[:url_count]
+        assert_equal 1, result[:batch_count]
       end
 
       assert_requested(:post, indexnow_url, times: 1) do |request|
@@ -74,6 +124,74 @@ class IndexmapPingerIndexNowTest < Minitest::Test
     end
   end
 
+  def test_skips_indexnow_ping_when_key_is_missing
+    Dir.mktmpdir do |dir|
+      public_path = Pathname(dir)
+      write_sitemap_files(
+        public_path,
+        marketing_lastmod: "2026-04-18T00:00:00Z",
+        insights_lastmod: "2026-04-10T00:00:00Z"
+      )
+
+      configuration = Indexmap::Configuration.new
+      configuration.base_url = "https://www.example.com"
+      configuration.public_path = public_path
+
+      result = Indexmap::Pinger::IndexNow.new(configuration: configuration).ping
+
+      assert_equal({status: :skipped, reason: :missing_key}, result)
+    end
+  end
+
+  def test_reports_indexnow_dry_run
+    Dir.mktmpdir do |dir|
+      public_path = Pathname(dir)
+      write_sitemap_files(
+        public_path,
+        marketing_lastmod: "2026-04-18T00:00:00Z",
+        insights_lastmod: "2026-04-10T00:00:00Z"
+      )
+
+      configuration = Indexmap::Configuration.new
+      configuration.base_url = "https://www.example.com"
+      configuration.public_path = public_path
+      configuration.index_now.key = "test-key"
+
+      with_env("INDEXNOW_DRY_RUN" => "1") do
+        result = Indexmap::Pinger::IndexNow.new(configuration: configuration).ping
+
+        assert_equal :dry_run, result[:status]
+        assert_equal 2, result[:url_count]
+        assert_equal 1, result[:batch_count]
+      end
+    end
+  end
+
+  def test_reports_failed_indexnow_submission
+    Dir.mktmpdir do |dir|
+      public_path = Pathname(dir)
+      write_sitemap_files(
+        public_path,
+        marketing_lastmod: "2026-04-18T00:00:00Z",
+        insights_lastmod: "2026-04-10T00:00:00Z"
+      )
+
+      configuration = Indexmap::Configuration.new
+      configuration.base_url = "https://www.example.com"
+      configuration.public_path = public_path
+      configuration.index_now.key = "test-key"
+
+      indexnow_url = "https://api.indexnow.org/indexnow"
+      stub_request(:post, indexnow_url).to_return(status: 500, body: "boom", headers: {})
+
+      result = Indexmap::Pinger::IndexNow.new(configuration: configuration).ping
+
+      assert_equal :failed, result[:status]
+      assert_equal 1, result[:failures].count
+      assert_equal 500, result[:failures].first[:status_code]
+    end
+  end
+
   private
 
   def with_env(overrides)

data/test/indexmap/task_runner_test.rb

@@ -20,11 +20,13 @@ class IndexmapTaskRunnerTest < Minitest::Test
       ]
       configuration.index_now.key = "test-key"
 
-      Indexmap::TaskRunner.new(configuration: configuration).create
+      result = Indexmap::TaskRunner.new(configuration: configuration).create
 
       assert_equal false, public_path.join("sitemap-pages.xml.gz").exist?
       assert_includes public_path.join("sitemap.xml").read, "<sitemapindex"
       assert_equal "test-key\n", public_path.join("test-key.txt").read
+      assert_equal [public_path.join("sitemap-pages.xml").to_s, public_path.join("sitemap.xml").to_s], result[:files]
+      assert_equal public_path.join("test-key.txt"), result[:index_now_key_path]
     end
   end
 
@@ -45,4 +47,17 @@ class IndexmapTaskRunnerTest < Minitest::Test
       assert_nil result
     end
   end
+
+  def test_write_index_now_key_can_generate_a_key_when_requested
+    Dir.mktmpdir do |dir|
+      configuration = Indexmap::Configuration.new
+      configuration.base_url = "https://example.com"
+      configuration.public_path = Pathname(dir)
+
+      result = Indexmap::TaskRunner.new(configuration: configuration).write_index_now_key(generate_if_missing: true)
+
+      assert_match(/\A[a-z0-9-]{8,128}\.txt\z/, result.basename.to_s)
+      assert_equal "#{result.basename(".txt")}\n", result.read
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indexmap
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Paulo Fidalgo