esv 0.1.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Geoffrey Dagley
+
+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.rdoc

@@ -0,0 +1,74 @@
+= esv
+
+Wrapper for English Standard Version (ESV) Bible Web Service. See ESV API docs http://www.esvapi.org/
+
+This is a work in progress.  Things are still in flux.
+
+Source: http://github.com/gdagley/esv
+Build status: http://runcoderun.com/gdagley/esv
+
+== SYNOPSIS:
+
+Application use:
+
+  b = ESV::Bible.new
+  
+  Default response for most actions is HTML
+  b.passage_query('John 1:1') # => "<div class=\"esv\"><h2>John 1:1 <object type=\"application/x-shockwave-flash\"  data=\"http://www.esvapi.org/assets/play.swf?myUrl=hw%2F43001001\" width=\"40\" height=\"12\" class=\"audio\"><param name=\"movie\" value=\"http://www.esvapi.org/assets/play.swf?myUrl=hw%2F43001001\" /><param name=\"wmode\" value=\"transparent\" /></object></h2>\n<div class=\"esv-text\"><h3 id=\"p43001001.01-1\">The Word Became Flesh</h3>\n<p class=\"chapter-first\" id=\"p43001001.05-1\"><span class=\"chapter-num\" id=\"v43001001-1\">1:1&nbsp;</span>In the beginning was the Word, and the Word was with God, and the Word was God.  (<a href=\"http://www.esv.org\" class=\"copyright\">ESV</a>)</p>\n</div>\n</div>"
+  
+  XML responses are converted to Hashes
+  b.passage_query('John 1:1', 'output-format' => 'crossway-xml-1.0') # =>  {"crossway_bible"=>{"class"=>"passage-query", "passage"=>{"reference"=>"John 1:1", "surrounding_chapters"=>{"previous"=>"Luke 24", "current"=>"John 1", "next"=>"John 2"}, "content"=>{"verse_unit"=>"<markerclass=\"begin-verse\" mid=\"v43001001\"></marker><begin_chapternum=\"1\"></begin_chapter><heading>The Word Became Flesh</heading><begin_paragraphclass=\"chapter-first\"></begin_paragraph><verse_numbegin_chapter=\"1\">1</verse_num>In the beginning was the Word, and the Word was with God, and the Word was God.<end_paragraph></end_paragraph>"}}, "copyright"=>"The Holy Bible, English Standard Version copyright (c)2001 by Crossway Bibles, a division of Good News Publishers. Used by permission. All rights reserved. http://www.esv.org"}}
+
+Command line use:
+
+'esv' - for looking up verses and passages
+  
+  > esv John 1:1
+  =======================================================
+  John 1:1
+  _______________________________________________________
+  The Word Became Flesh
+
+     [1:1]In the beginning was the Word, and the Word was with God, and the 
+  Word was God. (ESV)
+    
+'esv_daily_verse' - for retrieving the ESV Daily Verse
+  
+  > esv_daily_verse
+  =======================================================
+  Romans 8:38-39
+     [38]For I am sure that neither death nor life, nor angels nor rulers, 
+  nor things present nor things to come, nor powers, [39]nor height nor 
+  depth, nor anything else in all creation, will be able to separate us 
+  from the love of God in Christ Jesus our Lord. (ESV)
+  
+== TODO
+
+* Add command line binaries for:
+  * 'esv_daily_reading' - for retrieving the ESV Daily Reading Plan
+* Finish specs
+* Make more Ruby-like
+
+== REQUIREMENTS:
+
+* httparty
+
+== INSTALL:
+
+* sudo gem install gdagley-esv
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Geoffrey Dagley. See LICENSE for details.  
+
+The Holy Bible, English Standard Version copyright (c)2001 by Crossway Bibles, a publishing ministry of Good News Publishers. Used by permission. All rights reserved.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "esv"
+    gem.summary = %Q{Wrapper for English Standard Version (ESV) Bible Web Service. See ESV API docs http://www.esvapi.org/}
+    gem.email = "gdagley@gmail.com"
+    gem.homepage = "http://github.com/gdagley/esv"
+    gem.authors = ["Geoffrey Dagley"]
+    gem.add_dependency "httparty"
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "fakeweb"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "esv #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/bin/esv

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'esv'
+
+if ARGV.empty?
+  puts "Usage  : esv PASSAGE\nexample: esv John 1:1"
+else
+  puts ESV::Bible.new('output-format' => 'plain-text').passage_query(ARGV.join(' '))
+end

data/bin/esv_daily_verse

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'esv'
+
+puts ESV::Bible.new('output-format' => 'plain-text').daily_verse

data/esv.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{esv}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Geoffrey Dagley"]
+  s.date = %q{2009-09-16}
+  s.email = %q{gdagley@gmail.com}
+  s.executables = ["esv", "esv_daily_verse"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/esv",
+     "bin/esv_daily_verse",
+     "esv.gemspec",
+     "lib/esv.rb",
+     "lib/esv/bible.rb",
+     "lib/esv/reading_plan.rb",
+     "spec/esv/bible_spec.rb",
+     "spec/esv/reading_plan_spec.rb",
+     "spec/esv_spec.rb",
+     "spec/fixtures/passage_query.html",
+     "spec/fixtures/passage_query.xml",
+     "spec/fixtures/reading_plan_info.xml",
+     "spec/fixtures/reading_plan_query.html",
+     "spec/fixtures/reading_plan_query.xml",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/gdagley/esv}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Wrapper for English Standard Version (ESV) Bible Web Service. See ESV API docs http://www.esvapi.org/}
+  s.test_files = [
+    "spec/esv/bible_spec.rb",
+     "spec/esv/reading_plan_spec.rb",
+     "spec/esv_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+  end
+end

data/lib/esv.rb

@@ -0,0 +1,56 @@
+require 'esv/bible'
+require 'esv/reading_plan'
+
+module ESV
+  OUTPUT_FORMATS =
+    ['html', 'crossway-xml-1.0', 'plain-text', 'mp3']
+  
+  HTML_OPTIONS =
+    { 
+      'include-passage-references' => true,
+      'include-first-verse-numbers' => true,
+      'include-verse-numbers' => true,
+      'include-footnotes' => true,
+      'include-footnote-links' => true,
+      'include-headings' => true,
+      'include-subheadings' => true,
+      'include-surrounding-chapters' => false,
+      'include-word-ids' => false,
+      'link-url' => 'http://www.gnpcb.org/esv/search/',
+      'include-audio-link' => true,
+      'audio-format' => 'flash',
+      'audio-version' => 'hw',
+      'include-short-copyright' => true,
+      'include-copyright' => false,
+    }
+  
+  XML_OPTIONS =
+    {
+      'include-xml-declaration' => false,
+      'include-doctype' => true,
+      'include-quote-entities' => true,
+      'include-simple-entities' => false,
+      'include-cross-references' => false,
+      'include-line-breaks' => true,
+      'include-word-ids' => false,
+      'include-virtual-attributes' => false,
+      'base-element' => 'verse-unit',
+    }
+  
+  TEXT_OPTIONS =
+    {
+      'include-passage-references' => true,
+      'include-first-verse-numbers' => true,
+      'include-verse-numbers' => true,
+      'include-footnotes' => true,
+      'include-short-copyright' => true,
+      'include-copyright' => false,
+      'include-passage-horizontal-lines' => true,
+      'include-heading-horizontal-lines' => true,
+      'include-headings' => true,
+      'include-subheadings' => true,
+      'include-selahs' => true,
+      'include-content-type' => true,
+      'line-length' => 74,
+    }
+end

data/lib/esv/bible.rb

@@ -0,0 +1,55 @@
+require 'httparty'
+
+module ESV
+  class Bible
+    include HTTParty
+    
+    base_uri 'http://www.esvapi.org/v2/rest/'
+    
+    # The ESV API requires a key that can be passed in as one of the options, :key => 'value'.  By default, it is 'IP'
+    def initialize(default_options={})
+      @default_options = default_options
+      @default_options[:key] ||= 'IP'
+    end
+
+    # Lookup a passage
+    # 
+    # See http://www.esvapi.org/api for more information and options
+    def passage_query(passage, options={})
+      options[:passage] = passage
+      self.class.get '/passageQuery', :query => @default_options.merge(options)
+    end
+    
+    # Look up a passage or show word-search results, depending on the query
+    # 
+    # The output format is always HTML.
+    # 
+    # See http://www.esvapi.org/api for more information and options
+    def query(q, options={})
+      options[:q] = q
+      self.class.get '/query', :query => @default_options.merge(options)
+    end
+    
+    # Parse and display information about your query, including identify whether it is a passage reference or a word search
+    # 
+    # See http://www.esvapi.org/api for more information and options
+    def query_info(q)
+      options = {:q => q}
+      self.class.get '/queryInfo', :query =>  @default_options.merge(options)
+    end
+
+    # Display a random verse from a preselected list, or specify verse(s)
+    # 
+    # See http://www.esvapi.org/api for more information and options
+    def verse(options={})
+      self.class.get '/verse', :query => @default_options.merge(options)
+    end
+
+    # Display a verse that changes every day
+    # 
+    # See http://www.esvapi.org/api for more information and options
+    def daily_verse(options={})
+      self.class.get '/dailyVerse', :query => @default_options.merge(options)
+    end
+  end
+end

data/lib/esv/reading_plan.rb

@@ -0,0 +1,29 @@
+require 'httparty'
+
+module ESV
+  class ReadingPlan
+    include HTTParty
+    
+    base_uri 'http://www.esvapi.org/v2/rest/'
+    
+    # The ESV API requires a key that can be passed in as one of the options, :key => 'value'.  By default, it is 'IP'
+    def initialize(default_options={})
+      @default_options = default_options
+      @default_options[:key] ||= 'IP'
+    end
+
+    # Retrieve passages from our Devotions section
+    # 
+    # See http://www.esvapi.org/api for more information and options
+    def query(options={})
+      self.class.get '/readingPlanQuery', :query => @default_options.merge(options)
+    end
+    
+    # Parse and display information about the reading plan for a given date
+    # 
+    # See http://www.esvapi.org/api for more information and options
+    def info(options={})
+      self.class.get '/readingPlanInfo', :query => @default_options.merge(options)
+    end
+  end
+end

data/spec/esv/bible_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ESV::Bible do
+  before do
+    @bible = ESV::Bible.new(:key => 'TEST')
+  end
+  
+  describe "passage_query" do
+    it "should retrieve the passage" do
+      stub_get("http://www.esvapi.org/v2/rest/passageQuery?passage=John%201&key=TEST", "passage_query.html")
+      @bible.passage_query('John 1').should include("<h2>John 1")
+    end
+
+    it "should retrieve the passage as XML" do
+      stub_get("http://www.esvapi.org/v2/rest/passageQuery?output-format=crossway-xml-1.0&key=TEST&passage=John%201", "passage_query.xml")
+      passage = @bible.passage_query('John 1', 'output-format' => 'crossway-xml-1.0')['crossway_bible']["passage"]
+      passage["reference"].should == "John 1"
+    end
+  end
+  
+  describe "query" do
+  end
+  
+  describe "query_info" do
+  end
+  
+  describe "verse" do
+  end
+
+  describe "daily_verse" do
+  end
+end

data/spec/esv/reading_plan_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ESV::ReadingPlan do
+  before do
+    @plan = ESV::ReadingPlan.new(:key => 'TEST')
+  end
+  
+  describe "query" do
+    it "should retrieve the daily reading" do
+      stub_get("http://www.esvapi.org/v2/rest/readingPlanQuery?key=TEST", "reading_plan_query.html")
+      @plan.query.should include("<h2>2 Samuel 2")
+    end
+
+    it "should retrieve the daily reading as XML" do
+      stub_get("http://www.esvapi.org/v2/rest/readingPlanQuery?output-format=crossway-xml-1.0&key=TEST", "reading_plan_query.xml")
+      reading = @plan.query('output-format' => 'crossway-xml-1.0')["crossway_bible"]
+      reading["passage"][0]["reference"].should == "2 Samuel 2"
+    end
+
+    it "should retrieve the daily reading for a specific date" do
+      stub_get("http://www.esvapi.org/v2/rest/readingPlanQuery?date=2009-10-01&key=TEST", "reading_plan_query.html")
+      @plan.query('date' => '2009-10-01').should include("<h2>2 Samuel 2")
+    end
+  end
+  
+  describe "info" do
+    it "should retrieve XML info for reading plan" do
+      stub_get("http://www.esvapi.org/v2/rest/readingPlanInfo?key=TEST", "reading_plan_info.xml")
+      info = @plan.info['crossway_bible']
+      info["plan"].should == "one-year-tract"
+      info["date"].should == "20090908"
+    end
+  end
+end