sitemap_generator 5.0.5 → 5.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 6445cea5741bfbdf3a4a22d3ea49b066283f8877
-  data.tar.gz: 4d7e44c720170f44a3b302d9215b0f39fea0e093
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmIyNzk0YTc4MDcyODYxZTQ4NTFlMDhhOTk3Y2YzZGViZmM4N2U0OA==
+  data.tar.gz: !binary |-
+    NjJhMjBlNmM3NTJjOTg5MzRiYTJlMjlhMjVmNjc0NzQ2N2ZiYWJhYg==
 SHA512:
-  metadata.gz: 5fb21aedf7c06c9b9d9229ab00f9104e7fc177c2d4ae359d193f1766c7cf09826bf39a4a2f0964a020224ffa38494fe6ceda72107da5f22f60db02deaa8acbc7
-  data.tar.gz: 6b858a5b19e875595e17774608bdd9cb73ffeeb5dd7a0c5fa76223a95ee39d3e4fd458b9ab4642cb104708fcab97af79718ebb9c6e2067b064b4d422fe0ae587
+  metadata.gz: !binary |-
+    YWJiY2QyNDgyN2IwM2M2NzVmMDYwYmY5YzFlY2JmMjFlZWM1NmIzNzQ4YzA5
+    NWYwN2ExZTc4OWIyODJlY2ZmNTZlZDVlMmE1MWM3Njc2NmJiMDlkNTYyYWM5
+    NjcxNTE2ZGE3MDFhMWI2NjFjODA2YzQ3YTFiODhkZTI0ZjY0YzA=
+  data.tar.gz: !binary |-
+    YzI5M2E4ZGZjYmFiYWYyZmZhZmM0MzhmYzIzNWE0Y2M0MTFjYzliZDM4ZDkw
+    ZWQ2OTAzZTE3ZDI4ZTQ4ZTg5ZWZmYmM0MjMxMzczZjFkNGI0M2YyOTI1Mjcy
+    OWIyYWI1Y2IzZjg3MWQxOTRmY2YwYjc1YTFiNmE4YWU1YTk1N2M=

data/Gemfile.lock

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

data/README.md

@@ -117,6 +117,7 @@ That's it!  Welcome to the future!
 
 ## Changelog
 
