search_engine_submitter 0.0.1

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
+bundler_stubs/

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in search_engine_submitter.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Scott McCormack
+
+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,64 @@
+# SearchEngineSubmitter  [![Build Status](https://secure.travis-ci.org/flintinatux/search_engine_submitter.png)](http://travis-ci.org/flintinatux/search_engine_submitter) [![Dependency Status](https://gemnasium.com/flintinatux/search_engine_submitter.png)](https://gemnasium.com/flintinatux/search_engine_submitter) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/flintinatux/search_engine_submitter)
+
+A tool to make the submission of sitemaps and RSS/Atom feeds to search engines as painless as possible. Use it to notify Big-G and friends of updates to your blog, or to ping newly created backlinks for your latest SEO campaign.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'search_engine_submitter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install search_engine_submitter
+
+## Usage
+
+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
+```
+
+Use the `:to` option to specify which search engines you want for submittal. You can choose from `:google`, `:yahoo`, or `:bing`.
+
+```ruby
+SearchEngineSubmitter.submit_sitemap_url my_sitemap, :to => [:google, :yahoo]
+```
+
+You can also submit a URI:
+
+```ruby
+my_sitemap_uri = URI(my_sitemap)
+SearchEngineSubmitter.submit_sitemap_url my_sitemap_uri
+```
+
+Or even submit a URI directly:
+
+```ruby
+my_sitemap_uri.submit_sitemap :to => :google
+```
+
+All search engines consider RSS or Atom feeds to be acceptable formats for sitemaps, so if it makes your code more syntactically aesthetic, then you can use the RSS alias methods instead:
+
+```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]
+```
+
+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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |r|
+  r.rspec_opts = '--color --format documentation'
+end
+task :default => :spec
+
+namespace :gem do
+  require "bundler/gem_tasks"
+end

data/lib/search_engine_submitter/version.rb

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

data/lib/search_engine_submitter.rb

@@ -0,0 +1,54 @@
+require 'search_engine_submitter/version'
+require 'open-uri'
+
+module SearchEngineSubmitter
+  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_OPTIONS = { :to => [:google, :bing] }
+
+  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 }
+    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)
+    end
+    alias_method :submit_rss, :submit_sitemap
+  end
+
+  class InvalidSitemapError < Exception
+  end
+
+  private
+
+    class << self
+      def get_engines_from(options)
+        engines = Array(options[:to]).map(&:to_sym)
+        engines.map{ |to| to == :yahoo ? :bing : to }.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
+        end
+      end
+    end
+end
+
+module URI
+  class HTTP
+    include SearchEngineSubmitter::SubmitURI
+  end
+end

data/search_engine_submitter.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/search_engine_submitter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Scott McCormack"]
+  gem.email         = ["mail@madhackerdesigns.com"]
+  gem.description   = %q{A tool to make the submission of sitemaps and RSS/Atom feeds to search engines as painless as possible. Use it to notify Big-G and friends of updates to your blog, or to ping newly created backlinks for your latest SEO campaign.}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/flintinatux/search_engine_submitter"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "search_engine_submitter"
+  gem.require_paths = ["lib"]
+  gem.version       = SearchEngineSubmitter::VERSION
+  
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+end

data/spec/lib/search_engine_submitter_spec.rb

@@ -0,0 +1,64 @@
+require 'search_engine_submitter'
+
+describe SearchEngineSubmitter do
+
+  let(:sitemap_url) { 'http://testdomain.com/sitemap.xml' }
+  let(:bad_url) { 'htt://somedomain.a' }
+
+  shared_examples "a submitter" 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"] }
+    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"] }
+    end
+  end
+  
+  describe "submit sitemap url" do
+    engines = [:google, :yahoo, :bing]
+    engines.each do |engine|
+      describe "to only #{engine.to_s}" do
+        let(:search_engine) { engine }
+        it_should_behave_like 'a submitter'
+
+        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)
+          end
+        end
+      end
+    end
+
+    describe "to all three search engines" do
+      let(:search_engine) { engines }
+      it_should_behave_like 'a submitter'
+    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
+
+      it "should submit a good URI" do
+        responses = URI(sitemap_url).submit_sitemap
+        responses.each { |r| r.status.should eq ["200", "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"] }
+      end
+
+      it "should submit a good URI" do
+        responses = URI(sitemap_url).submit_rss
+        responses.each { |r| r.status.should eq ["200", "OK"] }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: search_engine_submitter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott McCormack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: A tool to make the submission of sitemaps and RSS/Atom feeds to search
+  engines as painless as possible. Use it to notify Big-G and friends of updates to
+  your blog, or to ping newly created backlinks for your latest SEO campaign.
+email:
+- mail@madhackerdesigns.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/search_engine_submitter.rb
+- lib/search_engine_submitter/version.rb
+- search_engine_submitter.gemspec
+- spec/lib/search_engine_submitter_spec.rb
+homepage: https://github.com/flintinatux/search_engine_submitter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1444840707988511149
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1444840707988511149
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A tool to make the submission of sitemaps and RSS/Atom feeds to search engines
+  as painless as possible. Use it to notify Big-G and friends of updates to your blog,
+  or to ping newly created backlinks for your latest SEO campaign.
+test_files:
+- spec/lib/search_engine_submitter_spec.rb