bible_gateway 0.0.12 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 936c48f6f63535b6b45f26270bd8f736b33547ee5143361a0ead5d3c9c9ab8f8
-  data.tar.gz: 93042e59fe2c1a5987337bf63f47fbda4742c0f6a365d78e0e3845ee610eb1ab
+  metadata.gz: e6c2cf9ceec0c095ec1a5ec095b0b77f21cadb4715e754a8640248b60c004201
+  data.tar.gz: 9609fe5c68301042cae31812f0c4f8e62f363fe7d83e326d57aa89310c401bd6
 SHA512:
-  metadata.gz: '09d00df060704129a77c21eb1e3b1ad2d3576d61d420ab2d4adc155a19b479c0be19d4a648afc4a6cbf703a9c21a97fae21650b8f4bec13ff11fe7758b8036b3'
-  data.tar.gz: 66d98831f4cbb6243f10156ebe3c70894205351fbd50ef12dadf1c2bfc9c75ab1ff43828b25d321eadd4bd2301d17b9aee3e328365adec9e34c9d133189ddfbc
+  metadata.gz: c9d1980166dd51fc83cc34b9e380479e74c7e6756daf9c587565a8657dfab5b6f24a1fe8d6f841813dae0829ac6f30b760dd9203f40ae66643d01b4c428b644a
+  data.tar.gz: 5167444cb5ae0af6df52f6988e3d4ed5e0d59944dac009ea1734abb3b887be5fee66d20956df6a15810a46b1bcf0a6d890d4592c1368d391db53420bcf659681

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.1
+ 

data/README.md

@@ -22,15 +22,28 @@ Or install it yourself as:
 
 ## Usage
 
-    BibleGateway.versions # available versions
+```
+require 'bible_gateway'
 
-    b = BibleGateway.new # defaults to :king_james_version, but can be initialized to different version
-    b.version = :english_standard_version
-    b.lookup('John 1:1') # => "<h4>John 1</h4>\n<h5>The Word Became Flesh</h5> <sup>1</sup> In the beginning was the Word, and the Word was with God, and the Word was God."
+BibleGateway.versions # available versions
 
-## Todo
+BibleGateway.versions # available versions
 
-* Add other versions that are available
+b = BibleGateway.new # defaults to :king_james_version, but can be initialized to different version
+
+b.version = :english_standard_version
+b.lookup('John 1:1') # => "<h4>John 1</h4>\n<h5>The Word Became Flesh</h5> <sup>1</sup> In the beginning was the Word, and the Word was with God, and the Word was God."
+```
+
+## Scraping the old site through old_lookup
+
+```
+require 'bible_gateway'
+
+b = BibleGateway.new # defaults to :king_james_version, but can be initialized to different version
+
+b.old_lookup('John 1:1') # scraping the old site
+```
 
 ## Contributing
 

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.1.0

data/bible_gateway.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
   spec.name          = "bible_gateway"
   spec.version       = BibleGateway::VERSION
   spec.authors       = ["Geoffrey Dagley"]
-  spec.email         = ["gdagley@gmail.com", "bibleableproject@gmail.com"]
+  spec.email         = ["gdagley@gmail.com", "bibleableproject@gmail.com", "ytbryan@gmail.com"]
   spec.description   = %q{An unofficial 'API' for BibleGateway.com.}
-  spec.summary       = %q{An unofficial 'API' for BibleGateway.com.}
+  spec.summary       = %q{An unofficial 'API' for BibleGateway.com and the classic BibleGateway}
   spec.homepage      = "https://github.com/gdagley/bible_gateway"
   spec.license       = "MIT"
 
@@ -21,7 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "nokogiri"
   spec.add_dependency "typhoeus"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "net-ping"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/bible_gateway.rb

@@ -6,7 +6,8 @@ require 'uri'
 class BibleGatewayError < StandardError; end
 
 class BibleGateway
-  GATEWAY_URL = "http://classic.biblegateway.com"
+  GATEWAY_URL = "http://biblegateway.com"
+  CLASSIC_GATEWAY_URL = "http://classic.biblegateway.com"
 
   VERSIONS = {
     :american_standard_version => "ASV",
@@ -62,15 +63,54 @@ class BibleGateway
   def lookup(passage)
     response = Typhoeus.get(passage_url(passage), followlocation: true)
     doc = Nokogiri::HTML(response.body)
-    scrape_passage(doc)
+    scrape_passage(doc, @version)
+  end
+
+  def old_lookup(passage)
+    response = Typhoeus.get(old_passage_url(passage), followlocation: true)
+    doc = Nokogiri::HTML(response.body)
+    old_way_scrape_passage(doc)
   end
 
   private
     def passage_url(passage)
-      URI.escape "#{GATEWAY_URL}/passage/?search=#{passage}&version=#{VERSIONS[version]}"
+      "#{GATEWAY_URL}/passage/?search=#{URI.encode_www_form_component(passage)}&version=#{URI.encode_www_form_component(VERSIONS[version])}"
+    end
+
+    def old_passage_url(passage)
+      "#{CLASSIC_GATEWAY_URL}/passage/?search=#{URI.encode_www_form_component(passage)}&version=#{URI.encode_www_form_component(VERSIONS[version])}"
+    end
+
+    def scrape_passage(doc, version)
+      container = doc.css('div.passage-text')
+      title = container.css("div.version-#{VERSIONS[version]}.result-text-style-normal.text-html h1 span")[0].content.strip if container.css("div.version-#{VERSIONS[version]}.result-text-style-normal.text-html h1")[0] != nil
+      segment = doc.at('div.passage-text')
+
+      segment.search('sup.crossreference').remove # remove cross reference links
+      segment.search('sup.footnote').remove # remove footnote links
+      segment.search("div.crossrefs").remove # remove cross references
+      segment.search("div.footnotes").remove # remove footnotes
+
+      text = ""
+      segment.search("span.text").each do |span|
+        text += span.inner_text
+      end
+
+      segment.search("span.text").each do |span|
+        html_content = span.inner_html
+        span.swap html_content
+      end
+      
+      segment.search('sup.versenum').each do |sup|
+        html_content = sup.content
+        sup.swap "<sup>#{html_content}</sup>"
+      end
+
+      content = segment.inner_html.gsub('<p></p>', '').gsub(/<!--.*?-->/, '').strip
+      {:title => title, :content => content, :text => text }
     end
 
-    def scrape_passage(doc)
+    def old_way_scrape_passage(doc)
       container = doc.css('div.container')
       title = container.css('div.passage-details h1')[0].content.strip
       segment = doc.at('div.passage-wrap')
@@ -79,29 +119,23 @@ class BibleGateway
       segment.search("div.crossrefs").remove # remove cross references
       segment.search("div.footnotes").remove # remove footnotes
 
-      #scripture_text should be text
+      # extract text only from scripture
       text = ""
       segment.search("span.text").each do |span|
         text += span.inner_text
       end
 
-      # text should be html so that text can be used above.
       segment.search("span.text").each do |span|
         html_content = span.inner_html
         span.swap html_content
       end
       
-      # text should be html so that text can be used above.
       segment.search('sup.versenum').each do |sup|
         html_content = sup.content
         sup.swap "<sup>#{html_content}</sup>"
       end
 
       content = segment.inner_html.gsub('<p></p>', '').gsub(/<!--.*?-->/, '').strip
-      
-      #scripture_text should be text
-      {:title => title, 
-      :content => content, 
-      :text => text }
+      {:title => title, :content => content, :text => text }
     end
 end

data/lib/bible_gateway/version.rb

@@ -1,3 +1,3 @@
 class BibleGateway
-  VERSION = "0.0.12"
+  VERSION = "0.1.0"
 end

data/spec/bible_gateway_spec.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 require "spec_helper"
+require 'net/ping'
 
 describe BibleGateway do
   it "should have a list of versions" do
@@ -39,7 +40,35 @@ describe BibleGateway do
 
   end
 
+  describe "reachability" do
+    context "biblegateway.com" do
+      it "should reach biblegateway.com" do
+        check = Net::Ping::External.new(BibleGateway::GATEWAY_URL)
+        check.ping?  
+      end
+    end
+
+    context "classic biblegateway.com" do
+      it "should reach classic biblegateway.com" do
+        check = Net::Ping::External.new(BibleGateway::CLASSIC_GATEWAY_URL)
+        check.ping?  
+      end
+    end
+  end
+
   describe "lookup" do
+    context "text only" do 
+      it "should find the scripture text" do
+        text = BibleGateway.new(:english_standard_version).lookup("John 1:1")[:text]
+        expect(text).to eq("The Word Became Flesh1 In the beginning was the Word, and the Word was with God, and the Word was God.")
+      end
+
+      it "should find the scripture text via old_lookup" do
+        text = BibleGateway.new(:english_standard_version).old_lookup("John 1:1")[:text]
+        expect(text).to eq("The Word Became Flesh1 In the beginning was the Word, and the Word was with God, and the Word was God.")
+      end
+    end
+
     context "verse" do
       it "should find the passage title" do
         title = BibleGateway.new(:english_standard_version).lookup("John 1:1")[:title]
@@ -56,6 +85,17 @@ describe BibleGateway do
         expect(content).to include("<h3>The Word Became Flesh</h3>")
         expect(content).to include("In the beginning was the Word, and the Word was with God, and the Word was God.")
       end
+
+      it "should find the passage title via old_lookup" do
+        title = BibleGateway.new(:english_standard_version).old_lookup("John 1:1")[:title]
+        expect(title).to eq("John 1:1")
+      end
+
+      it "should find and clean the passage content via old_lookup" do
+        content = BibleGateway.new(:english_standard_version).old_lookup("John 1:1")[:content]
+        expect(content).to include("<h3>The Word Became Flesh</h3>")
+        expect(content).to include("In the beginning was the Word, and the Word was with God, and the Word was God.")
+      end
     end
 
     context "chapter" do
@@ -75,6 +115,18 @@ describe BibleGateway do
         expect(content).to include("<h3>For God So Loved the World</h3>")
         expect(content).to include("For God so loved the world, that he gave his only Son, that whoever believes in him should not perish but have eternal life.")
       end
+
+      it "should find the passage title via old_lookup" do
+        title = BibleGateway.new(:english_standard_version).old_lookup("John 3")[:title]
+        expect(title).to eq("John 3")
+      end
+
+      it "should find and clean the passage content via old_lookup" do
+        content = BibleGateway.new(:english_standard_version).old_lookup("John 3")[:content]
+        expect(content).to include("<h3>You Must Be Born Again</h3>")
+        expect(content).to include("<h3>For God So Loved the World</h3>")
+        expect(content).to include("For God so loved the world, that he gave his only Son, that whoever believes in him should not perish but have eternal life.")
+      end
     end
 
     context "multiple chapters" do
@@ -91,7 +143,20 @@ describe BibleGateway do
         expect(content).to include("<span class=\"chapternum\">1 </span>")
         expect(content).to include("For you are not a God who delights in wickedness;")
       end
+
+      it "should find the passage title via old_lookup" do
+          title = BibleGateway.new(:english_standard_version).old_lookup("Psalm 1-5")[:title]
+          expect(title).to eq("Psalm 1-5")
+        end
+  
+        it "should find and clean the passage content via old_lookup" do
+          content = BibleGateway.new(:english_standard_version).old_lookup("Psalm 1-5")[:content]
+          expect(content).to include("<h3>The Way of the Righteous and the Wicked</h3>")
+          expect(content).to include("<span class=\"chapternum\">1 </span>")
+          expect(content).to include("<h3>Save Me, O My God</h3>")
+          expect(content).to include("<span class=\"chapternum\">1 </span>")
+          expect(content).to include("For you are not a God who delights in wickedness;")
+        end
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bible_gateway
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.1.0
 platform: ruby
 authors:
 - Geoffrey Dagley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-06 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,20 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ping
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,11 +98,13 @@ description: An unofficial 'API' for BibleGateway.com.
 email:
 - gdagley@gmail.com
 - bibleableproject@gmail.com
+- ytbryan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -124,7 +140,7 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: An unofficial 'API' for BibleGateway.com.
+summary: An unofficial 'API' for BibleGateway.com and the classic BibleGateway
 test_files:
 - spec/bible_gateway_spec.rb
 - spec/spec_helper.rb