sitemap_checker 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,5 @@
+source 'https://rubygems.org'
+
+gem 'nokogiri'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 GerlandoP
+
+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,30 @@
+# SitemapChecker
+
+Checks sitemap urls for valid response
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sitemap_checker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sitemap_checker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/lib/sitemap_checker.rb

@@ -0,0 +1,52 @@
+require "sitemap_checker/version"
+require 'open-uri'
+require 'nokogiri'
+require 'zlib'
+
+module SitemapChecker
+  class Checker
+    attr_reader :status_list
+
+    def initialize(url,schema='http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd')
+      @schema = schema
+      @url = url
+      @sitemap = get_xml_from_url
+      sitemap_is_valid?
+      @status_list = get_status_list
+    end
+
+    private
+
+    def get_xml_from_url
+      begin
+        Nokogiri::XML(Zlib::GzipReader.new(open(@url)))
+      rescue
+        Nokogiri::XML(open(@url))
+      end
+    end
+
+    def sitemap_is_valid?
+      xsd = Nokogiri::XML::Schema(open(@schema))
+      raise 'Invalid Schema' unless xsd.valid?(@sitemap)
+      true
+    end
+
+    def urls
+      @sitemap.xpath("//xmlns:loc")
+    end
+
+    def get_status_list
+      statuses = []
+      urls.each do |url|
+        begin
+          status = [url.content,open(url).status[0]]
+        rescue OpenURI::HTTPError => e
+          status = [url.content,e.io.status[0]]
+        end
+        statuses << status
+      end
+      statuses
+    end
+  end
+
+end

data/lib/sitemap_checker/version.rb

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

data/sitemap_checker.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sitemap_checker/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gerlando Piro"]
+  gem.email         = ["gerlando@gmail.com"]
+  gem.description   = %q{SiteMap Checker}
+  gem.summary       = %q{Gets status of Urls in SiteMap}
+  gem.homepage      = "https://github.com/gerlandop/sitemap_checker"
+
+  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          = "sitemap_checker"
+  gem.require_paths = ["lib"]
+  gem.version       = SitemapChecker::VERSION
+
+  gem.add_dependency 'nokogiri'
+end

data/spec/fixtures/sitemap_schema.xml

@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+            targetNamespace="http://www.sitemaps.org/schemas/sitemap/0.9"
+            xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
+            elementFormDefault="qualified">
+<xsd:annotation>
+  <xsd:documentation>
+    XML Schema for Sitemap files.
+    Last Modifed 2008-03-26
+  </xsd:documentation>
+</xsd:annotation>
+
+<xsd:element name="urlset">
+  <xsd:annotation>
+    <xsd:documentation>
+      Container for a set of up to 50,000 document elements.
+      This is the root element of the XML file.
+    </xsd:documentation>
+  </xsd:annotation>
+ <xsd:complexType>
+   <xsd:sequence>
+     <xsd:element name="url" type="tUrl" maxOccurs="unbounded"/>
+   </xsd:sequence>
+ </xsd:complexType>
+</xsd:element>
+
+<xsd:complexType name="tUrl">
+  <xsd:annotation>
+    <xsd:documentation>
+      Container for the data needed to describe a document to crawl.
+    </xsd:documentation>
+  </xsd:annotation>
+  <xsd:sequence>
+    <xsd:element name="loc" type="tLoc"/>
+    <xsd:element name="lastmod" type="tLastmod" minOccurs="0"/>
+    <xsd:element name="changefreq" type="tChangeFreq" minOccurs="0"/>
+    <xsd:element name="priority" type="tPriority" minOccurs="0"/>
+    <xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="strict"/>
+  </xsd:sequence>
+</xsd:complexType>
+
+<xsd:simpleType name="tLoc">
+  <xsd:annotation>
+    <xsd:documentation>
+      REQUIRED: The location URI of a document.
+      The URI must conform to RFC 2396 (http://www.ietf.org/rfc/rfc2396.txt).
+    </xsd:documentation>
+  </xsd:annotation>
+  <xsd:restriction base="xsd:anyURI">
+    <xsd:minLength value="12"/>
+    <xsd:maxLength value="2048"/>
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="tLastmod">
+  <xsd:annotation>
+    <xsd:documentation>
+      OPTIONAL: The date the document was last modified. The date must conform
+      to the W3C DATETIME format (http://www.w3.org/TR/NOTE-datetime).
+      Example: 2005-05-10
+      Lastmod may also contain a timestamp.
+      Example: 2005-05-10T17:33:30+08:00
+    </xsd:documentation>
+  </xsd:annotation>
+  <xsd:union>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:date"/>
+    </xsd:simpleType>
+    <xsd:simpleType>
+      <xsd:restriction base="xsd:dateTime"/>
+      </xsd:simpleType>
+  </xsd:union>
+</xsd:simpleType>
+
+<xsd:simpleType name="tChangeFreq">
+  <xsd:annotation>
+    <xsd:documentation>
+      OPTIONAL: Indicates how frequently the content at a particular URL is
+      likely to change. The value "always" should be used to describe
+      documents that change each time they are accessed. The value "never"
+      should be used to describe archived URLs. Please note that web
+      crawlers may not necessarily crawl pages marked "always" more often.
+      Consider this element as a friendly suggestion and not a command.
+    </xsd:documentation>
+  </xsd:annotation>
+  <xsd:restriction base="xsd:string">
+    <xsd:enumeration value="always"/>
+    <xsd:enumeration value="hourly"/>
+    <xsd:enumeration value="daily"/>
+    <xsd:enumeration value="weekly"/>
+    <xsd:enumeration value="monthly"/>
+    <xsd:enumeration value="yearly"/>
+    <xsd:enumeration value="never"/>
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="tPriority">
+  <xsd:annotation>
+    <xsd:documentation>
+      OPTIONAL: The priority of a particular URL relative to other pages
+      on the same site. The value for this element is a number between
+      0.0 and 1.0 where 0.0 identifies the lowest priority page(s).
+      The default priority of a page is 0.5. Priority is used to select
+      between pages on your site. Setting a priority of 1.0 for all URLs
+      will not help you, as the relative priority of pages on your site
+      is what will be considered.
+    </xsd:documentation>
+  </xsd:annotation>
+  <xsd:restriction base="xsd:decimal">
+    <xsd:minInclusive value="0.0"/>
+    <xsd:maxInclusive value="1.0"/>
+  </xsd:restriction>
+</xsd:simpleType>
+
+</xsd:schema>

data/spec/fixtures/valid_sitemap.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1" xmlns:geo="http://www.google.com/geo/schemas/sitemap/1.0" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9/">
+  <url>
+    <loc>http://www.github.com</loc>
+    <lastmod>2012-07-27T15:27:41-07:00</lastmod>
+    <changefreq>always</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>http://www.github.com/404</loc>
+    <lastmod>2012-07-27T15:27:41-07:00</lastmod>
+    <changefreq>always</changefreq>
+    <priority>1.0</priority>
+  </url>
+</urlset>

data/spec/sitemap_checker_spec.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'webmock/rspec'
+require './lib/sitemap_checker'
+WebMock.disable_net_connect!(:allow_localhost => true)
+
+describe SitemapChecker do
+  before(:each) do
+    @dir  = Pathname.new(File.dirname(__FILE__))
+    stub_request(:any, "http://www.github.com").to_return(:status => 200, :body => 'foo')
+    stub_request(:any, "http://www.github.com/404").to_return(:status => 404, :body => 'foo')
+    stub_request(:any, "http://www.github.com/index.xml").to_return(:status => 200, :body => File.read(@dir + 'fixtures/valid_sitemap.xml'))
+    stub_request(:any, "http://www.github.com/index.xml.gz").to_return(:status => 200, :body => File.read(@dir + 'fixtures/valid_sitemap.xml.gz'))
+    stub_request(:get, "http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd").
+      with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+      to_return(:status => 200, :body => File.read(@dir + 'fixtures/sitemap_schema.xml'), :headers => {})
+  end
+
+  it "accepts xml and gzipped files" do
+    @xml_sitemap = SitemapChecker::Checker.new('http://www.github.com/index.xml')
+    @gz_sitemap = SitemapChecker::Checker.new('http://www.github.com/index.xml.gz')
+    @xml_sitemap.status_list.size.should eq(2)
+    @gz_sitemap.status_list.size.should eq(2)
+  end
+
+  it "Errors if input doc does not match sitemap schema" do
+    lambda {SitemapChecker::Checker.new('http://www.github.com')}.should raise_error(RuntimeError, 'Invalid Schema')
+  end
+
+  it "returns list of urls with responses" do
+    @valid_sitemap = SitemapChecker::Checker.new('http://www.github.com/index.xml')
+    @valid_sitemap.status_list.should eq([['http://www.github.com','200'], ['http://www.github.com/404','404']])
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: sitemap_checker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gerlando Piro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SiteMap Checker
+email:
+- gerlando@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sitemap_checker.rb
+- lib/sitemap_checker/version.rb
+- sitemap_checker.gemspec
+- spec/fixtures/sitemap_schema.xml
+- spec/fixtures/valid_sitemap.xml
+- spec/fixtures/valid_sitemap.xml.gz
+- spec/sitemap_checker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gerlandop/sitemap_checker
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gets status of Urls in SiteMap
+test_files:
+- spec/fixtures/sitemap_schema.xml
+- spec/fixtures/valid_sitemap.xml
+- spec/fixtures/valid_sitemap.xml.gz
+- spec/sitemap_checker_spec.rb
+- spec/spec_helper.rb