sitemap_generator 3.3 → 3.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ./
   specs:
-    sitemap_generator (3.3)
+    sitemap_generator (3.4)
       builder
 
 GEM

data/README.md

@@ -7,7 +7,7 @@ Sitemaps adhere to the [Sitemap 0.9 protocol][sitemap_protocol] specification.
 ## Features
 
 * Framework agnostic
-* Supports [News sitemaps][sitemap_news], [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], [Geo sitemaps][sitemap_geo] and [Mobile sitemaps][sitemap_mobile]
+* Supports [News sitemaps][sitemap_news], [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], [Geo sitemaps][sitemap_geo], [Mobile sitemaps][sitemap_mobile] and [Alternate Links][alternate_links]
 * Supports read-only filesystems like Heroku via uploading to a remote host like Amazon S3
 * Compatible with Rails 2 & 3
 * Adheres to the [Sitemap 0.9 protocol][sitemap_protocol]
@@ -17,7 +17,6 @@ Sitemaps adhere to the [Sitemap 0.9 protocol][sitemap_protocol] specification.
 * Ensures your old sitemaps stay in place if the new sitemap fails to generate
 * Gives you complete control over your sitemaps and their content
 
-
 ### Show Me
 
 Install:
@@ -69,6 +68,7 @@ Does your website use SitemapGenerator to generate Sitemaps?  Where would you be
 
 ## Changelog
 
+* v3.4: Support [alternate links][alternate_links] for urls; Support configurable options in the `SitemapGenerator::S3Adapter`
 * v3.3: **Support creating sitemaps with no index file**.  A big thank-you to [Eric Hochberger][ehoch] for generously paying for this feature.
 * v3.2.1: Fix syntax error in SitemapGenerator::S3Adapter
 * v3.2: **Support mobile tags**, **SitemapGenerator::S3Adapter** a simple S3 adapter which uses Fog and doesn't require CarrierWave; Remove Ask from the sitemap ping because the service has been shutdown; [Turn off `include_index`][include_index_change] by default; Fix the news XML namespace;  Only include autoplay attribute if present
