biblesearch-api 1.0.1

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

@@ -0,0 +1,85 @@
+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 %{#passages} do
+    describe %{when returning no passages} do
+      before do
+        @passages = @biblesearch.passages('Batman 1:1-16', :version => 'KJV')
+      end
+      it %{has a collection} do
+        @passages.collection.must_be_instance_of Array
+      end
+
+      it %{should contain no passages} do
+        @passages.collection.length.must_equal 0
+      end
+    end
+
+    describe %{when returning a single passage} do
+      before do
+        @passages = @biblesearch.passages('John 3:16', :version => 'KJV')
+      end
+      it %{has a collection} do
+        @passages.collection.must_be_instance_of Array
+      end
+
+      it %{should contain a single passage} do
+        @passages.collection.size.must_equal 1
+        @passages.collection.first.tap do |passage|
+          passage.must_respond_to :display
+          passage.must_respond_to :version
+          passage.must_respond_to :version_abbreviation
+          passage.must_respond_to :path
+          passage.must_respond_to :start_verse_id
+          passage.must_respond_to :end_verse_id
+          passage.must_respond_to :text
+          passage.must_respond_to :copyright
+        end
+      end
+    end
+
+    describe %{when returning multiple passages} do
+      before do
+        @passages = @biblesearch.passages('')
+      end
+      it %{has a collection} do
+        @passages.collection.must_be_instance_of Array
+      end
+      it %{should contain passages} do
+        @passages.collection.each do |passage|
+          passage.must_respond_to :display
+          passage.must_respond_to :version
+          passage.must_respond_to :version_abbreviation
+          passage.must_respond_to :path
+          passage.must_respond_to :start_verse_id
+          passage.must_respond_to :end_verse_id
+          passage.must_respond_to :text
+          passage.must_respond_to :copyright
+        end
+      end
+    end
+
+    describe %{when passing a list of bible version ids} do
+      before do
+        @versions = ['KJV', 'CEV']
+        @passages = @biblesearch.passages('John 3:16', :versions => @versions)
+      end
+
+      it %{should provide the passage for each version specified} do
+        @passages.collection.each do |passage|
+          @versions.must_include passage.version
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+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 %{#search} do
+    it %{has a Hashie::Mash value} do
+      @biblesearch.search('john 3:16').value.must_be_instance_of Hashie::Mash
+      @biblesearch.search('Mahershalalhashbaz').value.must_be_instance_of Hashie::Mash
+    end
+
+    describe %{when doing a passage search} do
+      it %{returns passages} do
+        result = @biblesearch.search('john 3:16').value
+        result.type.must_equal 'passages'
+        result.must_respond_to(:passages)
+      end
+    end
+
+    describe %{when doing a keyword search} do
+      it %{returns verses} do
+        result = @biblesearch.search('Mahershalalhashbaz').value
+        result.type.must_equal 'verses'
+        result.must_respond_to(:verses)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+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 %{#verses} do
+    describe %{when returning no verses} do
+      before do
+        @verses = @biblesearch.verses('KJV:Batman.1', '1', '16')
+      end
+
+      it %{has a collection} do
+        @verses.collection.must_be_instance_of Array
+      end
+
+      it %{should contain no verses} do
+        @verses.collection.size.must_equal 0
+      end
+    end
+    
+    describe %{when returning one verse} do
+      before do
+        @verses = @biblesearch.verses('KJV:John.3', '16', '16')
+      end
+
+      it %{has a collection} do
+        @verses.collection.must_be_instance_of Array
+      end
+
+      it %{should contain one verse} do
+        @verses.collection.length.must_equal 1
+        @verses.collection.each do |verse|
+          verse.must_respond_to(:auditid)
+          verse.must_respond_to(:copyright)
+          verse.must_respond_to(:id)
+          verse.must_respond_to(:label)
+          verse.must_respond_to(:lastverse)
+          verse.must_respond_to(:next)
+          verse.must_respond_to(:osis_end)
+          verse.must_respond_to(:parent)
+          verse.must_respond_to(:previous)
+          verse.must_respond_to(:reference)
+          verse.must_respond_to(:text)
+          verse.must_respond_to(:verse)
+        end
+      end
+    end
+
+    describe %{when returning multiple verses} do
+      before do
+        @start_verse = 16
+        @end_verse = 17
+        @verses = @biblesearch.verses('KJV:John.3', @start_verse, @end_verse)
+      end
+
+      it %{has a collection} do
+        @verses.collection.must_be_instance_of Array
+      end
+
+      it %{should contain the proper number of verses} do
+        @verses.collection.length.must_equal(1 + @end_verse - @start_verse)
+        @verses.collection.each do |verse|
+          verse.must_respond_to(:auditid)
+          verse.must_respond_to(:copyright)
+          verse.must_respond_to(:id)
+          verse.must_respond_to(:label)
+          verse.must_respond_to(:lastverse)
+          verse.must_respond_to(:next)
+          verse.must_respond_to(:osis_end)
+          verse.must_respond_to(:parent)
+          verse.must_respond_to(:previous)
+          verse.must_respond_to(:reference)
+          verse.must_respond_to(:text)
+          verse.must_respond_to(:verse)
+        end
+      end
+    end
+  end
+
+  describe %{#verse} do
+    describe %{given verse signature} do
+      describe %{as a string} do
+        it %{raises an argument error for bad input} do
+          bad_verse_string = lambda { @biblesearch.verse('SupDawg') }
+          bad_verse_string.must_raise ArgumentError
+          (bad_verse_string.call rescue $!).message.must_equal 'Verse signature must be in the form "VERSION_ID:BOOK_ID.CHAPTER_NUMBER.VERSE_NUMBER"'
+        end
+      end
+
+      describe %{as a hash} do
+        before do
+          @options = {
+            :version_id => 'GNT',
+            :book_id => 'Acts',
+            :chapter => '8',
+            :verse => '34'
+          }
+        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_verse_hash = lambda { @biblesearch.verse(options) }
+              bad_verse_hash.must_raise ArgumentError
+              (bad_verse_hash.call rescue $!).message.must_equal 'Verse signature hash must include :version_id, :book_id, :chapter, and :verse'
+            end
+          end
+        end
+
+        describe %{with a complete hash} do
+          it %{returns the same thing as the equivalent string sig} do
+            @biblesearch.verse(@options).value.must_equal @biblesearch.verse('GNT:Acts.8.34').value
+          end
+        end
+      end
+    end
+
+    describe %{when requesting a valid verse} do
+      it %{has a verse value} do
+        result = @biblesearch.verse('GNT:Acts.8.34').value
+        result.must_be_instance_of Hashie::Mash
+        result.must_respond_to(:auditid)
+        result.must_respond_to(:copyright)
+        result.must_respond_to(:id)
+        result.must_respond_to(:label)
+        result.must_respond_to(:lastverse)
+        result.must_respond_to(:next)
+        result.must_respond_to(:osis_end)
+        result.must_respond_to(:parent)
+        result.must_respond_to(:previous)
+        result.must_respond_to(:reference)
+        result.must_respond_to(:text)
+        result.must_respond_to(:verse)
+      end
+    end
+
+    describe %{when requesting an invalid verse} do
+      it %{has a nil value} do
+        @biblesearch.verse('KJV:Batman.1.1').value.must_be_nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+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 %{#versions} do
+    before do
+      @versions = @biblesearch.versions
+    end
+
+    it %{has a collection} do
+      @versions.collection.must_be_instance_of Array
+    end
+
+    it %{should contain versions} do
+      @versions.collection.length.must_be :>, 0
+      @versions.collection.each do |version|
+        version.must_respond_to(:id)
+        version.must_respond_to(:name)
+        version.must_respond_to(:lang)
+        version.must_respond_to(:lang_code)
+        version.must_respond_to(:lang_name_eng)
+        version.must_respond_to(:abbreviation)
+        version.must_respond_to(:copyright)
+        version.must_respond_to(:contact_url)
+        version.must_respond_to(:info)
+      end
+    end
+
+    describe %{when I provide a language} do
+      describe %{that has representative versions on the remote end} do
+        before do
+          @spanish_versions = @biblesearch.versions(:language => 'spa')
+        end
+        it 'should return only those representative versions' do
+          @spanish_versions.collection.each do |version|
+            version.lang.must_equal 'spa'
+          end
+        end
+      end
+
+      describe %{that has no representative versions on the remote end} do
+        before do
+          @klingon_versions = @biblesearch.versions(:language => 'klingon')
+        end
+        it %{has a collection} do
+          @klingon_versions.collection.must_be_instance_of Array
+        end
+        it %{should be empty} do
+          @klingon_versions.collection.length.must_equal 0
+        end
+      end
+    end
+  end
+
+  describe %{#version} do
+    it %{requires a version id} do
+      lambda { @biblesearch.version }.must_raise ArgumentError
+    end
+
+    describe %{with a valid version id} do
+      it %{has a version value} do
+        result = @biblesearch.version('GNT').value
+        result.must_be_instance_of Hashie::Mash
+        result.must_respond_to(:id)
+        result.must_respond_to(:name)
+        result.must_respond_to(:lang)
+        result.must_respond_to(:lang_code)
+        result.must_respond_to(:lang_name_eng)
+        result.must_respond_to(:abbreviation)
+        result.must_respond_to(:copyright)
+        result.must_respond_to(:contact_url)
+        result.must_respond_to(:info)
+      end
+    end
+
+    describe %{with an invalid version id} do
+      it %{has a nil value} do
+        @biblesearch.version('JIMBOB').value.must_be_nil
+      end
+    end
+  end
+end

data/spec/biblesearch-api/pathtest.rb

@@ -0,0 +1 @@
+puts %{#{RUBY_VERSION}: #{__FILE__}}

data/spec/biblesearch-api_spec.rb

@@ -0,0 +1,137 @@
+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 %{.new} do
+    it %{requires an API key as its first argument} do
+      lambda {BibleSearch.new}.must_raise ArgumentError
+      rigamaroe = BibleSearch.new('rigamaroe')
+      rigamaroe.api_key.must_equal 'rigamaroe'
+    end
+    it %{accepts a base_uri as its second argument} do
+      whatever = BibleSearch.new('whatever', 'lookatmybible.com')
+      whatever.wont_be_nil
+      whatever.class.base_uri.must_equal 'http://lookatmybible.com'
+    end
+  end
+
+  describe %{#get_mash} do
+    before do
+      @api_result = @biblesearch.instance_eval('get_mash("/versions.js")')
+    end
+
+    it %{has metadata} do
+      @api_result.must_respond_to(:meta)
+      @api_result.meta.must_be_instance_of Hashie::Mash
+    end
+
+    it %{has a http response code in the metadata} do
+      @api_result.meta.http_code.wont_be_nil
+      @api_result.meta.http_code.must_be_kind_of Integer
+    end
+
+    it %{has a response} do
+      @api_result.must_respond_to(:response)
+    end
+
+    describe %{in the sunny day scenario} do
+      it %{has fums in the metadata} do
+        @api_result.meta.must_respond_to(:fums)
+        @api_result.meta.fums.wont_be_nil
+      end
+
+      it %{has a real response} do
+        @api_result.response.wont_be_nil
+        @api_result.must_be_instance_of Hashie::Mash
+      end
+    end
+
+    describe %{when something goes wrong} do
+      before do
+        @api_result = @biblesearch.instance_eval('get_mash("/my-pokemons.js")')
+      end
+
+      it %{has a http response code other than 200} do
+        @api_result.meta.http_code.wont_equal 200
+      end
+
+      it %{has a message in the metadata} do
+        @api_result.meta.message.wont_be_nil
+      end
+
+      it %{has a nil response} do
+        @api_result.response.must_be_nil
+      end
+    end
+  end
+
+  describe %{#pluralize_result} do
+    describe %{returns an array} do
+      it %{containing the contents of a passed array} do
+        result = [1, 2, 3, 4]
+        @biblesearch.instance_eval(%{pluralize_result([#{result.join(', ')}])}).must_equal result
+      end
+
+      it %{containing the singular value passed} do
+        result = 1
+        @biblesearch.instance_eval(%{pluralize_result(#{result})}).must_equal [result]
+      end
+    end
+  end
+
+  describe %{#fumsify} do
+    describe %{given a good API Result} do
+      before do
+        @api_result = @biblesearch.send(:get_mash, '/versions.js')
+      end
+
+      describe %{and a plural value} do
+        it %{returns a mash with a collection and a fums} do
+          fumsified = @biblesearch.send(:fumsify, @api_result, [])
+          fumsified.must_be_instance_of Hashie::Mash
+          fumsified.fums.wont_be_nil
+          fumsified.collection.must_be_kind_of(Array)
+        end
+      end
+
+      describe %{and a singular value} do
+        it %{returns a mash with a value and a fums} do
+          [1, 'a', Hashie::Mash.new({:foo => 'bar'})].each do |value|
+            fumsified = @biblesearch.send(:fumsify, @api_result, value)
+            fumsified.must_be_instance_of Hashie::Mash
+            fumsified.fums.wont_be_nil
+            fumsified.value.must_equal value
+          end
+        end
+      end
+    end
+
+    describe %{given a negative API Result} do
+      before do
+        @api_result = @biblesearch.send(:get_mash, '/my-pokemons.js')
+      end
+
+      it %{has a nil fums (same singular and plural behavior as good)} do
+        collection = [1, 2, 3, 4]
+        value = 1
+        fumsified_plural = @biblesearch.send(:fumsify, @api_result, collection)
+        fumsified_singular = @biblesearch.send(:fumsify, @api_result, value)
+
+        fumsified_plural.fums.must_be_nil
+        fumsified_plural.collection.must_equal collection
+
+        fumsified_singular.fums.must_be_nil
+        fumsified_singular.value.must_equal value
+      end
+    end
+  end
+end