votd 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.yardopts

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

data/CONTRIBUTING.md

@@ -0,0 +1,20 @@
+Inside of VotD's source is a module with classes and files referring
+to various Bible web APIs. By contributing to VotD with plugins you
+can help keep the gem fresh with new versions.
+
+The most basic way to get the code is to simply fork the code base on
+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
+request. VotD uses the testing framework [Rspec](http://rspec.info/)
+to manage testing, so use the Rspec syntax enhancements rather than
+another framework.
+
+Once your tests are done, work on the parsing system with your code,
+and you're ready to go!
+
+Just pop us a [Pull Request](https://github.com/doctorbh/votd/pulls)
+and you're code will be overviewed and ready to go soon.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in votd.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+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('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Christopher Clarke, Stephen Clarke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# VotD - (Bible) Verse of the Day
+
+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:
+
+* [Bible.org](http://labs.bible.org) - NETBible Translation
+
+Other services are are planned:
+
+* [Bible Gateway](http://www.biblegateway.com) - Multiple 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](CONTRIBUTING.md) file. Let us know before you begin work in case someone else has a module in-progress.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'votd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install votd
+
+## Usage
+
+To use VotD in our code:
+
+    require 'votd'
+    
+    votd = Votd.NetBible.new
+    
+    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.to_html     # <p class="votd-text">For by grace you are saved through faith...
+    
+Full text of HTML formatted VotD looks like the following
+
+    <p class="votd-text">For by grace you are saved through faith... it is not from works, so that no one can boast.</p>
+    <p>
+    <span class="votd-reference"><strong>Ephesians 2:8-9</strong></span>
+	<span class="votd-version"><em>(NETBible)</em></span>
+	</p>
+
+You can then use the provided CSS classes to style the VotD.
+
+For command-line usage see [here](https://github.com/doctorbh/votd/wiki/Shell-Tool)
+
+## Documentation
+
+Documentation may be found [here](http://rubydoc.info/gems/votd/file/README.md)
+
+## Source Code
+
+Source code is available in our [GitHub repository](https://github.com/doctorbh/votd).
+
+## Authors
+
+Christopher Clarke <beakr@ninjanizr.com>
+
+Stephen Clarke <doctorbh@ninjanizr.com>
+
+## Changelog
+
+See our [CHANGELOG](CHANGELOG.md) file.
+
+## TODO
+
+See our [TODO](TODO.md) file.
+
+## Requests
+
+To submit bug, feature requests, patches see our [Issues List](https://github.com/doctorbh/votd/issues) on GitHub.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write passing tests/specs (we use [RSpec](http://rspec.info))
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+See more on [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright
+
+&copy; 2012 Christopher Clarke, Stephen Clarke. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+
+task :default => :spec
+
+desc "Run RSpec tests [default]"
+RSpec::Core::RakeTask.new do |task|
+end
+
+desc "Generate YARD docs"
+YARD::Rake::YardocTask.new do |task|
+end
+

data/TODO.md

@@ -0,0 +1,11 @@
+## Todo
+
+* 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.
+
+* Integrate [ESV VOTD service](http://www.esvapi.org/api)
+
+* Integrate [Bible Gateway](http://www.biblegateway.com/)
+
+* Make compatible with Ruby < 1.9

data/bin/votd

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'votd'
+
+votd = Votd::NetBible.new
+
+puts "===================================================="
+puts "          VERSE OF THE DAY for #{votd.date.to_s}"
+puts "===================================================="
+puts votd.text
+puts "#{votd.reference} (#{votd.version})"
+

data/lib/votd/netbible.rb

@@ -0,0 +1,94 @@
+module Votd
+  # Retrieves a Verse of the Day from bible.org using the NETBible
+  # translation.
+  class NetBible
+    # The name of the Bible Translation that this module generates
+    BIBLE_VERSION = "NETBible"
+
+    # Initializes the NetBible class
+    def initialize
+      @reference = ""
+      @text      = ""
+      get_verse
+    end
+
+    # The scripture reference. e.g.
+    #    "Ephesians 2:8-9"
+    #
+    # @return [String]
+    def reference
+      @reference
+    end
+
+    # The full bible passage. e.g.
+    #     "For by grace you are saved through faith..."
+    # @return [String]
+    def text
+      @text
+    end
+
+    # The date the Verse was retrieved. e.g.
+    #     "2012-03-24"
+    #
+    # @return [String]
+    def date
+      Date.today
+    end
+
+    # The bible translation used for this VotD. For this module this
+    # will always be.
+    #     NETBible
+    #
+    # @return [String]
+    def version
+      BIBLE_VERSION
+    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\">#{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 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"))
+
+      # use bookname from first verse -- assume votd won't span books
+      bookname = netbible_data[0]["bookname"]
+
+      # use chapter from first verse -- assume votd won't span chapters
+      chapter = netbible_data[0]["chapter"]
+
+      # loop through each verse to get the verse numbers and verse text
+      verse_numbers = Array.new
+      verses        = Array.new
+      netbible_data.each do |verse|
+        verse_numbers << verse["verse"]
+        verses        << verse["text"]
+      end
+
+      # now build the reference
+      @reference = "#{bookname} #{chapter}:#{verse_numbers.join("-")}"
+
+      # build the text
+      @text = verses.join(" ")
+    end
+  end
+end

data/lib/votd/version.rb

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

data/lib/votd.rb

@@ -0,0 +1,14 @@
+require "votd/version"
+require "votd/netbible"
+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.
+module Votd
+  include HTTParty
+end

data/spec/fixtures/netbible.html

@@ -0,0 +1,5 @@
+<p class="votd-text">For by grace you are saved through faith... it is not from works, so that no one can boast.</p>
+<p>
+<span class="votd-reference"><strong>Ephesians 2:8-9</strong></span>
+<span class="votd-version"><em>(NETBible)</em></span>
+</p>

data/spec/fixtures/netbible.json

@@ -0,0 +1,14 @@
+[
+  {
+    "bookname": "Ephesians",
+    "chapter": "2",
+    "verse": "8",
+    "text": "For by grace you are saved through faith..."
+  },
+  {
+    "bookname": "Ephesians",
+    "chapter": "2",
+    "verse": "9",
+    "text": "it is not from works, so that no one can boast."
+  }
+]

data/spec/netbible_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+require 'votd'
+require 'fake_web'
+
+FakeWeb.allow_net_connect = false
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  def fixture(filename)
+    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")))
+end

data/spec/votd_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Votd do
+  it "has a VERSION number" do
+    Votd::VERSION.should be
+  end
+end

data/votd.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/votd/version', __FILE__)
+
+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-API wrappers}
+  gem.homepage      = "https://github.com/doctorbh/votd"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "votd"
+  gem.require_paths = ["lib"]
+  gem.version       = Votd::VERSION
+  gem.license       = "MIT"
+
+  gem.required_ruby_version = ">= 1.9.1"
+
+  gem.add_runtime_dependency     "httparty"
+
+  gem.add_development_dependency "fakeweb"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "redcarpet"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: votd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Steve Clarke
+- Chris Clarke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: fakeweb
+  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: rspec
+  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: guard-rspec
+  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
+    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: redcarpet
+  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'
+description: 
+email:
+- doctorbh@ninjanizr.com
+- beakr@ninjanizr.com
+executables:
+- votd
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- bin/votd
+- lib/votd.rb
+- lib/votd/netbible.rb
+- lib/votd/version.rb
+- spec/fixtures/netbible.html
+- spec/fixtures/netbible.json
+- spec/netbible_spec.rb
+- spec/spec_helper.rb
+- spec/votd_spec.rb
+- votd.gemspec
+homepage: https://github.com/doctorbh/votd
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Generate a (Bible) Verse of the Day using various Web-API wrappers
+test_files:
+- spec/fixtures/netbible.html
+- spec/fixtures/netbible.json
+- spec/netbible_spec.rb
+- spec/spec_helper.rb
+- spec/votd_spec.rb
+has_rdoc: