esv_api 0.0.1 → 1.0.0

data/README.md

@@ -1,6 +1,6 @@
 # ESV_API
 
-An API Wrapper for the ESV API
+An API Wrapper for the [ESV API](http://www.esvapi.org/api)
 
 # Limitations
 
@@ -11,12 +11,16 @@ Currently only supports `passage_query`
 ```ruby
 
     gem 'esv_api'
-
 ```
 
+
+# Usage
+
+For your rails app:
+ 
 ```ruby
 
-    # Create an initializer:
+    #Create an initializer:
 	
 	ESV.configure do |config|
 	  config.api_key = YOUR_API_KEY
@@ -28,6 +32,44 @@ Currently only supports `passage_query`
     @esv_text = ESV.passage_query( params[:passage] || "John 1", { 'include-footnotes' => 'false', 'include-headings' => 'false', 'include-subheadings' => 'false', 'include-audio-link' => 'false' } )
 ```
 
+## Query Types
+
+The following methods are available as query types:
+
+```ruby
+
+    passage_query(passage, options={})
+	
+    query( q, options={} )
+    
+    reading_plan_query( options={} )
+    
+    query_info( q, options={} )
+    
+    reading_plan_info( options={} )
+    
+    verse( options={} )
+    
+    daily_verse( options={} )
+```
+
+
+## Query Options
+
+The gem mirrors the API. To pass in options, just use the options hash in any available method, using options of the same name as specified in the [ESV API documentation](http://www.esvapi.org/api).
+
+For example:
+
+```ruby
+
+    @esv_text = ESV.passage_query( params[:passage] || "John 1", { 'include-footnotes' => 'false', 'include-headings' => 'false', 'include-subheadings' => 'false', 'include-audio-link' => 'false' } )
+```
+
+ 
+
+## Formatting HTML Output
+
+HTML is the default output and will appear unless output-format is specified. To make full use of the text, you will probably want to link a CSS stylesheet to your page, either one you've created or [GNP's CSS](http://www.gnpcb.org/esv/assets/style/text.css). This stylesheet contains close to the minimum markup needed to render the text accurately.
 
 # Credits
 

data/Rakefile

@@ -1,13 +1,10 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
+#!/usr/bin/env rake
 
-desc 'Default: run unit tests.'
-task :default => :test
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-desc 'Test the esv_api gem.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/esv_api.gemspec

@@ -1,9 +1,10 @@
 Gem::Specification.new do |s|
   s.add_dependency 'httparty'
+  s.add_development_dependency 'rspec'
   
   s.platform    = Gem::Platform::RUBY
   s.name        = 'esv_api'
-  s.version     = '0.0.1'
+  s.version     = '1.0.0'
   s.authors     = ["Jeff McFadden"]
   s.email       = ["jeff@forgeapps.com"]
   s.homepage    = "http://github.com/jeffmcfadden/esv_api"

data/lib/esv_api/client.rb

@@ -32,5 +32,68 @@ module ESV
       
       ESV::Client.get( self.endpoint + '/passageQuery', { :query => query } )
     end
+    
+    def query( q, options={} )
+      query = {
+          'key' => self.api_key,
+          'q' => q
+      }
+      
+      query = options.merge( query )
+      
+      ESV::Client.get( self.endpoint + '/query', { :query => query } )
+    end
+    
+    def reading_plan_query( options={} )
+      query = {
+          'key' => self.api_key,
+      }
+      
+      query = options.merge( query )
+      
+      ESV::Client.get( self.endpoint + '/readingPlanQuery', { :query => query } )
+    end
+    
+    def query_info( q, options={} )
+      query = {
+          'key' => self.api_key,
+          'q'   => q
+      }
+      
+      query = options.merge( query )
+      
+      ESV::Client.get( self.endpoint + '/queryInfo', { :query => query } )
+    end
+    
+    def reading_plan_info( options={} )
+      query = {
+          'key' => self.api_key,
+      }
+      
+      query = options.merge( query )
+      
+      ESV::Client.get( self.endpoint + '/readingPlanQuery', { :query => query } )
+    end
+    
+    def verse( options={} )
+      query = {
+          'key' => self.api_key,
+      }
+      
+      query = options.merge( query )
+      
+      ESV::Client.get( self.endpoint + '/verse', { :query => query } )
+    end
+    
+    def daily_verse( options={} )
+      query = {
+          'key' => self.api_key,
+      }
+      
+      query = options.merge( query )
+      
+      ESV::Client.get( self.endpoint + '/verse', { :query => query } )
+    end
+    
   end
 end

data/lib/esv_api/version.rb

@@ -3,7 +3,7 @@ module ESV
 
     # @return [Integer]
     def self.major
-      0
+      1
     end
 
     # @return [Integer]
@@ -13,7 +13,7 @@ module ESV
 
     # @return [Integer]
     def self.patch
-      1
+      0
     end
 
     # @return [String, NilClass]

data/spec/esv_api/client_spec.rb

@@ -0,0 +1,163 @@
+require 'helper'
+
+describe ESV::Client do
+  before do
+    @keys = ESV::Config::VALID_OPTIONS_KEYS
+    
+    ESV.configure do |config|
+      config.api_key = 'aae0629deae45288'
+    end
+  end
+
+  context "with module configuration" do
+
+    before do
+      ESV.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      ESV.reset
+    end
+
+    it "should inherit module configuration" do
+      api = ESV::Client.new
+      @keys.each do |key|
+        api.send(key).should == key
+      end
+    end
+      
+    context "with class configuration" do
+
+      before do
+        @configuration = {
+          :api_key => 'hereisAnAPIKey',
+          :endpoint => 'http://api.esv.org/',
+          :user_agent => 'Custom User Agent'
+        }
+      end
+
+      context "during initialization" do
+        it "should override module configuration" do
+          api = ESV::Client.new(@configuration)
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+      end
+
+      context "after initilization" do
+        it "should override module configuration after initialization" do
+          api = ESV::Client.new
+          @configuration.each do |key, value|
+            api.send("#{key}=", value)
+          end
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+      end
+
+    end
+  end
+  
+  describe ".passage_query" do
+    it "should return a string" do
+      api = ESV::Client.new
+      api.passage_query( 'John 1:1' ).should be_a String
+    end
+    
+    it "should not return an error with a valid passage" do
+      api = ESV::Client.new
+      api.passage_query( 'John 1:1' ).should_not include("ERROR")
+    end
+    
+    it "should return an error with an invalid passage" do
+      api = ESV::Client.new
+      api.passage_query( 'Fail Whale' ).should include("ERROR")
+    end
+  end
+  
+  describe ".query" do
+    it "should return a string" do
+      api = ESV::Client.new
+      api.query( 'John 1:1' ).should be_a String
+    end
+    
+    it "should not return an error with a valid passage" do
+      api = ESV::Client.new
+      api.query( 'John 1:1' ).should_not include("ERROR")
+    end
+  end
+  
+  describe ".reading_plan_query" do
+    it "should return a string" do
+      api = ESV::Client.new
+      api.reading_plan_query().should be_a String
+    end
+    
+    it "should not return an error with a valid passage" do
+      api = ESV::Client.new
+      api.reading_plan_query().should_not include("ERROR")
+    end
+  end
+  
+  describe ".query_info" do
+    it "should return a string" do
+      api = ESV::Client.new
+      api.query_info( 'John 1:1' ).should be_a String
+    end
+    
+    it "should not return an error with a valid passage" do
+      api = ESV::Client.new
+      api.query_info( 'John 1:1' ).should_not include("ERROR")
+    end
+    
+  end
+  
+  describe ".reading_plan_info" do
+    it "should return a string" do
+      api = ESV::Client.new
+      api.reading_plan_info().should be_a String
+    end
+    
+    it "should not return an error with a valid passage" do
+      api = ESV::Client.new
+      api.reading_plan_info().should_not include("ERROR")
+    end
+  end
+  
+  describe ".verse" do
+    it "should return a string" do
+      api = ESV::Client.new
+      api.verse().should be_a String
+    end
+    
+    it "should not return an error with a valid passage" do
+      api = ESV::Client.new
+      api.verse().should_not include("ERROR")
+    end
+  end
+  
+  describe ".daily_verse" do
+    it "should return a string" do
+      api = ESV::Client.new
+      api.daily_verse().should be_a String
+    end
+    
+    it "should not return an error with a valid passage" do
+      api = ESV::Client.new
+      api.daily_verse().should_not include("ERROR")
+    end
+  end
+  
+  
+  
+  
+  
+  
+  
+end

data/spec/esv_api_spec.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+describe ESV do
+  after do
+    ESV.reset
+  end
+  
+  describe ".new" do
+    it "should return an ESV::Client" do
+      ESV.new.should be_a ESV::Client
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,3 @@
+require 'esv_api'
+require 'rspec'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: esv_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70296141623180 !ruby/object:Gem::Requirement
+  requirement: &70242206491240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70296141623180
+  version_requirements: *70242206491240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70242206490820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242206490820
 description: ESV API Wrapper.
 email:
 - jeff@forgeapps.com
@@ -38,6 +49,9 @@ files:
 - lib/esv_api/client.rb
 - lib/esv_api/config.rb
 - lib/esv_api/version.rb
+- spec/esv_api/client_spec.rb
+- spec/esv_api_spec.rb
+- spec/helper.rb
 homepage: http://github.com/jeffmcfadden/esv_api
 licenses: []
 post_install_message: 
@@ -63,4 +77,7 @@ rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: ESV API Wrapper.
-test_files: []
+test_files:
+- spec/esv_api/client_spec.rb
+- spec/esv_api_spec.rb
+- spec/helper.rb