pingr 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bodacious
+
+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,79 @@
+# Pingr - Tell search engines about your sitemap changes
+
+Pingr is a super-simple gem built for the [blogit](http://github.com/KatanaCode/blogit "A Rails Blogging Engine") project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pingr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pingr
+
+## Usage
+
+From within your app (most likely a controller):
+
+``` ruby
+def ping_sitemaps
+  Pingr::Request.new(:google, my_sitemap_url).ping
+end
+```
+
+A good way to do this would be using Rails's after filters:
+
+``` ruby
+class PostsController < ActionController::Base
+
+  after_filter :ping_sitemaps, only: [:create, :update, :destroy]
+  
+  # ... 
+  
+  private
+  
+  def ping_sitemaps
+    Pingr::Request.new(:google, my_sitemap_url).ping
+    Pingr::Request.new(:bing, my_sitemap_url).ping
+  end
+  
+end
+```
+
+You can ping all [supported search engines](https://github.com/KatanaCode/pingr/blob/master/lib/pingr.rb#L9) by doing:
+
+``` ruby
+def ping_sitemaps
+  for search_engine in Pingr::SUPPORTED_SEARCH_ENGINES
+    Pingr::Request.new(search_engine, my_sitemap_url).ping
+  end
+end
+```
+
+... not the most elegant solution but we'll improve that in future versions.
+
+## Modes
+
+By default, Pingr is set to **:test** mode, meaning it won't actually perform the requests. If the Rails environment is :production then the mode is set to **:live** which *will* perform requests to the search engines.
+
+You can change this by manually setting `Pingr.mode`
+
+``` ruby
+# in config/initializers/pingr.rb
+Pingr.mode = :live if Rails.env =~ /staging|production/
+```
+
+**NOTE:** Search engines may penalise or black-list you if you perform too many requests - they recommend no more than one per hour.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/pingr.rb

@@ -0,0 +1,63 @@
+require "pingr/version"
+require "pingr/request"
+
+module Pingr
+  
+  # Exceptions raised from within Pingr are of this class
+  class PingrError < StandardError; end
+  
+  # Currently supported search engines
+  SUPPORTED_SEARCH_ENGINES = [:google, :bing]
+  
+  # Public: Set the mode Pingr is running in
+  # 
+  # mode_name - A Symbol or String value for the mode. Must be one of :test or :live
+  # 
+  # Raises PingrError if an invalid value is passed
+  def self.mode=(mode_name)
+    raise PingrError, "Unknown mode: #{mode_name}" unless mode_name.to_s =~ /test|live/
+    @mode = mode_name.to_sym
+  end
+
+  # Public: The mode Pingr is running in
+  # 
+  # Returns a Symbol either :test or :live
+  def self.mode
+    @mode ||= begin
+      if defined?(Rails) && Rails.env.production?
+        :live
+      else
+        :test
+      end
+    end
+  end
+  
+  # Public: A custom logger to keep track of the Pings
+  # 
+  # Returns a Logger object. By default, the log clears itself every week
+  def self.logger
+    @logger ||= Logger.new(logger_name, shift_age = 'weekly')
+  end
+  
+  # Public: Sets the logger to be used.
+  # If the developer would like to use their own custom logger, let 'em.
+  def self.logger=(_logger)
+    @logger = _logger
+  end
+  
+  private
+
+  # Private: The name of the Logger used by Pingr.
+  # If we've detected a Rails app, sets up a log file in the log directory.
+  # Otherwise, use STDOUT
+  # 
+  # Returns a String with the logger name or an IO object
+  def self.logger_name
+    if defined?(Rails)
+      Rails.join('log', "pingr.#{Rails.env}.log")
+    else
+      STDOUT
+    end
+  end
+
+end

data/lib/pingr/request.rb

@@ -0,0 +1,73 @@
+module Pingr
+  
+  # Public: The object created to ping a search engine with a sitemap
+  class Request
+
+    require 'logger'
+    require 'net/http' 
+    require 'uri'
+
+    # Public: Gets/Sets the String url of the sitemap we're submitting
+    attr_accessor :sitemap_url
+    
+    # Public: Gets/Sets the String or Symbol name of the search engine we're pinging
+    attr_accessor :search_engine
+
+    # Public: Initialize a new ping request
+    # 
+    # search_engine - A String or Symbol name of the search engine we're pinging
+    # sitemap_url - A String url of the sitemap we're submitting
+    # 
+    # Returns a Pingr::Request object
+    def initialize(search_engine, sitemap_url)
+      self.search_engine = search_engine.to_sym
+      self.sitemap_url = sitemap_url
+    end
+
+    # Public: The path to ping to submit sitemaps for this search_engine
+    # 
+    # Returns a String with the correct path to submit sitemaps
+    # 
+    # Raises: A PingrError if the search_engine attribute's value is not supported
+    def ping_path
+      case search_engine
+        # http://www.google.com/webmasters/tools/ping?sitemap=
+      when :google then "webmasters/tools/ping?sitemap=#{URI.escape(sitemap_url)}"
+        # http://www.bing.com/ping?sitemap=
+      when :bing then "ping?sitemap=#{URI.escape(sitemap_url)}"
+      else
+        raise PingrError, "Don't know how to ping search engine: #{search_engine}"
+      end
+    end
+
+    # Public: Perform the ping request (if in :live mode)
+    # Logs the success/failure of the ping in logger.
+    # 
+    # Returns true if ping was a success
+    # Returns false if ping was not successful
+    def ping
+      return true unless Pingr.mode == :test
+      uri     = URI.parse("http://#{search_engine}.com/#{ping_path}")
+      http    = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      response = http.request(request)
+      if response.code.to_s =~ /200|301/
+        logger.info "Pinged #{search_engine} Successfully - #{Time.now}"
+        return true
+      else
+        logger.warn "Error pinging #{search_engine}! (response code: #{response.code})- #{Time.now}"
+        return false
+      end
+    end
+
+    private
+    
+    # Private: A helper method to access Pingr::logger
+    # 
+    # Returns A Logger instance
+    def logger
+      Pingr.logger
+    end
+    
+  end
+end

data/lib/pingr/version.rb

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

data/pingr.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pingr/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pingr"
+  gem.version       = Pingr::VERSION
+  gem.authors       = ["Bodacious"]
+  gem.email         = ["bodacious@katanacode.com"]
+  gem.description   = %q{A simple gem for pinging search engines with your XML sitemap}
+  gem.summary       = %q{Ping search engines with your XML Sitemap}
+  gem.homepage      = "https://github.com/KatanaCode/pingr"
+
+  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.require_paths = ["lib"]
+  
+  gem.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: pingr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bodacious
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-27 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: A simple gem for pinging search engines with your XML sitemap
+email:
+- bodacious@katanacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pingr.rb
+- lib/pingr/request.rb
+- lib/pingr/version.rb
+- pingr.gemspec
+homepage: https://github.com/KatanaCode/pingr
+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: 3122621333235688264
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3122621333235688264
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ping search engines with your XML Sitemap
+test_files: []