sitemap_generator 3.1.1 → 3.2

data/VERSION

@@ -1 +1 @@
-3.1.1
+3.2

data/lib/sitemap_generator.rb

@@ -10,6 +10,7 @@ require 'sitemap_generator/sitemap_location'
 module SitemapGenerator
   autoload(:Interpreter, 'sitemap_generator/interpreter')
   autoload(:FileAdapter, 'sitemap_generator/adapters/file_adapter')
+  autoload(:S3Adapter,   'sitemap_generator/adapters/s3_adapter')
   autoload(:WaveAdapter, 'sitemap_generator/adapters/wave_adapter')
   autoload(:BigDecimal,  'sitemap_generator/core_ext/big_decimal')
   autoload(:Numeric,     'sitemap_generator/core_ext/numeric')

data/lib/sitemap_generator/adapters/s3_adapter.rb

@@ -0,0 +1,25 @@
+require 'fog'
+
+module SitemapGenerator
+  class S3Adapter
+
+    # Call with a SitemapLocation and string data
+    def write(location, raw_data)
+      SitemapGenerator::FileAdapter.new.write(location, raw_data)
+      
+      credentials = { 
+        :aws_access_key_id     => ENV['AWS_ACCESS_KEY_ID'],
+        :aws_secret_access_key => ENV['AWS_SECRET_ACCESS_KEY'],
+        :provider              => ENV['FOG_PROVIDER'],
+      }
+      
+      storage   = Fog::Storage.new(credentials)
+      directory = storage.directories.get(ENV['FOG_DIRECTORY'])
+      directory.files.create(
+        :key    => location.path_in_public, 
+        :body   => File.open(location.path),
+        :public => true,
+      )
+    end
+  end
+end

data/lib/sitemap_generator/builder/sitemap_file.rb

@@ -34,7 +34,8 @@ module SitemapGenerator
               xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
               xmlns:video="http://www.google.com/schemas/sitemap-video/1.1"
               xmlns:geo="http://www.google.com/geo/schemas/sitemap/1.0"
-              xmlns:news="http://www.google.com/schemas/sitemap-news/0.9/"
+              xmlns:news="http://www.google.com/schemas/sitemap-news/0.9"
+              xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0"
             >
         HTML
         @xml_wrapper_start.gsub!(/\s+/, ' ').gsub!(/ *> */, '>').strip!

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -26,6 +26,7 @@ module SitemapGenerator
       # * +video+/+videos+
       # * +geo+
       # * +news+
+      # * +mobile+
       def initialize(path, options={})
         options = options.dup
         if sitemap = path.is_a?(SitemapGenerator::Builder::SitemapFile) && path
@@ -33,8 +34,8 @@ module SitemapGenerator
           path = sitemap.location.path_in_public
         end
 
-        SitemapGenerator::Utilities.assert_valid_keys(options, :priority, :changefreq, :lastmod, :host, :images, :video, :geo, :news, :videos)
-        SitemapGenerator::Utilities.reverse_merge!(options, :priority => 0.5, :changefreq => 'weekly', :lastmod => Time.now, :images => [], :news => {}, :videos => [])
+        SitemapGenerator::Utilities.assert_valid_keys(options, :priority, :changefreq, :lastmod, :host, :images, :video, :geo, :news, :videos, :mobile)
+        SitemapGenerator::Utilities.reverse_merge!(options, :priority => 0.5, :changefreq => 'weekly', :lastmod => Time.now, :images => [], :news => {}, :videos => [], :mobile => false)
         raise "Cannot generate a url without a host" unless SitemapGenerator::Utilities.present?(options[:host])
         if video = options.delete(:video)
           options[:videos] = video.is_a?(Array) ? options[:videos].concat(video) : options[:videos] << video
@@ -51,7 +52,8 @@ module SitemapGenerator
           :images     => prepare_images(options[:images], options[:host]),
           :news       => prepare_news(options[:news]),
           :videos     => options[:videos],
-          :geo        => options[:geo]
+          :geo        => options[:geo],
+          :mobile     => options[:mobile]
         )
       end
 
@@ -98,7 +100,9 @@ module SitemapGenerator
               builder.video :description, video[:description]
               builder.video :content_loc, video[:content_loc]           if video[:content_loc]
               if video[:player_loc]
