dynamic_sitemaps 2.0.0.beta → 2.0.0.beta2

data/test/generator_test.rb

@@ -0,0 +1,404 @@
+require "test_helper"
+require "nokogiri"
+require "timecop"
+
+class GeneratorTest < ActiveSupport::TestCase
+  setup do
+    Timecop.freeze Time.new(2013, 7, 10, 13, 46, 23, "+10:00")
+    FileUtils.rm_rf Rails.root.join("public", "sitemaps")
+    DynamicSitemaps.reset!
+  end
+
+  teardown do
+    Timecop.return
+  end
+
+  test "basic sitemap with default settings" do
+    DynamicSitemaps.generate_sitemap
+
+    doc = open_sitemap(remove_namespaces: false)
+    assert_equal ({ "xmlns" => "http://www.sitemaps.org/schemas/sitemap/0.9" }), doc.namespaces
+    doc.remove_namespaces!
+
+    doc.xpath("urlset/url").tap do |url|
+      assert_equal 1, url.count
+      assert_equal "http://www.mytest.com/", url.xpath("loc").text
+      assert_equal "2013-07-10T03:46:23+00:00", url.xpath("lastmod").text
+      assert_equal "daily", url.xpath("changefreq").text
+      assert_equal "1.0", url.xpath("priority").text
+    end
+
+    # Test that it only keeps sitemap.xml when there's no need for an index
+    assert !File.exists?(Rails.root.join("public", "sitemaps", "site.xml"))
+  end
+
+  test "custom path and folder" do
+    path = File.dirname(__FILE__) + "/tmp/testpath"
+    folder = "myfolder"
+
+    FileUtils.rm_rf path
+    DynamicSitemaps.path = path
+    DynamicSitemaps.folder = folder
+
+    DynamicSitemaps.generate_sitemap do
+      host "www.mydomain.com"
+
+      sitemap :one do
+        url root_url
+      end
+      sitemap :two do
+        url root_url
+      end
+    end
+
+    assert_equal ["one.xml", "sitemap.xml", "two.xml"],
+                 Dir["#{path}/#{folder}/*"].sort.map { |p| File.basename(p) }.sort
+  end
+
+  test "index" do
+    14.times { Product.create }
+
+    DynamicSitemaps.per_page = 5
+    DynamicSitemaps.generate_sitemap do
+      host "www.test.com"
+
+      sitemap :first do
+        url root_url
+      end
+
+      sitemap :second do
+        1.upto(32) do |num|
+          url "http://#{host}/test#{num}"
+        end
+      end
+
+      sitemap_for Product.scoped do |product|
+        url product
+        url product_comments_url(product)
+      end
+    end
+
+    doc = open_sitemap(remove_namespaces: false)
+    assert_equal ({ "xmlns" => "http://www.sitemaps.org/schemas/sitemap/0.9" }), doc.namespaces
+    doc.remove_namespaces!
+
+    assert_equal ["first.xml", "products.xml", "products2.xml", "products3.xml",
+                  "products4.xml", "products5.xml", "products6.xml", "second.xml",
+                  "second2.xml", "second3.xml", "second4.xml", "second5.xml", "second6.xml",
+                  "second7.xml", "sitemap.xml"],
+                  Dir[Rails.root.join("public/sitemaps/*")].map { |p| File.basename(p) }.sort
+
+    assert_equal ["http://www.test.com/sitemaps/first.xml", "http://www.test.com/sitemaps/second.xml",
+                  "http://www.test.com/sitemaps/second2.xml", "http://www.test.com/sitemaps/second3.xml",
+                  "http://www.test.com/sitemaps/second4.xml", "http://www.test.com/sitemaps/second5.xml",
+                  "http://www.test.com/sitemaps/second6.xml", "http://www.test.com/sitemaps/second7.xml",
+                  "http://www.test.com/sitemaps/products.xml", "http://www.test.com/sitemaps/products2.xml",
+                  "http://www.test.com/sitemaps/products3.xml", "http://www.test.com/sitemaps/products4.xml",
+                  "http://www.test.com/sitemaps/products5.xml", "http://www.test.com/sitemaps/products6.xml"],
+                  doc.xpath("sitemapindex/sitemap/loc").map(&:text)
+  end
+
+  test "indexes in multiple folders" do
+    DynamicSitemaps.generate_sitemap do
+      ["one", "two"].each do |domain|
+        host "www.#{domain}.com"
+        folder "sitemaps/#{domain}"
+
+        sitemap :first do
+          url root_url
+        end
+
+        sitemap :second do
+          url "http://#{host}/test"
+        end
+      end
+    end
+
+    ["one", "two"].each do |folder|
+      assert_equal ["first.xml", "second.xml", "sitemap.xml"],
+                   Dir[Rails.root.join("public/sitemaps/#{folder}/*")].map { |p| File.basename(p) }.sort
+
+      doc = open_sitemap(Rails.root.join("public/sitemaps/#{folder}/sitemap.xml"))
+
+      assert_equal ["http://www.#{folder}.com/sitemaps/#{folder}/first.xml",
+                    "http://www.#{folder}.com/sitemaps/#{folder}/second.xml"],
+                    doc.xpath("sitemapindex/sitemap/loc").map(&:text)
+    end
+  end
+
+  test "custom index file name" do
+    DynamicSitemaps.index_file_name = "custom.xml"
+    DynamicSitemaps.generate_sitemap do
+      host "www.mydomain.com"
+
+      sitemap :one do
+        url root_url
+      end
+      sitemap :two do
+        url root_url
+      end
+    end
+
+    doc = open_sitemap(Rails.root.join("public", "sitemaps", "custom.xml"))
+    assert_equal 2, doc.xpath("sitemapindex/sitemap/loc").count
+  end
+
+  test "ensure unique sitemap names" do
+    assert_raises ArgumentError do
+      DynamicSitemaps.generate_sitemap do
+        host "www.example.com"
+        sitemap :site do
+          url root_url
+        end
+        sitemap :site do
+          url root_url
+        end
+      end
+    end
+  end
+
+  test "ensure unique sitemap names for relations" do
+    assert_raises ArgumentError do
+      DynamicSitemaps.generate_sitemap do
+        host "www.example.com"
+        sitemap_for Product.scoped
+        sitemap_for Product.where(id: 1)
+      end
+    end
+  end
+
+  test "unique sitemap names are checked in scope of folder" do
+    assert_nothing_raised do
+      DynamicSitemaps.generate_sitemap do
+        host "www.example.com"
+
+        folder "sitemaps/one"
+        sitemap_for Product.scoped
+
+        folder "sitemaps/two"
+        sitemap_for Product.scoped
+      end
+    end
+  end
+
+  test "sitemap name conflict with index file name" do
+    assert_raises ArgumentError do
+      DynamicSitemaps.generate_sitemap do
+        host "www.example.com"
+
+        sitemap :sitemap do
+          url root_url
+        end
+      end
+    end
+  end
+
+  test "always generate index" do
+    DynamicSitemaps.always_generate_index = true
+    DynamicSitemaps.generate_sitemap
+
+    doc = open_sitemap
+    assert_equal "http://www.mytest.com/sitemaps/site.xml", doc.xpath("sitemapindex/sitemap/loc").text
+
+    doc = open_sitemap(Rails.root.join("public", "sitemaps", "site.xml"))
+    assert_equal "http://www.mytest.com/", doc.xpath("urlset/url/loc").text
+  end
+
+  test "sitemap based on block" do
+    DynamicSitemaps.generate_sitemap do
+      host "www.test.com"
+      sitemap :test do
+        url "http://www.test.com/test"
+        url "http://www.test.com/test2"
+      end
+    end
+
+    doc = open_sitemap
+    
+    assert_equal 2, doc.xpath("urlset/url").count
+    assert_equal "http://www.test.com/test2", doc.xpath("urlset/url/loc").last.text
+  end
+
+  test "resourceful routes" do
+    Product.create.tap do |product|
+      product.update_column :updated_at, 213434.seconds.ago
+    end
+    Product.create slug: "test-slug"
+
+    DynamicSitemaps.generate_sitemap do
+      host "www.mytest.com"
+      sitemap_for Product.scoped
+    end
+
+    doc = open_sitemap
+    urls = doc.xpath("urlset/url")
+    assert_equal 2, urls.count
+
+    urls.first.tap do |url|
+      assert_equal "http://www.mytest.com/products/1", url.xpath("loc").text
+      assert_equal "2013-07-07T16:29:09+00:00", url.xpath("lastmod").text
+      assert_nil url.at_xpath("priority")
+      assert_nil url.at_xpath("changefreq")
+    end
+
+    urls.last.tap do |url|
+      assert_equal "http://www.mytest.com/products/test-slug", url.xpath("loc").text
+      assert_equal "2013-07-10T03:46:23+00:00", url.xpath("lastmod").text
+      assert_nil url.at_xpath("priority")
+      assert_nil url.at_xpath("changefreq")
+    end
+  end
+
+  test "resourceful routes with custom urls" do
+    Product.create featured: true
+    Product.create featured: false
+
+    DynamicSitemaps.generate_sitemap do
+      host "www.mytest.com"
+      sitemap_for Product.scoped do |product|
+        url product, last_mod: 1234.seconds.ago, priority: (product.featured? ? 1.0 : nil), change_freq: "weekly"
+        url product_comments_url(product)
+      end
+    end
+
+    doc = open_sitemap
+    urls = doc.xpath("urlset/url")
+    assert_equal 4, urls.count
+
+    urls[0].tap do |url|
+      assert_equal "http://www.mytest.com/products/1", url.xpath("loc").text
+      assert_equal "2013-07-10T03:25:49+00:00", url.xpath("lastmod").text
+      assert_equal "weekly", url.xpath("changefreq").text
+      assert_equal "1.0", url.xpath("priority").text
+    end
+
+    urls[1].tap do |url|
+      assert_equal "http://www.mytest.com/products/1/comments", url.xpath("loc").text
+      assert_nil url.at_xpath("lastmod")
+      assert_nil url.at_xpath("changefreq")
+      assert_nil url.at_xpath("priority")
+    end
+
+    urls[2].tap do |url|
+      assert_equal "http://www.mytest.com/products/2", url.xpath("loc").text
+      assert_nil url.at_xpath("priority")
+    end
+  end
+
+  test "sitemap_for complains if not given a relation" do
+    assert_raises ArgumentError do
+      DynamicSitemaps.generate_sitemap do
+        host "www.mytest.com"
+        sitemap_for Product.all
+      end
+    end
+  end
+
+  test "generates to temporary folder first" do
+    raise_test_error = false
+
+    block = Proc.new do
+      host "www.example.com"
+
+      sitemap :site do
+        url root_url
+      end
+
+      raise RuntimeError if raise_test_error
+
+      sitemap :second do
+        url root_url
+      end
+    end
+
+    valid_files = ["second.xml", "site.xml", "sitemap.xml"]
+
+    DynamicSitemaps.generate_sitemap &block
+    assert_equal valid_files, Dir[Rails.root.join("public/sitemaps/*")].map { |p| File.basename(p) }.sort
+
+    raise_test_error = true
+    assert_raises RuntimeError do
+      DynamicSitemaps.generate_sitemap &block
+    end
+    assert_equal valid_files, Dir[Rails.root.join("public/sitemaps/*")].map { |p| File.basename(p) }.sort
+
+    assert !Dir.exists?(DynamicSitemaps.temp_path)
+  end
+
+  test "removes temporary folder if failing" do
+    assert_raises RuntimeError do
+      DynamicSitemaps.generate_sitemap do
+        host "www.example.com"
+
+        sitemap :site do
+          url root_url
+        end
+
+        raise RuntimeError
+      end
+    end
+
+    assert !Dir.exists?(DynamicSitemaps.temp_path)
+  end
+
+  test "large sitemap" do
+    DynamicSitemaps.generate_sitemap do
+      host "www.mydomain.com"
+      sitemap :large do
+        1.upto(123456) do |num|
+          url "http://#{host}/test/#{num}"
+        end
+      end
+    end
+
+    doc = open_sitemap
+    assert_equal 3, doc.xpath("sitemapindex/sitemap/loc").count
+
+    doc = open_sitemap(Rails.root.join("public/sitemaps/large.xml"))
+    assert_equal 50000, doc.xpath("urlset/url").count
+
+    doc = open_sitemap(Rails.root.join("public/sitemaps/large2.xml"))
+    assert_equal 50000, doc.xpath("urlset/url").count
+
+    doc = open_sitemap(Rails.root.join("public/sitemaps/large3.xml"))
+    assert_equal 23456, doc.xpath("urlset/url").count
+  end
+
+  test "pinging search engines" do
+    stub_request :get, //
+    DynamicSitemaps.ping_environments << "test"
+
+    DynamicSitemaps.generate_sitemap do
+      ["www.test.com", "www.example.com"].each do |domain|
+        host domain
+        folder "sitemaps/#{domain}"
+        sitemap :site do
+          url root_url
+        end
+        ping_with "http://#{host}/sitemap.xml"
+      end
+    end
+
+    ["http://www.google.com/webmasters/sitemaps/ping?sitemap=http://www.test.com/sitemap.xml",
+     "http://www.bing.com/webmaster/ping.aspx?siteMap=http://www.test.com/sitemap.xml",
+     "http://www.google.com/webmasters/sitemaps/ping?sitemap=http://www.example.com/sitemap.xml",
+     "http://www.bing.com/webmaster/ping.aspx?siteMap=http://www.example.com/sitemap.xml"].each do |url|
+      assert_requested :get, url
+    end
+  end
+
+private
+
+  # Opens a sitemap file using Nokogiri::XML and removes namespaces by default.
+  # 
+  #   open_sitemap # => Nokogiri::XML with the contents of <rails root>/public/sitemaps/sitemap.xml
+  #   open_sitemap "/path/to/sitemap.xml"
+  #   open_sitemap "/path/to/sitemap.xml", remove_namespaces: false
+  def open_sitemap(*args)
+    options = args.extract_options!
+    doc = Nokogiri::XML(open(args[0] || Rails.root.join("public", "sitemaps", "sitemap.xml")))
+    doc.remove_namespaces! unless options[:remove_namespaces] == false
+    doc
+  end
+
+end

data/test/pinger_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+class PingerTest < ActiveSupport::TestCase
+  setup do
+    DynamicSitemaps.reset!
+  end
+
+  test "pinging search engines" do
+    stub_request :get, /^http:\/\/www\.google\.com\/webmasters\/sitemaps\/ping\?sitemap=.*/
+    stub_request :get, /^http:\/\/www\.bing\.com\/webmaster\/ping\.aspx\?siteMap=.*/
+
+    DynamicSitemaps.ping_environments << "test"
+    DynamicSitemaps::Pinger.ping_search_engines_with ["http://test.dk/sitemap.xml", "http://other.com/test.xml"]
+
+    ["http://www.google.com/webmasters/sitemaps/ping?sitemap=http%3A%2F%2Ftest.dk%2Fsitemap.xml",
+     "http://www.bing.com/webmaster/ping.aspx?siteMap=http%3A%2F%2Ftest.dk%2Fsitemap.xml",
+     "http://www.google.com/webmasters/sitemaps/ping?sitemap=http%3A%2F%2Fother.com%2Ftest.xml",
+     "http://www.bing.com/webmaster/ping.aspx?siteMap=http%3A%2F%2Fother.com%2Ftest.xml"].each do |url|
+      assert_requested :get, url
+    end
+  end
+
+  test "doesnt ping when given no sitemap urls" do
+    stub_request :get, //
+    DynamicSitemaps.ping_environments << "test"
+    DynamicSitemaps::Pinger.ping_search_engines_with []
+    assert_not_requested :get, //
+  end
+
+  test "pings only for environments specified" do
+    stub_request :get, //
+
+    DynamicSitemaps::Pinger.ping_search_engines_with "http://test.com/sitemap.xml"
+    assert_not_requested :get, //
+
+    DynamicSitemaps.ping_environments << "test"
+    DynamicSitemaps::Pinger.ping_search_engines_with "http://test.com/sitemap.xml"
+    assert_requested :get, //, times: 2
+  end
+
+  test "custom search engine ping url" do
+    stub_request :get, //
+    DynamicSitemaps.ping_environments << "test"
+    DynamicSitemaps.search_engine_ping_urls << "http://testsearch.com/ping?url=%s"
+    DynamicSitemaps::Pinger.ping_search_engines_with "http://test.dk/sitemap.xml"
+
+    [/www\.google\.com/,
+     /www\.bing\.com/,
+     "http://testsearch.com/ping?url=http%3A%2F%2Ftest.dk%2Fsitemap.xml"].each do |url|
+      assert_requested :get, url
+    end
+  end
+
+  test "handles failure when pinging" do
+    stub_request(:get, //).to_raise(StandardError)
+    DynamicSitemaps.ping_environments << "test"
+
+    assert_nothing_raised do
+      DynamicSitemaps::Pinger.ping_search_engines_with "http://test.dk/sitemap.xml"
+    end
+  end
+
+  test "ping for environment" do
+    assert DynamicSitemaps::Pinger.ping_for_environment?("production")
+    assert !DynamicSitemaps::Pinger.ping_for_environment?("development")
+    assert !DynamicSitemaps::Pinger.ping_for_environment?("test")
+    assert !DynamicSitemaps::Pinger.ping_for_environment?("staging")
+    
+    DynamicSitemaps.ping_environments << "staging"
+    assert DynamicSitemaps::Pinger.ping_for_environment?("staging")
+    assert DynamicSitemaps::Pinger.ping_for_environment?("production")
+  end
+end