highrise 1.2.0 → 2.0.0

data/CHANGELOG

@@ -1,3 +1,43 @@
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Wed Feb 17 09:42:25 2010 -1000
+
+    Version bump to 2.0.0 -- Complete rewrite of Cachable. Interface has changed, see docs and examples.
+
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Mon Feb 15 13:41:28 2010 -1000
+
+    Version bump to 1.2.0
+
+    Added Account class to handle the /account.xml end point.
+
+Author: Marcos Tapajós <tapajos@gmail.com>
+Date:   Wed Feb 10 22:57:34 2010 -0200
+
+    Version bump to 1.1.0 -- Added Deal class, .add_note helper, /me.xml endpoint
+
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Wed Sep 2 08:56:42 2009 -1000
+
+    Version bump to 1.0.1
+
+    Added a couple of convenience methods.
+
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Tue Sep 1 21:32:19 2009 -1000
+
+    Version bump to 1.0.0
+
+    Revised Taggable interface to support new tag API from 37Sigs and (removed curl dependencies)
+
+    Refactored Cachable
+
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Fri May 29 22:34:03 2009 -1000
+
+    Version bump to 0.13.0
+
+    Added Tag.find_by_name
+
 2009-05-27 Ken Mayer <kmayer@bitwrangler.com>
 
   * Version 0.12.0
@@ -84,8 +124,8 @@
   * Add Person.tag that show a array of tags, and Perton.tag(name), add a new
     tag to a person.
 
-2009-01-14 tapajos
+2009-01-14 Marcos Tapajós
 
   * Version 0.5.0
   
-  * Initial import
+  * Initial import

data/README.mkdn

@@ -1,4 +1,4 @@
-# Highrise (1.2.0)
+# Highrise (2.0.0)
 
 ## What is it?
 