-                builder.video :player_loc, video[:player_loc], :allow_embed => yes_or_no_with_default(video[:allow_embed], true), :autoplay => video[:autoplay]
+                loc_attributes = { :allow_embed => yes_or_no_with_default(video[:allow_embed], true) }
+                loc_attributes[:autoplay] = video[:autoplay] if SitemapGenerator::Utilities.present?(video[:autoplay])
+                builder.video :player_loc, video[:player_loc], loc_attributes
               end
               builder.video :duration, video[:duration]                 if video[:duration]
               builder.video :expiration_date,  w3c_date(video[:expiration_date])  if video[:expiration_date]
@@ -122,6 +126,10 @@ module SitemapGenerator
               builder.geo :format, geo[:format] if geo[:format]
             end
           end
+
+          unless SitemapGenerator::Utilities.blank?(self[:mobile])
+            builder.mobile :mobile
+          end
         end
         builder << '' # Force to string
       end

data/lib/sitemap_generator/link_set.rb

@@ -88,7 +88,7 @@ module SitemapGenerator
     #
     # * <tt>:include_index</tt> - Boolean.  Whether to <b>add a link to the sitemap index<b>
     #   to the current sitemap.  This points search engines to your Sitemap Index to
-    #   include it in the indexing of your site.  Default is `true`.  Turned off when
+    #   include it in the indexing of your site.  Default is `false`.  Turned off when
     #  `sitemaps_host` is set or within a `group()` block.
     #
     # * <tt>:include_root</tt> - Boolean.  Whether to **add the root** url i.e. '/' to the
@@ -102,11 +102,10 @@ module SitemapGenerator
     def initialize(options={})
       options = SitemapGenerator::Utilities.reverse_merge(options,
         :include_root => true,
-        :include_index => true,
+        :include_index => false,
         :filename => :sitemap,
         :search_engines => {
           :google         => "http://www.google.com/webmasters/sitemaps/ping?sitemap=%s",
-          :ask            => "http://submissions.ask.com/ping?sitemap=%s",
           :bing           => "http://www.bing.com/webmaster/ping.aspx?siteMap=%s",
           :sitemap_writer => "http://www.sitemapwriter.com/notify.php?crawler=all&url=%s"
         }

data/spec/sitemap_generator/link_set_spec.rb

@@ -24,7 +24,7 @@ describe SitemapGenerator::LinkSet do
       :sitemaps_path => nil,
       :public_path => SitemapGenerator.app.root + 'public/',
       :default_host => nil,
-      :include_index => true,
+      :include_index => false,
       :include_root => true
     }
 
@@ -36,12 +36,20 @@ describe SitemapGenerator::LinkSet do
   end
 
   describe "include_root include_index option" do
+    it "should include the root url and the sitemap index url" do
+      ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :include_root => true, :include_index => true)
+      ls.include_root.should be_true
+      ls.include_index.should be_true
+      ls.add_links { |sitemap| }
+      ls.sitemap.link_count.should == 2
+    end
+
     it "should not include the root url" do
       ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :include_root => false)
       ls.include_root.should be_false
-      ls.include_index.should be_true
+      ls.include_index.should be_false
       ls.add_links { |sitemap| }
-      ls.sitemap.link_count.should == 1
+      ls.sitemap.link_count.should == 0
     end
 
     it "should not include the sitemap index url" do
@@ -102,12 +110,12 @@ describe SitemapGenerator::LinkSet do
   describe "search_engines" do
     it "should have search engines by default" do
       ls.search_engines.should be_a(Hash)
-      ls.search_engines.size.should == 4
+      ls.search_engines.size.should == 3
     end
 
     it "should support being modified" do
       ls.search_engines[:newengine] = 'abc'
-      ls.search_engines.size.should == 5
+      ls.search_engines.size.should == 4
     end
 
     it "should support being set to nil" do
@@ -576,11 +584,6 @@ describe SitemapGenerator::LinkSet do
       ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :sitemaps_host => sitemaps_host)
       ls.include_index?.should be_false
     end
-
-    it "should return true" do
-      ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :sitemaps_host => default_host)
-      ls.include_index?.should be_true
-    end
   end
 
   describe "output" do

