primedia-endeca 1.1.0 → 1.2.0

data/endeca.gemspec

@@ -2,20 +2,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{endeca}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rein Henrichs", "Andy Stone"]
-  s.date = %q{2009-04-22}
+  s.date = %q{2009-05-13}
   s.description = %q{An Endeca client library for Ruby.}
   s.email = %q{}
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
   s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "endeca.gemspec", "example/benchmark.rb", "example/listing.rb", "lib/class_to_proc.rb", "lib/core_ext.rb", "lib/endeca.rb", "lib/endeca/benchmarking.rb", "lib/endeca/breadcrumb.rb", "lib/endeca/breadcrumbs.rb", "lib/endeca/caching.rb", "lib/endeca/dimension.rb", "lib/endeca/document.rb", "lib/endeca/document_collection.rb", "lib/endeca/logging.rb", "lib/endeca/map.rb", "lib/endeca/readers.rb", "lib/endeca/refinement.rb", "lib/endeca/refinement_dimension.rb", "lib/endeca/request.rb", "lib/endeca/transformer.rb", "spec/core_ext_spec.rb", "spec/endeca/benchmarking_spec.rb", "spec/endeca/breadcrumb_spec.rb", "spec/endeca/caching_spec.rb", "spec/endeca/dimension_spec.rb", "spec/endeca/document_collection_spec.rb", "spec/endeca/document_spec.rb", "spec/endeca/map_spec.rb", "spec/endeca/readers_spec.rb", "spec/endeca/refinement_dimension_spec.rb", "spec/endeca/refinement_spec.rb", "spec/endeca/request_spec.rb", "spec/endeca/transformer_spec.rb", "spec/endeca_spec.rb", "spec/rcov.opts", "spec/spec.opts", "spec/spec_helper.rb"]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/primedia/endeca-ruby}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{endeca}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.3}
   s.summary = %q{An Endeca client library for Ruby}
 end

data/lib/endeca.rb

@@ -28,7 +28,7 @@ module Endeca
   extend Logging
 
   # :stopdoc:
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
   # :startdoc:
 
   # Returns the version string for the library.

data/lib/endeca/caching.rb

@@ -10,16 +10,29 @@ require 'endeca'
 module Endeca #:nodoc:
 
   class << self
-    def perform_caching?; !@@cache_store.nil? end
-    def cache_store;      @@cache_store;      end
+    def perform_caching?
+      !cache_store.nil?
+    end
+
+    def cache_store
+      @cache_store
+    end
+
+    def disable_caching
+      @cache_store = nil
+    end
 
     # Defines the storage option for cached queries
+    #
+    # ActiveSupport::Cache.lookup_store will return MemoryStore 
+    # if nil is passed in and we don't want that.
     def cache_store=(store_option)
-      @@cache_store = ActiveSupport::Cache.lookup_store(store_option)
+      if store_option
+        @cache_store = ActiveSupport::Cache.lookup_store(store_option)
+      end
     end
   end
 
-
   # Caching is a way to speed up slow Endeca queries by keeping the result of
   # an Endeca request around to be reused by subequest requests. Caching is
   # turned off by default.
@@ -39,26 +52,19 @@ module Endeca #:nodoc:
   #   Endeca.cache_store = :drb_store, "druby://localhost:9192"
   #   Endeca.cache_store = :mem_cache_store, "localhost"
   #   Endeca.cache_store = MyOwnStore.new("parameter")
-  module Caching
-    def get_response_with_caching #:nodoc:
-      return get_response_without_caching unless Endeca.perform_caching?
-
-      fetch(cache_key) { get_response_without_caching }
+  module Caching    
+    def self.included(base)
+      base.alias_method_chain :get_response, :caching
     end
 
     private
 
-    def fetch(key, &block)
-      Endeca.cache_store.fetch(key, &block)
+    def get_response_with_caching #:nodoc:
+      return get_response_without_caching unless Endeca.perform_caching?
+      fetch { get_response_without_caching }
     end
 
-    def cache_key
-      Digest::SHA1.hexdigest uri.to_s
-    end
+    def cache_key;     Digest::SHA1.hexdigest uri.to_s end
+    def fetch(&block); Endeca.cache_store.fetch(cache_key, &block) end
   end
 end
-
-Endeca::Request.class_eval do
-  include Endeca::Caching
-  alias_method_chain :get_response, :caching
-end

data/lib/endeca/request.rb

@@ -1,9 +1,10 @@
 require 'uri'
+require 'lib/endeca/caching'
+
 module Endeca
   class RequestError < ::StandardError; end
 
   class Request
-
     def self.perform(path, query=nil)
       raise RequestError, "Must provide a path" unless path
       new(path, query).perform
@@ -77,5 +78,7 @@ module Endeca
 
       query_string_parts.empty? ? nil : query_string_parts.join('&')
     end
+    
+    include Caching
   end
 end

data/spec/endeca/caching_spec.rb

@@ -1,8 +1,14 @@
 require File.join(File.dirname(__FILE__), %w[.. spec_helper])
 
 describe Endeca::Request do
-  before(:all){ Endeca.cache_store = :memory_store }
-  after(:all){ Endeca.cache_store = nil }
+  before(:all) do 
+    Endeca.cache_store = :memory_store
+  end
+
+  after(:all) do 
+    Endeca.disable_caching
+  end
+
   before do
     @path     = "http://example.com"
     @query    = "foo=bar"
@@ -14,7 +20,7 @@ describe Endeca::Request do
     @request.stub!(:cache_key).and_return(@cache_key)
   end
 
-  context "When a cached response is available" do
+  describe "When a cached response is available" do
     before do
       Endeca.cache_store.write(@cache_key, @response)
     end
@@ -29,7 +35,7 @@ describe Endeca::Request do
     end
   end
 
-  context "When a cached response is not available" do
+  describe "When a cached response is not available" do
     before do
       Endeca.cache_store.delete(@cache_key)
     end
@@ -47,3 +53,21 @@ describe Endeca::Request do
     end
   end
 end
+
+
+describe Endeca::Caching do
+  it "should return false when cache store is not set" do
+    Endeca.perform_caching?.should be_false
+  end
+
+  it "should return false when if disable_caching has been set" do
+    Endeca.cache_store = :memory_store
+    Endeca.disable_caching
+    Endeca.perform_caching?.should be_false
+  end
+
+  it "should return memory store" do
+    Endeca.cache_store = :memory_store
+    Endeca.cache_store.class.should == ActiveSupport::Cache::MemoryStore
+  end
+end

data/spec/endeca/request_spec.rb

@@ -6,7 +6,7 @@ require File.join(File.dirname(__FILE__), %w[.. spec_helper])
 describe Endeca::Request do
   before do
     @path = 'http://example.com/foobar'
-    Endeca.cache_store = nil
+    Endeca.disable_caching
   end
 
   describe '.perform' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: primedia-endeca
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Rein Henrichs
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-22 00:00:00 -07:00
+date: 2009-05-13 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -66,7 +66,7 @@ files:
 - spec/rcov.opts
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/primedia/endeca-ruby
 post_install_message: 
 rdoc_options: