bcms_sitemap 0.9.1 → 0.9.8

data/README.markdown

@@ -1,6 +1,4 @@
-**WARNING: This module has not yet been tested in a live production environment** 
-
-Available as a gem at [Gemcutter.org](http://gemcutter.org)
+Available as a gem at [RubyGems.org](http://rubygems.org)
 
 # BCMS\_sitemap BrowserCMS sitemap submission module
 
@@ -77,14 +75,16 @@ and automatically create these upon saving the record for the individual search
 
 For more information see the individual sites:
 
-[Ask](http://about.ask.com/en/docs/about/webmasters.shtml),
 [Google](http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=156184),
 [Yahoo](http://help.yahoo.com/l/us/yahoo/smallbusiness/store/promote/sitemap/sitemap-16.html) and 
 [yahoo submissions](https://siteexplorer.search.yahoo.com/submit), [Live/Bing](http://www.bing.com/webmaster)
 
-[Moreover](http://moreover.com) does not require authentication. (Not really a search engine, but provides news many to companies)
+[Ask](http://about.ask.com/en/docs/about/webmasters.shtml) and
+[Moreover](http://moreover.com) does not require authentication. (Moreover is not really a search engine, but provides news many to companies)
   
 [See also](http://www.hariesdesign.com/tips-and-trick/6-seo/46-submit-a-sitemap-to-top-5-search-engine) http://www.hariesdesign.com/tips-and-trick/6-seo/46-submit-a-sitemap-to-top-5-search-engine
+
+Yahoo must be manually submitted the first time.
   
 ### Setting up your submission job
 You can use either cron or backgroundrb to submit your sitemap. My preference is cron.
@@ -97,11 +97,12 @@ Add the following:
     #!/usr/bin/env ruby
     require 'fileutils'
     
+    LUSER="...the user running the app..."
     APP_ROOT="/...yoursite..."
     RAILS_ENV="production"
     RAKE_OPTS='-q -s'
     Dir.chdir "#{APP_ROOT}/current"
-    `RAILS_ENV=#{RAILS_ENV} rake #{RAKE_OPTS} sitemap:submit`
+    `su #{LUSER} -c "RAILS_ENV=#{RAILS_ENV} rake #{RAKE_OPTS} sitemap:submit"`    
 
 Make it executable:
 
@@ -164,4 +165,8 @@ If you deploy using capistrano, you may want to add the sitemap:verify_signatori
 # Considerations for the future
 
 Currently the module is placing a template for rendering the search engines in the administration interface, due to inflexible module
-facilities in BrowserCMS. (Should be on the backlog for the browser cms team). Meanwhile, that view has to be stored locally.
+facilities in BrowserCMS. (Should be on the backlog for the browser cms team). Meanwhile, that view has to be stored locally.
+
+# Issues
+
+I have had some issues with submitting updates to yahoo. This is currently under investigation.

data/app/models/search_engine.rb

@@ -35,7 +35,7 @@ class SearchEngine < ActiveRecord::Base
   end
   
   def signatory_file_name
-    verification_file && !verification_file.empty? && File.join(signatory_folder, verification_file )
+    verification_file && !verification_file.blank? && File.join(signatory_folder, verification_file )
   end
   
   def has_signatory_file?
@@ -54,7 +54,7 @@ protected
   end
   
   def create_signatory_file
-    if verification_file
+    unless verification_file.blank?
       File.atomic_write(signatory_file_name) do |file|
         file.write(verification_content || '')
       end

data/db/migrate/20100212083005_create_search_engines.rb

@@ -15,7 +15,7 @@ class CreateSearchEngines < ActiveRecord::Migration
     SearchEngine.create :name => 'Yahoo', :url => 'http://search.yahooapis.com/SiteExplorerService/V1/ping?sitemap='
     SearchEngine.create :name => 'Ask', :url => 'http://submissions.ask.com/ping?sitemap='
     SearchEngine.create :name => 'Live/Bing', :url => 'http://www.bing.com/webmaster/ping.aspx?siteMap='
-    SearchEngine.create :name => 'Moreover', :url => 'http://api.moreover.com/ping?u='
+    SearchEngine.create :name => 'Moreover', :url => 'http://rpc.weblogs.com/pingSiteForm?url='
   end
 
   def self.down

data/lib/bcms_sitemap/sitemap_submitter.rb

@@ -1,14 +1,14 @@
 require 'cgi'
+require 'net/https'
 class Cms::SitemapSubmitter
   include ActionController::UrlWriter
-  include ActionController::Caching::Pages
   
   class << self
     
     # Checks to see if there has been any updates since last time.
     # If so, clears the cache for the relevant model and submits the url to the search engine's that have not yet been notified
     def run
-      submit_time = SearchEngine.enabled.minimum(:submitted_at)
+      submit_time = SearchEngine.enabled.minimum(:submitted_at) || Time.now.years_ago(10)
       
       # collect timestamp for all models. We don't want to expire more pages than necessary
       timestamps = {}
@@ -18,12 +18,12 @@ class Cms::SitemapSubmitter
       end
       last_update = timestamps.values.compact.max
       # try this {}.values.compact.max
-      if last_update && (submit_time.nil? || submit_time < last_update)
+      if last_update && (submit_time.nil? || (submit_time < last_update))
         # This is a lazy cleaning of cache
-        expire_page :controller => 'sitemaps', :action => 'index', :format => 'xml'
+        expire_sitemap :controller => 'sitemaps', :action => 'index', :format => 'xml'
 
         @models.each do |model|
-          expire_page :controller => 'sitemaps', :model => model, :format => 'xml' if !timestamps[model] || submit_time < timestamps[model]
+          expire_sitemap :controller => 'sitemaps', :action => model, :format => 'xml' if !timestamps[model] || submit_time < timestamps[model]
         end
         SearchEngine.enabled.all.each do |search_engine|
           if search_engine.submitted_at.nil? || search_engine.submitted_at < last_update
@@ -32,6 +32,19 @@ class Cms::SitemapSubmitter
         end
       end
     end
+    
+    def expire_sitemap(options = {})
+      return unless perform_caching
+      ApplicationController::expire_page sitemap_path(options)
+    end
+    
+    def sitemap_path(options = {})
+      if options[:action] == 'index'
+        "/#{options[:controller]}.#{options[:format]}"
+      else
+        "/#{options[:controller]}/#{options[:action]}.#{options[:format]}"
+      end
+    end
 
     # Submit a single search engine. Called from run through the search engine
     def submit(search_engine)
@@ -81,19 +94,25 @@ class Cms::SitemapSubmitter
   
   def initialize(search_engine) #:nodoc:
     @search_engine = search_engine
-    @connection = ActiveResource::Connection.new(search_engine.url)
   end
   
   def submit #:nodoc:
-    response = 200
-    begin
-      @connection.get(document_url)
+    #puts "Submitting #{document_url}"
+    resp = get document_url
+    #puts "Response was #{resp.code} #{resp.message}"
+    #puts "Body #{resp.body}"
+    if resp.is_a? Net::HTTPOK
       logger.info "Sitemap was successfully submitted to #{search_engine.name} (#{document_url})"
-    rescue => e
-      logger.error "Sitemap submition failed for #{search_engine.name} (#{document_url})\nResponse was #{e.response}"
-      response = e.response
+    else
+      logger.error "Sitemap submition failed for #{search_engine.name} (#{document_url})\nResponse was #{resp.code} #{resp.message}"
     end
-    response
+    resp.code
+  end
+  
+  def get(document_url)
+    url = URI.parse(document_url)
+    http = Net::HTTP.new(url.host, url.port)
+    resp = http.send_request('GET', url.request_uri)
   end
   
   def document_url #:nodoc:

data/test/integration/sitemap_submitter_test.rb

@@ -23,12 +23,12 @@ class Cms::SitemapSubmitterTest < ActiveSupport::TestCase
       @submitter = Cms::SitemapSubmitter.new(@search_engine)
     end
     should 'return response code on success' do
-      @submitter.instance_variable_get(:@connection).stubs(:get).returns('')
+      @submitter.stubs(:get).returns(Net::HTTPSuccess.new('1.1', 200, 'OK'))
       resp = @submitter.submit
       assert_equal 200, resp
     end
     should 'return response code on failure' do
-      @submitter.instance_variable_get(:@connection).expects(:get).raises(ActiveResource::ResourceNotFound, 404)
+      @submitter.stubs(:get).returns(Net::HTTPNotFound.new('1.1', 404, 'NotFound'))
       resp = @submitter.submit
       assert_equal 404, resp
     end
@@ -37,6 +37,23 @@ class Cms::SitemapSubmitterTest < ActiveSupport::TestCase
     end
   end
   
+  context 'expiring cache for sitemap' do
+    should 'execute' do
+      ApplicationController.perform_caching = true
+      assert_nil Cms::SitemapSubmitter.expire_sitemap( :controller => 'sitemaps', :action => 'test', :format => 'xml')
+      ApplicationController.perform_caching = false
+    end
+  end
+  
+  context 'calculating path' do
+    should 'exclude index from path' do
+      assert_equal '/sitemaps.xml', Cms::SitemapSubmitter.sitemap_path(:controller => 'sitemaps', :action => 'index', :format => 'xml')
+    end
+    should 'include odel in path' do
+      assert_equal '/sitemaps/test.xml', Cms::SitemapSubmitter.sitemap_path(:controller => 'sitemaps', :action => 'test', :format => 'xml')
+    end
+  end
+  
   context 'run' do
     setup do
       @search_engine = create_search_engine

data/test/unit/helpers/sitemaps_helper_test.rb

@@ -7,7 +7,7 @@ class SitemapsHelperTest < ActionView::TestCase
   context 'xml_url' do
     setup do
       page_routes(:new_article).reload_routes
-      @news = create_news_article :name => 'good-news', :created_at => Date.parse('2010-03-03')
+      @news = create_news_article :name => 'good-news' #, :created_at => Date.parse('2010-03-03')
       flunk "Expected news article not to respond to path" if @news.respond_to?(:path)
       @page = create_page :path => '/home'
       flunk "Expected page to respond to path" unless @page.respond_to?(:path)
@@ -16,7 +16,8 @@ class SitemapsHelperTest < ActionView::TestCase
       assert_equal "http://test.host/home", xml_url(@page)
     end
     should 'handle objects which does not have path' do
-      assert_equal "http://test.host/news/articles/2010/03/02/good-news", xml_url(@news)
+      date_path = Date.yesterday.strftime("%Y/%m/%d")
+      assert_equal "http://test.host/news/articles/#{date_path}/good-news", xml_url(@news)
     end
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bcms_sitemap
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  hash: 43
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 8
+  version: 0.9.8
 platform: ruby
 authors: 
 - Knut Stenmark
@@ -9,20 +15,26 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-03 00:00:00 +01:00
+date: 2010-07-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: browsercms
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 3
+        - 0
+        - 6
         version: 3.0.6
-    version: 
-description: Warning. Not tested in production environment yet. Sitemap submitter module for BrowserCMS, which enables submission of sitemap to different search engines
+  type: :runtime
+  version_requirements: *id001
+description: Sitemap submitter module for BrowserCMS, which enables submission of sitemap to different search engines
 email: knut.stenmark@gmail.com
 executables: []
 
@@ -55,6 +67,13 @@ files:
 - rails/init.rb
 - LICENSE.txt
 - README.markdown
+- test/functional/sitemaps_controller_test.rb
+- test/integration/sitemap_submitter_test.rb
+- test/performance/browsing_test.rb
+- test/test_factory.rb
+- test/test_helper.rb
+- test/unit/helpers/sitemaps_helper_test.rb
+- test/unit/search_engine_test.rb
 has_rdoc: true
 homepage: http://github.com/stonefield/bcms_sitemap
 licenses: []
@@ -65,21 +84,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Sitemap submitter module for BrowserCMS