bible_gateway 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c1b44e2ba49cfce9ccf56e305e458c150460dbb2
-  data.tar.gz: 0316c4816aa198cc77347a8d37f6b3daf373d930
+SHA256:
+  metadata.gz: e6c2cf9ceec0c095ec1a5ec095b0b77f21cadb4715e754a8640248b60c004201
+  data.tar.gz: 9609fe5c68301042cae31812f0c4f8e62f363fe7d83e326d57aa89310c401bd6
 SHA512:
-  metadata.gz: 4ba5dbfc7763168e0ddf871f532067cb6ed6e270e17ec075d229066403909573d4ad21eb6694e23b1188e8668394fbf18fec1e7f0b0a8b56d96908630ac40762
-  data.tar.gz: 5c77362001080b638cf23215d6a417c2f85052c685893f6f5392732c33d984df0535f199c0cd0c34ce5cdccbc7e8445251b7a73b3db40dde2563f99b3c2b3cae
+  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

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.1
+ 

data/README.md

@@ -1,10 +1,10 @@
 # BibleGateway
 
 Travis CI:
-[![Build Status](https://travis-ci.org/gdagley/bible_gateway.png?branch=master)](https://travis-ci.org/gdagley/bible_gateway)
-1.9.2, 1.9.3, 2.0.0
+[![Build Status](https://travis-ci.org/bibleable/bible_gateway.png?branch=master)](https://travis-ci.org/bibleable/bible_gateway)
+1.9.3, 2.0.0, 2.1.1
 
-An unofficial 'API' for BibleGateway.com.
+An unofficial 'API' for BibleGateway.com. 
 
 ## Installation
 
@@ -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
 
@@ -44,3 +57,7 @@ Or install it yourself as:
 
 See [LICENSE](License.txt) for details.
 Most Bible translations are copyrighted.  Please see [BibleGateway.com](http://biblegateway.com) for more information.
+
+## Thanks
+
+Special thanks to Geoffrey Dagley([@gdagley](http://github.com/gdagley)) - the original creator of `bible_gateway` rubygem. 

data/VERSION

@@ -1 +1 @@
-0.0.8
+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"]
+  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://www.biblegateway.com"
+  GATEWAY_URL = "http://biblegateway.com"
+  CLASSIC_GATEWAY_URL = "http://classic.biblegateway.com"
 
   VERSIONS = {
     :american_standard_version => "ASV",
@@ -32,6 +33,16 @@ class BibleGateway
     :worldwide_english_new_testament => "WE",
     :wycliffe_new_testament => "WYC",
     :youngs_literal_translation => "YLT",
+
+    # French
+    :bible_du_semeur => "BDS",
+    :louis_segond => "LSG",
+    :nouvelle_edition_de_geneve => "NEG1979",
+    :segond_21 => "SG21",
+
+    #Chinese
+    :chinese_new_version_simplified => "CNVS",
+    :chinese_union_version_simplified => "CUVS",
   }
 
   def self.versions
@@ -52,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')
@@ -68,16 +118,24 @@ class BibleGateway
       segment.search('sup.footnote').remove # remove footnote links
       segment.search("div.crossrefs").remove # remove cross references
       segment.search("div.footnotes").remove # remove footnotes
+
+      # extract text only from scripture
+      text = ""
       segment.search("span.text").each do |span|
-        text = span.inner_html
-        span.swap text
+        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|
-        text = sup.content
-        sup.swap "<sup>#{text}</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 }
+      {:title => title, :content => content, :text => text }
     end
 end

data/lib/bible_gateway/version.rb

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

data/spec/bible_gateway_spec.rb

@@ -1,81 +1,162 @@
 # coding: utf-8
 require "spec_helper"
+require 'net/ping'
 
 describe BibleGateway do
   it "should have a list of versions" do
-    BibleGateway.versions.should_not be_empty
+    expect(BibleGateway.versions).not_to be_empty
   end
 
   describe "setting the version" do
     it "should have a default version" do
       gateway = BibleGateway.new
-      gateway.version.should == :king_james_version
+      expect(gateway.version).to eq(:king_james_version)
     end
 
     it "should be able to set the version to use" do
       gateway = BibleGateway.new :english_standard_version
-      gateway.version.should == :english_standard_version
+      expect(gateway.version).to eq(:english_standard_version)
     end
 
     it "should raise an exception for unknown version" do
-      lambda { BibleGateway.new :unknown_version }.should raise_error(BibleGatewayError)
+      expect { BibleGateway.new :unknown_version }.to raise_error(BibleGatewayError)
     end
 
     it "should be able to change the version to use" do
       gateway = BibleGateway.new
       gateway.version = :english_standard_version
-      gateway.version.should == :english_standard_version
+      expect(gateway.version).to eq(:english_standard_version)
+    end
+
+    it "should be able to set the chinese version to use" do
+      gateway = BibleGateway.new :chinese_new_version_simplified
+      expect(gateway.version).to eq(:chinese_new_version_simplified)
     end
 
     it "should raise an exception when changing to unknown version" do
       gateway = BibleGateway.new
-      lambda {  gateway.version = :unknown_version }.should raise_error(BibleGatewayError)
+      expect {  gateway.version = :unknown_version }.to raise_error(BibleGatewayError)
+    end
+
+  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]
-        title.should == "John 1:1"
+        expect(title).to eq("John 1:1")
+      end
+
+      it "should find the passage title in chinese_new_version_simplified" do
+        title = BibleGateway.new(:chinese_new_version_simplified).lookup("John 1:1")[:title]
+        expect(title).to eq("约翰福音 1:1")
       end
 
       it "should find and clean the passage content" do
         content = BibleGateway.new(:english_standard_version).lookup("John 1:1")[:content]
-        content.should include("<h3>The Word Became Flesh</h3>")
-        content.should include("In the beginning was the Word, and the Word was with God, and the Word was God.")
+        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
       it "should find the passage title" do
         title = BibleGateway.new(:english_standard_version).lookup("John 3")[:title]
-        title.should == "John 3"
+        expect(title).to eq("John 3")
+      end
+
+      it "should find the passage title in chinese_new_version_simplified" do
+        title = BibleGateway.new(:chinese_new_version_simplified).lookup("John 3")[:title]
+        expect(title).to eq("约翰福音 3")
       end
 
       it "should find and clean the passage content" do
         content = BibleGateway.new(:english_standard_version).lookup("John 3")[:content]
-        content.should include("<h3>You Must Be Born Again</h3>")
-        content.should include("<h3>For God So Loved the World</h3>")
-        content.should 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.")
+        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
+
+      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
       it "should find the passage title" do
         title = BibleGateway.new(:english_standard_version).lookup("Psalm 1-5")[:title]
-        title.should == "Psalm 1-5"
+        expect(title).to eq("Psalm 1-5")
       end
 
       it "should find and clean the passage content" do
         content = BibleGateway.new(:english_standard_version).lookup("Psalm 1-5")[:content]
-        content.should include("<h3>The Way of the Righteous and the Wicked</h3>")
-        content.should include("<span class=\"chapternum\">1 </span>")
-        content.should include("<h3>Save Me, O My God</h3>")
-        content.should include("<span class=\"chapternum\">1 </span>")
-        content.should include("For you are not a God who delights in wickedness;")
+        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
+
+      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,96 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: bible_gateway
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Geoffrey Dagley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !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
     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: rspec
   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'
 description: An unofficial 'API' for BibleGateway.com.
 email:
 - gdagley@gmail.com
+- bibleableproject@gmail.com
+- ytbryan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .rspec
-- .travis.yml
+- ".document"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,20 +128,19 @@ 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
+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