esv_api 1.0.0 → 1.0.1

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Jeff McFadden
+
+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.md

@@ -2,10 +2,6 @@
 
 An API Wrapper for the [ESV API](http://www.esvapi.org/api)
 
-# Limitations
-
-Currently only supports `passage_query`
-
 # Installation
 
 ```ruby

data/esv_api.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   
   s.platform    = Gem::Platform::RUBY
   s.name        = 'esv_api'
-  s.version     = '1.0.0'
+  s.version     = '1.0.1'
   s.authors     = ["Jeff McFadden"]
   s.email       = ["jeff@forgeapps.com"]
   s.homepage    = "http://github.com/jeffmcfadden/esv_api"

data/lib/esv_api/client.rb

@@ -3,6 +3,17 @@ require 'esv_api/config'
 require 'httparty'
 
 module ESV
+  begin
+    require "dalli"
+    HAS_DALLI = true
+  rescue LoadError
+    HAS_DALLI = false
+  end
+  
+  def self.should_cache?
+    HAS_DALLI
+  end
+  
   # Wrapper for the ESV API
   #
   class Client
@@ -20,6 +31,10 @@ module ESV
       Config::VALID_OPTIONS_KEYS.each do |key|
         instance_variable_set("@#{key}".to_sym, attrs[key])
       end
+      
+      if ESV.should_cache?
+        @dc = Dalli::Client.new('localhost:11211')
+      end
     end
     
     def passage_query(passage, options={})
@@ -30,7 +45,19 @@ module ESV
       
       query = options.merge( query )
       
-      ESV::Client.get( self.endpoint + '/passageQuery', { :query => query } )
+      if ESV.should_cache?
+        cache_key = Digest::MD5.hexdigest( "esv_api_" + query.to_s )
+        
+        cached_value = @dc.get( cache_key )
+        
+        return cached_value unless cached_value.nil?
+      end
+      
+      esv_text = ESV::Client.get( self.endpoint + '/passageQuery', { :query => query } )
+      
+      @dc.set( cache_key, esv_text ) if ESV.should_cache?
+      
+      return esv_text
     end
     
     def query( q, options={} )

data/lib/esv_api/version.rb

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

data/spec/esv_api/client_spec.rb

@@ -5,7 +5,7 @@ describe ESV::Client do
     @keys = ESV::Config::VALID_OPTIONS_KEYS
     
     ESV.configure do |config|
-      config.api_key = 'aae0629deae45288'
+      config.api_key = 'a_valid_api_key'
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: esv_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-22 00:00:00.000000000Z
+date: 2012-01-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70242206491240 !ruby/object:Gem::Requirement
+  requirement: &70177774736500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70242206491240
+  version_requirements: *70177774736500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70242206490820 !ruby/object:Gem::Requirement
+  requirement: &70177774736080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242206490820
+  version_requirements: *70177774736080
 description: ESV API Wrapper.
 email:
 - jeff@forgeapps.com
@@ -42,6 +42,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - esv_api.gemspec