google-blogsearch-pings 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.idea
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Colin MacKenzie IV
+
+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.rdoc

@@ -0,0 +1,49 @@
+= google-blogsearch-pings
+
+The Google Blog Search Pinging Service API allows users who frequently update their blog to programmatically inform
+Google Blog Search about changes to their blogs. Blogging provider admins can also use this API to notify Google of
+changes to blogs on their platform(s).
+
+This gem utilizes the Google Blog Search Pinging Service API in order to notify Google of updates to your blog so that
+it can be reindexed more quickly.
+
+== Installation
+
+  gem install google-blogsearch-pings
+  
+== Usage
+
+  google = Google::Blogsearch::Ping.new("Name of Blog", "http://www.nameofblog.com/rss.xml")
+  google.ping!
+
+The above usage will infer the website as well as the path to the updated page from the URL of the RSS feed.
+Alternatively, you can set them explicitly using the following syntax:
+
+  google = Google::Blogsearch::Ping.new("Name of Blog", "http://www.nameofblog.com/rss.xml",
+                                        :site => "http://www.thesitename.com",
+                                        :updated => "http://www.nameofblog.com/path/to/updated/file.html")
+  google.ping!
+  
+Finally, you can tag the ping with keywords:
+
+  google = Google::Blogsearch::Ping.new("Name of Blog", "http://www.nameofblog.com/rss.xml",
+                                        :site => "http://www.thesitename.com",
+                                        :updated => "http://www.nameofblog.com/path/to/updated/file.html",
+                                        :tags => %w(ruby rails))
+  google.tags #=> ["ruby", "rails"]
+  
+  google.ping!
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Colin MacKenzie IV. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "google-blogsearch-pings"
+    gem.summary = %Q{Utilizes the Google Blog Search Pinging Service API in order to notify Google of updates to your blog so that it can be reindexed more quickly}
+    gem.description = %Q{Utilizes the Google Blog Search Pinging Service API in order to notify Google of updates to your blog so that it can be reindexed more quickly}
+    gem.email = "sinisterchipmunk@gmail.com"
+    gem.homepage = "http://thoughtsincomputation.com"
+    gem.authors = ["Colin MacKenzie IV"]
+    gem.add_development_dependency "rspec", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "google-blogsearch-pings #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/google-blogsearch-pings.rb

@@ -0,0 +1,42 @@
+require "xmlrpc/client"
+
+module Google
+  module Blogsearch
+    class Ping
+      attr_accessor :name, :feed_url, :site_url, :update_url, :tags
+      
+      def initialize(name, feed_url, options = {})
+        @name, @feed_url = name, feed_url
+        @site_url   = options.delete(:site)   || infer_url(feed_url)
+        @update_url = options.delete(:update) || options.delete(:updated) || infer_url(feed_url)
+        self.tags   = options.delete(:tags)   || []
+      end
+      
+      def ping!
+        server = XMLRPC::Client.new2("http://blogsearch.google.com/ping/RPC2")
+        if tags.length == 0
+          ok, param = server.call2("weblogUpdates.extendedPing", name, site_url, update_url, feed_url)
+        else
+          ok, param = server.call2("weblogUpdates.extendedPing", name, site_url, update_url, feed_url, tags_param)
+        end
+        
+        if ok
+          error, message = param['flerror'], param['message']
+          raise message if error
+          message
+        else
+          raise "#{param.faultString} (#{param.faultCode})"
+        end
+      end
+      
+      def tags_param
+        tags.join("|")
+      end
+
+      private
+      def infer_url(feed_url)
+        feed_url.gsub(/^((.*?:\/\/\/?).*?(\/|$))(.*|)/, '\1')
+      end
+    end
+  end
+end

data/spec/ping_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+=begin
+  Name of site
+  URL of site
+  URL of the page to be checked for changes
+  URL of RSS, RDF, or Atom feed
+  Optional a name (or "tag") categorizing your site content. You may delimit multiple values by using the '|' character.
+=end
+
+describe Google::Blogsearch::Ping do
+  subject { Google::Blogsearch::Ping.new("Thoughts in Computation", "http://thoughtsincomputation.com/rss") }
+  
+  it "should set name" do
+    subject.name.should == "Thoughts in Computation"
+  end
+  
+  it "should set feed URL" do
+    subject.feed_url.should == "http://thoughtsincomputation.com/rss"
+  end
+  
+  it "should infer site URL" do
+    subject.site_url.should == "http://thoughtsincomputation.com/"
+  end
+  
+  it "should infer update URL" do
+    subject.update_url.should == "http://thoughtsincomputation.com/"
+  end
+  
+  it "should have no tags" do
+    subject.tags.should == []
+  end
+  
+  it "should send the ping" do
+    client = XMLRPC::Client.new2("http://blogsearch.google.com/ping/RPC2")
+    XMLRPC::Client.should_receive(:new).and_return(client)
+    subject.ping!
+  end
+  
+  context "with site and update URLs" do
+    subject { Google::Blogsearch::Ping.new("Thoughts in Computation", "http://thoughtsincomputation.com/rss",
+                                           :site => "http://www.thoughtsincomputation.com",
+                                           :updated => "http://www.thoughtsincomputation.com") }
+    
+    it "should set the site URL" do
+      subject.site_url.should == "http://www.thoughtsincomputation.com"
+    end
+    
+    it "should set the updated URL" do
+      subject.update_url.should == "http://www.thoughtsincomputation.com"
+    end
+  end
+  
+  context "with tags" do
+    subject { Google::Blogsearch::Ping.new("Thoughts in Computation", "http://thoughtsincomputation.com/rss",
+                                           :tags => %w(ruby rails)) }
+    
+    it "should construct the tags parameter" do
+      subject.tags_param.should == "ruby|rails"
+    end
+
+    it "should have tags" do # duh :P
+      subject.tags.should == ["ruby", "rails"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "../lib/google-blogsearch-pings")

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: google-blogsearch-pings
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Colin MacKenzie IV
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Utilizes the Google Blog Search Pinging Service API in order to notify Google of updates to your blog so that it can be reindexed more quickly
+email: sinisterchipmunk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/google-blogsearch-pings.rb
+- spec/ping_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://thoughtsincomputation.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Utilizes the Google Blog Search Pinging Service API in order to notify Google of updates to your blog so that it can be reindexed more quickly
+test_files: 
+- spec/ping_spec.rb
+- spec/spec_helper.rb