data/spec/sitemap_generator/mobile_sitemap_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe "SitemapGenerator" do
+
+  it "should add the mobile sitemap element" do
+    loc = 'http://www.example.com/mobile_page.html'
+    format = 'html'
+
+    mobile_xml_fragment = SitemapGenerator::Builder::SitemapUrl.new('mobile_page.html',
+      :host => 'http://www.example.com',
+      :mobile => true
+    ).to_xml
+
+    # Check that the options were parsed correctly
+    doc = Nokogiri::XML.parse("<root xmlns:mobile='http://www.google.com/schemas/sitemap-mobile/1.0'>#{mobile_xml_fragment}</root>")
+    url = doc.at_xpath("//url")
+    url.should_not be_nil
+    url.at_xpath("loc").text.should == loc
+
+    mobile = url.at_xpath("mobile:mobile")
+    mobile.should_not be_nil
+
+    # Google's documentation and published schema don't match some valid elements may
+    # not validate.
+    xml_fragment_should_validate_against_schema(mobile, 'http://www.google.com/schemas/sitemap-mobile/1.0', 'sitemap-mobile')
+  end
+end

data/spec/sitemap_generator/sitemap_generator_spec.rb

@@ -56,8 +56,8 @@ describe "SitemapGenerator" do
         file_should_not_exist(rails_path('public/sitemap3.xml.gz'))
       end
 
-      it "should have 14 links" do
-        SitemapGenerator::Sitemap.link_count.should == 14
+      it "should have 13 links" do
+        SitemapGenerator::Sitemap.link_count.should == 13
       end
 
       it "index XML should validate" do
@@ -104,7 +104,7 @@ describe "SitemapGenerator" do
       file_should_not_exist(rails_path('public/fr/abc5.xml.gz'))
     end
 
-    it "should have 14 links" do
+    it "should have 13 links" do
       SitemapGenerator::Sitemap.link_count.should == 13
     end
 

data/spec/sitemap_generator/sitemap_groups_spec.rb

@@ -30,7 +30,7 @@ describe "Sitemap Groups" do
   it "should add default links if no groups are created" do
     @sm.create do
     end
-    @sm.link_count.should == 2
+    @sm.link_count.should == 1
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap_index.xml.gz')
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap1.xml.gz')
   end
@@ -41,7 +41,7 @@ describe "Sitemap Groups" do
       group(:filename => :sitemap_en) { }
       add '/after'
     end
-    @sm.link_count.should == 4
+    @sm.link_count.should == 3
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap_index.xml.gz')
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap1.xml.gz')
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap_en1.xml.gz')
@@ -93,7 +93,7 @@ describe "Sitemap Groups" do
       group(:filename => :second) { add '/four' }
       add 'five'
     end
-    @sm.link_count.should == 7
+    @sm.link_count.should == 6
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap_index.xml.gz')
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap1.xml.gz')
     file_should_exist(SitemapGenerator.app.root + 'public/first1.xml.gz')
@@ -108,7 +108,7 @@ describe "Sitemap Groups" do
       group(:default_host => 'http://betterhost.com') { add '/four' }
       add 'five'
     end
-    @sm.link_count.should == 7
+    @sm.link_count.should == 6
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap_index.xml.gz')
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap1.xml.gz')
     file_should_not_exist(SitemapGenerator.app.root + 'public/sitemap2.xml.gz')
@@ -122,7 +122,7 @@ describe "Sitemap Groups" do
       group(:sitemaps_host => 'http://newhost.com') { add '/four' }
       add 'five'
     end
-    @sm.link_count.should == 7
+    @sm.link_count.should == 6
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap_index.xml.gz')
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap1.xml.gz')
     file_should_exist(SitemapGenerator.app.root + 'public/sitemap2.xml.gz')

data/spec/sitemap_generator/video_sitemap_spec.rb

@@ -100,4 +100,10 @@ describe "SitemapGenerator" do
       doc.at_xpath("//url/video:video/video:#{element}").should be_nil
     end
   end
+
+  it "should not include autoplay param if blank" do
+    xml = video_xml(video_options.tap {|v| v.delete(:autoplay) })
+    doc = video_doc(xml)
+    doc.at_xpath("//url/video:video/video:player_loc").attribute('autoplay').should be_nil
+  end
 end

