sitemap_generator 2.1.7 → 2.1.8

data/Gemfile

@@ -11,14 +11,18 @@ gem 'rspec-rails', '~>1.3.2', :require => 'spec/rails'
 # Simplify these dependencies
 gem 'git', '1.2.5'
 gem 'jeweler', '=1.4.0'
-gem 'github', '0.4.5'
+gem 'github', '0.4.5' # comment out to test on 1.9; removed in framework_agnostic
 gem 'gemcutter', '0.6.1'
 
 # These seem to be dependencies of jeweler or one of the other gems
 gem 'nokogiri', '1.4.4'
 gem 'sqlite3-ruby', '1.3.1', :require => 'sqlite3'
 
-group :test do
-  gem 'ruby-debug', '~>0.10'
-  gem 'ruby-debug-base', '~>0.10'
-end
+#group :test do
+#  gem 'ruby-debug', '~>0.10'
+#  gem 'ruby-debug-base', '~>0.10'
+#end
+# group :test do
+#  gem 'ruby-debug-base19', '0.11.26'
+#  gem 'ruby-debug19'
+# end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ./
   specs:
-    sitemap_generator (2.1.7)
+    sitemap_generator (2.1.8)
 
 GEM
   remote: http://rubygems.org/
@@ -16,7 +16,6 @@ GEM
     activeresource (2.3.8)
       activesupport (= 2.3.8)
     activesupport (2.3.8)
-    columnize (0.3.4)
     gemcutter (0.6.1)
     git (1.2.5)
     github (0.4.5)
@@ -28,11 +27,9 @@ GEM
       gemcutter (>= 0.1.0)
       git (>= 1.2.5)
       rubyforge (>= 2.0.0)
-    json (1.5.4)
+    json (1.6.2)
     json_pure (1.5.4)
       spruz (~> 0.2.8)
-    linecache (0.46)
-      rbx-require-relative (> 0.0.4)
     mocha (0.9.10)
       rake
     nokogiri (1.4.4)
@@ -45,16 +42,10 @@ GEM
       activesupport (= 2.3.8)
       rake (>= 0.8.3)
     rake (0.9.2.2)
-    rbx-require-relative (0.0.5)
     rspec (1.3.1)
     rspec-rails (1.3.4)
       rack (>= 1.0.0)
       rspec (~> 1.3.1)
-    ruby-debug (0.10.3)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.3.0)
-    ruby-debug-base (0.10.3)
-      linecache (>= 0.3)
     rubyforge (2.0.4)
       json_pure (>= 1.1.7)
     spruz (0.2.13)
@@ -77,7 +68,5 @@ DEPENDENCIES
   rake (>= 0.8.7)
   rspec (= 1.3.1)
   rspec-rails (~> 1.3.2)
-  ruby-debug (~> 0.10)
-  ruby-debug-base (~> 0.10)
   sitemap_generator!
   sqlite3-ruby (= 1.3.1)

data/README.md

@@ -12,7 +12,7 @@ Features
 - Adheres to the [Sitemap 0.9 protocol][sitemap_protocol]
 - Handles millions of links
 - Automatically compresses your sitemaps
-- Notifies search engines (Google, Yahoo, Bing, Ask, SitemapWriter) of new sitemaps
+- Notifies search engines (Google, Bing, Ask, SitemapWriter) of new sitemaps
 - Ensures your old sitemaps stay in place if the new sitemap fails to generate
 - Gives you complete control over your sitemaps and their content
 
@@ -26,6 +26,7 @@ Does your website use SitemapGenerator to generate Sitemaps?  Where would you be
 Changelog
 -------
 
+- v2.1.8: Extend and improve Video Sitemap support.  Include sitemap docs in the README, support all element attributes, properly format values.
 - v2.1.7: Improve format of float priorities; Remove Yahoo from ping - the Yahoo
           service has been shut down.
 - v2.1.6: Fix the lastmod value on sitemap file links
@@ -109,9 +110,7 @@ Run `rake sitemap:refresh` as needed to create or rebuild your sitemap files.  S
 Search Engine Notification
 -----
 
