sitemaped 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71633dcc823c53b58e985df4cd7d704678e3413a
+  data.tar.gz: 8f76e93e6ca137fdde8a33274f87331f24afd46d
+SHA512:
+  metadata.gz: 6b700f97ed304f4eff6a24ed8c05b19e9f85e8a6b8b1f6211fd461e5d0fcecbf67d47e982653ae801d3b449dbd903a499ffd49ca7212655a160a2054bba1e080
+  data.tar.gz: a0ee197e2d965f12aef969b2160617839becc7a4a21487ba3f7c9f1299771e7083336156d034491fb6533e0d849216107b16e726dbf0f35c078044ef3fcab310

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    sitemaped (0.0.1)
+      nokogiri (~> 1.6)
+      nokogiri (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mini_portile (0.6.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  rake
+  sitemaped!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Railsemechanic, Matthias Kalb
+
+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,44 @@
+# Sitemaped
+Sitemaped is a powerful parser for XML sitemaps which respects all sitemaps listed in robots.txt and handles gziped and nested sitemaps as well.
+
+## Features
+
+- Respects sitemaps listed in robots.txt
+- Handles gziped sitemaps
+- Supports nested sitemaps (sitemap of sitemaps)
+
+## Installation
+### With Bundler
+Just add to your Gemfile
+~~~ruby
+gem 'sitemaped'
+~~~
+
+### Without Bundler
+If you're not using Bundler just execute on your commandline
+~~~bash
+$ gem install sitemaped
+~~~
+
+## Usage
+### Get a list of all URLs listed in the sitemap
+Sitemaped returns an array with all URLs listed in the sitemap(s)
+~~~ruby
+require 'sitemaped'
+
+website = Sitemaped.new('http://www.example.com') # => ["http://www.example.com/", "http://www.example.com/contact", ...]
+sitemap = website.sitemap
+~~~
+
+### Check whether an URL is covered by the sitemap
+To check whether an URL is covered by the sitemap use
+~~~ruby
+require 'sitemaped'
+
+sitemap = Sitemaped.new('http://www.example.com')
+sitemap.include?('http://www.example.com/contact') # => true or false
+~~~
+
+## ToDo
+- Search for optimizations
+- Add tests

data/Rakefile

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

data/lib/sitemaped.rb

@@ -0,0 +1,74 @@
+require 'nokogiri'
+require 'uri'
+require 'set'
+require 'open-uri'
+
+class Sitemaped
+
+  def initialize(url)
+    @url = URI.parse(URI.encode(url))
+    raise URI::InvalidURIError.new('scheme or host missing') unless @url.scheme and @url.host
+    @sitemap = Set.new
+  end
+
+  def sitemap
+    sitemaps.to_a
+  end
+
+  def include?(path)
+    sitemaps.include?(path)
+  end
+
+  private
+
+  def sitemaps
+    return @sitemap.empty? ? @sitemap.merge(robots_sitemap || default_sitemap) : @sitemap
+  end
+
+  def robots_sitemap
+    @robots_sitemap_urls ||= open("#{@url.scheme}://#{@url.host}/robots.txt").read.scan(/\s*sitemap:\s*([^\r\n]+)\s*$/i).flatten!
+  rescue
+    @robots_sitemap_urls = []
+  ensure
+    unless @robots_sitemap_urls.empty?
+      return @robots_sitemap_data ||= handle_nested_sitemaps(@robots_sitemap_urls)
+    end
+  end
+
+  def default_sitemap
+    @default_sitemap_data ||= parse_sitemap(load_sitemap("#{@url.scheme}://#{@url.host}/sitemap.xml") || load_sitemap("#{@url.scheme}://#{@url.host}/sitemap.xml.gz"))
+  end
+
+  def handle_nested_sitemaps(sitemap_list=[])
+    return sitemap_list.map do |sitemap_url|
+      load_sitemap(sitemap_url)
+    end.compact.map do |sitemap_io|
+      parse_sitemap(sitemap_io)
+    end.compact.flatten
+  end
+
+  def load_sitemap(url=nil)
+    sitemap_io = open(url)
+  rescue
+    return nil
+  else
+    begin
+      return Zlib::GzipReader.new(sitemap_io)
+    rescue
+      sitemap_io.rewind
+      return sitemap_io
+    end
+  end
+
+  def parse_sitemap(sitemap_io)
+    sitemap_data = Nokogiri::HTML(sitemap_io)
+    if nested_sitemaps = sitemap_data.xpath("//sitemapindex/sitemap/loc") and !nested_sitemaps.empty?
+      return handle_nested_sitemaps(nested_sitemaps.map(&:text).flatten)
+    end
+
+    return sitemap_data.xpath("//urlset/url/loc").map(&:text).flatten
+  rescue
+    nil
+  end
+
+end

data/lib/sitemaped/version.rb

@@ -0,0 +1,3 @@
+class Sitemaped
+  VERSION = "0.1.0"
+end

data/sitemaped.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sitemaped/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sitemaped"
+  spec.version       = Sitemaped::VERSION
+  spec.authors       = ["Matthias Kalb"]
+  spec.email         = ["matthias.kalb@railsmechanic.de"]
+  spec.summary       = %q{Parser for XML sitemaps}
+  spec.description   = %q{Parser for XML sitemaps which respects sitemaps listed in robots.txt and handles gziped and nested sitemaps as well.}
+  spec.homepage      = "https://github.com/railsmechanic/sitemaped"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6', '~> 1.6'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: sitemaped
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthias Kalb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parser for XML sitemaps which respects sitemaps listed in robots.txt
+  and handles gziped and nested sitemaps as well.
+email:
+- matthias.kalb@railsmechanic.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/sitemaped.rb
+- lib/sitemaped/version.rb
+- sitemaped.gemspec
+homepage: https://github.com/railsmechanic/sitemaped
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Parser for XML sitemaps
+test_files: []