@@ -498,6 +498,8 @@ You can read more about `add` in the [XML Specification](http://sitemaps.org/pro
 
 ### Supported Options to `add`
 
+For other options be sure to check out the **Sitemap Extensions** section below.
+
 * `changefreq` - Default: `'weekly'` (String).
 
   Indicates how often the content of the page changes.  One of `'always'`, `'hourly'`, `'daily'`, `'weekly'`, `'monthly'`, `'yearly'` or `'never'`.  Example:
@@ -744,14 +746,14 @@ end
 
 #### Supported options
 
-* `publication_name`
-* `publication_language`
-* `publication_date`
-* `genres`
-* `access`
-* `title`
-* `keywords`
-* `stock_tickers`
+* `:publication_name`
+* `:publication_language`
+* `:publication_date`
+* `:genres`
+* `:access`
+* `:title`
+* `:keywords`
+* `:stock_tickers`
 
 
 ### Image Sitemaps
@@ -770,11 +772,11 @@ end
 
 #### Supported options
 
-* `loc` Required, location of the image
-* `caption`
-* `geo_location`
-* `title`
-* `license`
+* `:loc` Required, location of the image
+* `:caption`
+* `:geo_location`
+* `:title`
+* `:license`
 
 
 ### Video Sitemaps
@@ -816,7 +818,32 @@ end
 
 #### Supported options
 
-* `format` Required, either 'kml' or 'georss'
+* `:format` Required, either 'kml' or 'georss'
+
+
+### Alternate Links
+
+A useful feature for internationalization is to specify alternate links for a url.
+
+Alternate links can be added by passing an `:alternate` Hash to `add`. You can pass more than one alternate link by passing an array of hashes using the `:alternates` option.
+
+Check out the Google specification [here][alternate_links].
+
+#### Example
+
+```ruby
+SitemapGenerator::Sitemap.create do
+  add('/index.html', :alternate => {
+    :href => 'http://www.example.de/index.html',
+    :lang => 'de'
+  })
+end
+```
+
+#### Supported options
+
+* `:href` - Required, string.
+* `:lang`  - Required, string.
 
 
 ## Raison d'être
@@ -901,3 +928,4 @@ Copyright (c) 2009 Karl Varga released under the MIT license
 [remote_hosts]:https://github.com/kjvarga/sitemap_generator/wiki/Generate-Sitemaps-on-read-only-filesystems-like-Heroku
 [include_index_change]:https://github.com/kjvarga/sitemap_generator/issues/70
 [ehoch]:https://github.com/ehoch
+[alternate_links]:http://support.google.com/webmasters/bin/answer.py?hl=en&answer=2620865

data/VERSION

@@ -1 +1 @@
-3.3
+3.4

data/lib/sitemap_generator/adapters/s3_adapter.rb

@@ -3,23 +3,31 @@ require 'fog'
 module SitemapGenerator
   class S3Adapter
 
+    def initialize(opts = {})
+      @aws_access_key_id = opts[:aws_access_key_id] || ENV['AWS_ACCESS_KEY_ID']
+      @aws_secret_access_key = opts[:aws_secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY']
+      @fog_provider = opts[:fog_provider] || ENV['FOG_PROVIDER']
+      @fog_directory = opts[:fog_directory] || ENV['FOG_DIRECTORY']
+    end
+
     # 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'],
+        :aws_access_key_id     => @aws_access_key_id,
+        :aws_secret_access_key => @aws_secret_access_key,
+        :provider              => @fog_provider,
       }
-      
+
       storage   = Fog::Storage.new(credentials)
-      directory = storage.directories.get(ENV['FOG_DIRECTORY'])
+      directory = storage.directories.get(@fog_directory)
       directory.files.create(
-        :key    => location.path_in_public, 
+        :key    => location.path_in_public,
         :body   => File.open(location.path),
         :public => true
       )
     end
+
   end
 end

data/lib/sitemap_generator/builder/sitemap_file.rb

@@ -36,6 +36,7 @@ module SitemapGenerator
               xmlns:geo="http://www.google.com/geo/schemas/sitemap/1.0"
               xmlns:news="http://www.google.com/schemas/sitemap-news/0.9"
               xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0"
+              xmlns:xhtml="http://www.w3.org/1999/xhtml"
             >
         HTML
         @xml_wrapper_start.gsub!(/\s+/, ' ').gsub!(/ *> */, '>').strip!

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -27,6 +27,7 @@ module SitemapGenerator
       # * +geo+
       # * +news+
       # * +mobile+
+      # * +alternate+/+alternates+
       def initialize(path, options={})
         options = options.dup
         if sitemap = path.is_a?(SitemapGenerator::Builder::SitemapFile) && path
@@ -34,12 +35,15 @@ module SitemapGenerator
           path = sitemap.location.path_in_public
         end
 
-        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)
+        SitemapGenerator::Utilities.assert_valid_keys(options, :priority, :changefreq, :lastmod, :host, :images, :video, :geo, :news, :videos, :mobile, :alternate, :alternates)
+        SitemapGenerator::Utilities.reverse_merge!(options, :priority => 0.5, :changefreq => 'weekly', :lastmod => Time.now, :images => [], :news => {}, :videos => [], :mobile => false, :alternates => [])
         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
         end
+        if alternate = options.delete(:alternate)
+          options[:alternates] = alternate.is_a?(Array) ? options[:alternates].concat(alternate) : options[:alternates] << alternate
+        end
 
         path = path.to_s.sub(/^\//, '')
         loc  = path.empty? ? options[:host] : (options[:host].to_s.sub(/\/$/, '') + '/' + path)
@@ -53,7 +57,8 @@ module SitemapGenerator
           :news       => prepare_news(options[:news]),
           :videos     => options[:videos],
           :geo        => options[:geo],
-          :mobile     => options[:mobile]
+          :mobile     => options[:mobile],
+          :alternates => options[:alternates]
         )
       end
 
@@ -120,6 +125,10 @@ module SitemapGenerator
             end
           end
 
+          self[:alternates].each do |alternate|
+            builder.xhtml :link, :rel => 'alternate', :hreflang => alternate[:lang], :href => alternate[:href]
+          end
+
           unless SitemapGenerator::Utilities.blank?(self[:geo])
             geo = self[:geo]
             builder.geo :geo do