-Using `rake sitemap:refresh` will notify major search engines to let them know that a new sitemap is available (Google, Yahoo, Bing, Ask, SitemapWriter).  To generate new sitemaps without notifying search engines (for example when running in a local environment) use `rake sitemap:refresh:no_ping`.
-
-To ping Yahoo you will need to set your Yahoo AppID in `config/sitemap.rb`.  For example: `SitemapGenerator::Sitemap.yahoo_app_id = "my_app_id"`
+Using `rake sitemap:refresh` will notify major search engines to let them know that a new sitemap is available (Google, Bing, Ask, SitemapWriter).  To generate new sitemaps without notifying search engines (for example when running in a local environment) use `rake sitemap:refresh:no_ping`.
 
 Crontab
 -----
@@ -213,7 +212,7 @@ overwrite each other.  You can use the `filename`, `sitemaps_namer` and `sitemap
 
 In the following example we generate three sitemaps each in its own subdirectory:
 
-    %w(google yahoo apple).each do |subdomain|
+    %w(google bing apple).each do |subdomain|
       SitemapGenerator::Sitemap.default_host = "https://#{subdomain}.mysite.com"
       SitemapGenerator::Sitemap.sitemaps_path = "sitemaps/#{subdomain}"
       SitemapGenerator::Sitemap.create do
@@ -226,8 +225,8 @@ Outputs:
     + sitemaps/google/sitemap1.xml.gz             2 links /  822 Bytes /  328 Bytes gzipped
     + sitemaps/google/sitemap_index.xml.gz          1 sitemaps /  389 Bytes /  217 Bytes gzipped
     Sitemap stats: 2 links / 1 sitemaps / 0m00s
-    + sitemaps/yahoo/sitemap1.xml.gz             2 links /  820 Bytes /  330 Bytes gzipped
-    + sitemaps/yahoo/sitemap_index.xml.gz          1 sitemaps /  388 Bytes /  217 Bytes gzipped
+    + sitemaps/bing/sitemap1.xml.gz             2 links /  820 Bytes /  330 Bytes gzipped
+    + sitemaps/bing/sitemap_index.xml.gz          1 sitemaps /  388 Bytes /  217 Bytes gzipped
     Sitemap stats: 2 links / 1 sitemaps / 0m00s
     + sitemaps/apple/sitemap1.xml.gz             2 links /  820 Bytes /  330 Bytes gzipped
     + sitemaps/apple/sitemap_index.xml.gz          1 sitemaps /  388 Bytes /  214 Bytes gzipped
@@ -249,9 +248,9 @@ If you don't want to have to generate all the sitemaps at once, or you want to r
       add '/home'
     end
 
-    # config/yahoo_sitemap.rb
-    SitemapGenerator::Sitemap.default_host = "https://yahoo.mysite.com"
-    SitemapGenerator::Sitemap.sitemaps_path = "sitemaps/yahoo"
+    # config/bing_sitemap.rb
+    SitemapGenerator::Sitemap.default_host = "https://bing.mysite.com"
+    SitemapGenerator::Sitemap.sitemaps_path = "sitemaps/bing"
     SitemapGenerator::Sitemap.create do
       add '/home'
     end
@@ -260,7 +259,7 @@ To generate each one specify the configuration file to run by passing the `CONFI
 
     rake sitemap:refresh CONFIG_FILE="config/google_sitemap.rb"
     rake sitemap:refresh CONFIG_FILE="config/apple_sitemap.rb"
-    rake sitemap:refresh CONFIG_FILE="config/yahoo_sitemap.rb"
+    rake sitemap:refresh CONFIG_FILE="config/bing_sitemap.rb"
 
 Sitemap Configuration
 ======
@@ -523,7 +522,9 @@ Sitemap Extensions
 News Sitemaps
 -----------
 
-A news item can be added to a sitemap URL by passing a `:news` hash to `add`.  The hash must  contain tags defined by the [News Sitemap][news_tags] specification.  For example:
+A news item can be added to a sitemap URL by passing a `:news` hash to `add`.  The hash must  contain tags defined by the [News Sitemap][news_tags] specification.
+
+### Example
 
     SitemapGenerator::Sitemap.create do
       add('/index.html', :news => {
@@ -538,7 +539,7 @@ A news item can be added to a sitemap URL by passing a `:news` hash to `add`.  T
       })
     end
 
-Supported news options include:
+### Supported options
 
 * `publication_name`
 * `publication_language`
@@ -549,10 +550,13 @@ Supported news options include:
 * `keywords`
 * `stock_tickers`
 
