indexmap 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a655a2fa64beda7c2724d6fb4f283a13a5baf47519863c489e982efa86f2c32
-  data.tar.gz: 42dac8a1312d05bba81df9534bba52eaa69d55c236688473757252a1038dae06
+  metadata.gz: 513c19d20a8373690c66fa99a0251db934298589a19139c2b77654340ce7006a
+  data.tar.gz: '087bd725e6ecaf81ff07510f78f7c5fa1d613730cd7b735c9f0ed60ecb3f4676'
 SHA512:
-  metadata.gz: d0615154aef9cf51613b73c46f834efb16c53b77dfb3611f8f980a8ae5c1e8eedaa653ca84ca5610a27b58377717e7c3acbd0fc1cdb162df90fd84d660912ed6
-  data.tar.gz: 796aeed197f26684ebbd74bb7b47d37c878fea855c02c4ec0636cd7ce28c44f32fb73a3c2a911955d194d175c8c80ce351c8b2f955e03707543a88e4ab740763
+  metadata.gz: 2f4065163991559ca5a1df38f1f01aafbdc539936f40aa81d78a3c5aa4abe34bdbc7cdb0df25d970a8a243e1b552c1946ec97c640f8d64350a46ef0d8de36006
+  data.tar.gz: d0ebff2036cefb30689a22ebddf313c89ac45a6dda11277a4a5322b6c39c6257e6d05e3615e0167ca876f985b14dc5ac21eba096f947876ab72be32bc6a73c33

data/CHANGELOG.md

@@ -5,12 +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.4.0] - 2026-04-22
+## [0.4.1] - 2026-04-22
 
 
-### Documentation
+### Added
 
-- improve the task messages (#4)
+- add output to ping tasks (#6)
 
 
 

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

@@ -17,25 +17,27 @@ 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, path: nil)
@@ -148,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
 
@@ -191,6 +193,44 @@ module Indexmap
       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
+
+        if submitted.empty?
+          return {
+            status: :failed,
+            url_count: 0,
+            batch_count: 0,
+            failures: failures
+          }
+        end
+
+        {
+          status: :partial,
+          url_count: submitted.sum { |result| result[:url_count] },
+          batch_count: submitted.count,
+          failures: failures
+        }
+      end
     end
   end
 end

data/lib/indexmap/version.rb

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

data/lib/tasks/indexmap_tasks.rake

@@ -35,14 +35,40 @@ 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 "Ensure the IndexNow key file exists in public/"
@@ -64,4 +90,46 @@ namespace :sitemap do
   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

@@ -48,12 +48,15 @@ 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)
         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
 
@@ -74,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)
@@ -83,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
 
@@ -104,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|
@@ -114,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)

metadata

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