votd 1.0.1 → 1.1.0

data/.yardopts

@@ -1,6 +1,7 @@
 --title "VotD - (Bible) Verse of the Day"
 lib/**/*
 -
-LICENSE
 CONTRIBUTING.md
-TODO.md
+CHANGELOG.md
+LICENSE
+TODO.md

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+* March 25, 2012 1.1.0 release
+  * Add support for [Bible Gateway](www.biblegateway.com)
+    * only supporting the default NIV translation for now, but
+      planning to implement other translations
+  * Update votd command line tool to load from Bible Gateway
+  * Move more code toward compatibility with Ruby 1.8
+
+* March 25, 2012 1.0.1 release
+  * Updated documentation links
+  
 * March 24, 2012 1.0.0 release
-  * Initial release with support for Bible.org's NETBible
+  * Initial release with support for Bible.org's [NETBible](http://labs.bible.org/)
   * YARD documentation added

data/Guardfile

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

data/README.md

@@ -3,13 +3,15 @@
 VotD (Verse of the Day) is a Ruby Gem that wraps various web services that generate
 daily Bible Verses.
 
-Currently the gem supports one VotD web service:
+Currently the gem supports two VotD web services:
 
 * [Bible.org](http://labs.bible.org) - NETBible Translation
+* [Bible Gateway](http://www.biblegateway.com) - NIV Translations (Currently only supporting the default NIV, but planning on adding more.)
 
 Other services are are planned:
 
-* [Bible Gateway](http://www.biblegateway.com) - Multiple Translations
+* [Bible Gateway](http://www.biblegateway.com) - More Translations
+ 
 * [ESV Bible Web Service](http://www.esvapi.org/) - ESV Translation
 
 If you are able to contribute modules for any of these, please see our [CONTRIBUTING](http://rubydoc.info/gems/votd/file/CONTRIBUTING.md) file. Let us know before you begin work in case someone else has a module in-progress.
@@ -36,6 +38,8 @@ To use VotD in our code:
     
     votd = Votd.NetBible.new
     
+    # or votd = Votd.BibleGateway.new
+    
     votd.reference   # Ephesians 2:8-9
     votd.text        # For by grace you are saved through faith...
     votd.date        # 2012-03-24

data/TODO.md

@@ -1,9 +1,13 @@
 ## Todo
 
-* Generate an appropriate VOTD from a static file if there's any error communicating with the VOTD API. (suggest something like 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 to. Currently only a bare stub of an app.
+* Update `votd` command-line version. Currently only a bare stub of an app.
 
 * Integrate [ESV API](http://www.esvapi.org/api)
 
+* Enable support for more translations from [Bible Gateway](http://www.biblegateway.com/usage/votd/docs/)
+
 * Ensure Ruby < 1.9 compatibility.
+
+* Clean up architecture to use one base class for all modules

data/bin/votd

@@ -1,8 +1,11 @@
 #!/usr/bin/env ruby
 
+# allow this to run from development environment
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
 require 'votd'
 
-votd = Votd::NetBible.new
+votd = Votd::BibleGateway.new
 
 puts "===================================================="
 puts "          VERSE OF THE DAY for #{votd.date.to_s}"

data/lib/votd/bible_gateway.rb

@@ -0,0 +1,67 @@
+require 'feedzirra'
+module Votd
+  # Retrieves a Verse of the Day from biblegateway.com using a variety
+  # of translations.
+  #
+  # docs: http://www.biblegateway.com/usage/votd/docs/
+  #
+  # version list: http://www.biblegateway.com/usage/linking/versionslist.php
+  #
+  # @todo Extend this to allow requesting any of the supported Bible translations that
+  #       Bible Gateway supports for VotD
+  #
+  class BibleGateway
+    # The name of the Bible Translation that this module generates
+    BIBLE_VERSION = "NIV"
+
+    # The URI of the API gateway
+    URI = "http://www.biblegateway.com/usage/votd/rss/votd.rdf?"
+
+    # Initializes the BibleGateway class
+    def initialize
+      @reference =  ""
+      @text = ""
+      get_verse
+    end
+
+    # @macro votd.date
+    def date
+      Date.today
+    end
+
+    # @macro votd.reference
+    def reference
+      @reference
+    end
+
+    # @macro votd.text
+    def text
+      @text
+    end
+
+    # @macro votd.version
+    def version
+      BIBLE_VERSION
+    end
+
+    # @macro votd.to_html
+    def to_html
+      html =  "<p class=\"votd-text\">#{self.text}</p>\n"
+      html << "<p>\n"
+      html << "<span class=\"votd-reference\"><strong>#{self.reference}</strong></span>\n"
+      html << "<span class=\"votd-version\"><em>(#{self.version})</em></span>\n"
+      html << "</p>\n"
+      html
+    end
+
+    private
+    # Gets the votd from the Bible Gateway RSS feed
+    def get_verse
+      feed = Feedzirra::Feed.parse(HTTParty.get(URI).body)
+      entry = feed.entries.first
+      @reference = entry.title
+      @text      = entry.content.strip
+    end
+
+  end
+end

data/lib/votd/netbible.rb

@@ -5,47 +5,51 @@ module Votd
     # The name of the Bible Translation that this module generates
     BIBLE_VERSION = "NETBible"
 
+    # The URI of the API gateway
+    URI = "http://labs.bible.org/api/?passage=votd&type=json"
+
     # Initializes the NetBible class
     def initialize
-      @reference = ""
-      @text      = ""
+      @reference, @text = ""
       get_verse
     end
 
-    # The scripture reference. e.g.
-    #    "Ephesians 2:8-9"
+    # @macro [new] votd.reference
+    # @example
+    #    votd.reference  # "Ephesians 2:8-9"
     #
-    # @return [String]
+    # @return [String] the scripture reference.
     def reference
       @reference
     end
 
-    # The full bible passage. e.g.
-    #     "For by grace you are saved through faith..."
-    # @return [String]
+    # @macro [new] votd.text
+    # @example
+    #   votd.text  # "For by grace you are saved through faith..."
+    # @return [String] the full bible passage
     def text
       @text
     end
 
-    # The date the Verse was retrieved. e.g.
-    #     "2012-03-24"
+    # @macro [new] votd.date
+    # @example
+    #   votd.date  # "2012-03-24"
     #
-    # @return [String]
+    # @return [String] the date the Verse was retrieved
     def date
       Date.today
     end
 
-    # The bible translation used for this VotD. For this module this
-    # will always be.
-    #     NETBible
-    #
-    # @return [String]
+    # For this module this will always be:
+    #   "NETBible"
+    # @macro [new] votd.version
+    # @return [String] the bible translation used for this VotD
     def version
       BIBLE_VERSION
     end
 
-    # Returns the Verse of the Day formatted as HTML.
-    # e.g.
+    # @macro [new] votd.to_html
+    # Returns the Verse of the Day formatted as HTML. e.g.
     #    <p class="votd-text">For by grace you are saved through faith...</p>
     #    <p>
     #    <span class="votd-reference"><strong>Ephesians 2:8-9</strong></span>
@@ -68,7 +72,7 @@ module Votd
     private
     # Gets the verse in JSON format from bible.org
     def get_verse
-      netbible_data = JSON.parse(HTTParty.get("http://labs.bible.org/api/?passage=votd&type=json"))
+      netbible_data = JSON.parse(HTTParty.get(URI))
 
       # use bookname from first verse -- assume votd won't span books
       bookname = netbible_data[0]["bookname"]

data/lib/votd/version.rb

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

data/lib/votd.rb

@@ -1,14 +1,12 @@
-require "votd/version"
+require "votd/bible_gateway"
 require "votd/netbible"
+require "votd/version"
 require "time"
 require "json"
 require "httparty"
 
 # This class acts as the entry point to all sub-modules that are used
-# to interact with various Verse of the Day APIs.
-#
-# Currently there is only NetBible (bible.org), but more can be accomodated
-# by following the established pattern.
+# to interact with various Verse of the Day web services.
 module Votd
   include HTTParty
 end

data/spec/fixtures/bible_gateway.html

@@ -0,0 +1,5 @@
+<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>
+<span class="votd-reference"><strong>1 John 1:9</strong></span>
+<span class="votd-version"><em>(NIV)</em></span>
+</p>

data/spec/fixtures/bible_gateway.rss

@@ -0,0 +1,32 @@
+<?xml version="1.0" ?>
+<rss version="2.0"
+xmlns:dc="http://purl.org/dc/elements/1.1/"
+xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
+xmlns:admin="http://webns.net/mvcb/"
+xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+xmlns:content="http://purl.org/rss/1.0/modules/content/">
+
+  <channel>
+    <title>Bible Gateway's Verse of the Day</title>
+    <link>http://www.biblegateway.com</link>
+    <description>A daily word of exultation.</description>
+    <dc:language>en-us</dc:language>
+    <dc:creator>BibleGateway.com</dc:creator>
+    <dc:rights>Copyright 2004</dc:rights>
+    <dc:date>2012-03-25T12:00:00Z</dc:date>
+    <sy:updatePeriod>daily</sy:updatePeriod>
+    <sy:updateFrequency>1</sy:updateFrequency>
+    <sy:updateBase>2000-01-01T12:00+00:00</sy:updateBase>
+
+    <item>
+      <title>1 John 1:9</title>
+      <description>Verse of the day</description>
+      <guid isPermaLink="false">http://www.biblegateway.com/passage/?search=1+John+1%3A9&amp;version=NIV</guid>
+      <content:encoded>
+        <![CDATA[&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.]]>
+      </content:encoded>
+      <dc:rights>Powered by BibleGateway.com</dc:rights>
+      <dc:date>2012-03-25T12:00:00Z</dc:date>
+    </item>
+  </channel>
+</rss>

data/spec/lib/votd/bible_gateway_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "Votd::BibleGateway" do
+  let(:votd) { Votd::BibleGateway.new }
+
+  it "is a type of BibleGateway" do
+    votd.should be_a(Votd::BibleGateway)
+  end
+
+  it "has a .date" do
+    votd.date.should == Date.today
+  end
+
+  it "has a .reference" do
+    votd.reference.should == "1 John 1:9"
+  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."
+  end
+
+  it "has a .version" do
+    votd.version.should == "NIV"
+  end
+
+  it "returns a HTML version" do
+    votd.to_html.should == File.read(fixture("bible_gateway.html"))
+  end
+end

data/spec/spec_helper.rb

@@ -11,6 +11,12 @@ RSpec.configure do |config|
     File.join(File.dirname(__FILE__), 'fixtures', filename)
   end
 
-  FakeWeb.register_uri(:get, "http://labs.bible.org/api/?passage=votd&type=json",
-                       body: open(fixture("netbible.json")))
+  # Register Bible Gateway URI
+  FakeWeb.register_uri(:get, Votd::BibleGateway::URI,
+                       :body => open(fixture("bible_gateway.rss")))
+
+  # Register NETBible URI
+  FakeWeb.register_uri(:get, Votd::NetBible::URI,
+                       :body => open(fixture("netbible.json")))
+
 end

data/votd.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = ">= 1.9.1"
 
   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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: votd
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -28,6 +28,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: feedzirra
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -146,13 +162,17 @@ files:
 - TODO.md
 - bin/votd
 - lib/votd.rb
+- lib/votd/bible_gateway.rb
 - lib/votd/netbible.rb
 - lib/votd/version.rb
+- spec/fixtures/bible_gateway.html
+- spec/fixtures/bible_gateway.rss
 - spec/fixtures/netbible.html
 - spec/fixtures/netbible.json
-- spec/netbible_spec.rb
+- spec/lib/votd/bible_gateway_spec.rb
+- spec/lib/votd/netbible_spec.rb
+- spec/lib/votd_spec.rb
 - spec/spec_helper.rb
-- spec/votd_spec.rb
 - votd.gemspec
 homepage: https://github.com/doctorbh/votd
 licenses:
@@ -180,9 +200,12 @@ signing_key:
 specification_version: 3
 summary: Generate a (Bible) Verse of the Day using various web service wrappers
 test_files:
+- spec/fixtures/bible_gateway.html
+- spec/fixtures/bible_gateway.rss
 - spec/fixtures/netbible.html
 - spec/fixtures/netbible.json
-- spec/netbible_spec.rb
+- spec/lib/votd/bible_gateway_spec.rb
+- spec/lib/votd/netbible_spec.rb
+- spec/lib/votd_spec.rb
 - spec/spec_helper.rb
-- spec/votd_spec.rb
 has_rdoc: