biblesearch-api 1.0.1

data/lib/biblesearch-api/endpoints/search.rb

@@ -0,0 +1,24 @@
+class BibleSearch
+  module Search
+    def search(query, options = {})
+      options = options.merge({:query => query})
+
+      result = Hashie::Mash.new
+      api_result = get_mash("/search.js", :query => options)
+
+      if api_result.meta.http_code == 200
+        api_result.response.search.tap do |search_response|
+          result.type = search_response.result.type
+          result.summary = search_response.result.summary
+          if result.type == 'passages'
+            result.passages = pluralize_result(search_response.result.passages)
+          elsif result.type == 'verses'
+            result.verses = pluralize_result(search_response.result.verses)
+          end
+        end
+      end
+
+      fumsify(api_result, result)
+    end
+  end
+end

data/lib/biblesearch-api/endpoints/verses.rb

@@ -0,0 +1,42 @@
+class BibleSearch
+  module Verses
+    def verses(chapter_id, start_verse="", end_verse="")
+
+      verses = []
+      api_result = get_mash("/chapters/#{chapter_id}/verses.js", :query => {:start => start_verse, :end => end_verse})
+      if api_result.meta.http_code == 200
+        verses = pluralize_result(api_result.response.verses)
+      end
+
+      fumsify(api_result, verses)
+    end
+
+    def verse(verse_sig)
+
+      # Validate a signature hash, calling its string sig equivalent if valid
+      if verse_sig.is_a?(Hash)
+        unless required_keys_present?(verse_sig, [:version_id, :book_id, :chapter, :verse])
+          raise ArgumentError.new('Verse signature hash must include :version_id, :book_id, :chapter, and :verse')
+        end
+
+        return verse("#{verse_sig[:version_id]}:#{verse_sig[:book_id]}.#{verse_sig[:chapter]}.#{verse_sig[:verse]}")
+      end
+
+      # Validate a signature string, returning a verse Mash if valid and the
+      # remote request succeeds
+      if verse_sig.is_a?(String)
+        unless verse_sig.match(/([A-Za-z0-9]+-)?[A-Za-z0-9]+:[A-Za-z0-9]+\.[0-9]+\.[0-9]+/)
+          raise ArgumentError.new('Verse signature must be in the form "VERSION_ID:BOOK_ID.CHAPTER_NUMBER.VERSE_NUMBER"')
+        end
+
+        verse = nil
+        api_result = get_mash("/verses/#{verse_sig}.js")
+        if api_result.meta.http_code == 200
+          verse = api_result.response.verses.first
+        end
+
+        return fumsify(api_result, verse)
+      end
+    end
+  end
+end

data/lib/biblesearch-api/endpoints/versions.rb