@@ -28,7 +28,7 @@ All these classes are inherited from ActiveResouce::Base. Refer to the [ActiveRe
 
 and, if you want [caching][c]:
 
-    Highrise::Base.cache_store= <your normal ActiveSupport::Caching options>
+    Highrise::Base.connection.cache_store= <your normal ActiveSupport::Caching options>
     
 If you are using this in a Rails application, putting this code in a config/initializers/highrise.rb
 file is recommended. See config_initializers_highrise.rb in the examples/ directory.

data/Rakefile

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'rake'
 require 'rubygems'
 require 'rake/rdoctask'

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :patch: 0
-:major: 1
-:minor: 2
+:major: 2
+:minor: 0
 :build: 

data/examples/config_initializers_highrise.rb

@@ -7,6 +7,6 @@ if Rails.env != 'test' then
     Highrise::Base.site = 'https://my_fancy_auth_token@example.com.i'
   end
   # The cache store can be anything that ActiveSupport can handle
-  Highrise::Base.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store
-  Highrise::Base.store_options = { :expires_in => 60.seconds }
+  Highrise::Base.connection.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store
+  Highrise::Base.connection.store_options = { :expires_in => 60.seconds }
 end

data/examples/sample.rb

@@ -3,7 +3,7 @@ require 'pp'
 
 Highrise::Base.site = 'https://yoursite.highrisehq.com'
 Highrise::Base.user = 'xxx'
-Highrise::Base.cache_store = :memory_store
+Highrise::Base.connection.cache_store = :memory_store
 
 @tags = Highrise::Tag.find(:all)
 

data/lib/cachable.rb

@@ -7,10 +7,8 @@
 # 
 #   require 'cachable'
 # 
-#   module CachedResource
-#     class Base < ActiveResource::Base
-#       include ::Cachable
-#     end
+#   module CachedResource < ActiveResource::Base
+#     include ::Cachable
 #   end
 #
 #
@@ -21,68 +19,65 @@
 # these stores
 #
 # === Configuration examples ('off' is the default):
-#   CachedResource.cache_store = ActiveSupport::Cache.lookup_store :memory_store
-#   CachedResource.cache_store = ActiveSupport::Cache.lookup_store :file_store, "/path/to/cache/directory"
-#   CachedResource.cache_store = ActiveSupport::Cache.lookup_store :drb_store, "druby://localhost:9192"
-#   CachedResource.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost"
-#   CachedResource.cache_store = MyOwnStore.new("parameter")
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :file_store, "/path/to/cache/directory"
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :drb_store, "druby://localhost:9192"
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost"
+#   CachedResource.connection.cache_store = MyOwnStore.new("parameter")
 #
 # === If you are using a store that has write options, you can set them
-#   CachedResource.store_options = { :expires_in => 60.seconds }
+#   CachedResource.connection.cache_options = { :expires_in => 60.seconds }
 #
 # Note: To ensure that caching is turned off, set CachedResource.connection.cache_store = nil
 #
-# FYI: You can use this with *any* active resource interface, not just Highrise.
+# FYI: You can use this with *any* active resource class, not just Highrise.
 
 module Cachable
   def self.included(base)
-    base.extend ClassMethods
-    base.class_eval do
-      class << self
-        alias_method_chain :find_every, :cache
-        alias_method_chain :find_single, :cache
+    ActiveResource::Connection.class_eval do
+      def cache_store
+        @cache_store ||= nil
       end
-    end
-  end
-
-  module ClassMethods
-    attr_writer :cache_store, :store_options
-    
-    def cache_store
-      @cache_store ||= nil
-    end
-    
-    def store_options
-      @store_options ||= {}
-    end
-    
-    def is_caching?
-      !@cache_store.nil?
-    end
-
-  private
-
-    # A little hacky -- we need to intercept the finds, but not get too deep inside the connection
-    def find_every_with_cache(options)
-      return find_every_without_cache(options) unless is_caching?
-      prefix_options, query_options = split_options(options[:params])
-      path = collection_path(prefix_options, query_options)
-      fetch(path) { find_every_without_cache(options)}
-    end
-
-    def find_single_with_cache(scope, options)
-      return find_single_without_cache(scope, options) unless is_caching?
-      prefix_options, query_options = split_options(options[:params])
-      path = element_path(scope, prefix_options, query_options)
-      fetch(path) { find_single_without_cache(scope, options)}
-    end
 
-    def cache_key(*args)
-      args.join('/')
-    end
+      def cache_store=(store)
+        @cache_store = store
+      end
+      
+      def cache_options
+        @cache_options ||= {}
+      end
+      alias :store_options :cache_options
+      
+      def cache_options=(options)
+        @cache_options = options
+      end
+      alias :store_options= :cache_options=
+      
+      def is_caching?
+        !@cache_store.nil?
+      end
+      
+      def get_with_cache(path, headers = {})
+        return get_without_cache(path, headers) unless is_caching?
+        cache_store.fetch(cache_key(path), cache_options) {get_without_cache(path, headers)}
+      end
+      alias_method_chain :get, :cache
 
-    def fetch(args, &block)
-      cache_store.fetch(cache_key(args), store_options, &block).dup
+      def put_with_cache(path, body = '', headers = {})
+        cache_store.delete(cache_key(path))
+        put_without_cache(path, body, headers)
+      end
+      alias_method_chain :put, :cache
+      
+      def delete_with_cache(path, headers = {})
+        cache_store.delete(cache_key(path))
+        delete_without_cache(path, headers)
+      end
+      alias_method_chain :delete, :cache
+      
+      def cache_key(*args)
+        args.join(':')
+      end
     end
-  end
+  end  
 end

data/lib/highrise/tag.rb

@@ -1,25 +1,12 @@
 module Highrise
-  class Tag < Base    
-    @cache = self.cache_store || ActiveSupport::Cache::MemoryStore.new
-    
+  class Tag < Base  
     def ==(object)
       (object.instance_of?(self.class) && object.id == self.id && object.name == self.name)
     end
     
-    class << self
-      # This find(:all) is very expensive, so cache all tags, once.
-      def find_by_name(arg)
-        @cache.fetch(to_key([self.to_s, arg])) {
-          tags = self.find(:all).each{|tag| @cache.write(to_key([self.to_s, tag.name]), tag)}
-          tags.find{|tag| tag.name == arg}
-        }
-      end
-      
-      private
-      
-      def to_key(*args)
-        args.join('/')
-      end
+    # You can't find :one because that finds all *objects* with that tag
+    def self.find_by_name(arg)
+      tags = self.find(:all).detect{|tag| tag.name == arg}
     end
   end
 end

data/spec/cachable_spec.rb

@@ -1,66 +1,84 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe Highrise::Base, "class configuration" do
+class CachedResource < ActiveResource::Base
+  include ::Cachable
+end
+
+describe CachedResource, "class configuration" do
   before(:each) do
-    Highrise::Base.site = 'http://example.com.i:3000'
+    CachedResource.site = 'http://example.com.i:3000'
   end
     
   it "should tell us if caching is active" do
-    Highrise::Base.cache_store = ActiveSupport::Cache.lookup_store :memory_store
-    Highrise::Base.is_caching?.should == true
+    CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+    CachedResource.connection.is_caching?.should == true
   end
   
   it "should tell us if caching is not active" do
-    Highrise::Base.cache_store = nil
-    Highrise::Base.is_caching?.should == false
+    CachedResource.connection.cache_store = nil
+    CachedResource.connection.is_caching?.should == false
   end
 end
 
-describe Highrise::Base do
+describe CachedResource do
   before(:all) do
-    Highrise::Base.site = 'http://example.com.i:3000'
-    Highrise::Base.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+    CachedResource.site = 'http://example.com.i:3000'
+    CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :memory_store
   end
   
   after(:all) do
-    Highrise::Base.cache_store = :none
+    CachedResource.connection.cache_store = :none
   end
   
   before(:each) do
-    @thing = Highrise::Base.new
+    @thing = CachedResource.new(:id => 1)
     @key = :key
-    Highrise::Base.stub!(:cache_key).and_return(@key)
+    CachedResource.connection.stub!(:cache_key).and_return(@key)
   end
   
   context "when a cached response is available" do
     before(:each) do
-      Highrise::Base.cache_store.write(@key, @thing)
+      CachedResource.connection.cache_store.write(@key, @thing.attributes)
     end
     
     it "should NOT make a request to the RESTful server" do
-      Highrise::Base.should_not_receive(:find_single_without_cache)
-      Highrise::Base.find(1)
+      CachedResource.connection.should_not_receive(:get_without_cache)
+      CachedResource.find(1)
     end
     
     it "should read from the cache" do
-      Highrise::Base.find(1).should == @thing
+      CachedResource.find(1).should == @thing
+    end
+    
+    it "should delete from the cache when an object is DELETEd" do
+      CachedResource.connection.should_receive(:delete_without_cache)
+      CachedResource.delete(1)
+      CachedResource.connection.cache_store.read(@key).should == nil
+    end
+
+    it "should delete from the cache when an object is modified" do
+      thing = CachedResource.find(1)
+      thing.stub(:load_attributes_from_response).and_return(@thing.attributes)
+      CachedResource.connection.should_receive(:put_without_cache)
+      thing.save
+      CachedResource.connection.cache_store.read(@key).should == nil
     end
   end
   
   context "when a cached response is NOT available" do
     before(:each) do
-      Highrise::Base.cache_store.delete(@key)
+      CachedResource.connection.cache_store.delete(@key)
     end
     
-    it "SHOULD perform an ARes request" do
-      Highrise::Base.should_receive(:find_single_without_cache).and_return(@thing)
-      Highrise::Base.find(1)
+    it "SHOULD perform an ActiveResource request" do
+      CachedResource.connection.should_receive(:get_without_cache).and_return(@thing.attributes)
+      CachedResource.find(1)
     end
     
     it "should cache the response using the caching key" do
-      Highrise::Base.should_receive(:find_single_without_cache).and_return(@thing)
-      Highrise::Base.find(1)
-      Highrise::Base.cache_store.read(@key).should == @thing
+      CachedResource.connection.should_receive(:get_without_cache).and_return(@thing.attributes)
+      CachedResource.find(1)
+      CachedResource.connection.cache_store.read(@key).should == @thing.attributes
     end
   end
 end

data/spec/highrise/note_spec.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/../spec_helper'
 describe Highrise::Note do
 
   before(:each) do
+    Highrise::Base.site = 'http://example.com.i:3000'
     @note = Highrise::Note.new(:id => 1)
   end
   

data/spec/highrise/person_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Person do

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: highrise
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - "Marcos Tapaj\xC3\xB3s"
@@ -10,29 +15,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 -10:00
+date: 2010-04-23 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activeresource
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
         version: "2.1"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
         version: "2.1"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: "\n\
   Based on the original API module from DHH, http://developer.37signals.com/highrise/, this\n\
   gem is a cleaned up, tested version of the same. Contributors have added support for tags \n\
@@ -114,18 +125,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper around Highrise API