+* * *
 Image Sitemaps
 -----------
 
-Images can be added to a sitemap URL by passing an `:images` array to `add`.  Each item in the array must be a Hash containing tags defined by the [Image Sitemap][image_tags] specification.  For example:
+Images can be added to a sitemap URL by passing an `:images` array to `add`.  Each item in the array must be a Hash containing tags defined by the [Image Sitemap][image_tags] specification.
+
+### Example
 
     SitemapGenerator::Sitemap.create do
       add('/index.html', :images => [{
@@ -560,7 +564,7 @@ Images can be added to a sitemap URL by passing an `:images` array to `add`.  Ea
         :title => 'Image' }])
     end
 
-Supported image options include:
+### Supported options
 
 * `loc` Required, location of the image
 * `caption`
@@ -568,16 +572,15 @@ Supported image options include:
 * `title`
 * `license`
 
+* * *
 Video Sitemaps
 -----------
 
-A video can be added to a sitemap URL by passing a `:video` Hash to `add`.  The Hash can contain tags defined by the [Video Sitemap specification][video_tags].
+A video can be added to a sitemap URL by passing a `:video` Hash to `add()`.  The Hash can contain tags defined by the [Video Sitemap specification][video_tags].
 
 To add more than one video to a url, pass an array of video hashes using the `:videos` option.
 
-To associate more than one `tag` with a video, pass the tags as an array with the key `:tags`.
-
-Example:
+### Example
 
     add('/index.html', :video => {
       :thumbnail_loc => 'http://www.example.com/video1_thumbnail.png',
@@ -588,35 +591,97 @@ Example:
       :category => 'Category'
     })
 
-Supported video options include:
-
-* `thumbnail_loc` Required
-* `title` Required
-* `description` Required
-* `content_loc` Depends.  At least one of `player_loc` or `content_loc` is required
-* `player_loc` Depends. At least one of `player_loc` or `content_loc` is required
-* `expiration_date` Recommended
-* `duration` Recommended
-* `rating`
-* `view_count`
-* `publication_date`
-* `family_friendly`
-* `tags` A list of tags if more than one tag.
-* `tag` A single tag.  See `tags`
-* `category`
-* `gallery_loc`
-* `uploader` (use `uploader_info` to set the info attribute)
+### Supported options
+
+* `:thumbnail_loc` - Required, string.
+
+  A URL pointing to the URL for the video thumbnail image file. We can accept most image sizes/types but recommend your thumbs are at least at least 640x480 pixels in .jpg, .png, or. gif formats. The max size is 1920 x 1080 pixels.
+
+* `:title` - Required, string.
+
+  The title of the video. Limited to 100 characters.
+
+* `:description` - Required, string.
+
+  The description of the video. Descriptions longer than 2048 characters will be truncated.
+
+* `:content_loc` - String. **At least one of `player_loc` or `content_loc` is required.**
+
+  The URL should point to a .mpg, .mpeg, .mp4, .m4v, .mov, .wmv, .asf, .avi, .ra, .ram, .rm, .flv, or other video file format, and can be omitted if `:player_loc` is specified. However, because Google needs to be able to check that the Flash object is actually a player for video (as opposed to some other use of Flash, e.g. games and animations), it's helpful to provide both.
+
+* `:player_loc` - String. **At least one of `player_loc` or `content_loc` is required.**
+
+  A URL pointing to a Flash player for a specific video. In general, this is the information in the src element of an <embed> tag and should not be the same as the content of the <loc> tag. ​Since each video is uniquely identified by its content URL (the location of the actual video file) or, if a content URL is not present, a player URL (a URL pointing to a player for the video), you must include either the `:player_loc` or `:content_loc` options. If these options are omitted and we can't find this information, we'll be unable to index your video.
+
+  Attributes:
+  * `:allow_embed` - Optional.  Values: boolean, or string 'yes' or 'no'.  Default: 'yes'.
+
+     Specifies whether Google can embed the video in search results.
+  * `:autoplay` - String, user defined.
+
+     A user-defined string that Google may append (if appropriate) to the flashvars parameter to enable autoplay of the video. For example: <embed src="http://www.example.com/videoplayer.swf?video=123" autoplay="ap=1"/>
+
+* `:expiration_date` - Recommended.  Values: Date, DateTime, Time, ActiveSupport::TimeWithZone or String.
+
+  The date after which the video will no longer be available.  Don't supply this information if your video does not expire.  Ruby date and time objects will be formatted for you in the appropriate W3C format.  However, if you are passing a string, follow these guidelines: acceptable values are complete date (YYYY-MM-DD) and complete date plus hours, minutes and seconds, and timezone (YYYY-MM-DDThh:mm:ss+TZD). For example, 2007-07-16T19:20:30+08:00.
+
+* `:duration` - Recommended. Integer.
 
