sitemap-builder 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,87 @@
+SitemapBuilder
+==============
+
+SitemapBuilder is a rail plugin for sitemap generation. It is heavily based on Adam Salter's Sitemap Generator plugin (git://github.com/adamsalter/sitemap_generator.git).
+
+This plugin is not a fork of Adam's plugin but a complete rewriting since the goal and the way to build sitemap is different.
+
+Indeed, I wanted a way to build seveal sitemap for the same website depending on some paramters such as the site language (see file sitemap_example.rb).
+
+Installation
+============
+
+no gem for now.
+
+    script/plugin install git://github.com/franck/sitemap-builder.git
+
+
+Usage
+=======
+
+Create a sitemap.rb file in config/
+
+Create a sitemap instance:
+
+    sitemap = SitemapBuilder::Sitemap.new(
+      :debug => true,
+      :host => "http://localhost:3000",
+      :filename => "sitemap.yml",
+      :ping_search_engines => true
+    )
+
+    sitemap.add root_path
+    sitemap.add pages_path
+    Page.all.each do |page|
+      sitemap.add page_path(page)
+    end
+    sitemap.add url_for(:controller => "articles", :action => "index", :only_path => true)
+  
+Then add the following lines for the sitemap generation and ping search engines (if set to true):
+
+    sitemap.generate
+    sitemap.ping_search_engines
+
+Then, fire the rake task :
+
+    rake sitemapbuilder:create
+
+I use whenever gem (git://github.com/javan/whenever.git) to schedule a new sitemap creation :
+
+    every 1.week do
+      rake "sitemapbuilder:create"
+    end
+
+    
+A complete example file is available inside the plugin root directory : sitemap_example.rb
+
+Sitemap index
+=============
+
+A sitemap index builder is also provided. Example of config/sitemap.rb:
+
+sitemap_index = SitemapBuilder::SitemapIndex.new()
+sitemap = SitemapBuilder::Sitemap.new()
+sitemap.add root_path
+sitemap_index.sitemaps << sitemap
+sitemap_index.generate
+
+These lines create a sitemap.xml file and a sitemap_index.xml file in the public directory.
+    
+Options
+=======
+
+SitemapBuilder::Sitemap accepts several options :
+* debug: generate sitemap files, verbose, does not ping search engines even if set to true (default: false)
+* host: base url of your website. don't forget the http:// (default: "http://localhost:3000")
+* filename: sitemap name (default: "sitemap.xml")
+* sitemap_folder: indicate a folder where the sitemap is located (default: "", example: "sitemaps")
+* ping_search_engines: ping google, yahoo, bing and ask.com (default: false)
+
+
+TODO
+====
+
+* test coverage
+* handling lot of links and sitemap indexes
+
+Copyright (c) 2009 Franck D'agostini, released under the MIT license

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the sitemap_builder plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the sitemap_builder plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SitemapBuilder'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "sitemap-builder"
+  gem.summary = "Rails plugins to build sitemap.xml"
+  gem.description = "Rails plugins to build sitemap.xml"
+  gem.email = "franck.dagostini@gmail.com"
+  gem.homepage = "http://github.com/franck/sitemap-builder"
+  gem.authors = ["Franck D'agostini"]
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/sitemap_builder/helper.rb

@@ -0,0 +1,26 @@
+require 'action_controller'
+require 'action_controller/test_process'
+begin
+  require 'application_controller'
+rescue LoadError
+  # Rails < 2.3
+  require 'application'
+end
+
+module SitemapBuilder
+  module Helper
+    def generate_sitemap    
+      controller = ApplicationController.new
+      controller.request = ActionController::TestRequest.new
+      controller.params = {}
+      controller.send(:initialize_current_url)
+      b = controller.instance_eval{binding}
+      sitemap_mapper_file = File.join(RAILS_ROOT, 'config/sitemap.rb')
+      eval(open(sitemap_mapper_file).read, b)
+    end
+    
+    def w3c_date(date)
+       date.utc.strftime("%Y-%m-%dT%H:%M:%S+00:00")
+    end
+  end
+end

data/lib/sitemap_builder/link.rb

@@ -0,0 +1,16 @@
+module SitemapBuilder
+  class Link
+    class << self
+      def generate(path, host, options={})
+        options = { 
+          :path => path,
+          :priority => 0.5,
+          :changefreq => 'weekly',
+          :lastmod => Time.now,
+          :host => host,
+          :loc => URI.join(host, path).to_s
+        }.merge options
+      end
+    end
+  end
+end

data/lib/sitemap_builder/sitemap.rb

@@ -0,0 +1,109 @@
+module SitemapBuilder  
+  class Sitemap  
+    attr_accessor :links, :default_host
+    
+    def initialize(options={})
+      options = { 
+        :debug => false,
+        :default_host => 'http://localhost:3000', 
+        :filename => 'sitemap.xml',
+        :sitemap_folder => '',
+        :ping_search_engines => false
+      }.merge options
+      @debug = options[:debug]
+      @default_host = options[:default_host]
+      @filename =  options[:filename]
+      @sitemap_folder = options[:sitemap_folder]
+      
+      @links = []
+      
+      deleting_previous_sitemap(fullpath)
+      create_sitemap_folder(@sitemap_folder)
+    end
+    
+    def add(link, options={})
+      link = Link.generate(link, @default_host, options)
+      p link[:loc] if @debug
+      @links << link
+    end
+        
+    def generate
+      puts "GENERATING XML FILE ..." if @debug
+    	xml_str = ""
+    	xml = Builder::XmlMarkup.new(:target => xml_str, :indent=>2)
+
+    	xml.instruct!
+      xml.urlset "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", 
+        "xsi:schemaLocation" => "http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd", 
+        "xmlns" => "http://www.sitemaps.org/schemas/sitemap/0.9" do
+
+        links.each do |link|
+          xml.url do
+            xml.loc        link[:loc]
+            xml.lastmod    w3c_date(link[:lastmod]) if link[:lastmod]
+            xml.changefreq link[:changefreq]        if link[:changefreq]
+            xml.priority   link[:priority]          if link[:priority]
+          end 
+        end
+      end
+    	save_file(xml_str)
+    	ping_search_engines if @ping_search_engines
+    end
+    
+    def ping_search_engines
+      puts "PINGING SEARCH ENGINES ..." if @debug
+      sitemap_uri = self.loc
+	    index_location = URI.escape(sitemap_uri)
+      search_engines = {
+        :google => "http://www.google.com/webmasters/sitemaps/ping?sitemap=#{index_location}",
+        :yahoo => "http://search.yahooapis.com/SiteExplorerService/V1/ping?sitemap=#{index_location}",
+        :ask => "http://submissions.ask.com/ping?sitemap=#{index_location}",
+        :bing => "http://www.bing.com/webmaster/ping.aspx?siteMap=#{index_location}"
+      }
+      
+      search_engines.each do |engine, link|
+        begin
+          if @debug
+            puts "pinging #{engine.to_s.titleize} : #{link}"
+          else
+            open(link)
+            puts "Successful ping of #{engine.to_s.titleize}"
+          end
+        rescue Timeout::Error, StandardError => e
+          puts "Ping failed for #{engine.to_s.titleize}: #{e.inspect}"
+        end
+      end      
+    end
+        
+    def save_file(xml)
+  		File.open(RAILS_ROOT + fullpath, "w+") do |f|
+  			f.write(xml)	
+  		end		
+  	end
+  	
+  	def fullpath
+  	  fullpath = "/public/"
+  	  fullpath << @sitemap_folder + '/' unless @sitemap_folder.blank?
+  	  fullpath << @filename
+	  end
+	  
+	  def loc
+	    loc = @default_host + '/'
+	    loc << @sitemap_folder + '/' unless @sitemap_folder.blank?
+	    loc << @filename
+    end
+   
+    def deleting_previous_sitemap(sitemap)
+      sitemap_files = Dir[File.join(RAILS_ROOT, sitemap)]
+      FileUtils.rm sitemap_files, :verbose => true
+    end
+    
+    def create_sitemap_folder(sitemap_folder)
+      return if sitemap_folder.blank?
+      path = RAILS_ROOT + "/public/" + sitemap_folder
+      unless File.exists?(path) && File.directory?(path)
+        FileUtils.mkdir path, :mode => 0755, :verbose => true
+      end
+    end
+  end
+end

data/lib/sitemap_builder/sitemap_index.rb

@@ -0,0 +1,41 @@
+module SitemapBuilder  
+  class SitemapIndex
+    attr_accessor :sitemaps
+    
+    def initialize(options={})
+      options = { 
+        :filename => 'sitemap_index.xml',
+      }.merge options
+      @filename = options[:filename]
+      @sitemaps = []
+    end
+    
+    def generate
+      puts "GENERATING XML INDEX FILE ..." if @debug
+    	xml_str = ""
+    	xml = Builder::XmlMarkup.new(:target => xml_str, :indent=>2)
+
+    	xml.instruct!
+      xml.sitemapindex "xmlns" => "http://www.sitemaps.org/schemas/sitemap/0.9" do
+        @sitemaps.each do |s|
+          xml.sitemap do
+            xml.loc s.loc
+            xml.lastmod w3c_date(Time.now)
+          end
+        end
+      end
+    	save_file(xml_str)
+    end
+    
+    def save_file(xml)
+  		File.open(RAILS_ROOT + fullpath, "w+") do |f|
+  			f.write(xml)
+  		end		
+  	end
+  	
+  	def fullpath
+  	  "/public/" + @filename
+	  end
+    
+  end
+end

data/lib/sitemap_builder.rb

@@ -0,0 +1,4 @@
+require 'sitemap_builder/sitemap'
+require 'sitemap_builder/sitemap_index'
+require 'sitemap_builder/link'
+require 'sitemap_builder/helper'

data/sitemap_example.rb

@@ -0,0 +1,31 @@
+# Example of config/sitemap.rb
+# One sitemap = one Sitemap instance
+
+# Example below generate two sitemaps. One per languages (FR and DE)
+# and then generate a sitemap inde file with the location of these two sitemaps
+
+sitemap_index = SitemapBuilder::SitemapIndex.new()
+
+["fr", "de"].each do |locale|
+  
+  sitemap = SitemapBuilder::Sitemap.new(
+    :debug => true,
+    :host => "http://localhost:3000",
+    :filename => "sitemap_#{locale}.yml",
+    :ping_search_engines => true
+  )
+  
+  
+  sitemap.add "/#{locale}"
+  
+  sitemap.add articles_path(:locale => locale)
+  Article.find(:all).each do |a|
+    sitemap.add article_path(a, :locale => locale), :lastmod => a.updated_at
+  end
+
+  sitemap.generate
+  sitemap.ping_search_engines
+  sitemap_index.sitemaps << sitemap
+end
+
+sitemap_index.generate

data/tasks/sitemap_builder_tasks.rake

@@ -0,0 +1,11 @@
+namespace :sitemapbuilder do
+  
+  desc 'create sitemap'
+  task :create => :environment do
+    include SitemapBuilder::Helper
+    
+    puts "CREATING SITEMAPS ..."
+    generate_sitemap
+  end
+  
+end

data/test/sitemap_builder_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class SitemapBuilderTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: sitemap-builder
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Franck D'agostini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-16 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Rails plugins to build sitemap.xml
+email: franck.dagostini@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/sitemap_builder.rb
+- lib/sitemap_builder/helper.rb
+- lib/sitemap_builder/link.rb
+- lib/sitemap_builder/sitemap.rb
+- lib/sitemap_builder/sitemap_index.rb
+- sitemap_example.rb
+- tasks/sitemap_builder_tasks.rake
+- test/sitemap_builder_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/franck/sitemap-builder
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails plugins to build sitemap.xml
+test_files: 
+- test/sitemap_builder_test.rb
+- test/test_helper.rb