votd 1.2.0 → 2.0.0

data/.travis.yml

@@ -1,12 +1,9 @@
 language: ruby
 rvm:
-#  - 1.8.7
   - 1.9.2
   - 1.9.3
-#  - jruby-18mode # JRuby in 1.8 mode
-#  - jruby-19mode # JRuby in 1.9 mode
-#  - rbx-18mode
-#  - rbx-19mode
+  #- jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
 notifications:
   email:
     recipients:

data/CHANGELOG.md

@@ -1,4 +1,12 @@
 # Changelog
+* March 30, 2010 2.0.0 release
+  * New `copyright` attribute containing any copyright information provided
+    by the VotD service. This may will cause any existing use of
+    `Votd.BibleGateway.text` to lose copyright data unless you add it.
+    (Previously, we were just using the copyright data that Bible Gateway
+    appended to the end of the Bible text.)
+    Bible Gateway requires that you add this copyright data. 
+  * Remove any reference to Ruby 1.8.7. Will not be supporting.
 
 * March 26, 2012 1.2.0 release
   * Refactored shared code from BibleGateway and NetBible into a Base class

data/Guardfile

@@ -1,8 +1,10 @@
-guard 'rspec', version: 2, cli: "--color --format documentation" do
+guard 'bundler' do
+  watch('Gemfile')
+  watch(%r{^.+\.gemspec})
+end
+
+guard 'rspec', :version => 2, :cli => "--color --format documentation" do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m|
-    puts "running spec/lib/#{m[1]}_spec.rb"
-    "spec/lib/#{m[1]}_spec.rb"
-  }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end

data/README.md

@@ -46,7 +46,8 @@ To use VotD in your code:
     votd.reference   # Ephesians 2:8-9
     votd.text        # For by grace you are saved through faith...
     votd.date        # 2012-03-24
-    votd.version     # NETBible
+    votd.version     # NIV
+    votd.copyright   # Copyright © ...
     
     votd.to_html     # <p class="votd-text">For by grace you are saved through faith...
     

data/Rakefile

@@ -6,10 +6,8 @@ require "yard"
 task :default => :spec
 
 desc "Run RSpec tests [default]"
-RSpec::Core::RakeTask.new do |task|
-end
+RSpec::Core::RakeTask.new
 
 desc "Generate YARD docs"
-YARD::Rake::YardocTask.new do |task|
-end
+YARD::Rake::YardocTask.new
 

data/TODO.md

@@ -1,6 +1,6 @@
 ## Todo
 
-* Generate an appropriate VOTD from a static file if there's any error communicating with the VOTD API. (e.g. John 3:16)
+* Generate an appropriate VotD from a static file if there's any error communicating with the VotD API. (e.g. John 3:16)
 
 * Update `votd` command-line version. Currently only a bare stub of an app.
 
