primedia-endeca 0.14.0 → 1.0.0

data/endeca.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{endeca}
-  s.version = "0.14.0"
+  s.version = "1.0.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-06}
+  s.date = %q{2009-04-21}
   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/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/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.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"]

data/lib/endeca/caching.rb

@@ -0,0 +1,64 @@
+require 'digest/sha1'
+
+require 'rubygems'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/array'
+require 'active_support/core_ext/class'
+require 'active_support/cache'
+require 'endeca'
+
+module Endeca #:nodoc:
+
+  class << self
+    def perform_caching?; !@@cache_store.nil? end
+    def cache_store;      @@cache_store;      end
+
+    # Defines the storage option for cached queries
+    def cache_store=(store_option)
+      @@cache_store = ActiveSupport::Cache.lookup_store(store_option)
+    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.
+  #
+  # Note: To ensure that caching is turned off, set Endeca.cache_store = nil
+  #
+  # == Caching stores
+  #
+  # All the caching stores from ActiveSupport::Cache are available to be used
+  # as backends for Endeca caching. See the Rails rdoc for more information on
+  # these stores
+  #
+  # Configuration examples (MemoryStore is the default):
+  #
+  #   Endeca.cache_store = :memory_store
+  #   Endeca.cache_store = :file_store, "/path/to/cache/directory"
+  #   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 }
+    end
+
+    private
+
+    def fetch(key, &block)
+      Endeca.cache_store.fetch(key, &block)
+    end
+
+    def cache_key
+      Digest::SHA1.hexdigest uri.to_s
+    end
+  end
+end
+
+Endeca::Request.class_eval do
+  include Endeca::Caching
+  alias_method_chain :get_response, :caching
+end

data/lib/endeca/request.rb

@@ -20,7 +20,7 @@ module Endeca
     end
     
     def response
-      handle_response(get_response)
+      @response ||= handle_response(get_response)
     end
 
     def uri

data/lib/endeca.rb

@@ -21,12 +21,14 @@ require 'endeca/request'
 require 'endeca/document_collection'
 require 'endeca/document'
 
+require 'endeca/caching'
+
 module Endeca
   extend Benchmarking
   extend Logging
 
   # :stopdoc:
-  VERSION = '0.11.0'
+  VERSION = '1.0.0'
   # :startdoc:
 
   # Returns the version string for the library.

data/spec/endeca/caching_spec.rb

@@ -0,0 +1,49 @@
+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 do
+    @path     = "http://example.com"
+    @query    = "foo=bar"
+    @request  = Endeca::Request.new(@path, @query)
+    @response = {"a successful" => "response"}
+
+    @request.stub!(:handle_response).and_return(@response)
+    @cache_key = :key
+    @request.stub!(:cache_key).and_return(@cache_key)
+  end
+
+  context "When a cached response is available" do
+    before do
+      Endeca.cache_store.write(@cache_key, @response)
+    end
+
+    it "should not perform the request" do
+      @request.should_not_receive(:get_response_without_caching)
+      @request.perform
+    end
+
+    it "should read from the cache" do
+      @request.perform.should == @response
+    end
+  end
+
+  context "When a cached response is not available" do
+    before do
+      Endeca.cache_store.delete(@cache_key)
+    end
+
+    it "should perform the request" do
+      @request.should_receive(:get_response_without_caching)
+      @request.perform
+    end
+
+    it "should cache the response using the caching key" do
+      @request.stub!(:get_response_without_caching).and_return(@response)
+
+      @request.perform
+      Endeca.cache_store.read(@request.send(:cache_key)).should == @response
+    end
+  end
+end

data/spec/endeca/request_spec.rb

@@ -6,6 +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
   end
 
   describe '.perform' do
@@ -24,6 +25,11 @@ describe Endeca::Request do
     before do
       @request = Endeca::Request.new(@path)
     end
+    
+    it "should not make more than one request" do
+      @request.should_receive(:handle_response).exactly(1).times.and_return({})
+      @request.perform
+    end    
 
     describe "when successful" do
       before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: primedia-endeca
 version: !ruby/object:Gem::Version 
-  version: 0.14.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Rein Henrichs
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-06 00:00:00 -07:00
+date: 2009-04-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,7 @@ files:
 - 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
@@ -60,6 +61,7 @@ files:
 - 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