esvbible 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.0.1 / 2008-08-05
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/esv_bible
+lib/esv_bible.rb
+spec/esv_bible_spec.rb

data/README.txt

@@ -0,0 +1,55 @@
+= EsvBible
+
+* Wrapper for English Standard Version (ESV) Bible Web Service
+
+== DESCRIPTION:
+
+See ESV API docs http://www.esvapi.org/
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  bible = EsvBible.new('YOUR API KEY HERE')
+
+  verse   = bible.verse   'Gen 1:1'
+  passage = bible.passage 'Gen 1'
+  
+  verse   = bible.verse   'John 1:1', {:output_format => :text, :include_headings => false}
+
+== REQUIREMENTS:
+
+* rspec - for testing
+
+== INSTALL:
+
+* sudo gem install esv_bible
+
+source is hosted at https://github.com/gdagley/esv_bible
+
+== LICENSE:
+
+The MIT License
+
+Copyright (c) 2008 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/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'hoe'
+require 'spec/version'
+require 'spec/rake/spectask'
+require './lib/esv_bible'
+
+Hoe.new('esvbible', EsvBible::VERSION) do |p|
+  p.rubyforge_name = 'esvbible' # if different than lowercase project name
+  p.remote_rdoc_dir = ""
+  p.developer('Geoffrey Dagley', 'gdagley@gmail.com')
+end
+
+task :default => :spec
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  unless ENV['NO_RCOV']
+    t.rcov = true
+    t.rcov_dir = 'coverage'
+    t.rcov_opts = ['--exclude', 'lib/spec.rb,lib/spec/runner.rb,spec\/spec,bin\/spec,examples,\/var\/lib\/gems,\/Library\/Ruby,\.autotest']
+  end
+end

data/lib/esv_bible.rb

@@ -0,0 +1,102 @@
+require 'net/http'
+
+class EsvBibleError < StandardError; end
+
+class EsvBible
+  VERSION = '0.0.1'
+  BASE_URL = 'http://www.esvapi.org/v2/rest'
+  VALID_FORMATS = [:plain_text, :html, :xml]
+  VALID_HTML_OPTIONS = [:include_passage_references, :include_first_verse_numbers, 
+      :include_verse_numbers, :include_headings, :include_subheadings, :include_footnotes, :include_footnote_links,
+      :include_surrounding_chapters, :include_word_ids, :include_audio_link, :audio_format, :audio_version, 
+      :include_copyright, :include_short_copyright]
+  VALID_TEXT_OPTIONS = [:include_passage_references, :include_first_verse_numbers, 
+      :include_verse_numbers, :include_headings, :include_subheadings, :include_selahs, 
+      :include_passage_horizontal_lines, :include_heading_horizontal_lines, :include_footnotes, 
+      :include_copyright, :include_short_copyright, :include_content_type, :line_length]
+  VALID_XML_OPTIONS  = []
+
+  attr_accessor :key
+  
+  class << self
+    def formats
+      VALID_FORMATS
+    end
+    
+    def html_options
+      VALID_HTML_OPTIONS
+    end
+    
+    def text_options
+      VALID_TEXT_OPTIONS
+    end
+
+    def xml_options
+      VALID_XML_OPTIONS
+    end    
+  end
+  
+  def initialize(key = 'IP')
+    @key = key
+  end
+  
+  def passage(passage, options = {})
+    cleanse! options
+    url = build_url("passageQuery", options.merge(:passage => passage))
+    open_bible(url)
+  end
+  
+  def verse(verse, options = {})
+    cleanse! options
+    url = build_url("verse", options.merge(:passage => verse))
+    open_bible(url)
+  end
+  
+  def search(query, options = {})
+    cleanse! options
+    url = build_url("query", options.merge(:q => query))
+    open_bible(url)
+  end
+  
+  def build_url(action, options = {})
+    url = "#{BASE_URL}/#{action}?"
+    options.each_pair do |key, value|
+      param = convert_to_param(key)
+      url << "#{param}=#{value}&"
+    end
+    url << "key=#{self.key}"
+  end
+
+  def open_bible(url, limit = 10)
+    raise EsvBibleError, 'HTTP redirect too deep' if limit == 0
+
+    url = URI.escape(url)
+    
+    response = Net::HTTP.get_response(URI.parse(url))
+    case response
+      when Net::HTTPSuccess
+        response.body
+      when Net::HTTPRedirection
+        open_passage(response['location'], limit - 1)
+      else
+        raise "#{rsp.code} #{rsp.message}"
+    end
+  end
+  
+  def cleanse! options
+    format = options[:output_format] || :html
+    raise EsvBibleError unless VALID_FORMATS.include?(format)
+    
+    valid_format_attributes = case format
+    when :html        then VALID_HTML_OPTIONS
+    when :plain_text  then VALID_TEXT_OPTIONS
+    when :xml         then VALID_XML_OPTIONS
+    end
+    options.reject! { |key, value| !valid_format_attributes.include?(key) }
+  end
+  
+  def convert_to_param(symbol)
+    symbol.to_s.gsub('_', '-')
+  end
+  
+end

data/spec/esv_bible_spec.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/esv_bible'
+
+describe 'Initializing and configuring ESV API' do
+  it "should default to 'IP' key" do
+    bible = EsvBible.new
+    bible.key.should == 'IP'
+  end
+  
+  it "should allow setting a key" do
+    bible = EsvBible.new('TEST')
+    bible.key.should == 'TEST'
+  end  
+end
+
+describe 'Showing a passage' do
+  before(:each) do
+    @bible = EsvBible.new('TEST')
+  end
+  
+  it "should retrieve a passage" do
+    @bible.should_receive(:open_bible).with("http://www.esvapi.org/v2/rest/passageQuery?passage=Gen 1&key=TEST")
+    @bible.passage 'Gen 1'
+  end  
+end
+
+describe 'Showing a verse' do
+  before(:each) do
+    @bible = EsvBible.new('TEST')
+  end
+  
+  it "should retrieve a verse" do
+    @bible.should_receive(:open_bible).with("http://www.esvapi.org/v2/rest/verse?passage=Gen 1:1&key=TEST")
+    @bible.verse 'Gen 1:1'
+  end
+end
+
+describe 'Searching' do
+  before(:each) do
+    @bible = EsvBible.new('TEST')
+  end
+  
+  it "search for a phrase" do
+    @bible.should_receive(:open_bible).with("http://www.esvapi.org/v2/rest/query?q=Some phrase&key=TEST")
+    @bible.search 'Some phrase'
+  end
+end
+
+describe "The inner workings of the library" do
+  before(:each) do
+    @bible = EsvBible.new('TEST')
+  end
+
+  it "should convert symbols to strings for params" do
+    @bible.convert_to_param(:symbol).should == 'symbol'
+  end
+  
+  it "should convert symbol underscores to hyphens" do
+    @bible.convert_to_param(:symbol_with_underscore).should == 'symbol-with-underscore'
+  end
+  
+  it "should build the url for action" do
+    @bible.build_url(:action).should include("http://www.esvapi.org/v2/rest/action?key=TEST")
+  end
+
+  it "should build the url for action and param" do
+    @bible.build_url(:action, :q => 'value').should include("http://www.esvapi.org/v2/rest/action?q=value&key=TEST")
+  end
+  
+  it "should build the url for action and multiple params" do
+    @bible.build_url(:action, :q => 'value', :something => true).should include("http://www.esvapi.org/v2/rest/action?something=true&q=value&key=TEST")
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: esvbible
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Geoffrey Dagley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: See ESV API docs http://www.esvapi.org/
+email: 
+- gdagley@gmail.com
+executables: 
+- esv_bible
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/esv_bible
+- lib/esv_bible.rb
+- spec/esv_bible_spec.rb
+has_rdoc: true
+homepage: Wrapper for English Standard Version (ESV) Bible Web Service
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: esvbible
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: See ESV API docs http://www.esvapi.org/
+test_files: []
+