sitemap_notifier 0.0.4 → 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sitemap_notifier.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lasse Bunk
+
+MIT License
+
+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.md

@@ -0,0 +1,110 @@
+[![Build Status](https://secure.travis-ci.org/lassebunk/sitemap_notifier.png)](http://travis-ci.org/lassebunk/sitemap_notifier)
+
+Sitemap Notifier
+================
+
+Sitemap Notifier is a Ruby on Rails plugin that, when installed, automatically notifies Google, Bing, and Yahoo of changes to your models, i.e. changes to your sitemap. It also works in conjunction with the [dynamic_sitemaps](https://github.com/lassebunk/dynamic_sitemaps) plugin.
+
+Installation
+------------
+
+In your *Gemfile*:
+
+```ruby
+gem 'sitemap_notifier'
+```
+  
+And run:
+
+```bash
+$ bundle install
+```
+
+Example
+-------
+
+Start by generating an initializer:
+
+```bash
+$ rails generate sitemap_notifier:install
+```
+
+Then, in *config/initializers/sitemap_notifier.rb*:
+
+```ruby
+SitemapNotifier::Notifier.configure do |config|
+  # Set URL to your sitemap. This is required.
+  # This can also be configured per model basis,
+  # see https://github.com/lassebunk/sitemap_notifier#per-model-sitemap-url
+  config.sitemap_url = "http://example.com/sitemap.xml"
+
+  # Models that should trigger notification of search engines.
+  # Default is to trigger on all creates, updates, and deletes.
+  config.models = [Article, Category]
+
+  # Or, if you want to specify on which actions to notify search engines:
+  config.models = { Article => [:create, :destroy],
+                    Product => :update,
+                    Page => :all }
+
+  # Enabled in which environments – default is [:production]
+  config.environments = [:development, :production]
+
+  # Delay to wait between notifications – default is 10 minutes
+  config.delay = 2.minutes
+
+  # Additional urls to ping
+  config.ping_urls << "http://localhost:3000/ping?sitemap=%{sitemap_url}"
+end
+```
+
+Then create or update a model:
+
+```ruby
+Article.create :title => "My New Article"
+```
+
+The search engines are then automatically notified.
+
+After installation
+------------------
+
+After you install and configure the plugin, it'll automatically notify Google, Bing, and Yahoo every time you update a model. After each notification, it'll wait 10 minutes (by default) before notifying again. This is to ensure that for example a batch update won't trigger an equal amount of notifications.
+
+Customization
+-------------
+
+### Per model sitemap URL
+
+The sitemaps defaults to what you set in `SitemapNotifier::Notifier.sitemap_url`. If you want to use a different sitemap URL based on data in your models, you can override the `sitemap_url` method of each of your models like this:
+
+```ruby
+class Product < ActiveRecord::Base
+  belongs_to :site
+
+  def sitemap_url
+    "http://#{site.domain}/sitemap.xml"
+  end
+end
+```
+
+### Conditional notifications
+
+You can decide on model level whether the search engines should be pinged by overriding the `notify_sitemap?` method of your models:
+
+```ruby
+class Product < ActiveRecord::Base
+  belongs_to :site
+
+  def notify_sitemap?
+    site.id == 1
+  end
+end
+```
+
+Documentation
+-------------
+
+* [Complete documentation](http://rubydoc.info/github/lassebunk/sitemap_notifier)
+
+Copyright &copy; 2010-2013 Lasse Bunk, released under the MIT license

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/generators/sitemap_notifier/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates initializer for SitemapNotifier.
+
+Example:
+    rails generate sitemap_notifier:install
+
+    This will create:
+        config/initializers/sitemap_notifier.rb

data/lib/generators/sitemap_notifier/install_generator.rb

@@ -0,0 +1,10 @@
+module SitemapNotifier
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    
+    desc "Creates an initializer for breadcrumbs in config/initializers/sitemap_notifier.rb"
+    def create_initializer
+      copy_file "initializer.rb", "config/initializers/sitemap_notifier.rb"
+    end
+  end
+end

data/lib/generators/sitemap_notifier/templates/initializer.rb

@@ -1,15 +1,30 @@
-# replace this with your own url
-SitemapNotifier::Notifier.sitemap_url = "http://example.com/sitemap.xml"
+SitemapNotifier::Notifier.configure do |config|
+  # Set URL to your sitemap. This is required.
+  #   config.sitemap_url = "http://example.com/sitemap.xml"
+  #
+  # This can also be configured per model basis,
+  # see https://github.com/lassebunk/sitemap_notifier#per-model-sitemap-url
 
-# source models – default is :all for all models
-#   SitemapNotifier::Notifier.models = [Article, Category]
+  # Models that should trigger notification of search engines.
+  # It will trigger on creates, updates, and destroys af those models.
+  #   config.models = [Article, Category]
 
-# enabled in which environments – default is [:production]
-#   SitemapNotifier::Notifier.environments = [:development, :production]
-#   SitemapNotifier::Notifier.environments = :all
+  # To trigger notifications on the specified actions only:
+  #   config.models = { Article => [:create, :destroy],
+  #                     Product => :update,
+  #                     Page => :all }
 
-# delay to wait between notifications – default is 600 seconds
-#   SitemapNotifier::Notifier.delay = 30
+  # Enabled in which environments – default is [:production]
+  #   config.environments = [:development, :production]
+  # or
+  #   config.environments = :all
 
-# additional urls – be sure to call this after setting sitemap_url
-#   SitemapNotifier::Notifier.urls << "http://localhost:3000/ping"
+  # Delay to wait between notifications – default is 10 minutes
+  #   config.delay = 2.minutes
+
+  # Additional urls to ping
+  #   config.ping_urls << "http://localhost:3000/ping?sitemap=%{sitemap_url}"
+
+  # If you don't want the notifications to run in the background
+  #   config.background = false
+end

data/lib/sitemap_notifier.rb

@@ -1,2 +1,3 @@
+require "sitemap_notifier/version"
 require 'sitemap_notifier/active_record'
 require 'sitemap_notifier/notifier'

data/lib/sitemap_notifier/active_record.rb

@@ -1,15 +1,31 @@
+require "active_record"
+
 module SitemapNotifier
   module ActiveRecord
-    def notify_sitemap
-      notifier = ::SitemapNotifier::Notifier
+    def self.included(base)
+      [:create, :update, :destroy].each do |action|
+        base.send("after_#{action}") do
+          notify_sitemap(action)
+        end
+      end
+    end
+
+    def notify_sitemap(action)
+      notifier = SitemapNotifier::Notifier
       
-      if notifier.models == :all || notifier.models.include?(self.class)
-        notifier.notify!
+      if (notifier.notify_of_changes_to?(self.class, action)) && notify_sitemap?
+        notifier.run(sitemap_url)
       end
     end
-    
-    def self.included(base)
-      base.after_save :notify_sitemap
+
+    def notify_sitemap?
+      true
+    end
+
+    def sitemap_url
+      SitemapNotifier::Notifier.sitemap_url
     end
   end
-end
+end
+
+ActiveRecord::Base.send :include, SitemapNotifier::ActiveRecord

data/lib/sitemap_notifier/notifier.rb

@@ -5,81 +5,203 @@ require 'cgi'
 module SitemapNotifier
   class Notifier
     class << self
-      # sitemap url
+      # The default sitemap URL to send to search engines.
+      #
+      # Example:
+      #
+      #   SitemapNotifier::Notifier.sitemap_url = "http://test.dk/sitemap.xml"
+      #
+      # The default sitemap URL can be overridden on model level:
+      #
+      #   class Product < ActiveRecord::Base
+      #     belongs_to :site
+      #
+      #     def sitemap_url
+      #       "http://#{site.domain}/sitemap.xml"
+      #     end
+      #   end
       attr_accessor :sitemap_url
-      
-      # source
-      attr_writer :models
+
+      # Set models that should trigger notification.
+      #
+      # If you supply a hash, you can specify which actions should trigger notifications using +:create+, +:update+, +:destroy+, or +:all+.
+      #
+      # If you supply an array, all creates, updates, and deletes will trigger notification.
+      #
+      # Example:
+      #
+      #   # Will trigger notifications on creates, updates, and destroys on articles and products:
+      #   SitemapNotifier::Notifier.models = [Article, Product]
+      #
+      #   # Will trigger notifications on the specified actions:
+      #   config.models = { Article => [:create, :destroy],
+      #                     Product => :update,
+      #                     Page => :all }
       def models
-        @models ||= :all
+        @models ||= {}
       end
       
-      # delay
-      attr_writer :delay
+      def models=(hash_or_array)
+        if hash_or_array == :all
+          @models = { :all => :all }
+        elsif hash_or_array.is_a?(Array)
+          @models = Hash[hash_or_array.map { |model| [model, :all] }]
+        else
+          @models = hash_or_array
+        end
+      end
+      
+      # Seconds to wait between notifications of the search engines.
+      # Default: 10 minutes
+      #
+      # Example:
+      #
+      #   SitemapNotifier::Notifier.delay = 2.minutes
       def delay
         @delay ||= 600
       end
+      attr_writer :delay
       
-      # environments
-      attr_writer :environments
+      # Environments where sitemap notifications should be triggered.
+      #
+      # Example:
+      #
+      #   SitemapNotifier::Notifier.environments = [:development, :production]
       def environments
         @environments ||= [:production]
       end
-      
-      # urls
-      attr_writer :urls
-      def urls
-        @urls ||= ["http://www.google.com/webmasters/sitemaps/ping?sitemap=#{CGI::escape(sitemap_url)}",
-                   "http://www.bing.com/webmaster/ping.aspx?siteMap=#{CGI::escape(sitemap_url)}",
-                   "http://submissions.ask.com/ping?sitemap=#{CGI::escape(sitemap_url)}"]
+      attr_writer :environments
+
+      # Current environment. If not set manually, it returns the current Rails environment, like +:development:+ or +:production+.
+      def env
+        defined?(Rails) ? Rails.env.to_sym : @env
+      end
+      attr_writer :env
+
+      # URLs to be pinged / notified of changes to sitemap.
+      # Default is Google and Bing (and therefore Yahoo).
+      #
+      # Example:
+      #
+      #   SitemapNotifier::Notifier.ping_urls << "http://mydomain.com/ping?sitemap=%{sitemap_url}"
+      #
+      # The sitemap URL will then be interpolated into the ping URL at runtime.
+      def ping_urls
+        @ping_urls ||= ["http://www.google.com/webmasters/sitemaps/ping?sitemap=%{sitemap_url}",
+                        "http://www.bing.com/webmaster/ping.aspx?siteMap=%{sitemap_url}"]
                    # no Yahoo here, as they will be using Bing from september 15th, 2011
       end
+      attr_writer :ping_urls
+
+      # Whether to run the notification pings in the background.
+      # Default: +true+
+      #
+      # Example:
+      #
+      #   SitemapNotifier::Notifier.background = false
+      def background
+        return @background if defined?(@background)
+        @background = true
+      end
+      attr_writer :background
       
-      # running pid
-      attr_accessor :running_pid
-
-      def notify!
-        raise "sitemap_url not set – use SitemapNotifier::Notifier.sitemap_url = 'xx'" unless sitemap_url
-        
-        if (environments == :all || environments.include?(Rails.env.to_sym)) && !running?
-          self.running_pid = fork do
-            Rails.logger.info "Notifying search engines of changes to sitemap..."
-            
-            urls.each do |url|
-              if get_url(url)
-                Rails.logger.info "#{url} – ok"
-              else
-                Rails.logger.info "#{url} – failed"
-              end
+      # Runs the search engine notifications after checking environment and delay.
+      def run(url = nil)
+        url ||= sitemap_url
+
+        raise "sitemap_url not set - use SitemapNotifier::Notifier.sitemap_url = 'http://domain.com/sitemap.xml'" unless url
+
+        if (environments == :all || environments.include?(env)) && ping?(url)
+          ping_all url
+          sitemap_notified url
+        end
+      end
+
+      # Pings all the configured search engines with the supplied +url+.
+      def ping_all(url)
+        p = Proc.new do
+          Rails.logger.info "Notifying search engines of changes to sitemap #{url}..." if defined?(Rails)
+          
+          escaped_url = escape_sitemap_url(url)
+
+          ping_urls.each do |url|
+            url.gsub! "%{sitemap_url}", escaped_url
+            if ping_url(url)
+              Rails.logger.info "Successfully notified #{url}" if defined?(Rails)
+            else
+              Rails.logger.info "Failed to notify #{url}" if defined?(Rails)
             end
-            
-            sleep delay
-            exit
           end
         end
+
+        background ? Thread.new(&p) : p.call
       end
-      
-    protected
-    
-      def get_url(url)
-        uri = URI.parse(url)
-        begin
-          return Net::HTTPSuccess === Net::HTTP.get_response(uri)
-        rescue Exception
-          return false
+
+      # Yields a configuration block to configure the notifier.
+      #
+      # Example:
+      #
+      #   SitemapNotifier::Notifier.configure do |config|
+      #     config.sitemap_url = "http://test.dk/sitemap.xml"
+      #   end
+      def configure
+        yield self
+        if models.is_a?(Array) && models.empty? && defined?(Rails)
+          Rails.logger.warn "SitemapNotifier was configured without any models to trigger notifications. Search engines will therefore not be notified."
         end
       end
+
+      # For testing purposes. Resets all configuration and information about notified sitemaps.
+      def reset
+        [:@sitemap_url, :@models, :@delay, :@environments, :@ping_urls, :@background, :@notified_urls].each do |var|
+          remove_instance_variable var if instance_variable_defined?(var)
+        end
+      end
+
+      # URL encodes the given +url+.
+      def escape_sitemap_url(url)
+        CGI::escape(url)
+      end
       
-      def running?
-        return false unless running_pid
-        
+      # Makes a GET request to the supplied +url+. Returns +true+ when successful, +false+ otherwise.
+      def ping_url(url)
         begin
-          Process.getpgid(running_pid)
-          true
-        rescue Errno::ESRCH
-          false
+          Net::HTTP.get(URI.parse(url))
+          return true
+        rescue
+          return false
         end
       end
+
+      # Returns +true+ if search engines should be modified. Returns +false+ if the configured +delay+ hasn't been met.
+      def ping?(sitemap_url)
+        last_notified = notified_at(sitemap_url)
+        last_notified.nil? || Time.now >= last_notified + delay
+      end
+
+      # Holds notified URL times like notified_urls["http://mydomain.com/sitemap.xml"] # => 2013-02-05 19:10:29 +0100
+      def notified_urls
+        @notified_urls ||= {}
+      end
+
+      # Returns the latest notification time for the given URL.
+      def notified_at(sitemap_url)
+        notified_urls[sitemap_url]
+      end
+
+      # Stores notification time for the given URL.
+      def sitemap_notified(sitemap_url)
+        notified_urls[sitemap_url] = Time.now
+      end
+
+      # Returns +true+ if changes to the given model class should trigger notifications.
+      def notify_of_changes_to?(model, action)
+        valid_actions = models[model] || models[:all]
+
+        return valid_actions == :all ||
+               valid_actions == action ||
+               (valid_actions.is_a?(Array) && valid_actions.include?(action))
+      end
     end
   end
 end

data/lib/sitemap_notifier/version.rb

@@ -0,0 +1,3 @@
+module SitemapNotifier
+  VERSION = "1.0.0"
+end

data/sitemap_notifier.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sitemap_notifier/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sitemap_notifier"
+  gem.version       = SitemapNotifier::VERSION
+  gem.authors       = ["Lasse Bunk"]
+  gem.email         = ["lassebunk@gmail.com"]
+  gem.description   = %q{Ruby on Rails plugin that automatically notifies Google, Bing, and Yahoo of changes to your models, i.e. changes to your sitemap.}
+  gem.summary       = %q{Automatically notify search engines when your models are updated.}
+  gem.homepage      = "http://github.com/lassebunk/sitemap_notifier"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activerecord", ">= 3.0.0"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "timecop"
+  gem.add_development_dependency "fakeweb"
+  gem.add_development_dependency "mocha"
+end

data/test/db.rb

@@ -0,0 +1,42 @@
+require "active_record"
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+
+ActiveRecord::Migration.create_table :articles do |t|
+  t.string :title
+end
+
+ActiveRecord::Migration.create_table :products do |t|
+  t.string :name
+end
+
+ActiveRecord::Migration.create_table :users do |t|
+  t.string :name
+end
+
+ActiveRecord::Migration.create_table :sites do |t|
+  t.string :name
+  t.boolean :has_sitemap
+end
+
+# Standard model to trigger notifications
+class Article < ActiveRecord::Base
+end
+
+# Model with custom sitemap URL
+class Product < ActiveRecord::Base
+  def sitemap_url
+    "http://mycustomurl.com/sitemapfile.xml"
+  end
+end
+
+# Model that should not trigger notifications
+class User < ActiveRecord::Base
+end
+
+# Model that has conditional notifications
+class Site < ActiveRecord::Base
+  def notify_sitemap?
+    has_sitemap?
+  end
+end

data/test/notifier_test.rb

@@ -0,0 +1,168 @@
+require "test_helper"
+
+class NotifierTest < Test::Unit::TestCase
+  def setup
+    SitemapNotifier::Notifier.reset
+    SitemapNotifier::Notifier.configure do |config|
+      config.environments = :all
+      config.background = false
+    end
+  end
+
+  def test_configuration_block
+    SitemapNotifier::Notifier.configure do |config|
+      config.sitemap_url = "http://myconfigureddomain.com/sitemap.xml"
+    end
+    assert_equal "http://myconfigureddomain.com/sitemap.xml", SitemapNotifier::Notifier.sitemap_url
+  end
+
+  def test_doesnt_notify_when_no_models_configured
+    SitemapNotifier::Notifier.configure do |config|
+    end
+    [Article, Product, User, Site].each do |model|
+      [:create, :update, :destroy].each do |action|
+        assert !SitemapNotifier::Notifier.notify_of_changes_to?(model, :create), "Notifies of #{action} on #{model.name}."
+      end
+    end
+  end
+
+  def test_notifies_when_configured_to_all_models
+    SitemapNotifier::Notifier.configure do |config|
+      config.models = :all
+    end
+
+    [Article, Product, User, Site].each do |model|
+      [:create, :update, :destroy].each do |action|
+        assert SitemapNotifier::Notifier.notify_of_changes_to?(model, action), "Doesn't notify of #{action} on #{model.name}."
+      end
+    end
+  end
+
+  def test_per_model_action_settings
+    SitemapNotifier::Notifier.configure do |config|
+      config.models = { Article => [:create, :destroy],
+                        Product => :update,
+                        Site => :all }
+    end
+
+    [[Article, :create, true],
+     [Article, :update, false],
+     [Article, :destroy, true],
+     [Product, :create, false],
+     [Product, :update, true],
+     [Product, :destroy, false],
+     [Site, :create, true],
+     [Site, :update, true],
+     [Site, :destroy, true]].each do |model, action, value|
+      assert_equal value, SitemapNotifier::Notifier.notify_of_changes_to?(model, action), "Expected value to be #{value} for #{action} on #{model}."
+    end
+  end
+
+  def test_models_without_action_settings
+    SitemapNotifier::Notifier.configure do |config|
+      config.models = [Article, Product]
+    end
+
+    [[Article, :create, true],
+     [Article, :update, true],
+     [Article, :destroy, true],
+     [Product, :create, true],
+     [Product, :update, true],
+     [Product, :destroy, true],
+     [Site, :create, false],
+     [Site, :update, false],
+     [Site, :destroy, false]].each do |model, action, value|
+      assert_equal value, SitemapNotifier::Notifier.notify_of_changes_to?(model, action), "Expected value to be #{value} for #{action} on #{model}."
+    end
+  end
+
+  def test_waits_delay
+    notifier = SitemapNotifier::Notifier
+    notifier.configure do |config|
+      config.sitemap_url = "http://test.dk/sitemap.xml"
+      config.models = [Article]
+      config.delay = 10
+    end
+
+    SitemapNotifier::Notifier.expects(:ping_all).twice
+
+    Article.create!
+    Article.create!
+    Timecop.travel(Time.now + 20) do
+      Article.create!
+    end
+  end
+
+  def test_notifies_search_engines
+    sitemap_url = "http://mydomain.dk/sitemap.xml"
+
+    SitemapNotifier::Notifier.configure do |config|
+      config.models = [Article]
+      config.sitemap_url = sitemap_url
+    end
+
+    ["http://www.google.com/webmasters/sitemaps/ping?sitemap=#{CGI::escape(sitemap_url)}",
+     "http://www.bing.com/webmaster/ping.aspx?siteMap=#{CGI::escape(sitemap_url)}"].each do |ping_url|
+      Net::HTTP.expects(:get).with(URI.parse(ping_url))
+    end
+    Article.create! :title => "Test"
+  end
+
+  def test_notifies_for_configured_models
+    SitemapNotifier::Notifier.configure do |config|
+      config.models = [Article, Product]
+      config.sitemap_url = "http://test.dk/sitemap.xml"
+    end
+
+    SitemapNotifier::Notifier.expects(:ping_all).twice
+
+    [Article, Product, User].each do |model|
+      model.create!
+    end
+  end
+
+  def test_notifies_custom_ping_url
+    sitemap_url = "http://test.dk/sitemap.xml"
+
+    SitemapNotifier::Notifier.configure do |config|
+      config.models = [Article]
+      config.sitemap_url = sitemap_url
+      config.ping_urls << "http://bla.dk/ping.php?test=%{sitemap_url}"
+    end
+
+    ["http://www.google.com/webmasters/sitemaps/ping?sitemap=#{CGI::escape(sitemap_url)}",
+     "http://www.bing.com/webmaster/ping.aspx?siteMap=#{CGI::escape(sitemap_url)}",
+     "http://bla.dk/ping.php?test=#{CGI::escape(sitemap_url)}"].each do |ping_url|
+      Net::HTTP.expects(:get).with(URI.parse(ping_url))
+    end
+
+    Article.create!
+  end
+
+  def test_notifies_about_custom_sitemap_url
+    SitemapNotifier::Notifier.configure do |config|
+      config.models = [Product]
+    end
+
+    custom_sitemap_url = "http://mycustomurl.com/sitemapfile.xml"
+    ["http://www.google.com/webmasters/sitemaps/ping?sitemap=#{CGI::escape(custom_sitemap_url)}",
+     "http://www.bing.com/webmaster/ping.aspx?siteMap=#{CGI::escape(custom_sitemap_url)}"].each do |ping_url|
+      Net::HTTP.expects(:get).with(URI.parse(ping_url))
+    end
+
+    Product.create!
+  end
+
+  def test_responds_to_conditional_notifications
+    SitemapNotifier::Notifier.configure do |config|
+      config.sitemap_url = "http://test.dk/sitemap.xml"
+      config.models = [Site]
+      config.delay = 0
+    end
+
+    SitemapNotifier::Notifier.expects(:ping_all).twice
+
+    2.times { Site.create! :has_sitemap => true }
+    Site.create! :has_sitemap => false
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'test/unit'
+require 'sitemap_notifier'
+require 'db'
+require 'timecop'
+require 'fakeweb'
+require 'mocha/setup'
+
+# Catch requests to Google and Bing
+[%r{http://www\.google\.com/webmasters/sitemaps/ping\?sitemap=},
+ %r{http://www\.bing\.com/webmaster/ping\.aspx\?siteMap=}].each do |url|
+   FakeWeb.register_uri(:get, url, :body => "OK!")  
+end
+
+# Catch all other HTTP requests and make them fail so we don't accidentally make real HTTP requests in the test suite
+FakeWeb.register_uri(:any, //, :body => "Fail! (change this in test_helper.rb)", :status => ["400", "Bad Request"])

metadata

@@ -1,69 +1,169 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sitemap_notifier
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Lasse Bunk
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-28 00:00:00 Z
-dependencies: []
-
-description: Ruby on Rails plugin that automatically notifies Google, Bing, Yahoo, and Ask.com of changes to your models, i.e. changes to your sitemap.
-email: lassebunk@gmail.com
+date: 2013-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby on Rails plugin that automatically notifies Google, Bing, and Yahoo
+  of changes to your models, i.e. changes to your sitemap.
+email:
+- lassebunk@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/generators/sitemap_notifier/sitemap_notifier_generator.rb
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/sitemap_notifier/USAGE
+- lib/generators/sitemap_notifier/install_generator.rb
 - lib/generators/sitemap_notifier/templates/initializer.rb
+- lib/sitemap_notifier.rb
 - lib/sitemap_notifier/active_record.rb
 - lib/sitemap_notifier/notifier.rb
-- lib/sitemap_notifier.rb
+- lib/sitemap_notifier/version.rb
+- sitemap_notifier.gemspec
+- test/db.rb
+- test/notifier_test.rb
+- test/test_helper.rb
 homepage: http://github.com/lassebunk/sitemap_notifier
-licenses: []
-
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 3925366765903606920
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 3925366765903606920
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Automatically notify search engines when your models are updated.
-test_files: []
-
+test_files:
+- test/db.rb
+- test/notifier_test.rb
+- test/test_helper.rb

data/lib/generators/sitemap_notifier/sitemap_notifier_generator.rb

@@ -1,7 +0,0 @@
-class SitemapNotifierGenerator < Rails::Generators::NamedBase
-  source_root File.expand_path('../templates', __FILE__)
-  
-  def create_initializer
-    copy_file "initializer.rb", "config/initializers/#{file_name}.rb"
-  end
-end