esv_api 1.0.1 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3792614c9313314f8a04daf433532160d302626
+  data.tar.gz: 24b72318f3af8bca01516cc5aa75e05e1545728b
+SHA512:
+  metadata.gz: a04bdf6a34ac115c4e6bd95a70f8ed6ba91f743b7b3807351ec350b87483823b1b46352a028a8ade03bd520eef08fed9d03248abee869551bae3453bdc6cfb30
+  data.tar.gz: 09d6aeae3288e8420f2ab0d456033e6513ce42a8090da9d1343325a3ce26a4702407e655bec82b66091d5e488edf6b79b3229639c41d7b40df19d68b29c2e1af

data/README.md

@@ -67,6 +67,10 @@ For example:
 
 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.
 
+## Caching
+
+If you have the `dalli` gem installed, `esv_api` will cache the data returned from passage_query calls, taking options into account when setting the key.
+
 # Credits
 
 With love to the Twitter Gem, from which I borrowed heavily.

data/esv_api.gemspec

@@ -1,16 +1,16 @@
 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     = '1.0.1'
+  s.version     = '1.0.2'
   s.authors     = ["Jeff McFadden"]
   s.email       = ["jeff@forgeapps.com"]
   s.homepage    = "http://github.com/jeffmcfadden/esv_api"
   s.summary     = "ESV API Wrapper."
   s.description = "ESV API Wrapper."
-  
+
   s.required_ruby_version = '>= 1.9.2'
 
   s.files         = `git ls-files`.split("\n")

data/lib/esv_api/client.rb

@@ -9,17 +9,17 @@ module ESV
   rescue LoadError
     HAS_DALLI = false
   end
-  
-  def self.should_cache?
-    HAS_DALLI
+
+  def self.should_use_caching?
+    ESV.options[:should_cache] && HAS_DALLI
   end
-  
+
   # Wrapper for the ESV API
   #
   class Client
     include HTTParty
     format :html
-    
+
     attr_accessor *Config::VALID_OPTIONS_KEYS
 
     # Initializes a new API object
@@ -31,96 +31,96 @@ module ESV
       Config::VALID_OPTIONS_KEYS.each do |key|
         instance_variable_set("@#{key}".to_sym, attrs[key])
       end
-      
-      if ESV.should_cache?
+
+      if ESV.should_use_caching?
         @dc = Dalli::Client.new('localhost:11211')
       end
     end
-    
+
     def passage_query(passage, options={})
       query = {
           'key' => self.api_key,
           'passage' => passage
       }
-      
+
       query = options.merge( query )
-      
-      if ESV.should_cache?
+
+      if ESV.should_use_caching?
         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?
-      
+
+      @dc.set( cache_key, esv_text ) if ESV.should_use_caching?
+
       return esv_text
     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/config.rb

@@ -17,7 +17,8 @@ module ESV
     VALID_OPTIONS_KEYS = [
       :api_key,
       :endpoint,
-      :user_agent
+      :user_agent,
+      :should_cache
     ]
 
     attr_accessor *VALID_OPTIONS_KEYS
@@ -45,6 +46,7 @@ module ESV
       self.api_key            = DEFAULT_API_KEY
       self.endpoint           = DEFAULT_ENDPOINT
       self.user_agent         = DEFAULT_USER_AGENT
+      self.should_cache       = true
       self
     end
 

data/lib/esv_api/version.rb

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

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: esv_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.0.2
 platform: ruby
 authors:
 - Jeff McFadden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-26 00:00:00.000000000Z
+date: 2015-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70177774736500 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70177774736500
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70177774736080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70177774736080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ESV API Wrapper.
 email:
 - jeff@forgeapps.com
@@ -55,28 +60,27 @@ files:
 - spec/helper.rb
 homepage: http://github.com/jeffmcfadden/esv_api
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
 - none
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ESV API Wrapper.
 test_files:
 - spec/esv_api/client_spec.rb