+  The duration of the clip in seconds.
 
+* `:rating` - Optional.  The value must be a float or integer between 0.0 and 5.0.
 
+  The rating of the video.
+
+* `:view_count` - Optional, integer.
+
+  The number of times the video has been viewed.
+
+* `:publication_date` - Optional. Values: Date, DateTime, Time, ActiveSupport::TimeWithZone or String.
+
+  The date the video was first published. Ruby date and time objects will be formatted for you in the appropriate W3C format.  However, if you are passing a string, follow these guidelines: acceptable values are complete date (YYYY-MM-DD) and complete date plus hours, minutes and seconds, and timezone (YYYY-MM-DDThh:mm:ss+TZD). For example, 2007-07-16T19:20:30+08:00.
+
+* `:family_friendly` - Optional.  Values: boolean, or string 'yes' or 'no'.
+
+  Whether the video is suitable for viewing by children.  If `No` the video is only available to users with SafeSearch turned off.
+
+* `:tags` - Optional. A list of one or more string tags.  A maximum of 32 tags is permitted.
+
+* `:tag` - Optional.  String.  A single tag.  If the video has more than one tag, use `:tags`.
+
+  A tag associated with the video. Tags are generally very short descriptions of key concepts associated with a video or piece of content. A single video could have several tags, although it might belong to only one category. For example, a video about grilling food may belong in the Grilling category, but could be tagged "steak", "meat", "summer", and "outdoor".
+
+* `:category` - Optional, string.
+
+  The video's category. For example, cooking. The value should be a string no longer than 256 characters. In general, categories are broad groupings of content by subject. Usually a video will belong to a single category. For example, a site about cooking could have categories for Broiling, Baking, and Grilling.
+
+* `:gallery_loc` - Optional, string.
+
+  A link to the gallery (collection of videos) in which this video appears. Only one <video:gallery_loc> tag can be listed for each video.
+
+  Attributes:
+  * `:gallery_title` - Optional, string.  The title of the gallery.  Sets the `title` attribute of the <video:gallery_loc> tag.
+
+* `:uploader` - Optional, string.
+
+  A name or handle of the video’s uploader. Only one <video:uploader> is allowed per video.
+
+  Attributes:
+  * `:uploader_info` - Optional, string.  Specifies the URL of a webpage with additional information about this uploader. This URL must be on the same domain as the <loc> tag. Sets the `info` attribute of the <video:uploader_info> tag.
+
+* * *
 Geo Sitemaps
 -----------
 
 Pages with geo data can be added by passing a `:geo` Hash to `add`.  The Hash only supports one tag of `:format`.  Google provides an [example of a geo sitemap link here][geo_tags].  Note that the sitemap does not actually contain your KML or GeoRSS.  It merely links to a page that has this content.
 
-    add('/stores/1234.xml', :geo => { :format => 'kml' })
+### Example:
+
+    SitemapGenerator::Sitemap.create do
+      add('/stores/1234.xml', :geo => { :format => 'kml' })
+    end
 
-Supported geo options include:
+### Supported options
 
 * `format` Required, either 'kml' or 'georss'
 

data/VERSION

@@ -1 +1 @@
-2.1.7
+2.1.8

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -1,5 +1,7 @@
 require 'builder'
 require 'uri'
+require 'time'
+require 'date'
 
 module SitemapGenerator
   module Builder
@@ -59,9 +61,9 @@ module SitemapGenerator
         builder = ::Builder::XmlMarkup.new if builder.nil?
         builder.url do
           builder.loc        self[:loc]