+* v5.1.0: Require only `fog-aws` instead of `fog` for the `S3Adapter` and support using IAM profile instead of setting access key & secret directly.  Implement `respond_to?` on the `SitemapGenerator::Sitemap` pseudo class.  Make `:lang` optional on alternate links so they can be used for [AppIndexing](https://developers.google.com/app-indexing/reference/deeplinks).  Documented [Mobile Sitemaps](#internal_mobile) `:mobile` option.
 * v5.0.5: Use MIT licence.  Fix deploys with Capistrano 3 ([#163](https://github.com/kjvarga/sitemap_generator/issues/163)).  Allow any Fog storage options for S3 adapter ([#167](https://github.com/kjvarga/sitemap_generator/pull/167)).
 * v5.0.4: Don't include the `media` attribute on alternate links unless it's given
 * v5.0.3: Add support for Video sitemaps options `:live` and ':requires_subscription'
@@ -274,7 +275,7 @@ SitemapGenerator::Sitemap.ping_search_engines('http://example.com/sitemap.xml.gz
 
 To keep your sitemaps up-to-date, setup a cron job.  Make sure to pass the `-s` option to silence rake.  That way you will only get email if the sitemap build fails.
 
-If you're using Whenever, your schedule would look something like this:
+If you're using [Whenever](https://github.com/javan/whenever), your schedule would look something like this:
 
 ```ruby
 # config/schedule.rb
@@ -364,7 +365,7 @@ _This section needs better documentation.  Please consider contributing._
 
 * `SitemapGenerator::S3Adapter`
 
-  Uses `fog` to upload to Amazon S3 storage.
+  Uses `fog-aws` to upload to Amazon S3 storage.
 
 * `SitemapGenerator::WaveAdapter`
 
@@ -619,7 +620,7 @@ From this example we can see that:
 * The Rails URL/path helper methods are made available to us, and
 * The basic syntax for adding paths to the sitemap using `add`
 
-You can read more about `add` in the [XML Specification](http://sitemaps.org/protocol.php#xmlTagDefinitions).
+You can read more about `add` in the [XML Specification](http://www.sitemaps.org/protocol.html#xmlTagDefinitions).
 
 ### Supported Options to `add`
 
@@ -659,11 +660,11 @@ add '/about', :priority => 0.75
 
 * `expires` - Optional (Integer, Time, Date, DateTime, String)
 
-  [expires][Request removal of this URL from search engines' indexes].   Example (uses ActiveSupport):
+  [Request removal of this URL from search engines' indexes][expires].   Example (uses ActiveSupport):
 
 ```ruby
 add '/about', :expires => Time.now + 2.weeks
-
+```
 
 ### Adding Links to the Sitemap Index
 
@@ -1044,10 +1045,29 @@ end
 
 * `:alternate`/`:alternates` - Hash or array of hashes, respectively
     * `:href` - Required, string.
-    * `:lang`  - Required, string.
+    * `:lang`  - Optional, string.
     * `:nofollow` - Optional, boolean. Used to mark link as "nofollow".
     * `:media` - Optional, string.  Specify [media targets for responsive design pages][media].
 
+### <a name="internal_mobile"></a> Mobile Sitemaps
+
+Mobile sitemaps include a specific `<mobile:mobile/>` tag.
+
+Check out the Google specification [here][sitemap_mobile].
+
+#### Example
+
+```ruby
+SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+SitemapGenerator::Sitemap.create do
+  add('/index.html', :mobile => true)
+end
+```
+
+#### Supported options
+
+* `:mobile` - Presence of this option will turn on the mobile flag regardless of value.
+
 ## Raison d'être
 
 Most of the Sitemap plugins out there seem to try to recreate the Sitemap links by iterating the Rails routes. In some cases this is possible, but for a great deal of cases it isn't.
@@ -1080,9 +1100,9 @@ Easy hey?
 
 Tested and working on:
 
-* **Rails** 3.0.0, 3.0.7
+* **Rails** 3.0.0, 3.0.7, 4.2.3
 * **Rails** 1.x - 2.3.8
-* **Ruby** 1.8.6, 1.8.7, 1.8.7 Enterprise Edition, 1.9.1, 1.9.2
+* **Ruby** 1.8.6, 1.8.7, 1.8.7 Enterprise Edition, 1.9.1, 1.9.2, 2.1.3
 
 
 ## Known Bugs
@@ -1116,8 +1136,8 @@ Copyright (c) 2009 Karl Varga released under the MIT license
 
 [canonical_repo]:http://github.com/kjvarga/sitemap_generator
 [enterprise_class]:https://twitter.com/dhh/status/1631034662 "I use enterprise in the same sense the Phusion guys do - i.e. Enterprise Ruby. Please don't look down on my use of the word 'enterprise' to represent being a cut above. It doesn't mean you ever have to work for a company the size of IBM. Or constantly fight inertia, writing crappy software, adhering to change management practices and spending hours in meetings... Not that there's anything wrong with that - Wait, what?"
-[sitemaps_org]:http://www.sitemaps.org/protocol.php "http://www.sitemaps.org/protocol.php"
-[sitemaps_xml]:http://www.sitemaps.org/protocol.php#xmlTagDefinitions "XML Tag Definitions"
+[sitemaps_org]:http://www.sitemaps.org/protocol.html "http://www.sitemaps.org/protocol.html"
+[sitemaps_xml]:http://www.sitemaps.org/protocol.html#xmlTagDefinitions "XML Tag Definitions"
 [sitemap_generator_usage]:http://wiki.github.com/adamsalter/sitemap_generator/sitemapgenerator-usage "http://wiki.github.com/adamsalter/sitemap_generator/sitemapgenerator-usage"
 [sitemap_images]:http://www.google.com/support/webmasters/bin/answer.py?answer=178636
 [sitemap_video]:https://support.google.com/webmasters/answer/80471?hl=en&ref_topic=4581190
@@ -1125,7 +1145,7 @@ Copyright (c) 2009 Karl Varga released under the MIT license
 [sitemap_geo]:#
 [sitemap_mobile]:http://support.google.com/webmasters/bin/answer.py?hl=en&answer=34648
 [sitemap_pagemap]:https://developers.google.com/custom-search/docs/structured_data#addtositemap
-[sitemap_protocol]:http://sitemaps.org/protocol.php
+[sitemap_protocol]:http://www.sitemaps.org/protocol.html
 [video_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=80472#4
 [image_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=178636
 [geo_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=94555

data/VERSION

@@ -1 +1 @@
-5.0.5
+5.1.0

data/lib/sitemap_generator.rb

@@ -42,6 +42,10 @@ module SitemapGenerator
         (@link_set ||= reset!).send(*args, &block)
       end
 
+      def respond_to?(name, include_private = false)
+        (@link_set ||= reset!).respond_to?(name, include_private)
+      end
+
       # Use a new LinkSet instance
       def reset!
         @link_set = LinkSet.new

data/lib/sitemap_generator/adapters/s3_adapter.rb

@@ -1,7 +1,7 @@
 begin
-  require 'fog'
+  require 'fog/storage'
 rescue LoadError
-  raise LoadError.new("Missing required 'fog'.  Please 'gem install fog' and require it in your application.")
+  raise LoadError.new("Missing required 'fog-aws'.  Please 'gem install fog-aws' and require it in your application.")
 end
 
 module SitemapGenerator
@@ -21,11 +21,15 @@ module SitemapGenerator
     def write(location, raw_data)
       SitemapGenerator::FileAdapter.new.write(location, raw_data)
 
-      credentials = {
-        :aws_access_key_id     => @aws_access_key_id,
-        :aws_secret_access_key => @aws_secret_access_key,
-        :provider              => @fog_provider,
-      }
+      credentials = { :provider => @fog_provider }
+
+      if @aws_access_key_id && @aws_secret_access_key
+        credentials[:aws_access_key_id] = @aws_access_key_id
+        credentials[:aws_secret_access_key] = @aws_secret_access_key
+      else
+        credentials[:use_iam_profile] = true
+      end
+
       credentials[:region] = @fog_region if @fog_region
       credentials[:path_style] = @fog_path_style if @fog_path_style
 

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -136,7 +136,8 @@ module SitemapGenerator
 
           self[:alternates].each do |alternate|
             rel = alternate[:nofollow] ? 'alternate nofollow' : 'alternate'
-            attributes = { :rel => rel, :hreflang => alternate[:lang].to_s, :href => alternate[:href].to_s }
+            attributes = { :rel => rel, :href => alternate[:href].to_s }
+            attributes[:hreflang] = alternate[:lang].to_s if SitemapGenerator::Utilities.present?(alternate[:lang])
             attributes[:media] = alternate[:media].to_s if SitemapGenerator::Utilities.present?(alternate[:media])
             builder.xhtml :link, attributes
           end

data/lib/sitemap_generator/sitemap_location.rb

@@ -41,7 +41,7 @@ module SitemapGenerator
     # * <tt>:verbose</tt> - whether to output summary into to STDOUT.  Default +false+.
     # * <tt>:create_index</tt> - whether to create a sitemap index.  Default `:auto`.  See <tt>LinkSet::create_index=</tt>
     #   for possible values. Only applies to the SitemapIndexLocation object.
-    # * <tt>compress</tt> - The LinkSet compress setting.  Default: true.  If `false` any `.gz` extension is
+    # * <tt>compress</tt> - The LinkSet compress setting.  Default: +true+.  If `false` any `.gz` extension is
     #   stripped from the filename.  If `:all_but_first`, only the `.gz` extension of the first
     #   filename is stripped off.  If `true` the extensions are left unchanged.
     def initialize(opts={})

data/spec/sitemap_generator/alternate_sitemap_spec.rb

@@ -24,6 +24,27 @@ describe "SitemapGenerator" do
     alternate.attribute('media').should be_nil
   end
 
+  it "should not include hreflang element unless provided" do
+    xml_fragment = SitemapGenerator::Builder::SitemapUrl.new('link_with_alternates.html',
+                                                             :host => 'http://www.example.com',
+                                                             :alternates => [
+                                                                 {
+                                                                     :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').should be_nil
+  end
+
   it "should add alternate links to sitemap" do
     xml_fragment = SitemapGenerator::Builder::SitemapUrl.new('link_with_alternates.html',
       :host => 'http://www.example.com',

data/spec/sitemap_generator/sitemap_generator_spec.rb

@@ -549,6 +549,15 @@ describe "SitemapGenerator" do
     end
   end
 
+  describe "respond_to?" do
+    it "should correctly identify the methods that it responds to" do
+      SitemapGenerator::Sitemap.respond_to?(:create).should be_true
+      SitemapGenerator::Sitemap.respond_to?(:adapter).should be_true
+      SitemapGenerator::Sitemap.respond_to?(:default_host).should be_true
+      SitemapGenerator::Sitemap.respond_to?(:invalid_func).should be_false
+    end
+  end
+
   protected
 
   #

metadata

@@ -1,69 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 5.0.5
+  version: !binary |-
+    NS4xLjA=
 platform: ruby
 authors:
 - Karl Varga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2015-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: SitemapGenerator is a framework-agnostic XML Sitemap generator written
@@ -78,25 +79,26 @@ files:
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- Rakefile
 - README.md
+- Rakefile
 - VERSION
 - lib/capistrano/sitemap_generator.rb
 - lib/capistrano/tasks/sitemap_generator.cap
+- lib/sitemap_generator.rb
+- lib/sitemap_generator/adapters.rb
 - lib/sitemap_generator/adapters/file_adapter.rb
 - lib/sitemap_generator/adapters/fog_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
+- lib/sitemap_generator/builder.rb
 - lib/sitemap_generator/builder/sitemap_file.rb
 - lib/sitemap_generator/builder/sitemap_index_file.rb
 - lib/sitemap_generator/builder/sitemap_index_url.rb
 - lib/sitemap_generator/builder/sitemap_url.rb
-- lib/sitemap_generator/builder.rb
+- lib/sitemap_generator/core_ext.rb
 - lib/sitemap_generator/core_ext/big_decimal.rb
 - lib/sitemap_generator/core_ext/numeric.rb
-- lib/sitemap_generator/core_ext.rb
 - lib/sitemap_generator/helpers/number_helper.rb
 - lib/sitemap_generator/interpreter.rb
 - lib/sitemap_generator/link_set.rb
@@ -106,11 +108,9 @@ files:
 - lib/sitemap_generator/tasks.rb
 - lib/sitemap_generator/templates.rb
 - lib/sitemap_generator/utilities.rb
-- lib/sitemap_generator.rb
 - lib/tasks/sitemap_generator_tasks.rake
 - rails/install.rb
 - rails/uninstall.rb
-- templates/sitemap.rb
 - spec/blueprint.rb
 - spec/files/sitemap.create.rb
 - spec/files/sitemap.groups.rb
@@ -151,34 +151,41 @@ files:
 - spec/support/schemas/sitemap-video.xsd
 - spec/support/schemas/sitemap.xsd
 - spec/support/xml_macros.rb
+- templates/sitemap.rb
 homepage: http://github.com/kjvarga/sitemap_generator
 licenses:
 - MIT
 metadata: {}
-post_install_message: |
-  NOTE: SitemapGenerator 4.x uses a new file naming scheme which is more standards-compliant.
-  If you're upgrading from 3.x, please see the release note in the README:
+post_install_message: ! 'NOTE: SitemapGenerator 4.x uses a new file naming scheme
+  which is more standards-compliant.
+
+  If you''re upgrading from 3.x, please see the release note in the README:
+
 
   https://github.com/kjvarga/sitemap_generator#important-changes-in-version-4
 
+
   The simple answer is that your index file is now called sitemap.xml.gz
+
   and not sitemap_index.xml.gz, but please take a look and see what else has changed.
+
+'
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Easily generate XML Sitemaps