grubby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88c8ecc06ffba254ee9e9de3d42f868c0692b244
+  data.tar.gz: 8cd3445f33c9f7db05550947d686293ceee620c1
+SHA512:
+  metadata.gz: d9dc7435763425d54d82f4930935c913cd67eb15a1250c58c7ccf3b0e419eeb6ceb87289ed3c22386faa96e3ae3584a9f39cf8e671af8b56b52bb3e2c8257e4d
+  data.tar.gz: 2c5c96993c8a673274a4acc34c3f82a8719fbea508c1dffb5ce8cff1d4a13cd90c9fcbf8a3c743500a31f08419c687c24adf5f2aee464a8a4f1935b2b302b184

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.15.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonathan Hefner
+
+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,127 @@
+# grubby
+
+[Fail-fast] web scraping.  *grubby* adds a layer of utility and
+error-checking atop the marvelous [Mechanize gem].  See API summary
+below, or browse the [full documentation].
+
+[Fail-fast]: https://en.wikipedia.org/wiki/Fail-fast
+[Mechanize gem]: https://rubygems.org/gems/mechanize
+[full documentation]: http://www.rubydoc.info/gems/grubby/
+
+
+## Examples
+
+The following example scrapes the [Hacker News] front page:
+
+```ruby
+require "grubby"
+
+class HackerNews < Grubby::PageScraper
+
+  scrapes(:items) do
+    page.search!(".athing").map{|item| HackerNewsItem.new(item) }
+  end
+
+end
+
+class HackerNewsItem < Grubby::Scraper
+
+  scrapes(:title) { @row1.at!(".storylink").text }
+  scrapes(:submitter) { @row2.at!(".hnuser").text }
+  scrapes(:story_uri) { URI.join(@base_uri, @row1.at!(".storylink")["href"]) }
+  scrapes(:comments_uri) { URI.join(@base_uri, @row2.at!(".age a")["href"]) }
+
+  def initialize(source)
+    @row1 = source
+    @row2 = source.next_sibling
+    @base_uri = source.document.url
+    super
+  end
+
+end
+
+grubby = Grubby.new
+
+# The following line will raise an exception if anything goes wrong
+# during the scraping process.  For example, if the structure of the
+# HTML does not match expectations, either due to a bad assumption or
+# due to a site-wide change, the script will terminate immediately with
+# a relevant error message.  This prevents bad values from propogating
+# and causing hard-to-trace errors.
+hn = HackerNews.new(grubby.get("https://news.ycombinator.com/news"))
+
+puts hn.items.take(10).map(&:title) # your scraping logic goes here
+```
+
+[Hacker News]: https://news.ycombinator.com/news
+
+
+## Core API
+
+- [Grubby](http://www.rubydoc.info/gems/grubby/Grubby)
+  - [#get_mirrored](http://www.rubydoc.info/gems/grubby/Grubby:get_mirrored)
+  - [#singleton](http://www.rubydoc.info/gems/grubby/Grubby:singleton)
+  - [#time_between_requests](http://www.rubydoc.info/gems/grubby/Grubby:time_between_requests)
+- [Scraper](http://www.rubydoc.info/gems/grubby/Grubby/Scraper)
+  - [.fields](http://www.rubydoc.info/gems/grubby/Grubby/Scraper.fields)
+  - [.scrapes](http://www.rubydoc.info/gems/grubby/Grubby/Scraper.scrapes)
+  - [#[]](http://www.rubydoc.info/gems/grubby/Grubby/Scraper:[])
+  - [#source](http://www.rubydoc.info/gems/grubby/Grubby/Scraper:source)
+  - [#to_h](http://www.rubydoc.info/gems/grubby/Grubby/Scraper:to_h)
+- [PageScraper](http://www.rubydoc.info/gems/grubby/Grubby/PageScraper)
+  - [#page](http://www.rubydoc.info/gems/grubby/Grubby/PageScraper:page)
+- [JsonScraper](http://www.rubydoc.info/gems/grubby/Grubby/JsonScraper)
+  - [#json](http://www.rubydoc.info/gems/grubby/Grubby/JsonScraper:json)
+- Nokogiri::XML::Searchable
+  - [#at!](http://www.rubydoc.info/gems/grubby/Nokogiri/XML/Searchable:at%21)
+  - [#search!](http://www.rubydoc.info/gems/grubby/Nokogiri/XML/Searchable:search%21)
+- Mechanize::Page
+  - [#at!](http://www.rubydoc.info/gems/grubby/Mechanize/Page:at%21)
+  - [#search!](http://www.rubydoc.info/gems/grubby/Mechanize/Page:search%21)
+- Mechanize::Page::Link
+  - [#to_absolute_uri](http://www.rubydoc.info/gems/grubby/Mechanize/Page/Link#to_absolute_uri)
+
+
+## Supplemental API
+
+*grubby* uses several gems which extend core Ruby objects with
+convenience methods.  When you import *grubby* you automatically make
+these methods available.  See each gem below for its specific API
+documentation:
+
+- [Active Support](https://rubygems.org/gems/activesupport)
+  ([docs](http://www.rubydoc.info/gems/activesupport/))
+- [casual_support](https://rubygems.org/gems/casual_support)
+  ([docs](http://www.rubydoc.info/gems/casual_support/))
+- [gorge](https://rubygems.org/gems/gorge)
+  ([docs](http://www.rubydoc.info/gems/gorge/))
+- [mini_sanity](https://rubygems.org/gems/mini_sanity)
+  ([docs](http://www.rubydoc.info/gems/mini_sanity/))
+- [pleasant_path](https://rubygems.org/gems/pleasant_path)
+  ([docs](http://www.rubydoc.info/gems/pleasant_path/))
+
+
+## Installation
+
+Install from [Ruby Gems](https://rubygems.org/gems/grubby):
+
+```bash
+$ gem install grubby
+```
+
+Then require in your Ruby script:
+
+```ruby
+require "grubby"
+```
+
+
+## Contributing
+
+Run `rake test` to run the tests.  You can also run `rake irb` for an
+interactive prompt that pre-loads the project code.
+
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end
+
+desc "Launch IRB with this gem pre-loaded"
+task :irb do
+  # HACK because lib/grubby/version is prematurely loaded by bundler/gem_tasks
+  Object.send(:remove_const, :Grubby)
+
+  require "grubby"
+  require "irb"
+  ARGV.clear
+  IRB.start
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/grubby.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "grubby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "grubby"
+  spec.version       = Grubby::VERSION
+  spec.authors       = ["Jonathan Hefner"]
+  spec.email         = ["jonathan.hefner@gmail.com"]
+
+  spec.summary       = %q{Fail-fast web scraping}
+  spec.homepage      = "https://github.com/jonathanhefner/grubby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 5.0"
+  spec.add_runtime_dependency "casual_support", "~> 3.0"
+  spec.add_runtime_dependency "dumb_delimited", "~> 1.0"
+  spec.add_runtime_dependency "gorge", "~> 1.0"
+  spec.add_runtime_dependency "mechanize", "~> 2.7"
+  spec.add_runtime_dependency "mini_sanity", "~> 1.0"
+  spec.add_runtime_dependency "pleasant_path", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

data/lib/grubby.rb

@@ -0,0 +1,169 @@
+require "active_support/all"
+require "casual_support"
+require "dumb_delimited"
+require "gorge"
+require "mechanize"
+require "mini_sanity"
+require "pleasant_path"
+
+require_relative "grubby/log"
+
+require_relative "grubby/core_ext/string"
+require_relative "grubby/core_ext/uri"
+require_relative "grubby/mechanize/fetch_with_retry"
+require_relative "grubby/mechanize/download"
+require_relative "grubby/mechanize/file"
+require_relative "grubby/mechanize/link"
+require_relative "grubby/mechanize/page"
+require_relative "grubby/nokogiri/searchable"
+
+
+class Grubby < Mechanize
+
+  # @return [Integer, Float, Range<Integer>, Range<Float>]
+  #   The enforced minimum amount of time to wait between requests, in
+  #   seconds.  If the value is a Range, a random number within the
+  #   Range is chosen for each request.
+  attr_accessor :time_between_requests
+
+  # @param singleton_journal [Pathname, String]
+  #   Optional journal file to persist the list of resources processed
+  #   by {singleton}.  Useful to ensure only-once processing across
+  #   multiple program runs.
+  def initialize(singleton_journal = nil)
+    super()
+
+    # Prevent "memory leaks", and prevent mistakenly blank urls from
+    # resolving.  (Blank urls resolve as a path relative to the last
+    # history entry.  Without this setting, an erroneous `agent.get("")`
+    # could sometimes successfully fetch a page.)
+    self.max_history = 0
+
+    # Prevent files of unforeseen content type from being buffered into
+    # memory by default, in case they are very large.  However, increase
+    # the threshold for what is considered "large", to prevent
+    # unnecessary writes to disk.
+    #
+    # References:
+    #   - http://docs.seattlerb.org/mechanize/Mechanize/PluggableParser.html
+    #   - http://docs.seattlerb.org/mechanize/Mechanize/Download.html
+    #   - http://docs.seattlerb.org/mechanize/Mechanize/File.html
+    self.max_file_buffer = 1_000_000 # only applies to Mechanize::Download
+    self.pluggable_parser.default = Mechanize::Download
+    self.pluggable_parser["text/plain"] = Mechanize::File
+    self.pluggable_parser["application/json"] = Grubby::JsonParser
+
+    # Set up configurable rate limiting, and choose a reasonable default
+    # rate limit.
+    self.pre_connect_hooks << Proc.new{ self.send(:sleep_between_requests) }
+    self.time_between_requests = 1.0
+
+    @journal = singleton_journal ?
+      singleton_journal.to_pathname.touch_file : Pathname::NULL
+    @seen = SingletonKey.parse_file(@journal).
+      group_by(&:purpose).transform_values{|sks| sks.map(&:key).index_to{ true } }
+  end
+
+  # Calls +#get+ with each of +mirror_uris+ until a successful
+  # ("200 OK") response is recieved, and returns that +#get+ result.
+  # Rescues and logs +Mechanize::ResponseCodeError+ failures for all but
+  # the last mirror.
+  #
+  # @param mirror_uris [Array<String>]
+  # @return [Mechanize::Page, Mechanize::File, Mechanize::Download, ...]
+  # @raise [Mechanize::ResponseCodeError]
+  #   if all +mirror_uris+ fail
+  def get_mirrored(mirror_uris, parameters = [], referer = nil, headers = {})
+    i = 0
+    begin
+      get(mirror_uris[i], parameters, referer, headers)
+    rescue Mechanize::ResponseCodeError => e
+      i += 1
+      if i >= mirror_uris.length
+        raise
+      else
+        $log.info("Mirror failed with response code #{e.response_code}: #{mirror_uris[i - 1]}")
+        $log.debug("Trying next mirror: #{mirror_uris[i]}")
+        retry
+      end
+    end
+  end
+
+  # Ensures only-once processing of the resource indicated by +target+
+  # for the specified +purpose+.  A list of previously-processed
+  # resource URIs and content hashes is maintained in the Grubby
+  # instance.  The given block is called with the fetched resource only
+  # if the resource's URI and the resource's content hash have not been
+  # previously processed under the specified +purpose+.
+  #
+  # @param target [URI, String, Mechanize::Page::Link, #to_absolute_uri]
+  #   designates the resource to fetch
+  # @param purpose [String]
+  #   the purpose of processing the resource
+  # @yield [resource]
+  #   processes the resource
+  # @yieldparam resource [Mechanize::Page, Mechanize::File, Mechanize::Download, ...]
+  #   the fetched resource
+  # @return [Boolean]
+  #   whether the given block was called
+  # @raise [Mechanize::ResponseCodeError]
+  #   if fetching the resource results in error (see +Mechanize#get+)
+  def singleton(target, purpose = "")
+    series = []
+
+    original_url = target.to_absolute_uri
+    return if skip_singleton?(purpose, original_url.to_s, series)
+
+    url = normalize_url(original_url)
+    return if skip_singleton?(purpose, url.to_s, series)
+
+    $log.info("Fetching #{url}")
+    resource = get(url)
+    skip = skip_singleton?(purpose, resource.uri.to_s, series) |
+      skip_singleton?(purpose, "content hash: #{resource.content_hash}", series)
+
+    yield resource unless skip
+
+    series.map{|k| SingletonKey.new(purpose, k) }.append_to_file(@journal)
+
+    !skip
+  end
+
+
+  private
+
+  SingletonKey = DumbDelimited[:purpose, :key]
+
+  def skip_singleton?(purpose, key, series)
+    return false if series.include?(key)
+    series << key
+    already = (@seen[purpose.to_s] ||= {}).displace(key, true)
+    $log.info("Skipping #{series.first} (already seen #{series.last})") if already
+    already
+  end
+
+  def normalize_url(url)
+    url = url.dup
+    $log.warn("Discarding fragment in URL: #{url}") if url.fragment
+    url.fragment = nil
+    url.path = url.path.chomp("/")
+    url
+  end
+
+  def sleep_between_requests
+    @last_request_at ||= 0.0
+    delay_duration = @time_between_requests.is_a?(Range) ?
+      rand(@time_between_requests) : @time_between_requests
+    sleep_duration = @last_request_at + delay_duration - Time.now.to_f
+    sleep(sleep_duration) if sleep_duration > 0
+    @last_request_at = Time.now.to_f
+  end
+
+end
+
+
+require_relative "grubby/version"
+require_relative "grubby/json_parser"
+require_relative "grubby/scraper"
+require_relative "grubby/page_scraper"
+require_relative "grubby/json_scraper"

data/lib/grubby/core_ext/string.rb

@@ -0,0 +1,12 @@
+class String
+
+  # Constructs a URI from the String.  Raises an exception if the String
+  # does not denote an absolute URI.
+  #
+  # @return [URI]
+  # @raise [RuntimeError] if the String does not denote an absolute URI
+  def to_absolute_uri
+    URI(self).to_absolute_uri
+  end
+
+end

data/lib/grubby/core_ext/uri.rb

@@ -0,0 +1,12 @@
+module URI
+
+  # Raises an exception if the URI is not +absolute?+.
+  #
+  # @return [self]
+  # @raise [RuntimeError] if the URI is not +absolute?+
+  def to_absolute_uri
+    raise "URI is not absolute: #{self}" unless self.absolute?
+    self
+  end
+
+end

data/lib/grubby/json_parser.rb

@@ -0,0 +1,45 @@
+class Grubby::JsonParser < Mechanize::File
+
+  # Returns the options to use when parsing JSON.  The returned options
+  # Hash is not +dup+ed and can be modified directly.  Any modifications
+  # will be applied to all future parsing.
+  #
+  # For information about available options, see
+  # {http://ruby-doc.org/stdlib/libdoc/json/rdoc/JSON.html#method-i-parse
+  # +JSON.parse+}.
+  #
+  # @return [Hash]
+  def self.json_parse_options
+    @json_parse_options ||= {
+      max_nesting: false,
+      allow_nan: false,
+      symbolize_names: false,
+      create_additions: false,
+      object_class: Hash,
+      array_class: Array,
+    }
+  end
+
+  # Sets the options to use when parsing JSON.  The entire options Hash
+  # is replaced, and the new value will be applied to all future
+  # parsing.  To set options individually, see {json_parse_options}.
+  #
+  # For information about available options, see
+  # {http://ruby-doc.org/stdlib/libdoc/json/rdoc/JSON.html#method-i-parse
+  # +JSON.parse+}.
+  #
+  # @param options [Hash]
+  def self.json_parse_options=(options)
+    @json_parse_options = options
+  end
+
+  # @return [Hash, Array]
+  #   The parsed JSON data.
+  attr_reader :json
+
+  def initialize(uri = nil, response = nil, body = nil, code = nil)
+    @json = body && JSON.parse(body, self.class.json_parse_options)
+    super
+  end
+
+end

data/lib/grubby/json_scraper.rb

@@ -0,0 +1,13 @@
+class Grubby::JsonScraper < Grubby::Scraper
+
+  # @return [Hash, Array]
+  #   The parsed JSON data being scraped.
+  attr_reader :json
+
+  # @param source [Grubby::JsonParser]
+  def initialize(source)
+    @json = source.assert_kind_of!(Grubby::JsonParser).json
+    super
+  end
+
+end

data/lib/grubby/log.rb

@@ -0,0 +1,5 @@
+$log ||= Logger.new($stderr).tap do |logger|
+  logger.formatter = ->(severity, datetime, progname, msg) do
+    "[#{datetime.to_ymd} #{datetime.to_hms}] #{severity} #{msg}\n"
+  end
+end

data/lib/grubby/mechanize/download.rb

@@ -0,0 +1,8 @@
+class Mechanize::Download
+
+  # private
+  def content_hash
+    @content_hash ||= Digest::SHA1.new.io(self.body_io).hexdigest
+  end
+
+end

data/lib/grubby/mechanize/fetch_with_retry.rb

@@ -0,0 +1,39 @@
+# This monkey patch attempts to fix the insidious "too many connection
+# resets" bug described here: https://github.com/sparklemotion/mechanize/issues/123
+#
+# The code is taken and modified from this helpful blog article:
+# http://scottwb.com/blog/2013/11/09/defeating-the-infamous-mechanize-too-many-connection-resets-bug/
+class Mechanize::HTTP::Agent
+
+  MAX_CONNECTION_RESET_RETRIES = 9
+  IDEMPOTENT_HTTP_METHODS = [:get, :head, :options, :delete]
+
+  # Replacement for +Mechanize::HTTP::Agent#fetch+.  When a "too many
+  # connection resets" error is encountered, this method shuts down the
+  # persistent HTTP connection, and then retries the request (upto
+  # {MAX_CONNECTION_RESET_RETRIES} times).
+  def fetch_with_retry(uri, http_method = :get, headers = {}, params = [], referer = current_page, redirects = 0)
+    retry_count = 0
+    begin
+      fetch_without_retry(uri, http_method, headers, params, referer, redirects)
+    rescue Net::HTTP::Persistent::Error => e
+      # raise if different type of error
+      raise unless e.message.include?("too many connection resets")
+      # raise if non-idempotent http method
+      raise unless IDEMPOTENT_HTTP_METHODS.include?(http_method)
+      # raise if we've tried too many times
+      raise if retry_count >= MAX_CONNECTION_RESET_RETRIES
+
+      # otherwise, shutdown the persistent HTTP connection and try again
+      retry_count += 1
+      $log.warn("Possible connection reset bug.  Retry(#{retry_count}) #{http_method.to_s.upcase} #{uri}")
+      self.http.shutdown
+      sleep(retry_count) # incremental backoff in case problem is with server
+      retry
+    end
+  end
+
+  alias_method :fetch_without_retry, :fetch
+  alias_method :fetch, :fetch_with_retry
+
+end

data/lib/grubby/mechanize/file.rb

@@ -0,0 +1,8 @@
+class Mechanize::File
+
+  # private
+  def content_hash
+    @content_hash ||= self.body.to_s.sha1
+  end
+
+end

data/lib/grubby/mechanize/link.rb

@@ -0,0 +1,20 @@
+class Mechanize::Page::Link
+
+  # Returns the URI represented by the Link, in absolute form.  If the
+  # href attribute of the Link is expressed in relative form, the URI of
+  # the Link's Page is used to convert to absolute form.
+  #
+  # @return [URI]
+  def to_absolute_uri
+    # Via the W3 spec: "If the a element has no href attribute, then the
+    # element represents a placeholder for where a link might otherwise
+    # have been placed, if it had been relevant, consisting of just the
+    # element's contents."[1]  So, we assume a link with no href
+    # attribute (i.e. `uri == nil`) should be treated the same as an
+    # intra-page link.
+    #
+    # [1]: https://www.w3.org/TR/2016/REC-html51-20161101/textlevel-semantics.html#the-a-element
+    URI.join(self.page.uri, self.uri || "#").to_absolute_uri
+  end
+
+end

data/lib/grubby/mechanize/page.rb

@@ -0,0 +1,17 @@
+class Mechanize::Page
+
+  # @!method search!(*queries)
+  # See {::Nokogiri::XML::Searchable#search!}.
+  #
+  # @param queries [Array<String>]
+  # @return [Array<Nokogiri::XML::Element>]
+  def_delegators :parser, :search!
+
+  # @!method at!(*queries)
+  # See {::Nokogiri::XML::Searchable#at!}.
+  #
+  # @param queries [Array<String>]
+  # @return [Nokogiri::XML::Element]
+  def_delegators :parser, :at!
+
+end

data/lib/grubby/nokogiri/searchable.rb

@@ -0,0 +1,27 @@
+module Nokogiri::XML::Searchable
+
+  # Searches the node using the given XPath or CSS queries, and returns
+  # the results.  Raises an exception if there are no results.  See also
+  # +#search+.
+  #
+  # @param queries [Array<String>]
+  # @return [Array<Nokogiri::XML::Element>]
+  # @raise [RuntimeError] if queries yield no results
+  def search!(*queries)
+    results = search(*queries)
+    raise "No elements matching #{queries.map(&:inspect).join(" OR ")}" if results.empty?
+    results
+  end
+
+  # Searches the node using the given XPath or CSS queries, and returns
+  # only the first result.  Raises an exception if there are no results.
+  # See also +#at+.
+  #
+  # @param queries [Array<String>]
+  # @return [Nokogiri::XML::Element]
+  # @raise [RuntimeError] if queries yield no results
+  def at!(*queries)
+    search!(*queries).first
+  end
+
+end

data/lib/grubby/page_scraper.rb

@@ -0,0 +1,13 @@
+class Grubby::PageScraper < Grubby::Scraper
+
+  # @return [Mechanize::Page]
+  #   The Page being scraped.
+  attr_reader :page
+
+  # @param source [Mechanize::Page]
+  def initialize(source)
+    @page = source.assert_kind_of!(Mechanize::Page)
+    super
+  end
+
+end

data/lib/grubby/scraper.rb

@@ -0,0 +1,99 @@
+class Grubby::Scraper
+
+  class Error < RuntimeError
+  end
+
+  # Defines an attribute reader method named by +field+.  During
+  # +initialize+, the given block is called, and the attribute is set to
+  # the block's return value.  By default, if the block's return value
+  # is nil, an exception will be raised.  To prevent this behavior, set
+  # +optional+ to true.
+  #
+  # @param field [Symbol, String]
+  #   name of the scraped value
+  # @param optional [Boolean]
+  #   whether to permit a nil scraped value
+  # @yield []
+  #   scrapes the value
+  # @yieldreturn [Object]
+  #   scraped value
+  def self.scrapes(field, optional: false, &block)
+    field = field.to_sym
+    self.fields << field
+
+    define_method(field) do
+      return @scraped[field] if @scraped.key?(field)
+
+      unless @errors.key?(field)
+        begin
+          value = instance_eval(&block)
+          if value.nil?
+            raise "`#{field}` cannot be nil" unless optional
+            $log.debug("Scraped nil value for #{self.class}##{field}")
+          end
+          @scraped[field] = value
+        rescue RuntimeError => e
+          @errors[field] = e
+        end
+      end
+
+      raise "`#{field}` raised a #{@errors[field].class}" if @errors.key?(field)
+
+      @scraped[field]
+    end
+  end
+
+  # @return [Array<Symbol>]
+  #   The names of all scraped values, as defined by {scrapes}.
+  def self.fields
+    @fields ||= []
+  end
+
+  # @return [Object]
+  #   The source being scraped.  Typically a Mechanize pluggable parser
+  #   such as +Mechanize::Page+.
+  attr_reader :source
+
+  # @param source
+  # @raise [Grubby::Scraper::Error]
+  #   if any scraped values result in error
+  def initialize(source)
+    @source = source
+    @scraped = {}
+    @errors = {}
+
+    self.class.fields.each do |field|
+      begin
+        self.send(field)
+      rescue RuntimeError
+      end
+    end
+
+    unless @errors.empty?
+      listing = @errors.map do |field, error|
+        error_class = " (#{error.class})" unless error.class == RuntimeError
+        error_trace = error.backtrace.join("\n").indent(2)
+        "* #{field} -- #{error.message}#{error_class}\n#{error_trace}"
+      end
+      raise Error.new("Failed to scrape the following fields:\n#{listing.join("\n")}")
+    end
+  end
+
+  # Returns the scraped value named by +field+.
+  #
+  # @param field [Symbol, String]
+  # @return [Object]
+  # @raise [RuntimeError]
+  #   if +field+ is not a valid name
+  def [](field)
+    @scraped.fetch(field.to_sym)
+  end
+
+  # Returns all scraped values as a Hash.
+  #
+  # @return [Hash<Symbol, Object>]
+  def to_h
+    @scraped.dup
+  end
+
+end

data/lib/grubby/version.rb

@@ -0,0 +1,3 @@
+class Grubby
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: grubby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Hefner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: casual_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dumb_delimited
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: gorge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: mini_sanity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pleasant_path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- jonathan.hefner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grubby.gemspec
+- lib/grubby.rb
+- lib/grubby/core_ext/string.rb
+- lib/grubby/core_ext/uri.rb
+- lib/grubby/json_parser.rb
+- lib/grubby/json_scraper.rb
+- lib/grubby/log.rb
+- lib/grubby/mechanize/download.rb
+- lib/grubby/mechanize/fetch_with_retry.rb
+- lib/grubby/mechanize/file.rb
+- lib/grubby/mechanize/link.rb
+- lib/grubby/mechanize/page.rb
+- lib/grubby/nokogiri/searchable.rb
+- lib/grubby/page_scraper.rb
+- lib/grubby/scraper.rb
+- lib/grubby/version.rb
+homepage: https://github.com/jonathanhefner/grubby
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Fail-fast web scraping
+test_files: []