sitemaps_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84077b93f96854c50072c350407fb253b9e0a952
+  data.tar.gz: 6b1437162a1e98e3e882815cabea1ab5e4b1dc90
+SHA512:
+  metadata.gz: 1e705e71f275f333a98dee425c0c11eddcab08b502233e0500328e926f3570227549ef7867206ad03dcd292a932b477b71592123b7ab456594c981dac5e624fb
+  data.tar.gz: 0decafa6d29c0785d01f2099c64691678df91123986e5f075decf3c5b09d55738195aa6d53c787dfbd757b39462c4df245711c5b1ce90640a88afdc89a28854c

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,17 @@
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jon@accidental.cc. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TermScout
+
+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,58 @@
+# Sitemaps
+
+Discover, retrieve and parse XML sitemaps, according to the spec at [sitemaps.org](http://sitemaps.org).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sitemaps'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sitemaps
+
+## Usage
+
+```ruby
+require 'sitemaps'
+
+# parse a sitemap from a string
+Sitemaps.parse("<xml ns=\"...")
+
+# fetch and parse a sitemap from a known url
+Sitemaps.fetch("http://google.com/sitemap.xml", recurse: true, fetch: :builtin)
+
+# attempt to discover a sitemap url for a domain
+# parallel fetches a small set of 'normal' urls, returns whichever comes back first, most likely only one.
+xml = Sitemaps.discover("http://example.com")
+if url.present?
+  sitemap = Sitemaps.parse(xml)
+end
+
+# sitemap usage
+
+sitemap.entries.first #> Struct(loc: 'http://example.com/page', lastmod: DateTime.utc, changefreq: :monthly, priority: 0.5)
+
+urls = sitemap.entries.map(&:loc)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/termscout/sitemaps. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sitemaps"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sitemaps.rb

@@ -0,0 +1,60 @@
+require "active_support/core_ext/object/blank"
+
+# Discover, fetch and parse XML sitemaps as defined by the `http://sitemaps.org` spec.
+module Sitemaps
+  Entry   = Struct.new(:loc, :lastmod, :changefreq, :priority)
+  Submap  = Struct.new(:loc, :lastmod)
+  Sitemap = Struct.new(:entries, :sitemaps)
+
+  def self.parse(source)
+    Sitemaps::Parser.parse(source)
+  end
+
+  def self.fetch(url, fetch: nil, recurse: true)
+    fetch ||= -> (url) { Sitemaps::Fetcher.fetch(url) }
+    recurse ? fetch_recursive(url, fetch) : fetch_single(url, fetch)
+  end
+
+  def self.fetch_single(url, fetch)
+    source = fetch.call(parse_url(url))
+    Sitemaps::Parser.parse(source)
+  end
+
+  def self.fetch_recursive(url, fetch)
+    queue = [url]
+    maps  = {}
+
+    # walk the queue, fetching the sitemap requested and adding
+    # new sitemaps to the queue as found
+    loop do
+      begin
+        url = queue.pop
+        break if url.nil?
+        next  unless maps[url].nil?
+
+        maps[url] = fetch_single(url, fetch)
+        queue.push(*maps[url].sitemaps.map(&:loc))
+      rescue => ex
+        $stderr.puts "ERROR FETCHING: #{url}, #{ex.message}, ignoring..."
+        next
+      end
+    end
+
+    # collapse the recovered maps into a single one with everything
+    maps.each_with_object(Sitemap.new([], [])) do |(_, map), result|
+      result.sitemaps.concat(map.sitemaps)
+      result.entries.concat(map.entries)
+    end
+  end
+
+  def self.parse_url(url)
+    return url if url.is_a? URI
+
+    url = "http://#{url}" unless url =~ /^https?/
+    URI.parse(url)
+  end
+end
+
+require "sitemaps/version"
+require "sitemaps/parser"
+require "sitemaps/fetcher"

data/lib/sitemaps/fetcher.rb

@@ -0,0 +1,42 @@
+module Sitemaps
+  # Simple single purpose HTTP client
+  module Fetcher
+    class FetchError < StandardError; end
+    class MaxRedirectError < StandardError; end
+
+    @max_attempts = 10
+
+    def self.fetch(uri)
+      attempts = 0
+
+      until attempts >= @max_attempts
+        resp = Net::HTTP.get_response(uri)
+
+        # on a good 2xx response, return the body
+        if resp.code.to_s =~ /2\d\d/
+          if resp.header["Content-Encoding"].blank? && uri.path =~ /\.gz$/
+            return Zlib::GzipReader.new(StringIO.new(resp.body)).read
+          else
+            return resp.body
+          end
+
+          # on a 3xx response, handle the redirect
+        elsif resp.code.to_s =~ /3\d\d/
+          location = URI.parse(resp.header['location'])
+          location = uri + resp.header['location'] if location.relative?
+
+          uri       = location
+          attempts += 1
+          next
+
+          # otherwise (4xx, 5xx) throw an exception
+        else
+          fail FetchError, "Failed to fetch URI, #{uri}, failed with response code: #{resp.code}"
+        end
+      end
+
+      # if we got here, we ran out of attempts
+      fail MaxRedirectError, "Failed to fetch URI #{uri}, redirected too many times" if attempts >= @max_attempts
+    end
+  end
+end

data/lib/sitemaps/parser.rb

@@ -0,0 +1,51 @@
+module Sitemaps
+  # Parse XML Sitemaps
+  module Parser
+    require "time"
+    require "rexml/document"
+    require "active_support"
+    require "active_support/core_ext/object/try"
+
+    def self.parse(source)
+      document = REXML::Document.new(source)
+      entries  = document.elements.to_a("/urlset/url").map do |root|
+        loc  = parse_loc(root) || next
+        mod  = parse_lastmod(root)
+        freq = parse_changefreq(root)
+        pri  = parse_priority(root)
+
+        Sitemaps::Entry.new(loc, mod, freq, pri)
+      end.reject(&:nil?)
+
+      sitemaps = document.elements.to_a("/sitemapindex/sitemap").map do |root|
+        loc  = parse_loc(root) || next
+        mod  = parse_lastmod(root)
+
+        Sitemaps::Submap.new(loc, mod)
+      end.reject(&:nil?)
+
+      Sitemaps::Sitemap.new(entries, sitemaps)
+    end
+
+    def self.parse_loc(root)
+      loc = root.get_text("loc").try(:value)
+      loc && URI.parse(loc) rescue nil
+    end
+
+    def self.parse_lastmod(root)
+      mod = root.get_text("lastmod").try(:value)
+      mod && Time.parse(mod) rescue nil
+    end
+
+    VALID_CHANGEFREQ = %w(always hourly daily weekly monthly yearly never).freeze
+    def self.parse_changefreq(root)
+      freq = root.get_text("changefreq").try(:value)
+      freq && VALID_CHANGEFREQ.include?(freq) ? freq.to_sym : nil
+    end
+
+    def self.parse_priority(root)
+      priority = root.get_text("priority").try(:value) || "0.5"
+      priority && Float(priority) rescue 0.5 # default priority according to spec
+    end
+  end
+end

data/lib/sitemaps/version.rb

@@ -0,0 +1,3 @@
+module Sitemaps
+  VERSION = "0.1.0".freeze
+end

data/sitemaps.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sitemaps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sitemaps_parser"
+  spec.version       = Sitemaps::VERSION
+  spec.authors       = ["Jonathan Raphaelson"]
+  spec.email         = ["jraphaelson@termscout.com"]
+
+  spec.summary       = "Retrieve and parse sitemaps, according to the sitemaps.org spec."
+  spec.homepage      = "http://github.com/termscout/sitemaps"
+  spec.license       = "MIT"
+
+  files = `git ls-files -z`.split("\x0")
+  files.reject! { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.files         = files
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1"
+  spec.add_development_dependency "vcr", "~> 3"
+  spec.add_development_dependency "rubocop", "~> 0.38.0"
+  spec.add_development_dependency "byebug", "~> 8.2"
+
+  spec.add_runtime_dependency "activesupport", "~> 4"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: sitemaps_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Raphaelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: 
+email:
+- jraphaelson@termscout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sitemaps.rb
+- lib/sitemaps/fetcher.rb
+- lib/sitemaps/parser.rb
+- lib/sitemaps/version.rb
+- sitemaps.gemspec
+homepage: http://github.com/termscout/sitemaps
+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: Retrieve and parse sitemaps, according to the sitemaps.org spec.
+test_files: []