arwen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28a4731079ae915acfb7f6b50e7210ef4e9cb46eaf2cca7072734c900e12c30f
+  data.tar.gz: 857982f366ff50a6d60d0ae2aa87a108b913c1ac9f67ae15294e7b9cb14c6597
+SHA512:
+  metadata.gz: 8abe5eec16f455c42e3a0d799f9f1d758c376e7340b981a09c5b9a08e938f84afd52769d0af0a0703e810a2fb00114a7e8c06755ba9e3ebc7a7911bac87d84bd
+  data.tar.gz: e5b7e9157ae6ed2dd5cf09ec9850205dec2d2d03d7341fc14e72e0cfe71431a7a2b9358cb7a1345272bbcfb8ed4e46663ca13693d6d9058eede1f298ca55efce

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.11
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+benchmarks/

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require:
+  - rubocop-rake
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-02-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in arwen.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.7"
+gem "rubocop-minitest"
+gem "rubocop-rake"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    arwen (0.1.0)
+      ox (~> 2.14)
+      typhoeus (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.14.2)
+    minitest (5.14.4)
+    ox (2.14.1)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-minitest (0.10.3)
+      rubocop (>= 0.87, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.11.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  arwen!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  rubocop-minitest
+  rubocop-rake
+
+BUNDLED WITH
+   2.2.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Adam Hake
+
+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,62 @@
+# Arwen
+
+Arwen parses sitemaps that adhere to the sitemaps.org protocol.  Inspired by benbalter's [sitemap-parser gem](https://github.com/benbalter/sitemap-parser), arwen automatically detects if recursion is needed by analyzing the presence of `<sitemapindex>`. It also leverages Typheous' parallel request functionality via `Typheous::Hydra` when needed to drastically speed up
+fetching large sitemaps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arwen'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install arwen
+
+## Usage
+
+To parse a sitemap, create a new `Arwen` instance, passing it the URL to the sitemap and, optionally, any options that should be passed to `Typheous::Request`.
+
+```ruby
+arwen = Arwen.new("https://www.example.org/sitemap.xml")
+```
+As long as the sitemap implements the sitemaps.org protocol, `arwen` will check if the sitemap should be parsed recursively (i.e. if the sitemap implements `<sitemapindex>`).  The sitemap is not fetched until a method is called that accesses it.
+
+`arwen` uses `Ox` has its XML parser. To access the raw `Ox::Document` sitemap, use the `sitemap` instance method. See the `Ox::Document` [documentation](http://www.ohler.com/ox/Ox/Document.html) for full details.
+
+```ruby
+arwen.sitemap # Ox::document
+```
+The `urls` instance method returns an array of `Arwen::Url` objects.  `Arwen::Url` is a simple object that models the `<url>` schema in the sitemaps.org protocol.
+
+```ruby
+arwen.urls # Array<Arwen::Url>
+```
+
+To get an array of just the url strings for the whole sitemap, use the `to_a` instance method:
+
+```ruby
+arwen.to_a # Array<string>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/adamhake/arwen.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+*Yes, the name is a reference to the Half-Elven daughter of Elrond.*

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/arwen.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require "arwen/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "arwen"
+  spec.version       = Arwen::VERSION
+  spec.authors       = ["Adam Hake"]
+  spec.email         = ["adamhake@gmail.com"]
+
+  spec.summary       = "Parses a sitemap recursively using typheous"
+  spec.description   = "Sitemap Parser recursively parses a sitemap leveraging typheous concurrent https request"
+  spec.homepage      = "https://github.com/adamhake/arwen"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "ox", "~> 2.14"
+  spec.add_dependency "typhoeus", "~> 1.4"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "arwen"
+
+# 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(__FILE__)

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/arwen.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "arwen/version"
+require "arwen/url"
+require "ox"
+require "typhoeus"
+
+# Parses a sitemap url and provides all links provided by the sitemap or sitemap_index.
+# It uses Typheous for network requests and making concurrent requests when parsing a sitemap_index.
+# Ox is the XML parser used to parse the sitemap. Sitemaps are assumed to follow the sitemaps.org protocol.
+#
+# @see https://github.com/typhoeus/typhoeus
+# @see https://github.com/ohler55/ox
+# @see https://www.sitemaps.org/protocol.html
+class Arwen
+  # Create a new Arwen instance
+  #
+  # @param [string] url the full URL to the sitemap or sitemap_index XML file
+  # @param [hash] opts options passed to Typheous::Request instances.
+  # @option opts [integer] :max_concurrency maximum concurrent requests passed to Typheous::Hydra
+  # @see https://rubydoc.info/github/typhoeus/typhoeus/Typhoeus/Request
+  def initialize(url, opts = {})
+    @url = url
+    max_concurrency = opts.delete(:max_concurrency) { 200 }
+    @opts = { followlocation: true }.merge(opts)
+    @hydra = Typhoeus::Hydra.new(max_concurrency: max_concurrency)
+  end
+
+  # fetches and returns all urls for the sitemap with corresponding <url> sitemap schema metadata
+  #
+  # @return [Array<SitemapParser::Url>]
+  def urls
+    @urls ||= all_urls(sitemap)
+  end
+
+  # returns an array of url strings for all URls in the sitemap
+  #
+  # @return [Array<String>]
+  def to_a
+    urls.map(&:url)
+  end
+
+  # parses the sitemap url to an Ox::Document instance
+  #
+  # @return [Ox::Document]
+  # @see http://www.ohler.com/ox/Ox/Document.html
+  def sitemap
+    @sitemap ||= raw_sitemap
+  end
+
+  private
+
+  def all_urls(sitemap)
+    return parse_multiple_sitemaps(sitemap) if sitemap.root.respond_to?(:sitemap)
+
+    parse_single_sitemap(sitemap)
+  end
+
+  def parse_multiple_sitemaps(sitemap)
+    raise "invalid sitemap format" unless sitemap&.root&.value == "sitemapindex"
+
+    urls = sitemap.root.locate("sitemap/loc/*")
+    site_urls = []
+
+    requests = fetch_sitemaps(urls)
+    requests.each do |req|
+      sitemap = Ox.load(req.response.body)
+      site_urls += parse_single_sitemap(sitemap)
+    end
+
+    site_urls
+  end
+
+  def fetch_sitemaps(urls)
+    requests = urls.map do |url|
+      req = Typhoeus::Request.new(url, @opts)
+      @hydra.queue(req)
+      req
+    end
+    @hydra.run
+
+    requests
+  end
+
+  def parse_single_sitemap(sitemap)
+    raise "invalid sitemap format" unless sitemap&.root&.value == "urlset"
+
+    sitemap.root.nodes.map { |node| Url.new(node) }
+  end
+
+  def raw_sitemap
+    response = Typhoeus.get(@url, @opts)
+    raise "invalid sitemap url for #{@url}" unless response.success?
+
+    Ox.load(response.body)
+  end
+end

data/lib/arwen/url.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Arwen
+  # Models the sitemap <url> schema definition according the sitemap.org protocol
+  #
+  # @see https://www.sitemaps.org/protocol.html#urldef
+  class Url
+    # @return [string] <loc> schema value
+    attr_accessor :url
+
+    # @return [string] <lastmod> schema value
+    attr_accessor :lastmod
+
+    # @return [float] <priority> schema value
+    attr_accessor :priority
+
+    # @return [string] <changefreq> schema value
+    attr_accessor :changefreq
+
+    # The Ox::Element object used to initialize the Url instance
+    # @return [Ox::Element]
+    attr_reader :raw
+
+    # Create a new SitemapParser::URL
+    #
+    # @param [Ox::Element] ox_element element in the sitemap tree
+    # @see http://www.ohler.com/ox/Ox/Element.html
+    def initialize(ox_element)
+      @url = ox_element.locate("loc/*").first
+      @lastmod = ox_element.locate("lastmod/*").first
+      @priority = ox_element.locate("priority/*").first&.to_f
+      @changefreq = ox_element.locate("changefreq/*").first
+      @raw = ox_element
+    end
+
+    # converts the string lastmod value to a `Date` object
+    #
+    # @return [Date]
+    def to_date
+      return nil if lastmod.nil?
+
+      Date.parse(lastmod)
+    end
+  end
+end

data/lib/arwen/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Arwen
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: arwen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Hake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Sitemap Parser recursively parses a sitemap leveraging typheous concurrent
+  https request
+email:
+- adamhake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- arwen.gemspec
+- bin/console
+- bin/setup
+- lib/arwen.rb
+- lib/arwen/url.rb
+- lib/arwen/version.rb
+homepage: https://github.com/adamhake/arwen
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/adamhake/arwen
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Parses a sitemap recursively using typheous
+test_files: []