data/spec/support/schemas/sitemap-mobile.xsd

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xsd:schema
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    targetNamespace="http://www.google.com/schemas/sitemap-mobile/1.0"
+    xmlns="http://www.google.com/schemas/sitemap-mobile/1.0"
+    elementFormDefault="qualified">
+
+<xsd:annotation>
+  <xsd:documentation>
+    XML Schema for the Mobile Sitemap extension. This schema defines the
+    Mobile-specific elements only; the core Sitemap elements are defined
+    separately.
+
+    Help Center documentation for the Mobile Sitemap extension:
+
+      http://www.google.com/support/webmasters/bin/topic.py?topic=8493
+
+    Copyright 2010 Google Inc. All Rights Reserved.
+  </xsd:documentation>
+</xsd:annotation>
+
+<xsd:element name="mobile">
+  <xsd:annotation>
+    <xsd:documentation>
+      Mobile sitemaps just contain an empty "mobile" tag to identify a
+      URL as having mobile content.
+    </xsd:documentation>
+  </xsd:annotation>
+  <xsd:complexType/>
+</xsd:element>
+
+</xsd:schema>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: '3.2'
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-23 00:00:00.000000000Z
+date: 2012-08-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70275948886900 !ruby/object:Gem::Requirement
+  requirement: &70093962414600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275948886900
+  version_requirements: *70093962414600
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70275948886460 !ruby/object:Gem::Requirement
+  requirement: &70093962414160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275948886460
+  version_requirements: *70093962414160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70275948886040 !ruby/object:Gem::Requirement
+  requirement: &70093962413740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275948886040
+  version_requirements: *70093962413740
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70275948885620 !ruby/object:Gem::Requirement
+  requirement: &70093962413320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70275948885620
+  version_requirements: *70093962413320
 description: SitemapGenerator is an XML Sitemap generator written in Ruby with automatic
   Rails integration.  It supports Video, News, Image and Geo sitemaps and includes
   Rake tasks for managing your sitemaps.
@@ -71,6 +71,7 @@ files:
 - README.md
 - VERSION
 - lib/sitemap_generator/adapters/file_adapter.rb
+- lib/sitemap_generator/adapters/s3_adapter.rb
 - lib/sitemap_generator/adapters/wave_adapter.rb
 - lib/sitemap_generator/adapters.rb
 - lib/sitemap_generator/application.rb
@@ -111,6 +112,7 @@ files:
 - spec/sitemap_generator/helpers/number_helper_spec.rb
 - spec/sitemap_generator/interpreter_spec.rb
 - spec/sitemap_generator/link_set_spec.rb
+- spec/sitemap_generator/mobile_sitemap_spec.rb
 - spec/sitemap_generator/news_sitemap_spec.rb
 - spec/sitemap_generator/sitemap_generator_spec.rb
 - spec/sitemap_generator/sitemap_groups_spec.rb
@@ -126,6 +128,7 @@ files:
 - spec/support/file_macros.rb
 - spec/support/schemas/siteindex.xsd
 - spec/support/schemas/sitemap-geo.xsd
+- spec/support/schemas/sitemap-mobile.xsd
 - spec/support/schemas/sitemap-news.xsd
 - spec/support/schemas/sitemap-video.xsd
 - spec/support/schemas/sitemap.xsd
@@ -144,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3037685693484208211
+      hash: 2266016413658369845
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3037685693484208211
+      hash: 2266016413658369845
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -176,6 +179,7 @@ test_files:
 - spec/sitemap_generator/helpers/number_helper_spec.rb
 - spec/sitemap_generator/interpreter_spec.rb
 - spec/sitemap_generator/link_set_spec.rb
+- spec/sitemap_generator/mobile_sitemap_spec.rb
 - spec/sitemap_generator/news_sitemap_spec.rb
 - spec/sitemap_generator/sitemap_generator_spec.rb
 - spec/sitemap_generator/sitemap_groups_spec.rb
@@ -191,6 +195,7 @@ test_files:
 - spec/support/file_macros.rb
 - spec/support/schemas/siteindex.xsd
 - spec/support/schemas/sitemap-geo.xsd
+- spec/support/schemas/sitemap-mobile.xsd
 - spec/support/schemas/sitemap-news.xsd
 - spec/support/schemas/sitemap-video.xsd
 - spec/support/schemas/sitemap.xsd