-          builder.lastmod    w3c_date(self[:lastmod])   if self[:lastmod]
-          builder.changefreq self[:changefreq]          if self[:changefreq]
-          builder.priority   '%0.1f'%self[:priority]    if self[:priority]
+          builder.lastmod    w3c_date(self[:lastmod])      if self[:lastmod]
+          builder.changefreq self[:changefreq]             if self[:changefreq]
+          builder.priority   format_float(self[:priority]) if self[:priority]
 
           unless self[:news].blank?
             news_data = self[:news]
@@ -97,20 +99,18 @@ 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 => (video[:allow_embed] ? 'yes' : 'no'), :autoplay => video[:autoplay]
+                builder.video :player_loc, video[:player_loc], :allow_embed => yes_or_no_with_default(video[:allow_embed], true), :autoplay => video[:autoplay]
               end
-
-              builder.video :rating, video[:rating]                     if video[:rating]
-              builder.video :view_count, video[:view_count]             if video[:view_count]
-              builder.video :publication_date, video[:publication_date] if video[:publication_date]
-              builder.video :expiration_date, video[:expiration_date]   if video[:expiration_date]
-              builder.video :family_friendly, (video[:family_friendly] ? 'yes' : 'no')  if video[:family_friendly]
               builder.video :duration, video[:duration]                 if video[:duration]
+              builder.video :expiration_date,  w3c_date(video[:expiration_date])  if video[:expiration_date]
+              builder.video :rating, format_float(video[:rating])       if video[:rating]
+              builder.video :view_count, video[:view_count]             if video[:view_count]
+              builder.video :publication_date, w3c_date(video[:publication_date]) if video[:publication_date]
               video[:tags].each {|tag| builder.video :tag, tag }        if video[:tags]
               builder.video :tag, video[:tag]                           if video[:tag]
               builder.video :category, video[:category]                 if video[:category]
-              builder.video :gallery_loc, video[:gallery_loc]           if video[:gallery_loc]
-
+              builder.video :family_friendly,  yes_or_no_with_default(video[:family_friendly], true) if video.has_key?(:family_friendly)
+              builder.video :gallery_loc, video[:gallery_loc], :title => video[:gallery_title] if video[:gallery_loc]
               if video[:uploader]
                 builder.video :uploader, video[:uploader], video[:uploader_info] ? { :info => video[:uploader_info] } : {}
               end
@@ -149,7 +149,51 @@ module SitemapGenerator
       end
 
       def w3c_date(date)
-         date.utc.strftime("%Y-%m-%dT%H:%M:%S+00:00")
+        if date.is_a?(String)
+          date
+        elsif date.respond_to?(:iso8601)
+          date.iso8601.sub(/Z$/i, '+00:00')
+        elsif date.is_a?(Date) && !date.is_a?(DateTime)
+          date.strftime("%Y-%m-%d")
+        else
+          zulutime = if date.is_a?(DateTime)
+            date.new_offset(0)
+          elsif date.respond_to?(:utc)
+            date.utc
+          else
+            nil
+          end
+
+          if zulutime
+            zulutime.strftime("%Y-%m-%dT%H:%M:%S+00:00")
+          else
+            zone = date.strftime('%z').insert(-3, ':')
+            date.strftime("%Y-%m-%dT%H:%M:%S") + zone
+          end
+        end
+      end
+
+      # Accept a string or boolean and return 'yes' or 'no'.  If a string, the
+      # value must be 'yes' or 'no'.  Pass the default value as a boolean using `default`.
+      def yes_or_no(value)
+        if value.is_a?(String)
+          raise ArgumentError.new("Unrecognized value for yes/no field: #{value.inspect}") unless value =~ /^(yes|no)$/i
+          value.downcase
+        else
+          value ? 'yes' : 'no'
+        end
+      end
+
+      # If the value is nil, return `default` converted to either 'yes' or 'no'.
+      # If the value is set, return its value converted to 'yes' or 'no'.
+      def yes_or_no_with_default(value, default)
+        yes_or_no(value.nil? ? default : value)
+      end
+
+      # Format a float to to one decimal precision.
+      # TODO: Use rounding with precision once merged with framework_agnostic.
+      def format_float(value)
+        value.is_a?(String) ? value : ('%0.1f' % value)
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sitemap_generator
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 27
   prerelease: 
   segments: 
   - 2
   - 1
-  - 7
-  version: 2.1.7
+  - 8
+  version: 2.1.8
 platform: ruby
 authors: 
 - Karl Varga
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-27 00:00:00 -08:00
+date: 2011-12-16 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency