kmayer-highrise 0.8.1 → 0.9.0

data/README.mkdn

@@ -1,10 +1,8 @@
-# Highrise (0.8.0)
+# Highrise (0.9.0)
 
-## What
+## What is it?
 
-[Highrise][h] is a gem that provides an easy way to use the [Highrise API][api].
-
-This gem provides a set of classes to access available information on [Highrise][h].
+This gem provides a set of classes to access information on [Highrise][h] via the published [API][api]
 
 These are the list of classes:
 
@@ -16,14 +14,14 @@ All these classes are inherited of ActiveResouce::Base. For more informations se
 
     gem install kmayer-highrise
 
-## Dependencies
+### Dependencies
 
 * ActiveResorce >= 2.2.2
 * ActiveSupport >= 2.1
 * Curb
 * Hpricot
 
-## Configure your key.
+### Configure your key
     
     require 'rubygems'
     require 'highrise'
@@ -35,7 +33,7 @@ or
     Highrise::Base.site = 'http://your_site.highrisehq.com'
     Highrise::Base.user = 'api-auth-token'
 
-and, if you want caching(!)
+and, if you want [caching][c]:
 
     Highrise::Base.connection.cache_store= <your normal ActiveSupport::Caching options>
     
@@ -69,18 +67,19 @@ Comments are welcome. Send your feedback through the [issue tracker on GitHub][i
 [How to Cache Anything With ActiveSupport][rh] on the very *day* I started writing the cache code. Thank you, Rein
 for writing an excellent tutorial and [posting your source][e] on GitHub.
 
+[api]: http://developer.37signals.com/highrise
 [ar]: http://api.rubyonrails.org/classes/ActiveResource/Base.html
-[mt]: http://www.improveit.com.br/en/company/tapajos
-[ii]: http://www.improveit.com.br/en
+[c]:  http://api.rubyonrails.org/classes/ActiveSupport/Cache
 [co]: http://github.com/kmayer
-[mit]:http://www.opensource.org/licenses/mit-license.php
+[e]:  http://github.com/primedia/endeca/tree/master
 [h]:  http://www.highrisehq.com/
 [i]:  http://github.com/kmayer/highrise/issues
+[ii]: http://www.improveit.com.br/en
 [km]: http://github.com/kmayer
 [lg]: http://github.com/luisbebop
+[mit]:http://www.opensource.org/licenses/mit-license.php
+[mt]: http://www.improveit.com.br/en/company/tapajos
 [nb]: http://github.com/slainer86
-[tl]: http://github.com/ThiagoLelis
-[api]: http://developer.37signals.com/highrise
 [re]: http://www.railsenvy.com/2009/4/29/rails-envy-podcast-episode-077-04-29-2009
 [rh]: http://reinh.com/blog/2009/04/27/how-to-cache-anything-with-activesupport.html
-[e]:  http://github.com/primedia/endeca/tree/master
+[tl]: http://github.com/ThiagoLelis

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 0
 :major: 0
-:minor: 8
+:minor: 9

data/lib/cachable.rb

@@ -6,7 +6,7 @@ require 'digest/sha1'
 #
 # == Usage
 # 
-#   require 'lib/cachable'
+#   require 'cachable'
 # 
 #   module CachedResource
 #     class Base < ActiveResource::Base
@@ -16,7 +16,7 @@ require 'digest/sha1'
 #
 # == Caching stores
 #
-# All the caching stores from ActiveSupport::Cache are available to be used
+# All the caching stores from ActiveSupport::Cache are available
 # as backends for caching. See the Rails rdoc for more information on
 # these stores
 #
@@ -28,7 +28,9 @@ require 'digest/sha1'
 #   CachedResource.connection.cache_store = :mem_cache_store, "localhost"
 #   CachedResource.connection.cache_store = MyOwnStore.new("parameter")
 #
-# Note: To ensure that caching is turned off, set CachedResource.connection.cache_store = nil
+# Note: To ensure that caching is turned off, set CachedResource.connection.cache_store = :none
+#
+# FYI: You can use this with *any* active resource interface, not just Highrise.
 
 module Cachable
   def self.included(base)
@@ -39,8 +41,19 @@ module Cachable
       @cache_store ||= nil
     end
 
-    def cache_store=(store_option)
-      @cache_store = store_option.nil? ? nil : ActiveSupport::Cache.lookup_store(store_option)
+    # Wrapper for lookup_store, with a couple of special options:
+    #   Passing +:none+ will turn off caching
+    #   Passing +:rails+ will use the default Rails/AS cache (whatever it happens to be)
+    #   Passing no args or nil will return the default cache from AS
+    def cache_store=(*store_option)
+      @cache_store = case store_option
+      when [:none]
+        nil
+      when [:rails]
+        Rails.cache rescue ActiveSupport::Cache.lookup_store
+      else
+        ActiveSupport::Cache.lookup_store(*store_option)
+      end
     end
 
     def is_caching?

data/spec/highrise/cachable_spec.rb

@@ -12,9 +12,14 @@ describe Highrise::Base, "class configuration" do
   end
   
   it "should tell us if caching is not active" do
-    @connection.cache_store = nil
+    @connection.cache_store = :none
     @connection.is_caching?.should == false
   end
+
+  it "should use the Rails stack default cache" do
+    @connection.cache_store = :rails
+    @connection.is_caching?.should == true
+  end
 end
 
 describe Highrise::Base do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kmayer-highrise
 version: !ruby/object:Gem::Version 
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors: 
 - "Marcos Tapaj\xC3\xB3s"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-01 00:00:00 -07:00
+date: 2009-05-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency