search_engine_submitter 0.0.1 → 1.0.0

data/README.md

@@ -16,6 +16,10 @@ Or install it yourself as:
 
     $ gem install search_engine_submitter
 
+## Changes
+
+The latest update introduced a breaking change by switching from class methods to object methods. The new changes will make it much easier to test, use, and maintain. Sorry for any inconvience! See Usage below for details on the new syntax.
+
 ## Usage
 
 To submit a sitemap or RSS feed url to all three major search engines:
@@ -23,23 +27,23 @@ To submit a sitemap or RSS feed url to all three major search engines:
 ```ruby
 require 'search_engine_submitter'
 my_sitemap = 'http://testdomain.com/sitemap.xml'
-SearchEngineSubmitter.submit_sitemap_url my_sitemap
+submitter = SearchEngineSubmitter::Submitter.new
+submitter.submit_sitemap_url my_sitemap
 ```
 
-Use the `:to` option to specify which search engines you want for submittal. You can choose from `:google`, `:yahoo`, or `:bing`.
+You can also specify the search engines you want. Choose from any combination of `:google`, `:yahoo`, and `:bing`. You can even submit a URI:
 
 ```ruby
-SearchEngineSubmitter.submit_sitemap_url my_sitemap, :to => [:google, :yahoo]
-```
+submitter = SearchEngineSubmitter::Submitter.new(:engines => [:google, :yahoo])
+submitter.submit_sitemap_url my_sitemap
 
-You can also submit a URI:
+# or...
 
-```ruby
-my_sitemap_uri = URI(my_sitemap)
-SearchEngineSubmitter.submit_sitemap_url my_sitemap_uri
+submitter.engines = [:bing]
+submitter.submit_sitemap_url URI(my_sitemap)
 ```
 
-Or even submit a URI directly:
+You can also submit a URI directly. Use the `:to` option to specify your preferred engines.
 
 ```ruby
 my_sitemap_uri.submit_sitemap :to => :google
@@ -49,8 +53,8 @@ All search engines consider RSS or Atom feeds to be acceptable formats for sitem
 
 ```ruby
 my_rss_feed = 'http://testdomain.com/rss'
-SearchEngineSubmitter.submit_rss_url my_rss_feed, :to => :yahoo
-URI(my_rss_feed).submit_rss :to => [:google, :bing]
+submitter.submit_rss_url my_rss_feed
+URI(my_rss_feed).submit_rss
 ```
 
 The return value of all of these methods is an array of [OpenURI::Meta](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/open-uri/rdoc/OpenURI/Meta.html) objects containing the response of each search engine submittal.

data/lib/search_engine_submitter.rb

@@ -2,53 +2,68 @@ require 'search_engine_submitter/version'
 require 'open-uri'
 
 module SearchEngineSubmitter
+  InvalidSitemapError = Class.new StandardError
+
   SEARCH_ENGINE_URL = {
     :google => 'http://www.google.com/webmasters/sitemaps/ping?sitemap=',
     :bing   => 'http://www.bing.com/webmaster/ping.aspx?siteMap='
     # Note - :yahoo uses :bing for webmaster tools now.
   }
+  DEFAULT_ENGINES = [:google, :bing]
 
-  DEFAULT_OPTIONS = { :to => [:google, :bing] }
+  class Submitter
+    attr_reader :engines
 
-  class << self
-    def submit_sitemap_url(url, options = DEFAULT_OPTIONS)
-      engines = get_engines_from options
-      engines.map { |engine| submit_url_to_search_engine url, engine }
+    def initialize(options={})
+      engine_list = options[:engines] || []
+      @engines = get_engines_from engine_list 
     end
-    alias_method :submit_rss_url, :submit_sitemap_url
-  end
 
-  # Mixin for HTTP URIs
-  module SubmitURI
-    def submit_sitemap(options = DEFAULT_OPTIONS)
-      SearchEngineSubmitter.submit_sitemap_url(self, options)
+    def engines=(engine_list)
+      @engines = get_engines_from engine_list
     end
-    alias_method :submit_rss, :submit_sitemap
-  end
 
-  class InvalidSitemapError < Exception
-  end
+    def submit_sitemap_url(url)
+      engines.map { |engine| submit_url_to_search_engine url, engine }
+    end
+    alias_method :submit_rss_url, :submit_sitemap_url
 
-  private
+    private
 
-    class << self
-      def get_engines_from(options)
-        engines = Array(options[:to]).map(&:to_sym)
-        engines.map{ |to| to == :yahoo ? :bing : to }.uniq
+      def get_engines_from(engine_list)
+        engine_list = Array(engine_list)
+        return DEFAULT_ENGINES if engine_list.empty?
+        engine_list.map(&:to_sym).map{ |engine| engine == :yahoo ? :bing : engine }.uniq
       end
 
       def submit_url_to_search_engine(url, engine)
         begin
           return URI(SEARCH_ENGINE_URL[engine] + url.to_s).read
-        rescue OpenURI::HTTPError
-          raise SearchEngineSubmitter::InvalidSitemapError
+        rescue OpenURI::HTTPError => e
+          raise InvalidSitemapError.new(e.message)
         end
       end
+  end
+
+  # Mixin for HTTP URIs
+  module URISubmitter
+    def submit_sitemap(options={})
+      submitter(options).submit_sitemap_url self
     end
+    alias_method :submit_rss, :submit_sitemap
+
+    private
+
+      def submitter(options={})
+        @submitter ||= Submitter.new
+        @submitter.engines = options[:to] if options[:to]
+        @submitter
+      end
+  end
 end
 
 module URI
   class HTTP
-    include SearchEngineSubmitter::SubmitURI
+    include SearchEngineSubmitter::URISubmitter
   end
 end

data/lib/search_engine_submitter/version.rb

@@ -1,3 +1,3 @@
 module SearchEngineSubmitter
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/spec/lib/search_engine_submitter_spec.rb

@@ -1,64 +1,80 @@
 require 'search_engine_submitter'
 
+RSpec::Matchers.define :be_ok do
+  match do |responses|
+    responses.each { |r| r.status == ["200", "OK"] }
+  end
+end
+
 describe SearchEngineSubmitter do
 
   let(:sitemap_url) { 'http://testdomain.com/sitemap.xml' }
   let(:bad_url) { 'htt://somedomain.a' }
 
-  shared_examples "a submitter" do
+  before(:all) do
+    @submitter = SearchEngineSubmitter::Submitter.new
+    @uri = URI(sitemap_url)
+  end
+
+  shared_examples "a Submitter object" do
     it "should submit a good url" do
-      responses = subject.submit_sitemap_url sitemap_url, :to => search_engine
-      responses.each { |r| r.status.should eq ["200", "OK"] }
+      responses = @submitter.submit_sitemap_url sitemap_url
+      responses.should be_ok
     end
 
     it "should submit a good URI" do
-      responses = URI(sitemap_url).submit_sitemap :to => search_engine
-      responses.each { |r| r.status.should eq ["200", "OK"] }
+      responses = @submitter.submit_sitemap_url @uri
+      responses.should be_ok
     end
   end
-  
-  describe "submit sitemap url" do
+
+  describe "with object methods" do
     engines = [:google, :yahoo, :bing]
+    describe "to all three engines" do
+      before { @submitter = SearchEngineSubmitter::Submitter.new(:engines => engines) }
+      it_should_behave_like 'a Submitter object'
+    end
+
     engines.each do |engine|
       describe "to only #{engine.to_s}" do
-        let(:search_engine) { engine }
-        it_should_behave_like 'a submitter'
+        before { @submitter.engines = engine }
+        it_should_behave_like 'a Submitter object'
 
         if engine == :google
           it "should raise error for bad url" do
-            expect { subject.submit_sitemap_url bad_url, :to => search_engine }.to raise_error(SearchEngineSubmitter::InvalidSitemapError)
+            expect { @submitter.submit_sitemap_url bad_url }.to raise_error(SearchEngineSubmitter::InvalidSitemapError)
           end
         end
       end
     end
 
-    describe "to all three search engines" do
-      let(:search_engine) { engines }
-      it_should_behave_like 'a submitter'
+    it "should work with RSS alias method" do
+      responses = @submitter.submit_rss_url sitemap_url
+      responses.should be_ok
     end
+  end
 
-    describe "with no :to option" do
-      it "should submit a good url" do
-        responses = subject.submit_sitemap_url sitemap_url
-        responses.each { |r| r.status.should eq ["200", "OK"] }
-      end
-
+  describe "with URI mixin methods" do
+    describe "to all three engines" do
       it "should submit a good URI" do
-        responses = URI(sitemap_url).submit_sitemap
-        responses.each { |r| r.status.should eq ["200", "OK"] }
+        responses = @uri.submit_sitemap
+        responses.should be_ok
       end
     end
 
-    describe "with RSS alias methods" do
-      it "should submit a good url" do
-        responses = subject.submit_rss_url sitemap_url
-        responses.each { |r| r.status.should eq ["200", "OK"] }
+    engines = [:google, :yahoo, :bing]
+    engines.each do |engine|
+      describe "to only #{engine.to_s}" do
+        it "should submit a good URI" do
+          responses = @uri.submit_sitemap :to => engine
+          responses.should be_ok
+        end
       end
+    end
 
-      it "should submit a good URI" do
-        responses = URI(sitemap_url).submit_rss
-        responses.each { |r| r.status.should eq ["200", "OK"] }
-      end
+    it "should work with RSS alias method" do
+      responses = @uri.submit_rss
+      responses.should be_ok
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: search_engine_submitter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -60,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1444840707988511149
+      hash: -2439904746061039351
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1444840707988511149
+      hash: -2439904746061039351
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24