@@ -8,6 +8,4 @@
 
 * Enable support for more translations from [Bible Gateway](http://www.biblegateway.com/usage/votd/docs/)
 
-* Ensure Ruby 1.8.7 compatibility.
-
 * Add some kind of simple caching

data/lib/votd/base.rb

@@ -26,14 +26,21 @@ module Votd
     # @return [String] the bible translation used for this VotD
     attr_reader :version
 
+    # @example
+    #    votd.copyright # "Brought to you by BibleGateway.com. Copyright (C) . All Rights Reserved."
+    # @return [String] any copyright information supplied by VotD provider
+    attr_reader :copyright
+
     # The default Bible version to use if none is given and no other default
     # is provided
     DEFAULT_BIBLE_VERSION = "KJV"
 
     # Initializes the class and retrieves the verse of the day.
+    # @return [Base]
     def initialize
       @text      = ""
       @reference = ""
+      @copyright = nil
       @date      = Date.today
       get_votd
     end

data/lib/votd/bible_gateway.rb

@@ -18,19 +18,66 @@ module Votd
     URI = "http://www.biblegateway.com/usage/votd/rss/votd.rdf?"
 
     # Initializes the BibleGateway class
+    # @return [BibleGateway]
     def initialize
+      # Regular expression for pulling the copyright out of the Bible text
+      @regex_copyright_text = /(Brought to you by BibleGateway.*$)/
       super
     end
 
     private
+
     # @todo Generate default VotD from Votd::Base if there's a problem getting feed
     # Gets the votd from the Bible Gateway RSS feed
+    # @return [String]
     def get_votd
-      feed       = Feedzirra::Feed.parse(HTTParty.get(URI).body)
-      entry      = feed.entries.first
-      @reference = entry.title
-      @text      = entry.content.strip
-      @version   = BIBLE_VERSION
+      feed         = Feedzirra::Feed.parse(HTTParty.get(URI).body)
+      entry        = feed.entries.first
+      cleaned_text = clean_text(entry.content)
+
+      @reference   = entry.title
+      @text        = cleaned_text
+      @copyright   = get_copyright(entry.content)
+      @version     = BIBLE_VERSION
+    end
+
+    # Cleans up the text. Removes:
+    #   - HTML quote entities
+    #   - HTML tags
+    #   - Copyright text
+    #   - Extra spaces, line breaks, etc.
+    # @return [String]
+    def clean_text(text)
+      text = strip_html_quote_entities(text)
+      text = strip_html_tags(text)
+      text = strip_copyright_text(text)
+      text.strip
+    end
+
+    # Extracts copyright tag from the Bible text
+    # @return [String]
+    def get_copyright(text)
+      text = strip_html_quote_entities(text)
+      text = strip_html_tags(text)
+      text.match(@regex_copyright_text)[1]
+    end
+
+    # Removes HTML quote entities added by BibleGateway
+    # @return [String]
+    def strip_html_quote_entities(text)
+      text.gsub(/&.dquo;/, '')
+    end
+
+    # Removes HTML tags from the Bible text
+    # @return [String]
+    def strip_html_tags(text)
+      text.gsub(/<\/?[^>]*>/, '')
+    end
+
+    # Removes copyright text from the Bible text
+    # @return [String]
+    def strip_copyright_text(text)
+      text.gsub(@regex_copyright_text, '')
     end
   end
 end

data/lib/votd/netbible.rb

@@ -11,6 +11,7 @@ module Votd
     URI = "http://labs.bible.org/api/?passage=votd&type=json"
 
     # Initializes the NetBible class
+    # @return [Votd::NetBible]
     def initialize
       super
     end

data/lib/votd/version.rb

@@ -1,4 +1,4 @@
 module Votd
   # Gem version number
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

data/spec/fixtures/base.html

@@ -0,0 +1,5 @@
+<p class="votd-text">For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.</p>
+<p>
+<span class="votd-reference"><strong>John 3:16</strong></span>
+<span class="votd-version"><em>(KJV)</em></span>
+</p>

data/spec/fixtures/bible_gateway.html

@@ -1,4 +1,4 @@
-<p class="votd-text">&ldquo;If we confess our sins, he is faithful and just and will forgive us our sins and purify us from all unrighteousness.&rdquo;<br/><br/> Brought to you by <a href="http://www.biblegateway.com">BibleGateway.com</a>. Copyright (C) . All Rights Reserved.</p>
+<p class="votd-text">If we confess our sins, he is faithful and just and will forgive us our sins and purify us from all unrighteousness.</p>
 <p>
 <span class="votd-reference"><strong>1 John 1:9</strong></span>
 <span class="votd-version"><em>(NIV)</em></span>

data/spec/lib/votd/base_spec.rb

@@ -26,4 +26,16 @@ describe "Votd::Base" do
       votd.date.should == Date.today
     end
   end
+
+  describe ".copyright" do
+    it "returns nil copyright information" do
+      votd.copyright.should be_nil
+    end
+  end
+
+  describe ".to_html" do
+    it "returns a HTML version" do
+      votd.to_html.should == File.read(fixture("base.html"))
+    end
+  end
 end

data/spec/lib/votd/bible_gateway_spec.rb

@@ -7,23 +7,39 @@ describe "Votd::BibleGateway" do
     votd.should be_a(Votd::BibleGateway)
   end
 
-  it "has a .date" do
-    votd.date.should == Date.today
+  describe ".text" do
+    it "returns the correct scripture verse" do
+      votd.text.should == "If we confess our sins, he is faithful and just and will forgive us our sins and purify us from all unrighteousness."
+    end
   end
 
-  it "has a .reference" do
-    votd.reference.should == "1 John 1:9"
+  describe ".reference" do
+    it "returns the correct scripture reference" do
+      votd.reference.should == "1 John 1:9"
+    end
   end
 
-  it "has a .text" do
-    votd.text.should == "&ldquo;If we confess our sins, he is faithful and just and will forgive us our sins and purify us from all unrighteousness.&rdquo;<br/><br/> Brought to you by <a href=\"http://www.biblegateway.com\">BibleGateway.com</a>. Copyright (C) . All Rights Reserved."
+  describe ".version" do
+    it "returns the correct bible version" do
+      votd.version.should == "NIV"
+    end
   end
 
-  it "has a .version" do
-    votd.version.should == "NIV"
+  describe ".date" do
+    it "returns the correct date" do
+      votd.date.should == Date.today
+    end
   end
 
-  it "returns a HTML version" do
-    votd.to_html.should == File.read(fixture("bible_gateway.html"))
+  describe ".copyright" do
+    it "returns copyright information" do
+      votd.copyright.should == "Brought to you by BibleGateway.com. Copyright (C) . All Rights Reserved."
+    end
+  end
+
+  describe ".to_html" do
+    it "returns a HTML version" do
+      votd.to_html.should == File.read(fixture("bible_gateway.html"))
+    end
   end
 end

data/spec/lib/votd/netbible_spec.rb

@@ -8,24 +8,39 @@ describe "Votd::NETBible" do
     votd.should be_a(Votd::NetBible)
   end
 
-  it "has a .date" do
-    votd.date.should == Date.today
+  describe ".text" do
+    it "returns the correct scripture verse" do
+      votd.text.should == "For by grace you are saved through faith... it is not from works, so that no one can boast."
+    end
   end
 
-  it "has a .reference" do
-    votd.reference.should == "Ephesians 2:8-9"
+  describe ".reference" do
+    it "returns the correct scripture reference" do
+      votd.reference.should == "Ephesians 2:8-9"
+    end
   end
 
-  it "has a .text" do
-    votd.text.should == "For by grace you are saved through faith... it is not from works, so that no one can boast."
+  describe ".version" do
+    it "returns the correct bible version" do
+      votd.version.should == "NETBible"
+    end
   end
 
-  it "has a .version" do
-    votd.version.should == "NETBible"
+  describe ".date" do
+    it "returns the correct date" do
+      votd.date.should == Date.today
+    end
   end
 
-  it "returns a HTML version" do
-    votd.to_html.should == File.read(fixture("netbible.html"))
+  describe ".copyright" do
+    it "returns nil copyright information" do
+      votd.copyright.should be_nil
+    end
   end
 
+  describe ".to_html" do
+    it "returns a HTML version" do
+      votd.to_html.should == File.read(fixture("netbible.html"))
+    end
+  end
 end

data/votd.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Steve Clarke", "Chris Clarke"]
   gem.email         = ["doctorbh@ninjanizr.com", "beakr@ninjanizr.com"]
   gem.summary       = %q{Generate a (Bible) Verse of the Day using various web service wrappers}
-  gem.homepage      = "https://github.com/doctorbh/votd"
+  gem.homepage      = "http://doctorbh.github.com/votd"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,15 +15,15 @@ Gem::Specification.new do |gem|
   gem.version       = Votd::VERSION
   gem.license       = "MIT"
 
-  gem.required_ruby_version = ">= 1.9.1"
+  gem.required_ruby_version = ">= 1.9.2"
 
   gem.add_runtime_dependency     "httparty"
-  gem.add_runtime_dependency     "json" if RUBY_VERSION < "1.9"
   gem.add_runtime_dependency     "feedzirra"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "fakeweb"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "guard-bundler"
   gem.add_development_dependency "yard"
   gem.add_development_dependency "redcarpet"
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: votd
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-26 00:00:00.000000000 Z
+date: 2012-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -108,6 +108,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +183,7 @@ files:
 - lib/votd/bible_gateway.rb
 - lib/votd/netbible.rb
 - lib/votd/version.rb
+- spec/fixtures/base.html
 - spec/fixtures/bible_gateway.html
 - spec/fixtures/bible_gateway.rss
 - spec/fixtures/netbible.html
@@ -177,7 +194,7 @@ files:
 - spec/lib/votd_spec.rb
 - spec/spec_helper.rb
 - votd.gemspec
-homepage: https://github.com/doctorbh/votd
+homepage: http://doctorbh.github.com/votd
 licenses:
 - MIT
 post_install_message: 
@@ -189,7 +206,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -203,6 +220,7 @@ signing_key:
 specification_version: 3
 summary: Generate a (Bible) Verse of the Day using various web service wrappers
 test_files:
+- spec/fixtures/base.html
 - spec/fixtures/bible_gateway.html
 - spec/fixtures/bible_gateway.rss
 - spec/fixtures/netbible.html