scripture_lookup 0.0.1

data/bin/scripture

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'scripture_lookup'
+
+# Use the default provider.
+provider = ScriptureLookup.new
+
+translation = ARGV[1]
+translation ||= :NASB
+puts provider.lookup(ARGV[0], translation)

data/lib/scripture_lookup/bible_gateway_scraper.rb

@@ -0,0 +1,48 @@
+require 'metainspector'
+require_relative 'response'
+require_relative 'parsers/bible_gateway_scrape_parser'
+
+module ScriptureLookup
+  class BibleGatewayScraper
+    attr_accessor :options
+
+    def initialize(opts = {})
+      @options = default_options.merge(opts)
+    end
+
+    def default_options
+      {response_class: Response,
+       parser: BibleGatewayScrapeParser}
+    end
+
+    def lookup reference, version
+      url = "http://www.biblegateway.com/passage/?search=#{reference}&version=#{version.to_s}"
+      doc = get_doc(url)
+
+      generate_response doc
+
+    rescue ScriptureLookup::Error
+      raise
+    rescue => error
+      raise ScriptureLookup::Error
+    end
+
+    private
+
+    ##
+    # BibleGatewayScraper#get_doc deals with the fetching of HTML content from Bible Gateway.
+    def get_doc(url)
+      page = MetaInspector.new(url)
+      doc = page.document
+
+      raise page.errors[0] if !page.ok?
+
+      doc
+    end
+
+    def generate_response doc
+      parser = options[:parser].new
+      options[:response_class].new(parser.parse(doc))
+    end
+  end
+end

data/lib/scripture_lookup/errors/error.rb

@@ -0,0 +1,10 @@
+module ScriptureLookup
+  class Error < StandardError
+    attr_reader :original
+
+    def initialize(message=nil, original=$!)
+      super message || original && original.message
+      @original = original
+    end
+  end
+end

data/lib/scripture_lookup/parsers/bible_gateway_scrape_parser.rb

@@ -0,0 +1,46 @@
+require 'loofah'
+
+module ScriptureLookup
+  # Encapsulate the messy parsing of raw BibleGateway.com HTML into
+  # a structure of hashes and arrays expected by Response.
+  class BibleGatewayScrapeParser
+    def parse(doc)
+      # scrub out footnotes and cross references.
+      frag = Loofah.fragment(doc)
+      kill_sup = Loofah::Scrubber.new { |node| node.remove if (node.name == "sup") or node["class"] == "chapternum" }
+      frag.scrub!(kill_sup)
+
+      {translation: translation(frag),
+       content: content(frag)}
+    end
+
+    private
+
+    def translation(doc)
+      path = './/div[contains(@class, "heading")]/p'
+      doc.xpath(path).text
+    end
+
+    def content(doc)
+      path = './/div[contains(@class, "passage")]//span[contains(@class, "text")]'
+      passages = doc.xpath(path)
+
+      passages.each_with_object({}) do |passage, hsh|
+        reference = passage["class"].split.last   #ex.  "Col-1-9"
+        hsh[reference] = {} unless hsh.has_key? reference
+        add_passage_text(hsh[reference], passage)
+      end
+    end
+
+    def add_passage_text(hsh, passage)
+      if passage.parent.name == "h3"
+        hsh[:title] = passage.text
+      elsif passage.parent.name == "h4"
+        hsh[:subtitle] = passage.text
+      else
+        hsh[:verse] = [] unless hsh.has_key? :verse
+        hsh[:verse] << passage.text
+      end
+    end
+  end
+end

data/lib/scripture_lookup/response.rb

@@ -0,0 +1,54 @@
+module ScriptureLookup
+
+  # Response encapsulates the response from any of the various
+  # scripture providers.
+  #
+  # Response.response_data is expected to be a well formatted hash of
+  # scripture.  Current hash structure contains the following.
+  #   * [:translation] - The name of the translation coming back from the
+  #                      provider, such as "English Standard Version (ESV)".
+  #   * [:content] - A hash of scripture, where each key is reference, such
+  #                  as "Col-1-9" or "Ps-23-2".
+  #   * [:content][<ref>][:title] - Either nil or a string containing a
+  #                                 title for that verse.
+  #   * [:content][<ref>][:subtitle] - Either nil or a string containing
+  #                                    a subtitle for that verse.
+  #   * [:content][<ref>][:verse] - An array of strings containing the scripture
+  #                                 for that verse.  This allows us to maintain
+  #                                 linebreaks between each portion of the verse
+  #                                 if desired (often Psalms and other poetic
+  #                                 sections of Scripture place linebreaks in the midst
+  #                                 of each verse).
+  class Response
+    attr_reader :response_data
+
+    def initialize(response_data)
+      @response_data = response_data
+    end
+
+    def verses
+      response_data[:content].values.inject([]) do |res, verse|
+        res + verse[:verse]
+      end
+
+    rescue ScriptureLookup::Error
+      raise
+    rescue => error
+      raise ScriptureLookup::Error
+    end
+
+    # Default implementation of to_s simply returns the text for each
+    # verse as a single paragraph (no line breaks).
+    def to_s
+      response_data[:content].values.inject("") do |res, verse|
+        res += " " unless res.empty?
+        res + verse[:verse].join(" ")
+      end
+
+    rescue ScriptureLookup::Error
+      raise
+    rescue => error
+      raise ScriptureLookup::Error
+    end
+  end
+end

data/lib/scripture_lookup.rb

@@ -0,0 +1,14 @@
+module ScriptureLookup
+  extend self
+
+  require_relative 'scripture_lookup/errors/error'
+  require_relative 'scripture_lookup/bible_gateway_scraper'
+
+  # Sugar method to be able to quickly create a provider.
+  #
+  # BibleGatewayScraper is the default provider as it can return scripture
+  # from the most translations.
+  def new
+    BibleGatewayScraper.new
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: scripture_lookup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Warren Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: metainspector
+  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'
+- !ruby/object:Gem::Dependency
+  name: loofah
+  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: A gem to assist in pulling back and querying scripture.
+email: warren@thewrightangle.com
+executables:
+- scripture
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/scripture_lookup.rb
+- lib/scripture_lookup/bible_gateway_scraper.rb
+- lib/scripture_lookup/response.rb
+- lib/scripture_lookup/parsers/bible_gateway_scrape_parser.rb
+- lib/scripture_lookup/errors/error.rb
+- bin/scripture
+homepage: http://thewrightangle.com
+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: Pull back verses from popular Bible sites easily.
+test_files: []