@@ -0,0 +1,28 @@
+class BibleSearch
+  module Versions
+    def versions(options = {})
+      api_endpoint = '/versions.js'
+      unless options[:language].nil?
+        api_endpoint += %{?language=#{options[:language]}}
+      end
+
+      versions = []
+      api_result = get_mash(api_endpoint)
+      if api_result.meta.http_code == 200
+        versions = pluralize_result(api_result.response.versions)
+      end
+
+      fumsify(api_result, versions)
+    end
+
+    def version(version_id)
+      version = nil
+      api_result = get_mash("/versions/#{version_id.upcase}.js")
+      if api_result.meta.http_code == 200
+        version = api_result.response.versions.first
+      end
+    
+      fumsify(api_result, version)
+    end
+  end
+end

data/spec/biblesearch-api/endpoints/books_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+require 'biblesearch-api'
+
+describe BibleSearch do
+  before do
+    VCR.insert_cassette %{endpoint-#{File.basename(__FILE__, '.rb')}-#{__name__}}
+    @biblesearch = BibleSearch.new('DUMMY_API_KEY')
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  describe %{books} do
+    it %{requires a version id} do
+      lambda { @biblesearch.books }.must_raise ArgumentError
+      (lambda { @biblesearch.books('GNT') }.call rescue $!).wont_be_kind_of ArgumentError
+    end
+
+    it %{accepts an optional testament id} do
+      all_cool = lambda { @biblesearch.books('GNT', 'OT') }
+      (all_cool.call rescue $!).wont_be_kind_of ArgumentError
+    end
+
+    describe %{when I make a valid request} do
+      before do
+        @books = @biblesearch.books('GNT')
+      end
+
+      it %{has a collection} do
+        @books.collection.must_be_kind_of(Array)
+      end
+
+      it %{contains books} do
+        @books.collection.length.must_be :>, 0
+        @books.collection.each do |book|
+          book.must_respond_to(:version_id)
+          book.must_respond_to(:name)
+          book.must_respond_to(:abbr)
+          book.must_respond_to(:ord)
+          book.must_respond_to(:book_group_id)
+          book.must_respond_to(:testament)
+          book.must_respond_to(:id)
+          book.must_respond_to(:osis_end)
+          book.must_respond_to(:parent)
+          book.must_respond_to(:copyright)
+        end
+      end
+    end
+
+    describe %{when I make a bad request} do
+      before do
+        @books = @biblesearch.books('SupDawg')
+      end
+
+      it %{has a collection} do
+        @books.collection.must_be_instance_of Array
+      end
+
+      it %{contains no items} do
+        @books.collection.length.must_equal 0
+      end
+    end
+
+  end
+
+  describe %{book} do
+    describe %{given a book signature} do
+      describe %{as a string} do
+        it %{raises an argument error for bad input} do
+          bad_book_string = lambda { @biblesearch.book('SupDawg') }
+          bad_book_string.must_raise ArgumentError
+          (bad_book_string.call rescue $!).message.must_equal 'Book signature must be in the form "VERSION_ID:BOOK_ID"'
+        end
+      end
+
+      describe %{as a hash} do
+        before do
+          @options = {
+            :version_id => 'GNT',
+            :book_id => '2Tim'
+          }
+        end
+
+        describe %{if any pieces are missing} do
+          it %{raises an argument error} do
+            @options.keys.each do |key|
+              options = @options
+              options.delete(key)
+              bad_book_hash = lambda { @biblesearch.book(options) }
+              bad_book_hash.must_raise ArgumentError
+              (bad_book_hash.call rescue $!).message.must_equal 'Book signature hash must include :version_id and :book_id'
+            end
+          end
+        end
+
+        describe %{with a complete hash} do
+          it %{returns the same thing as the equivalent string sig} do
+            @biblesearch.book(@options).value.must_equal @biblesearch.book('GNT:2Tim').value
+          end
+        end
+      end
+
+      describe %{when I make a valid request} do
+        it %{has a book value} do
+          @biblesearch.book('GNT:2Tim').value.tap do |book|
+            book.must_respond_to(:version_id)
+            book.must_respond_to(:name)
+            book.must_respond_to(:abbr)
+            book.must_respond_to(:ord)
+            book.must_respond_to(:book_group_id)
+            book.must_respond_to(:testament)
+            book.must_respond_to(:id)
+            book.must_respond_to(:osis_end)
+            book.must_respond_to(:parent)
+            book.must_respond_to(:copyright)
+          end
+        end
+      end
+
+      describe %{when I request an invalid book} do
+        it %{returns nil} do
+          @biblesearch.book('GNT:Batman').value.must_be_nil
+        end
+      end
+    end
+  end
+end

data/spec/biblesearch-api/endpoints/chapters_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+require 'biblesearch-api'
+
+describe BibleSearch do
+  before do
+    VCR.insert_cassette %{endpoint-#{File.basename(__FILE__, '.rb')}-#{__name__}}
+    @biblesearch = BibleSearch.new('DUMMY_API_KEY')
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  describe %{#chapters} do
+
+    describe %{given a book signature} do
+      describe %{as a string} do
+        it %{raises an argument error for bad input} do
+          bad_book_string = lambda { @biblesearch.chapters('SupDawg') }
+          bad_book_string.must_raise ArgumentError
+          (bad_book_string.call rescue $!).message.must_equal 'Book signature must be in the form "VERSION_ID:BOOK_ID"'
+        end
+      end
+
+      describe %{as a hash} do
+        before do
+          @options = {
+            :version_id => 'GNT',
+            :book_id => '2Tim'
+          }
+        end
+
+        describe %{if any pieces are missing} do
+          it %{raises an argument error} do
+            @options.keys.each do |key|
+              options = @options
+              options.delete(key)
+              bad_book_hash = lambda { @biblesearch.chapters(options) }
+              bad_book_hash.must_raise ArgumentError
+              (bad_book_hash.call rescue $!).message.must_equal "Book signature hash must include :version_id and :book_id"
+            end
+          end
+        end
+
+        describe %{with a complete hash} do
+          it %{returns the same thing as the equivalent string sig} do
+            @biblesearch.chapters(@options).collection.must_equal @biblesearch.chapters('GNT:2Tim').collection
+          end
+        end
+      end
+    end
+
+    describe %{when I make a valid request} do
+      before do
+        @chapters = @biblesearch.chapters('GNT:2Tim')
+      end
+
+      it %{has a collection} do
+        @chapters.collection.must_be_instance_of Array
+      end
+
+      it %{should contain chapters} do
+        @chapters.collection.length.must_be :>, 0
+        @chapters.collection.each do |chapter|
+          chapter.must_respond_to(:auditid)
+          chapter.must_respond_to(:label)
+          chapter.must_respond_to(:chapter)
+          chapter.must_respond_to(:id)
+          chapter.must_respond_to(:osis_end)
+          chapter.must_respond_to(:parent)
+          chapter.must_respond_to(:next)
+          chapter.must_respond_to(:previous)
+          chapter.must_respond_to(:copyright)
+        end
+      end
+    end
+
+    describe %{when I make a bad request} do
+      before do
+        @chapters = @biblesearch.chapters('GNT:Batman')
+      end
+
+      it %{has a collection} do
+        @chapters.collection.must_be_instance_of Array
+      end
+
+      it %{contains no items} do
+        @chapters.collection.length.must_equal 0
+      end
+    end
+  end
+
+  describe %{#chapter} do
+    describe %{given a chapter signature} do
+      describe %{as a string} do
+        it %{raises an argument error for bad input} do
+          bad_chapter_string = lambda { @biblesearch.chapter('SupDawg') }
+          bad_chapter_string.must_raise ArgumentError
+          (bad_chapter_string.call rescue $!).message.must_equal 'Chapter signature must be in the form "VERSION_ID:BOOK_ID.CHAPTER_NUMBER"'
+        end
+      end
+
+      describe %{as a hash} do
+        before do
+          @options = {
+            :version_id => 'GNT',
+            :book_id => '2Tim',
+            :chapter => 1
+          }
+        end
+
+        describe %{if any pieces are missing} do
+          it %{raises an argument error} do
+            @options.keys.each do |key|
+              options = @options
+              options.delete(key)
+              bad_chapter_hash = lambda { @biblesearch.chapter(options) }
+              bad_chapter_hash.must_raise ArgumentError
+              (bad_chapter_hash.call rescue $!).message.must_equal "Chapter signature hash must include :version_id, :book_id, and :chapter"
+            end
+          end
+        end
+
+        describe %{with a complete hash} do
+          it %{returns the same thing as the equivalent string sig} do
+            @biblesearch.chapter(@options).value.must_equal @biblesearch.chapter('GNT:2Tim.1').value
+          end
+        end
+      end
+    end
+
+    describe %{when I make a valid request} do
+      it %{has a chapter value} do
+        @biblesearch.chapter('GNT:2Tim.1').value.tap do |chapter|
+          chapter.must_respond_to(:auditid)
+          chapter.must_respond_to(:label)
+          chapter.must_respond_to(:chapter)
+          chapter.must_respond_to(:id)
+          chapter.must_respond_to(:osis_end)
+          chapter.must_respond_to(:parent)
+          chapter.must_respond_to(:next)
+          chapter.must_respond_to(:previous)
+          chapter.must_respond_to(:copyright)
+        end
+      end
+    end
+
+    describe %{when I request an invalid chapter} do
+      it %{has a nil value} do
+        @biblesearch.chapter('GNT:Batman.1').value.must_be_nil
+      end
+    end
+  end
+end

data/spec/biblesearch-api/endpoints/fumsify_for_all_endpoints_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'biblesearch-api'
+
+describe BibleSearch do
+  before do
+    VCR.insert_cassette %{#{File.basename(__FILE__, '.rb')}-#{__name__}}
+    @biblesearch = BibleSearch.new('DUMMY_API_KEY')
+  end
+
+  after do
+    VCR.eject_cassette
+  end
+
+  describe %{the Books endpoint} do
+    it %{has real fums for all valid requests} do
+      @biblesearch.books('GNT').fums.wont_be_nil
+      @biblesearch.book('GNT:2Tim').fums.wont_be_nil
+    end
+
+    it %{has nil fums for bad requests} do
+      @biblesearch.books('Gotham').fums.must_be_nil
+      @biblesearch.book('Gotham:Batman').fums.must_be_nil
+    end
+  end
+
+  describe %{the Chapters endpoint} do
+    it %{has real fums for all valid requests} do
+      @biblesearch.chapters('GNT:2Tim').fums.wont_be_nil
+      @biblesearch.chapter('GNT:2Tim.1').fums.wont_be_nil
+    end
+
+    it %{has nil fums for bad requests} do
+      @biblesearch.chapters('Gotham:Batman').fums.must_be_nil
+      @biblesearch.chapter('Gotham:Bataman.1').fums.must_be_nil
+    end
+  end
+
+  describe %{the Passages endpoint} do
+    it %{has real fums for all requests} do
+      @biblesearch.passages('John 3:16', :version => 'KJV').fums.wont_be_nil
+      @biblesearch.passages('Batman 13:17', :version => 'DCU').fums.wont_be_nil
+    end
+  end
+
+  describe %{the Search endpoint} do
+    it %{has real fums for all requests} do
+      @biblesearch.search('john 3:16').fums.wont_be_nil
+      @biblesearch.search('batman 13:17').fums.wont_be_nil
+    end
+  end
+
+  describe %{the Verses endpoint} do
+    it %{has real fums for all valid requests} do
+      @biblesearch.verses('KJV:John.3', '16', '16').fums.wont_be_nil
+      @biblesearch.verse('GNT:Acts.8.34').fums.wont_be_nil
+    end
+
+    it %{has nil fums for bad requests} do
+      @biblesearch.verses('Gotham:Batman', '13', '17').fums.must_be_nil
+      @biblesearch.verses('Metropolis:Superman.1.2').fums.must_be_nil
+    end
+  end
+
+  describe %{the Versions endpoint} do
+    it %{has real fums for all valid requests} do
+      @biblesearch.versions.fums.wont_be_nil
+      @biblesearch.version('GNT').fums.wont_be_nil
+    end
+
+    it %{has nil fums for bad requests} do
+      @biblesearch.version('Gotham').fums.must_be_nil
+    end
+  end
+
+end