data/spec/sitemap_generator/alternate_sitemap_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "SitemapGenerator" do
+
+  it "should add alternate links to sitemap" do
+    xml_fragment = SitemapGenerator::Builder::SitemapUrl.new('link_with_alternates.html',
+      :host => 'http://www.example.com',
+      :alternates => [
+        {
+          :lang => 'de',
+          :href => 'http://www.example.de/link_with_alternate.html'
+        }
+      ]
+    ).to_xml
+
+    doc = Nokogiri::XML.parse("<root xmlns='http://www.sitemaps.org/schemas/sitemap/0.9' xmlns:xhtml='http://www.w3.org/1999/xhtml'>#{xml_fragment}</root>")
+    url = doc.css('url')
+    url.should_not be_nil
+    url.css('loc').text.should == 'http://www.example.com/link_with_alternates.html'
+
+    alternate = url.at_xpath('xhtml:link')
+    alternate.should_not be_nil
+    alternate.attribute('rel').value.should == 'alternate'
+    alternate.attribute('hreflang').value.should == 'de'
+    alternate.attribute('href').value.should == 'http://www.example.de/link_with_alternate.html'
+  end
+
+end

data/spec/sitemap_generator/builder/sitemap_url_spec.rb

@@ -67,6 +67,21 @@ describe SitemapGenerator::Builder::SitemapUrl do
     loc[:videos].should == [3,4,1,2]
   end
 
+  it "should support a :alternates option" do
+    loc = SitemapGenerator::Builder::SitemapUrl.new('', :host => 'http://test.com', :alternates => [1,2,3])
+    loc[:alternates].should == [1,2,3]
+  end
+
+  it "should support a singular :alternate option" do
+    loc = SitemapGenerator::Builder::SitemapUrl.new('', :host => 'http://test.com', :alternate => 1)
+    loc[:alternates].should == [1]
+  end
+
+  it "should support an array :alternate option" do
+    loc = SitemapGenerator::Builder::SitemapUrl.new('', :host => 'http://test.com', :alternate => [1,2], :alternates => [3,4])
+    loc[:alternates].should == [3,4,1,2]
+  end
+
   it "should not fail if invalid characters are used in the URL" do
     special = ':$&+,;:=?@'
     url = SitemapGenerator::Builder::SitemapUrl.new("/#{special}", :host => "http://example.com/#{special}/")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: '3.3'
+  version: '3.4'
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-10-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70307560374840 !ruby/object:Gem::Requirement
+  requirement: &70204620843820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70307560374840
+  version_requirements: *70204620843820
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70307560374400 !ruby/object:Gem::Requirement
+  requirement: &70204620843380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70307560374400
+  version_requirements: *70204620843380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70307560373980 !ruby/object:Gem::Requirement
+  requirement: &70204620842960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70307560373980
+  version_requirements: *70204620842960
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70307560373560 !ruby/object:Gem::Requirement
+  requirement: &70204620842540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70307560373560
+  version_requirements: *70204620842540
 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.
@@ -101,6 +101,7 @@ files:
 - spec/files/sitemap.create.rb
 - spec/files/sitemap.deprecated.rb
 - spec/files/sitemap.groups.rb
+- spec/sitemap_generator/alternate_sitemap_spec.rb
 - spec/sitemap_generator/application_spec.rb
 - spec/sitemap_generator/builder/sitemap_file_spec.rb
 - spec/sitemap_generator/builder/sitemap_index_file_spec.rb
@@ -147,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -845779486658727923
+      hash: -4570809208005834438
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -845779486658727923
+      hash: -4570809208005834438
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -168,6 +169,7 @@ test_files:
 - spec/files/sitemap.create.rb
 - spec/files/sitemap.deprecated.rb
 - spec/files/sitemap.groups.rb
+- spec/sitemap_generator/alternate_sitemap_spec.rb
 - spec/sitemap_generator/application_spec.rb
 - spec/sitemap_generator/builder/sitemap_file_spec.rb
 - spec/sitemap_generator/builder/sitemap_index_file_spec.rb