votd 1.1.0 → 1.2.0

data/.travis.yml

@@ -0,0 +1,16 @@
+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
+notifications:
+  email:
+    recipients:
+      - beakr@ninjanizr.com
+      - doctorbh@ninjanizr.com
+    on_success: always
+    on_failure: always

data/.yardopts

@@ -1,4 +1,5 @@
 --title "VotD - (Bible) Verse of the Day"
+--protected
 lib/**/*
 -
 CONTRIBUTING.md

data/CHANGELOG.md

@@ -1,11 +1,17 @@
 # Changelog
 
+* March 26, 2012 1.2.0 release
+  * Refactored shared code from BibleGateway and NetBible into a Base class
+    and inherited from this. This makes the code base easier to manage and
+    extend. See the [CONTRIBUTING](https://github.com/doctorbh/votd/blob/master/CONTRIBUTING.md) page for more info on how to make use of the Base class.
+  * Updated docs
+  	 
 * March 25, 2012 1.1.0 release
-  * Add support for [Bible Gateway](www.biblegateway.com)
+  * Added 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
+  * Updated votd command line tool to load from Bible Gateway
+  * Moved more code toward compatibility with Ruby 1.8
 
 * March 25, 2012 1.0.1 release
   * Updated documentation links

data/CONTRIBUTING.md

@@ -9,8 +9,23 @@ GitHub. This will hand over a copy of the code to you so that you can
 really do whatever you want.
 
 To create a plugin, you must find an API and wrap it in a module
-located in `lib/votd`. Once this is complete, you can start by
-creating a new file in `spec` to test your plugin before your pull
+located in `lib/votd`.
+
+* Your class must inherit from {Votd::Base} and
+needs to override the {Votd::Base#get_votd} method.
+
+* Your class must supply the `BIBLE_VERSION` constant, or set `@version` inside the class somewhere.
+
+* Your initializer must consist of at least the following:
+
+      ```ruby
+      # Initializes the MyBible class
+      def initialize
+      	super
+      end
+      ```
+    
+Creating a new file in `spec` to test your plugin before your pull
 request. VotD uses the testing framework [Rspec](http://rspec.info/)
 to manage testing, so use the Rspec syntax enhancements rather than
 another framework.

data/README.md

@@ -1,8 +1,11 @@
 # VotD - (Bible) Verse of the Day
 
+[![Build Status](https://secure.travis-ci.org/doctorbh/votd.png?branch=master)](http://travis-ci.org/doctorbh/votd)
+
 VotD (Verse of the Day) is a Ruby Gem that wraps various web services that generate
 daily Bible Verses.
 
+
 Currently the gem supports two VotD web services:
 
 * [Bible.org](http://labs.bible.org) - NETBible Translation
@@ -14,7 +17,7 @@ Other services are are planned:
  
 * [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.
+If you are able to contribute modules for any of these, please see our [CONTRIBUTING](https://github.com/doctorbh/votd/blob/master/CONTRIBUTING.md) file. Let us know before you begin work in case someone else has a module in-progress.
 
 ## Installation
 
@@ -32,7 +35,7 @@ Or install it yourself as:
 
 ## Usage
 
-To use VotD in our code:
+To use VotD in your code:
 
     require 'votd'
     
@@ -80,15 +83,15 @@ To submit bug, feature requests, patches see our [Issues List](https://github.co
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
 
-See more on [CONTRIBUTING](http://rubydoc.info/gems/votd/file/CONTRIBUTING.md).
+See more on [CONTRIBUTING](https://github.com/doctorbh/votd/blob/master/CONTRIBUTING.md).
 
 ## Changelog
 
-See our [CHANGELOG](http://rubydoc.info/gems/votd/file/CHANGELOG.md) file.
+See our [CHANGELOG](https://github.com/doctorbh/votd/blob/master/CHANGELOG.md) file.
 
 ## TODO
 
-See our [TODO](http://rubydoc.info/gems/votd/file/TODO.md) file.
+See our [TODO](https://github.com/doctorbh/votd/blob/master/TODO.md) file.
 
 ## Authors
 
@@ -100,4 +103,4 @@ Stephen Clarke <doctorbh@ninjanizr.com>
 
 (The MIT License)
 
-&copy; 2012 Christopher Clarke, Stephen Clarke. See [LICENSE](http://rubydoc.info/gems/votd/1.0.0/file/LICENSE) for details.
+&copy; 2012 Christopher Clarke, Stephen Clarke. See [LICENSE](https://github.com/doctorbh/votd/blob/master/LICENSE) for details.

data/TODO.md

@@ -8,6 +8,6 @@
 
 * Enable support for more translations from [Bible Gateway](http://www.biblegateway.com/usage/votd/docs/)
 
-* Ensure Ruby < 1.9 compatibility.
+* Ensure Ruby 1.8.7 compatibility.
 
-* Clean up architecture to use one base class for all modules
+* Add some kind of simple caching

data/lib/votd/base.rb

@@ -0,0 +1,72 @@
+module Votd
+  # This is the base class that all Votd lookup modules inherit from.
+  # It provides default values for the Votd in the event of lookup failure.
+  # Child classes should override the {#get_votd} method to implement their
+  # specific lookup function.
+  class Base
+    # @example
+    #   votd.text  # "For by grace you are saved through faith..."
+    # @return [String] the full bible passage
+    attr_reader :text
+
+    # @example
+    #    votd.reference  # "Ephesians 2:8-9"
+    #
+    # @return [String] the scripture reference.
+    attr_reader :reference
+
+    # @example
+    #   votd.date  # "2012-03-24"
+    #
+    # @return [String] the date the Verse was retrieved
+    attr_reader :date
+
+    # @example
+    #     votd.version  # "NIV"
+    # @return [String] the bible translation used for this VotD
+    attr_reader :version
+
+    # 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.
+    def initialize
+      @text      = ""
+      @reference = ""
+      @date      = Date.today
+      get_votd
+    end
+
+    # 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>
+    #    <span class="votd-version"><em>(NETBible)</em></span>
+    #    </p>
+    #
+    # This should provide sufficient hooks to style the CSS. If this is not
+    # sufficient, you can build the HTML by hand using the individual data.
+    #
+    # @return [String] the VotD formatted as HTML
+    def to_html
+      html =  "<p class=\"votd-text\">#{@text}</p>\n"
+      html << "<p>\n"
+      html << "<span class=\"votd-reference\"><strong>#{@reference}</strong></span>\n"
+      html << "<span class=\"votd-version\"><em>(#{@version})</em></span>\n"
+      html << "</p>\n"
+      html
+    end
+
+    protected
+    # Gets the VotD. For {Votd::Base} this will return default values and can be
+    # used in the event of an exception thrown when getting data from live web
+    # services in subclasses of {Votd::Base}
+    def get_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."
+      @reference = "John 3:16"
+      @version   = DEFAULT_BIBLE_VERSION
+    end
+
+  end
+end

data/lib/votd/bible_gateway.rb

@@ -10,7 +10,7 @@ module Votd
   # @todo Extend this to allow requesting any of the supported Bible translations that
   #       Bible Gateway supports for VotD
   #
-  class BibleGateway
+  class BibleGateway < Votd::Base
     # The name of the Bible Translation that this module generates
     BIBLE_VERSION = "NIV"
 
@@ -19,49 +19,18 @@ module Votd
 
     # 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
+      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
-    def get_verse
-      feed = Feedzirra::Feed.parse(HTTParty.get(URI).body)
-      entry = feed.entries.first
+    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
     end
-
   end
 end

data/lib/votd/netbible.rb

@@ -1,7 +1,9 @@
 module Votd
-  # Retrieves a Verse of the Day from bible.org using the NETBible
+  # @todo Clean up generated verse when it has trailing punctuation
+  #       and/or begins with lower-case. Substitute "..."
+  # Retrieves a Verse of the Day from http://bible.org using the NETBible
   # translation.
-  class NetBible
+  class NetBible < Votd::Base
     # The name of the Bible Translation that this module generates
     BIBLE_VERSION = "NETBible"
 
@@ -10,68 +12,13 @@ module Votd
 
     # Initializes the NetBible class
     def initialize
-      @reference, @text = ""
-      get_verse
-    end
-
-    # @macro [new] votd.reference
-    # @example
-    #    votd.reference  # "Ephesians 2:8-9"
-    #
-    # @return [String] the scripture reference.
-    def reference
-      @reference
-    end
-
-    # @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
-
-    # @macro [new] votd.date
-    # @example
-    #   votd.date  # "2012-03-24"
-    #
-    # @return [String] the date the Verse was retrieved
-    def date
-      Date.today
-    end
-
-    # 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
-
-    # @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>
-    #    <span class="votd-version"><em>(NETBible)</em></span>
-    #    </p>
-    #
-    # This should provide sufficient hooks to style the CSS. If this is not
-    # sufficient, you can build the HTML by hand using the individual data.
-    #
-    # @return [String] the VotD formatted as 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
+      super
     end
 
     private
+    # @todo Generate default VotD from Votd::Base if there's a problem getting feed
     # Gets the verse in JSON format from bible.org
-    def get_verse
+    def get_votd
       netbible_data = JSON.parse(HTTParty.get(URI))
 
       # use bookname from first verse -- assume votd won't span books
@@ -93,6 +40,8 @@ module Votd
 
       # build the text
       @text = verses.join(" ")
+
+      @version = BIBLE_VERSION
     end
   end
 end

data/lib/votd/version.rb

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

data/lib/votd.rb

@@ -1,3 +1,4 @@
+require "votd/base"
 require "votd/bible_gateway"
 require "votd/netbible"
 require "votd/version"

data/spec/lib/votd/base_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "Votd::Base" do
+  let(:votd) { Votd::Base.new }
+
+  describe ".text" do
+    it "returns the default scripture verse" do
+      votd.text.should == "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."
+    end
+  end
+
+  describe ".reference" do
+    it "returns the default scripture reference" do
+      votd.reference.should == "John 3:16"
+    end
+  end
+
+  describe ".version" do
+    it "returns the default bible version" do
+      votd.version.should == "KJV"
+    end
+  end
+
+  describe ".date" do
+    it "returns the default date" do
+      votd.date.should == Date.today
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: votd
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-25 00:00:00.000000000 Z
+date: 2012-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -151,6 +151,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - .yardopts
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -162,6 +163,7 @@ files:
 - TODO.md
 - bin/votd
 - lib/votd.rb
+- lib/votd/base.rb
 - lib/votd/bible_gateway.rb
 - lib/votd/netbible.rb
 - lib/votd/version.rb
@@ -169,6 +171,7 @@ files:
 - spec/fixtures/bible_gateway.rss
 - spec/fixtures/netbible.html
 - spec/fixtures/netbible.json
+- spec/lib/votd/base_spec.rb
 - spec/lib/votd/bible_gateway_spec.rb
 - spec/lib/votd/netbible_spec.rb
 - spec/lib/votd_spec.rb
@@ -204,6 +207,7 @@ test_files:
 - spec/fixtures/bible_gateway.rss
 - spec/fixtures/netbible.html
 - spec/fixtures/netbible.json
+- spec/lib/votd/base_spec.rb
 - spec/lib/votd/bible_gateway_spec.rb
 - spec/lib/votd/netbible_spec.rb
 - spec/lib/votd_spec.rb